DICT 查询

在提现之前告诉您一个 Pix 密钥属于谁：姓名、证件和银行。

GET /v2/ex/chaves/{chave}

权限范围：ex.pix.send。

查询由机构按账户逐个开启。未开启时，响应为 403 consulta_de_chave_desligada：请向机构申请。

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
}

字段	说明
`chave`	所查询的密钥，采用 Pix 格式：电子邮件和随机密钥为小写，电话带 `+55`。
`tipo`	`CPF`、`CNPJ`、`EMAIL`、`TELEFONE` 或 `EVP`（随机密钥）。
`nome`	密钥所有人的姓名。
`nomeFantasia`	当所有人是有商号的企业时，为其商号。
`documento`	密钥所有人完整的 CPF 或 CNPJ。仅当执行查询的机构以隐去部分数字的形式提供时，才会如此返回。
`ispb`、`banco`、`bancoNomeCompleto`、`bancoCodigo`、`bancoCnpj`	密钥所在的机构，来自巴西中央银行的参与者名单。
`documentoConfere`	仅在查询带 `documento` 时：该密钥是否属于这个 CPF 或 CNPJ。

发送 documento（CPF 或 CNPJ，带或不带格式）即可知道密钥是否属于它。执行查询的机构未提供某个字段时，该字段可能缺失。

查询有限额：每个账户每分钟最多 5 次，安装每天有总量上限。一小时内再次查询同一密钥时直接作答，不计入限额。超过限额时，响应为 429 limite_de_consultas，并带以秒为单位的 Retry-After。

错误	何时
`400 chave_pix_invalida`	密钥不是有效的 CPF 或 CNPJ、电子邮件、电话（`+55` 加号码），也不是随机密钥。
`400 documento_invalido`	`documento` 不是有效的 CPF 或 CNPJ。
`403 consulta_de_chave_desligada`	您的账户未开启查询。
`404 chave_nao_encontrada`	该密钥在 Pix 中不存在。
`429 limite_de_consultas`	短时间内查询过多，或达到当日总量。请在 `Retry-After` 之后重试。
`503 consulta_de_chave_indisponivel`	查询暂时没有响应。请几分钟后重试。