Skip to main content
POST
/
v1
/
dict
/
entries
Create an Entry
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --header 'X-Reason: <x-reason>' \
  --data '
{
  "keyType": "EMAIL",
  "key": "john.doe@example.com"
}
'
{
  "id": "019c96a0-0c0c-7221-8cf3-13313fb60081",
  "key": "john.doe@example.com",
  "keyType": "EMAIL",
  "status": "ACTIVE",
  "account": {
    "branch": "0001",
    "number": "123456789",
    "participant": "12345678",
    "type": "TRAN"
  },
  "owner": {
    "name": "John Doe",
    "taxIdNumber": "12345678901",
    "type": "NATURAL_PERSON"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Account-Id
string
required

Unique identifier of the Midaz Ledger Account (UUID format).

​
X-Reason
enum<string>
required

Reason for creating the entry.

Available options:
USER_REQUESTED,
RECONCILIATION

Body

application/json
​
keyType
enum<string>
required

Type of Pix key being created.

Available options:
EMAIL,
PHONE,
CPF,
CNPJ,
EVP
Example:

"EMAIL"

​
key
string

Pix key value being registered (e.g., email address, phone, or CPF). Not required for EVP type.

Example:

"john.doe@example.com"

​
metadata
object

Optional key-value map for storing custom attributes.

Response

Pix entry created successfully.

​
id
string

Unique identifier of the entry (UUID format).

Example:

"019c96a0-0c0c-7221-8cf3-13313fb60081"

​
key
string

Pix key value.

Example:

"john.doe@example.com"

​
keyType
string

Type of Pix key.

Example:

"EMAIL"

​
status
string

Entry status (ACTIVE, INACTIVE).

Example:

"ACTIVE"

​
account
object
​
owner
object
​
createdAt
string<date-time>

Creation timestamp.

Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>

Last update timestamp.

Example:

"2024-01-15T10:30:00Z"