/api/BancoCentralProibidos
💡 O endpoint
/api/BancoCentralProibidos
permite consultar informações sobre o Quadro Geral de Proibidos do Banco Central, que lista pessoas físicas ou jurídicas temporariamente proibidas de prestar serviços de auditoria para instituições autorizadas pelo Banco Central.
Introdução
A API Banco Central - Quadro Geral de Proibidos fornece informações sobre penalidades aplicadas a pessoas físicas ou jurídicas, incluindo:
- Dados de CPF ou CNPJ da entidade proibida;
- Detalhes das penalidades, como duração e descrição;
- Datas de início e fim da proibição.
Essa API é ideal para análise de risco/crédito e compliance/ESG.
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br
Endpoint
GET /api/BancoCentralProibidos
Esse endpoint retorna informações detalhadas sobre pessoas físicas ou jurídicas temporariamente proibidas de prestar serviços de auditoria.
Regras:
- Apenas um documento (CPF ou CNPJ) pode ser enviado por requisição.
- Este endpoint não permite a geração de comprovantes.
Autenticação
A autenticação é feita utilizando um TOKEN. Sem um token válido, o acesso será negado (401
).
Regras de Autenticação
- O
TOKEN
deve ser incluído como parâmetro obrigatório. - Caso o token seja inválido ou expirado, entre em contato pelo e-mail: suporte@directd.com.br.
Campos da API
Dados Retornados
- Nome da Entidade: Nome da pessoa física ou jurídica penalizada.
- Documento: CPF ou CNPJ do penalizado.
- Lista de Penalidades:
- Número PAS: Identificador do processo sancionador.
- Descrição: Detalhes sobre a penalidade aplicada.
- Prazo em Anos: Duração da penalidade.
- Data de Início: Data de início da proibição.
- Data de Fim: Data de término da proibição.
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CNPJ | string | Não | CNPJ da entidade penalizada (com ou sem formatação). |
CPF | string | Não | CPF da entidade penalizada (com ou sem formatação). |
TOKEN | string | Sim | Token de autenticação. |
Exemplo de Requisição
Usando cURL
curl -X 'GET' \
'https://apiv3.directd.com.br/api/BancoCentralProibidos?CNPJ=12345678000123&TOKEN=68ADA2C3-8016-47DA-ADE6-13AE239308FE' \
-H 'accept: application/json'
Respostas
Sucesso (200)
A consulta foi realizada com sucesso e retorna os dados da entidade penalizada.
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "Banco Central - Quadro Geral de Proibidos",
"consultaUid": "direct-123456",
"mensagem": "Consulta realizada com sucesso.",
"resultado": "Sucesso",
"apiVersao": "v3",
"tempoExecucaoMs": 200
},
"retorno": {
"nomeEntidade": "Empresa Exemplo Ltda.",
"documento": "12345678000123",
"penalidades": [
{
"numeroPAS": "PAS123456",
"descricao": "Proibição por não conformidade com padrões de auditoria.",
"prazoEmAnos": "5",
"dataInicio": "01/01/2023",
"dataFim": "01/01/2028"
}
]
}
}
Erros Comuns
Código | Descrição |
---|---|
400 | Requisição inválida: parâmetros incorretos. |
401 | Não autenticado: token inválido ou ausente. |
403 | Não autorizado: saldo insuficiente para realizar a consulta. |
404 | Não encontrado: registro não localizado. |
408 | Tempo esgotado: consulta não foi concluída no prazo. |
500 | Erro interno: falha no processamento da consulta. |
503 | Serviço em manutenção: indisponível temporariamente. |
Notas Importantes
- Apenas um documento (CPF, CNPJ, Número da APF ou CAR) deve ser enviado por consulta.
- Este endpoint não gera comprovantes.
- Em caso de dúvidas ou suporte, entre em contato pelo e-mail suporte@directd.com.br.