POST
/
v1
/
entries
Create key
curl --request POST \
  --url http://localhost:4011/v1/entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "+5511987654321",
  "keyType": 0,
  "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
  "isKeyValidated": false
}'
{
  "key": "+5511987654321",
  "keyType": 0,
  "status": "ACTIVE",
  "statusString": "ACTIVE"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Body

application/json
​
key
string
required

Pix key value

Example:

"+5511987654321"

​
keyType
enum<integer>
required

Pix key type enumeration (0- REGISTRATION_NUMBER, 1- TAX_IDENTIFIER, 2- EMAIL, 3- PHONE, 4- RANDOM).

Available options:
0,
1,
2,
3,
4
​
accountId
string<uuid>
required

Account ID owning the key

Example:

"01989f9e-6508-79f8-9540-835be49fbd0d"

​
isKeyValidated
boolean
required

Whether key is pre-validated

Example:

false

Response

Pix key created successfully

​
key
string

Created Pix key

Example:

"+5511987654321"

​
keyType
enum<integer>

Pix key type enumeration (0- REGISTRATION_NUMBER, 1- TAX_IDENTIFIER, 2- EMAIL, 3- PHONE, 4- RANDOM).

Available options:
0,
1,
2,
3,
4
​
status
enum<string>

Pix key status.

Available options:
ACTIVE,
WAITING_OWNERSHIP_CONFIRMATION,
CREATING,
IM_CLAIMER_PENDING_CONFIRM_CLAIM_REQUEST,
IM_CLAIMER_PENDING_OWNER_GIVEWAY,
IM_OWNER_PENDING_GIVEAWAY_CONFIRM,
IM_CLAIMER_AND_OWNER_GAVEAWAY_PENDING_MY_CONFIRM
​
statusString
string

Human-readable status

Example:

"ACTIVE"