DICT lookup

Tells you who owns a Pix key before a payout: the name, the document and the bank.

GET /v2/ex/chaves/{chave}

Scope: ex.pix.send.

The institution turns the lookup on, account by account. When it is off, the response is 403 consulta_de_chave_desligada: ask the institution.

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
}

Field	Description
`chave`	The key looked up, in Pix form: e-mail and random key in lowercase, phone with `+55`.
`tipo`	`CPF`, `CNPJ`, `EMAIL`, `TELEFONE` or `EVP` (the random key).
`nome`	The name of the key owner.
`nomeFantasia`	The trade name, when the owner is a company that has one.
`documento`	The owner's full CPF or CNPJ. It comes with part of the digits hidden only when the institution that runs the lookup provides it that way.
`ispb`, `banco`, `bancoNomeCompleto`, `bancoCodigo`, `bancoCnpj`	The institution that holds the key, from the Central Bank participant lists.
`documentoConfere`	Only with `documento` in the lookup: whether the key belongs to that CPF or CNPJ.

Send documento (the CPF or the CNPJ, with or without the mask) to learn whether the key belongs to it. Any field may be missing when the institution that runs the lookup does not provide it.

The lookup has limits: up to 5 per minute per account, and a daily total for the installation. The same key looked up again within one hour answers without counting. Past a limit, the response is 429 limite_de_consultas, with Retry-After in seconds.

Error	When
`400 chave_pix_invalida`	The key is not a valid CPF or CNPJ, e-mail, phone (`+55` and the number) or random key.
`400 documento_invalido`	The `documento` is not a valid CPF or CNPJ.
`403 consulta_de_chave_desligada`	The lookup is not turned on for your account.
`404 chave_nao_encontrada`	The key does not exist in Pix.
`429 limite_de_consultas`	Too many lookups in a short time, or the daily total. Retry after `Retry-After`.
`503 consulta_de_chave_indisponivel`	The lookup did not answer now. Retry in a few minutes.