List Pix Keys of an Account

Request

ENDPOINT

/baas/pix/keys

METHOD

GET

Query Params

Field	Type	Description	Characters
account_key *	string	Account uuid key.	uuid key
pix_key_status	enum	Enumerator Pix Key Status Enumerator indicating the status of the pix keys to be returned.	-

Enumerator Pix Key Status

Enumerator	Description
pending_confirmation	Pending confirmation
active	Active
inactivated	Inactive
pending_claim_request_confirmation	Pending confirmation of the Pix key portability request

Response

STATUS

200

Response Body

[
  {
    "account_key": "6d30a0b1-cb90-4ceb-b1ea-5bd600cdf3c8",
    "pix_key": "63927180432",
    "pix_key_status": "active",
    "pix_key_type": "cpf",
    "updated_at": "2022-09-02T20:00:36",
    "created_at": "2022-09-02T20:00:36"
  },
  {
    "account_key": "40cea00e-9d99-46f9-b55f-dbafa84553a9",
    "pix_key": "+5562985013819",
    "pix_key_status": "pending_confirmation",
    "pix_key_type": "phone_number",
    "updated_at": "2022-09-02T20:00:36",
    "created_at": "2022-09-02T20:00:36"
  },
  {
    "account_key": "0ebc3bfb-be25-4093-adf2-f0cdee6f5e69",
    "pix_key": "address@email.com",
    "pix_key_status": "pending_confirmation",
    "pix_key_type": "email",
    "updated_at": "2022-09-02T20:00:36",
    "created_at": "2022-09-02T20:00:36"
  }
]

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}