Consultar chave no DICT
Consulta de chave PIX no DICT
Caso seja necessário consultar a veracidade de uma chave antes de uma movimentação financeira, é necessário consultar a mesma no diretório de participantes do sistema Pix.
Este procedimento é uma boa prática para garantir a veracidade de informações especialmente para transferência de Pix-out.
Toda consulta no diretório DICT é obrigatoriamente registrada o CNPJ/CPF do consultante da chave. Este processo é transparente para o cliente do produto Pix Cobrança.
Usado para:
- consultar a veracidade de uma chave no diretório DICT;
- validar dados de um titular de uma chave;
É possível consultar qualquer tipo de chave no DICT.
Como consultar uma chave no DICT
ENDPOINT: https://kaizen.bt-staging.app/pix-service/dict/:keyId
_Esse endpoint utiliza o método GET.
Header da requisição
| header | descrição |
|---|---|
| tax-id-logged | - CPF ou CNPJ do consultante da chave no DICT |
Modelo de requisição:
https://kaizen.bt-{{env}}.app/pix-service/dict/{{CHAVE}}
curl --location 'https://kaizen.bt-staging.app/pix-service/dict/52779545038' \
--header 'tax-id-logged: 99988877766' \
--header 'Authorization: Bearer TOKEN'
Modelo de resposta:
{
"endToEndId": "E03311443202304041744EdKreXIIods",
"entry": {
"creationDate": "2022-06-13T13:13:17.053Z",
"account": {
"user": {
"taxId": "***34515***",
"taxIdHash": "26131d678bd1aff34312fbb8208a6e2a",
"type": "personal",
"name": "LUCAS MADEIRA"
},
"ispb": "30306294"
},
"keyType": "EMAIL",
"key": "[email protected]"
}
}
{
"entry": {
"account": {
"user": {
"taxId": "62829257000108",
"taxIdHash": "7e0e63583ca4e18dd2fe243fcc3c7474979fa03c736888aef890473847e05d07",
"type": "corporate",
"name": "PIX COBRANCA"
},
"ispb": "03311443"
},
"keyType": "EVP",
"key": "afc5d013-dfa8-421a-b6d1-06932e6dc9ae"
}
}
{
"status": "400",
"message": "[400] Entry is blocked (stackId: 45271747-1e48-4cbf-9572-755297045814)",
"stackId": "45271747-1e48-4cbf-9572-755297045814",
"details": {
"correlationId": "B2023090810260475303311443B5E963",
"detail": "Entry is blocked",
"status": "400",
"title": "Bad Request",
"type": "https://dict.pi.rsfn.net.br/api/v1/error/EntryBlocked",
"$": {
"xmlns": "urn:ietf:rfc:7807"
}
},
"stack": false
}
Observe que, por motivos de conformidade com a Lei Geral de Proteção de Dados (LGPD), as chaves mantidas por pessoas físicas têm o valor do taxID (CPF) ofuscado por meio de um código hash. O cliente BIT Capital, ao possuir o CPF para consulta, pode confirmar o número do CPF utilizando o código hash declarado no campo "taxidhash".
Descrição dos campos:
| campo | tipo | descrição |
|---|---|---|
| internal | boolean | - true: informa que a chave consultada faz parte do mesmo ISPB do consultante. Neste caso, ISBP Parati. Identificamos como "chave interna" - false: informa que a chave consultada não faz parte do ISPB do consultante. Identificamos como "chave externa". |
| endToEndId | string(32) | - identificador de 32 caracteres que sempre inicia com a letra "E" |
| entry.account.user.taxId | string(11 | 13) | - numero do CPF ou CNPJ do detentor da chave |
| entry.account.user.taxIdHash | string() | - hash do CPF (dono da chave) |
| entry.account.user.name | string() | - nome do detentor da chave |
| entry.account.user.type | ENUM(personal | corporate) | - tipo de conta bancária vinculada a chave - PERSONAL: chave vinculada a uma pessoa física - CORPORATE: chave vinculada a uma pessoa jurídica |
| entry.account.ispb | string(8) | - identifica o ISPB detentor da chave consultada; |
| entry.keyType | ENUM (EVP | PHONE | EMAIL | CPF | CNPJ ) | - identifica o tipo de chave |
| entry.key | string() | - identifica a chave consultada |
Importante:
Chaves reais do PIX não são consultadas no ambiente de desenvolvimento. Para simulação de consultas de chaves externas no ambiente de desenvolvimento, é necessário requerer alguns exemplos com a equipe de Integração da BIT Capital.
Informação:
Para entender o funcionamento do Sistema de baldes e fichas do Bacen, para a consulta de chaves no DICT, acesse o link:
Atenção:
Caso o usuário exceda seu limite de consulta de chaves no BACEN (erro de 429) ele será penalizado por 10 minutos sem conseguir realizar uma nova consulta. Caso ocorram novas tentativas durante a janela de penalidade, o usuário continuará recebendo erro 429.
Mais informações sobre os limites de consultas podem ser encontrados no site do BACEN pelo link:
Updated 5 months ago