Debitado do seu saldo a cada chamada cobrada. Autenticação pelo header X-API-Key. Veja como obter a chave.
Consulta detalhadas informações de histórico creditício baseadas no Sistema de Informações de Créditos, um repositório central mantido pelo Banco Central do Brasil. Esta consulta agrega dados sobre operações de crédito com exposição igual ou superior a R$ 200,00, permitindo análise completa do perfil de risco e comportamento de pagamento.
O endpoint fornece uma visão abrangente do perfil creditício da entidade consultada, incluindo classificação de risco, composição da carteira, vencimentos pendentes e evolução do compromisso financeiro. É especialmente útil para:
Validação cadastral: Confirmar informações de clientes e fornecedores contra registros oficiais
Análise de risco: Avaliar exposição creditícia e probabilidade de inadimplência
Conformidade e compliance: Subsidiar decisões regulatórias e de crédito
Decisões operacionais: Automatizar fluxos de aprovação e concessão de crédito
Os dados retornados abrangem múltiplas dimensões: indicadores de risco, distribuição de operações por modalidade, períodos de vencimento, relacionamentos bancários e métricas de evolução.
Dados gerais: documentoConsultado, situacao, relacionamentos, perfil, quantidadeInstituicoes, quantidadeOperacoes
Indicadores de risco: score, classeRisco, volume
Composição da carteira: indice (consolidado, por cartão, crédito pessoal e cheque especial), carteiraCredito (valores a vencer e vencidos)
Análise temporal: percentualPrazo (distribuição em curto, médio e longo prazo), percentualVencido (cartão, empréstimos, financiamentos nas modalidades imobiliária e veicular, adiantamento de depósitos)
Distribuição por modalidade: percentualCategoria (linha de risco maior, cartão, financiamentos, empréstimos, financiamentos de exportação, imobiliários, veiculares, adiantamentos de depositantes, operações de arrendamento, coobrigações, outros créditos e outras operações)
Evolução financeira: percentualEvolucaoCompromisso (total, maior risco, financiamentos e cartão)
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
Cada requisição processa apenas um documento por vez
A consulta retorna dados consolidados conforme reportado pelas instituições financeiras ao Sistema de Informações de Créditos
Informações refletem posição em data específica e são atualizadas conforme alimentação das instituições financeiras
O sigilo bancário é respeitado em conformidade com regulamentações do Banco Central
Recomenda-se usar esta consulta como complemento a outras ferramentas de análise de crédito e risco
Valores monetários podem estar em diferentes formatos; consulte a API para tipagem exata
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.