Consulta DICT

Dice de quién es una clave Pix antes del retiro: el nombre, el documento y el banco.

GET /v2/ex/chaves/{chave}

Alcance: ex.pix.send.

La institución activa la consulta, cuenta por cuenta. Desactivada, la respuesta es 403 consulta_de_chave_desligada: pídasela a la institución.

GET /v2/ex/chaves/a4ffc42c-62d5-49ab-860f-72f1e9791fd5?documento=12345678909
→ 200
{
  "chave": "a4ffc42c-62d5-49ab-860f-72f1e9791fd5",
  "tipo": "EVP",
  "nome": "Ana Souza",
  "documento": "12345678909",
  "ispb": "18236120",
  "banco": "NU PAGAMENTOS - IP",
  "bancoNomeCompleto": "NU PAGAMENTOS S.A. - INSTITUIÇÃO DE PAGAMENTO",
  "bancoCodigo": "260",
  "bancoCnpj": "18236120000158",
  "documentoConfere": true
}

Campo	Descripción
`chave`	La clave consultada, en la forma del Pix: el correo y la clave aleatoria en minúsculas, el teléfono con el `+55`.
`tipo`	`CPF`, `CNPJ`, `EMAIL`, `TELEFONE` o `EVP` (la clave aleatoria).
`nome`	El nombre del dueño de la clave.
`nomeFantasia`	El nombre comercial, cuando el dueño es una empresa que lo tiene.
`documento`	El CPF o el CNPJ completo del titular. Viene con parte de los dígitos ocultos solo cuando la institución que consulta lo informa así.
`ispb`, `banco`, `bancoNomeCompleto`, `bancoCodigo`, `bancoCnpj`	La institución donde está la clave, según las listas de participantes del Banco Central.
`documentoConfere`	Solo con `documento` en la consulta: si la clave es de ese CPF o CNPJ.

Envíe documento (el CPF o el CNPJ, con o sin máscara) para saber si la clave es suya. Cada campo puede faltar cuando la institución que consulta no lo informa.

La consulta tiene límites: hasta 5 por minuto por cuenta, y un total por día en la instalación. La misma clave consultada de nuevo dentro de una hora responde sin contar. Pasado un límite, la respuesta es 429 limite_de_consultas, con Retry-After en segundos.

Error	Cuándo
`400 chave_pix_invalida`	La clave no tiene la forma de un CPF o CNPJ válido, correo, teléfono (`+55` y el número) ni clave aleatoria.
`400 documento_invalido`	El `documento` no es un CPF ni un CNPJ válido.
`403 consulta_de_chave_desligada`	La consulta no está activada para su cuenta.
`404 chave_nao_encontrada`	La clave no existe en el Pix.
`429 limite_de_consultas`	Demasiadas consultas en poco tiempo, o el total del día. Repita después del `Retry-After`.
`503 consulta_de_chave_indisponivel`	La consulta no respondió ahora. Repita en unos minutos.