Check Pix Key

Checks the ownership of an external Pix key.

Use this operation to identify the recipient associated with the key before making a Pix transfer.

📘

Lookup limits

This operation is subject to both the Rate Limit and the Token Bucket. Lookups consume Token Bucket tokens, and invalid lookups consume more than valid ones.

See the Token Bucket limits and rules.

⚠️

Sandbox

In Sandbox, only the key 47996515839 is available for lookup. The cpfCnpj field is returned masked in that environment.

To check the available balance before performing lookups in volume, use Check available tokens in the bucket.

Related content

Guides

Query Params
string
enum

Pix Key type

Allowed:
string

Pix Key value

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