List keys

Lists, in paginated form, the Pix keys linked to the authenticated account.

Use status to filter by a single status or statusList to query multiple statuses in the same request, separated by commas.

The response shows the current status of each key and, when applicable, whether it can be removed, through canBeDeleted, and the reason for the restriction in cannotBeDeletedReason. When returned, qrCode contains the Base64 image and the Pix Copy and Paste payload associated with the key.

⚠️

Key status

Keys in statuses such as AWAITING_ACTIVATION, AWAITING_DELETION or ERROR may require a new lookup before actions that depend on the current status.

Before removing a key, validate canBeDeleted and, when removal is not available, check cannotBeDeletedReason.

To view a specific key by ID, use Retrieve a single key.

Related content

Guides

Error Library

Query Params
integer

List starting element

integer
≤ 100

Number of list elements (max: 100)

string
enum

Filter by current key status

Allowed:
string

Filter by one or more key statuses

Responses

403

Forbidden. Occurs when the request body is filled, GET method calls must have an empty body.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json