A API Score de Crédito - QUOD é responsável por retornar o Score de uma Pessoa Física ou Jurídica e realiza uma análise do risco de crédito.
Score de Crédito - QUOD
Consulta responsável por retornar o Score de uma Pessoa Física ou Jurídica e realiza uma análise do risco de crédito.
Casos de Uso
- Integração com Score de Crédito - QUOD
- Qualificação e roteamento inteligente de leads
- Modelos de crédito e propensão
- Segmentação e personalização de campanhas
Aplicações
- Prevenção de Autuações Fiscais
- Onboarding de Clientes e Fornecedores
- Prevenção de Lavagem de Dinheiro
- Análise de Risco/Crédito
Benefícios
- Documentação de Score de Crédito - QUOD acessível e atualizada
- Aumenta conversão com menos atrito
- Melhora acurácia dos modelos
- Dados prontos para uso analítico
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/ScoreEndpoint
GET https://apiv3.directd.com.br/api/Score?CPF={0}&CNPJ={1}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Score de Crédito - QUOD.
Nota: Esta consulta não gera comprovantes.
Campos Retornados
- Capacidade de Pagamento: Descrição sobre a capacidade de pagamento da entidade consultada
- Data da Consulta: Data da consulta
- Documento Consultado: Documento consultado referente ao CPF/CNPJ
- Faixa do Score: Informa a faixa do score da entidade.
- Indicador: Descreve o título do indicador
- Lista de Indicadores de Negócio: Lista os indicadores de negócios utilizados para gerar o score final
- Lista de Motivos: Lista os motivos que fez a entidade possuir o score apresentado
- Observação: Observação relacionada ao registro retornado
- Perfil: Detalhes sobre o perfil da entidade
- Pessoa Física: Retorna os dados da pessoa física consultada
- Pessoa Jurídica: Retorna os dados da pessoa Jurídica consultada
- Risco: Descreve o risco que a entidade possui com relação ao indicador analisado
- Score: Pontuação da entidade consultada
- Status: Retorna detalhes sobre o status do registro em questão
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
CNPJ | string | Sim | O parâmetro CNPJ pode ser enviado com ou sem formatação. |
CPF | string | Sim | O parâmetro CPF pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br |
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"enviarCallback": false,
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"dataConsulta": "string",
"documentoConsultado": "string",
"pessoaFisica": {
"score": 0,
"faixaScore": "string",
"capacidadePagamento": "string",
"perfil": "string"
},
"pessoaJuridica": {
"score": 0,
"faixaScore": "string",
"motivos": [
"string"
],
"indicadoresNegocio": [
{
"indicador": "string",
"status": "string",
"risco": "string",
"observacao": "string"
}
]
},
"observacao": "string"
}
}Erros Comuns
| Código | Descrição |
|---|---|
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. |
Notas Importantes
- Informe apenas um único documento por requisição
- Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
- Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228