Debitado do seu saldo a cada chamada cobrada. Autenticação pelo header X-API-Key. Veja como obter a chave.
Consulta registros de indivíduos que estão temporariamente impedidos de atuar em instituições financeiras ou consórcios, conforme determinações regulatórias. O recurso retorna informações sobre bloqueios administrativos, incluindo motivos, prazos e histórico de restrições aplicadas.
Ideal para integração em processos de avaliação de risco, validação cadastral em fluxos de crédito e conformidade regulatória. Reduz a necessidade de consultas manuais repetitivas e aumenta a confiabilidade na detecção de impedimentos antes de operações críticas.
{
"type": "object",
"properties": {
"data": {
"type": [
"object",
"null"
],
"properties": {
"retorno": {
"type": [
"object",
"null"
],
"properties": {
"cpf": {
"type": [
"string",
"null"
],
"description": "CPF do indivíduo."
},
"nome": {
"type": [
"string",
"null"
],
"description": "Nome do indivíduo consultado."
},
"observacoes": {
"type": [
"string",
"null"
],
"description": "Observações adicionais sobre o registro."
},
"penalidades": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"dataFim": {
"type": [
"string",
"null"
],
"description": "Data de término da penalidade."
},
"descricao": {
"type": [
"string",
"null"
],
"description": "Descrição da penalidade aplicada."
},
"numeroPAS": {
"type": [
"string",
"null"
],
"description": "Número do Processo Administrativo Sancionador."
},
"dataInicio": {
"type": [
"string",
"null"
],
"description": "Data de início da penalidade."
},
"prazoEmAnos": {
"type": [
"string",
"null"
],
"description": "Duração da penalidade em anos."
}
}
},
"description": "Lista de penalidades associadas ao indivíduo."
},
"constamPenalidades": {
"type": [
"boolean",
"null"
],
"description": "Indica se o indivíduo possui penalidades."
}
},
"description": "Dados retornados da consulta."
},
"metaDados": {
"type": [
"object",
"null"
],
"properties": {
"ip": {
"type": [
"string",
"null"
],
"description": "Endereço IP de origem da requisição."
},
"data": {
"type": [
"string",
"null"
],
"description": "Data e hora de execução da consulta."
},
"chave": {
"type": [
"string",
"null"
],
"description": "Chave de autenticação utilizada."
},
"usuario": {
"type": [
"string",
"null"
],
"description": "Usuário que realizou a consulta."
},
"mensagem": {
"type": [
"string",
"null"
],
"description": "Mensagem descritiva da resposta."
},
"apiVersao": {
"type": [
"string",
"null"
],
"description": "Versão da API utilizada."
},
"resultado": {
"type": [
"string",
"null"
],
"description": "Status textual do resultado da consulta."
},
"assincrono": {
"type": [
"boolean",
"null"
],
"description": "Indica se a consulta foi processada de forma assíncrona."
},
"consultaUid": {
"type": [
"string",
"null"
],
"description": "Identificador único da consulta."
},
"resultadoId": {
"type": [
"number",
"null"
],
"description": "Identificador numérico do resultado."
},
"consultaNome": {
"type": [
"string",
"null"
],
"description": "Nome da consulta realizada."
},
"enviarCallback": {
"type": [
"boolean",
"null"
],
"description": "Indica se um callback deve ser enviado."
},
"urlComprovante": {
"type": [
"string",
"null"
],
"description": "URL de acesso ao comprovante gerado."
},
"tempoExecucaoMs": {
"type": [
"number",
"null"
],
"description": "Tempo de execução da consulta em milissegundos."
},
"gerarComprovante": {
"type": [
"boolean",
"null"
],
"description": "Indica se um comprovante será gerado."
}
},
"description": "Metadados da consulta."
}
},
"description": "Dados da consulta ao quadro geral de inabilitados."
},
"found": {
"type": [
"boolean",
"null"
],
"description": "Indica se o registro foi encontrado na consulta."
},
"message": {
"type": [
"string",
"null"
],
"description": "Mensagem descritiva da resposta."
}
}
}
Códigos de erro
Código
Mensagem
Quando acontece
400
Requisição Inválida
a requisição está incorreta ou os parâmetros são inválidos.
401
Não Autenticado
o usuário não forneceu as credenciais corretas para acessar o recurso.
403
Não Autorizado
o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível.
404
Não Encontrado
o servidor não encontrou uma representação atual do recurso solicitado.
408
Tempo Esgotado
o servidor não conseguiu retornar a requisição no prazo estabelecido.
500
Falha ao Realizar Consulta
o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte.
503
Consulta em Manutenção
a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte.
Observações
A consulta processa o resultado de forma síncrona, com retorno imediato.
O endpoint não gera documentos comprobatórios. O resultado é uma consulta informacional para fins de validação interna.
Quando um CPF não retorna registros, o campo found indica falso, mas a requisição é processada com sucesso.
Recomenda-se cachear resultados por período adequado ao seu contexto operacional, considerando que atualizações de impedimentos ocorrem periodicamente.
Integre este endpoint em workflows de compliance para automatizar verificações e reduzir riscos em decisões operacionais.
Integrar
OpenAPI (JSON) ↗ — importe a URL
no Postman ou no Insomnia para gerar a coleção com todos os endpoints. Também dá para consultar
pelo chat: conecte via MCP. Esta página em Markdown.