Consulta DICT

Diz de quem é uma chave Pix antes do saque: o nome, o documento e o banco.

GET /v2/ex/chaves/{chave}

Escopo: ex.pix.send.

A consulta é ligada pela instituição, conta a conta. Desligada, a resposta é 403 consulta_de_chave_desligada: peça a ela.

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	Descrição
`chave`	A chave consultada, na forma do Pix: o e-mail e a chave aleatória em minúsculas, o telefone com o `+55`.
`tipo`	`CPF`, `CNPJ`, `EMAIL`, `TELEFONE` ou `EVP` (a chave aleatória).
`nome`	O nome do dono da chave.
`nomeFantasia`	O nome fantasia, quando o dono é uma empresa que o tem.
`documento`	O CPF ou o CNPJ do dono, inteiro. Vem com parte dos dígitos escondida só quando a instituição que consulta o informa assim.
`ispb`, `banco`, `bancoNomeCompleto`, `bancoCodigo`, `bancoCnpj`	A instituição onde a chave está, pelas listas de participantes do Banco Central.
`documentoConfere`	Só com `documento` na consulta: se a chave é desse CPF ou CNPJ.

Mande documento (o CPF ou o CNPJ, com ou sem máscara) para saber se a chave é dele. Cada campo pode faltar quando a instituição que consulta não o informa.

A consulta tem limites: até 5 por minuto por conta, e um total por dia na instalação. A mesma chave consultada de novo em até uma hora responde sem contar. Passado um limite, a resposta é 429 limite_de_consultas, com Retry-After em segundos.

Erro	Quando
`400 chave_pix_invalida`	A chave não tem a forma de um CPF ou CNPJ válido, e-mail, telefone (`+55` e o número) nem chave aleatória.
`400 documento_invalido`	O `documento` não é um CPF nem um CNPJ válido.
`403 consulta_de_chave_desligada`	A consulta não está ligada para a sua conta.
`404 chave_nao_encontrada`	A chave não existe no Pix.
`429 limite_de_consultas`	Consultas demais em pouco tempo, ou o total do dia. Repita depois do `Retry-After`.
`503 consulta_de_chave_indisponivel`	A consulta não respondeu agora. Repita em alguns minutos.