GET
/
v1
/
entries
List Keys
curl --request GET \
  --url http://localhost:4011/v1/entries \
  --header 'Authorization: Bearer <token>'
[
  {
    "key": "12345678901",
    "status": "ACTIVE",
    "statusString": "ACTIVE",
    "type": 0
  }
]

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Query Parameters

​
account_id
string<uuid>
required

Account ID to retrieve Pix keys for

Response

Pix keys retrieved successfully

​
key
string

Pix key value

Example:

"12345678901"

​
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"

​
type
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