✨ A API Score de Crédito + Indicadores Comportamentais oferece uma análise detalhada de risco de crédito para Pessoas Físicas e Jurídicas. Com ela, é possível obter o Score de Crédito e informações comportamentais relacionadas ao histórico financeiro e demográfico.
Introdução
A API Score de Crédito + Indicadores Comportamentais é essencial para validação e análise de risco de crédito em processos de onboarding e compliance financeiro. Os dados incluem pontuação de crédito, indicadores sociodemográficos e históricos financeiros detalhados.
URL Base
A API está hospedada no seguinte endereço:
https://api.directd.com.br
Endpoint
Consulta de Score de Crédito e Indicadores
GET /api/ScoreCreditoIndicadoresComportamentais
Descrição: Endpoint para realizar consultas detalhadas de score de crédito e indicadores comportamentais.
Nota: Este endpoint não gera comprovantes.
Autenticação
Para acessar esta API, é necessário fornecer um token de autenticação.
Regras de Autenticação:
- O token deve ser enviado como parâmetro na URL da requisição.
- O token é obrigatório para realizar consultas.
Campos da API
Informações Cadastrais
- CPF: Cadastro de Pessoa Física.
- Nome: Nome completo da pessoa.
- Data de Nascimento: Data de nascimento no formato ISO (YYYY-MM-DD).
- Idade: Idade estimada.
Indicadores Demográficos
- Faixa Etária
- Sexo
- Estado Civil
- Escolaridade:
- Descrição
- Grupo
Indicadores Socioeconômicos
- Classe Social
- Renda Presumida
- Renda Salário
- Profissão:
- CBO: Classificação Brasileira de Ocupações.
- Descrição.
- Sócio de Empresa: Flag indicando se é sócio.
- Ano de Entrada na Sociedade
- Quantidade de Empresas Sócio
- Qualificação do Sócio
Indicadores Públicos
- Flag Homônimo
- Flag Tem Óbito
- Banco
- Flag PEP (Pessoa Exposta Politicamente)
- Auxílio Emergencial
Status Financeiro
- Quantidade de Dívidas Bancárias
- Quantidade de Bancos com Dívidas Bancárias
- Quantidade CCF (Cheques Sem Fundo)
- Probabilidade de Inadimplência
- Registro de Protesto:
- Quantidade de Cidades com Protesto
- Histórico:
- Quantidade, Valor Médio e Valor Total por Status (Andamento, Encerrado, Consolidado)
- Tendência por Status (Andamento, Encerrado, Consolidado)
- Pontuação de Crédito:
- Pontuação Sociodemográfica
- Score de Crédito
- Nível de Crédito
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CPF | string | Sim | CPF da pessoa consultada. Pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | Token de autenticação necessário para a consulta. |
Exemplos de Requisição
Consulta por CPF:
curl 'https://api.directd.com.br/api/ScoreCreditoIndicadoresComportamentais?CPF=12345678909&TOKEN=seu_token_aqui'
Respostas
Sucesso (200)
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "Score de Crédito + Indicadores Comportamentais",
"consultaUid": "score-credito-123456",
"usuario": "João Silva",
"mensagem": "Sucesso",
"apiVersao": "v3",
"tempoExecucaoMs": 180
},
"retorno": {
"cpf": "123.456.789-09",
"nome": "JOÃO SILVA",
"dataNascimento": "1980-05-15",
"idade": "43",
"dadoDemografico": {
"faixaEtaria": "40-50",
"sexo": "Masculino",
"estadoCivil": "Casado",
"escolaridade": {
"descricao": "Ensino Superior Completo",
"grupo": "Nível Universitário"
}
},
"socioEconomico": {
"classeSocial": "B",
"rendaPresumida": "10.000,00",
"rendaSalario": "8.500,00",
"profissao": {
"cbo": "2512",
"descricao": "Engenheiro Civil"
},
"socioEmpresa": true,
"anoEntradaSociedade": "2015",
"quantidadeEmpresasSocio": 2,
"qualificacaoSocio": "Administrador"
},
"dadoPublico": {
"homonimo": false,
"obito": false,
"banco": "Banco do Brasil",
"pep": false,
"auxilioEmergencial": "Não Recebeu"
},
"statusFinanceiro": {
"quantidadeDividasBancaria": 1,
"quantidadeBancosComDividasBancaria": 1,
"quantidadeCcf": 0,
"probabilidadeInadimplencia": "Baixa",
"pontuacaoCredito": {
"pontuacaoSocioDemografica": 750,
"scoreCredito": 820,
"nivelCredito": "Muito Bom"
}
}
}
}
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. |