Validar chave Pix (DICT)

Valida uma chave Pix no DICT (Diretório de Identificadores de Contas
Transacionais) e retorna os dados públicos do recebedor (nome,
instituição, CPF/CNPJ mascarado). Pré-requisito comum antes de iniciar
uma transferência Pix por chave.

Recomendação fortemente sugerida: envie keyType explícito. O app
normalmente já sabe qual tipo o usuário selecionou (tab CPF/CNPJ/Email/
Phone/EVP). Sem keyType, o backend tenta inferir pelo formato, o que
é ambíguo em CPF×celular (ambos com 11 dígitos numéricos).

Sobre os dados bancários do recebedor (ispb, bankAccountNumber,
bankBranchNumber, bankAccountType): a Autra retorna esses campos
criptografados (RSA) por privacidade — nossa API filtra esses valores
antes de devolver.

App NÃO precisa enviar bank no /pix-payments: basta passar
creditParty.key. O backend Autra faz o DICT lookup internamente,
preenche credit_party.bank + end_to_end_id (ISPB do destino,
exigência BACEN) e envia para a Autra. Para a UI de confirmação
usuário→destino, holderName + bankName + nationalRegistrationMask
é o suficiente (padrão de mercado — Santander, PicPay, etc.).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Chave Pix. Aceita:

  • CPF (11 dígitos, ex: 12345678900)
  • CNPJ (14 dígitos, ex: 12345678000190)
  • E-mail (ex: [email protected])
  • Telefone E.164 (ex: +5511999998888) — sem o +55 também é aceito quando keyType=PHONE
  • EVP / chave aleatória (UUID, ex: 7e912979-224e-431e-aeb1-d8fb466c10f3)
string
enum

Tipo da chave, case-insensitive. Quando enviado, o backend usa
normalização específica do tipo e retorna 400 INVALID_KEY_FORMAT
se key violar o formato esperado.

Quando omitido, o backend infere pelo formato:

  • + prefix → PHONE
  • 14 dígitos → CNPJ
  • 11 dígitos → tenta validar como CPF (dígitos verificadores mod 11), senão assume telefone (3º dígito = 9)
  • contém @ → EMAIL
  • UUID-like → EVP
Allowed:
Responses

400

MISSING_PARAM se key não enviado, ou INVALID_KEY_FORMAT se
key não bate com o keyType informado.

403

Token inválido ou IP não autorizado.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json