Debitado do seu saldo a cada chamada cobrada. Autenticação pelo header X-API-Key. Veja como obter a chave.
Este endpoint avalia a capacidade de pagamento e o perfil de risco de uma pessoa física ou jurídica. Retorna uma pontuação consolidada baseada em múltiplos indicadores de comportamento financeiro e histórico, permitindo decisões rápidas sobre concessão de crédito, aprovação de parceiros e identificação de riscos.
Principais casos de uso:
Qualificação automática e roteamento inteligente de leads durante processos de venda
Construção e refinamento de modelos de crédito e propensão de compra
Segmentação de clientes para personalização de campanhas e ofertas
Validação de fornecedores e parceiros no onboarding
Análise preventiva de risco em operações financeiras
Apoio em processos de due diligence e conformidade
{
"type": "object",
"properties": {
"observacao": {
"type": [
"string",
"null"
],
"description": "Observação relacionada ao registro retornado."
},
"dataConsulta": {
"type": [
"string",
"null"
],
"description": "Data e hora em que a consulta foi realizada."
},
"pessoaFisica": {
"type": [
"object",
"null"
],
"properties": {
"score": {
"type": [
"number",
"null"
],
"description": "Pontuação da pessoa física."
},
"perfil": {
"type": [
"string",
"null"
],
"description": "Detalhes sobre o perfil da pessoa física."
},
"faixaScore": {
"type": [
"string",
"null"
],
"description": "Classificação da faixa de score (Alto, Médio ou Baixo índice de inadimplência)."
},
"capacidadePagamento": {
"type": [
"string",
"null"
],
"description": "Descrição sobre a capacidade de pagamento da pessoa física."
}
},
"description": "Dados de score de crédito da pessoa física consultada."
},
"pessoaJuridica": {
"type": [
"object",
"null"
],
"properties": {
"score": {
"type": [
"number",
"null"
],
"description": "Pontuação da pessoa jurídica."
},
"motivos": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "Lista de motivos que resultaram no score apresentado."
},
"faixaScore": {
"type": [
"string",
"null"
],
"description": "Classificação da faixa de score (Alto, Médio ou Baixo índice de inadimplência)."
},
"indicadoresNegocio": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"risco": {
"type": [
"string",
"null"
],
"description": "Nível de risco associado ao indicador."
},
"status": {
"type": [
"string",
"null"
],
"description": "Status do indicador."
},
"indicador": {
"type": [
"string",
"null"
],
"description": "Título do indicador de negócio."
},
"observacao": {
"type": [
"string",
"null"
],
"description": "Observação sobre o indicador."
}
}
},
"description": "Lista de indicadores de negócio utilizados no cálculo do score."
}
},
"description": "Dados de score de crédito da pessoa jurídica consultada."
},
"documentoConsultado": {
"type": [
"string",
"null"
],
"description": "Documento consultado referente ao CPF ou CNPJ."
}
}
}
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 faixa de score varia em três níveis: 0-600 (alto risco de inadimplência), 601-700 (médio risco) e 701-1000 (baixo risco).
Este endpoint não gera comprovantes de consulta.
A resposta inclui metadados como data/hora exata da consulta, versão da API e tempo de execução.
Recomenda-se integrar os indicadores de negócio retornados em dashboards analíticos para acompanhamento contínuo.
Em caso de dificuldades, consulte a documentação completa do gateway ou entre em contato com o suporte.
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.