Consulte a titularidade de uma chave Pix

Consulte os dados do titular de uma chave Pix para identificar o destinatário antes de realizar uma transferência.

As consultas são controladas por dois mecanismos independentes: Rate Limit e Token Bucket. Ambos precisam estar disponíveis para que a consulta seja processada.

Limites de consulta

Rate Limit

São permitidas até 5 requisições por minuto por conta Asaas. Ao ultrapassar esse limite, novas consultas são temporariamente bloqueadas.

Token Bucket

O Token Bucket utiliza fichas para controlar o volume de consultas realizadas.

Os limites se aplicam às consultas por telefone, e-mail, CPF, CNPJ ou chave aleatória.

Quando as fichas se esgotam, novas consultas ficam bloqueadas até o reabastecimento do Token Bucket.

1. Consulte o saldo de fichas

Antes de realizar consultas em volume, verifique a quantidade de fichas disponível:

GET /pix/tokenBucket/addressKey

Consulte o endpoint: Consulta de fichas disponíveis no balde.

Se houver poucas fichas disponíveis, aguarde o incremento de 2 fichas por minuto antes de continuar.

2. Consulte a chave Pix

Informe o tipo e a chave que deseja consultar:

GET /pix/addressKeys/external?type=&key=

Valores aceitos em type:

Consulte o endpoint: Consultar chave Pix.

Próximos passos

• Consulte o saldo do Token Bucket
• Consulte uma chave Pix