Consultar chave PIX no DICT
Consulta uma chave PIX no Diretório de Identificadores de Contas Transacionais (DICT) para obter informações do titular, como nome, documento e instituição financeira.
Importante: Esta funcionalidade depende da integração com provedores que suportam a consulta DICT. A chave será validada sintaticamente antes da consulta no DICT.
Tipos de chave PIX suportados:
- CPF: Chave baseada em CPF (11 dígitos)
- CNPJ: Chave baseada em CNPJ (14 dígitos)
- EMAIL: Chave baseada em endereço de e-mail
- PHONE: Chave baseada em telefone (formato brasileiro: DDD + número, sem +55)
- EVP: Chave aleatória (UUID)
Formatação das chaves na resposta:
- CPF: Retornado no formato 000.000.000-00
- CNPJ: Retornado no formato 00.000.000/0000-00
- PHONE: Retornado apenas com DDD + número (ex: 18996192794, sem +55)
- EMAIL e EVP: Mantidos como informados
Validação e Comportamento:
A chave PIX será validada antes da consulta no DICT. Se a chave estiver em formato inválido, a requisição será rejeitada com erro 422.
Se a chave não for encontrada no DICT ou houver erro de comunicação com o serviço, será retornado erro 400 com a mensagem "Chave PIX não encontrada."
Apenas quando a chave for encontrada com sucesso no DICT será retornado 200 OK com is_valid: true e as informações do titular.
Request
- Base URL: https://api.virtualpay.online/v2
- URL: https://api.virtualpay.online/v2/pix/dict
- Auth: API key in header x-client-id
Request body
Example request
{
"key": "12345678901",
"type": "CPF"
}Response
Chave PIX encontrada no DICT com sucesso
Example response
{
"key": "123.456.789-01",
"type": "CPF",
"name": "JOAO DA SILVA",
"key_type": "CPF",
"document": "123.456.789-01",
"ispb": "12345678",
"ispb_reduced_name": "BANCO DO BRASIL S.A.",
"is_valid": true
}Changes
No recorded changes to this operation across all 1 revision of this API.