Orientações e respostas da equipe da Direct Data

/api/Score

💡 A API Credit Rating - Quod retorna o score de crédito de uma Pessoa Física ou Jurídica e realiza uma análise detalhada de risco. Ideal para onboarding, prevenção de lavagem de dinheiro e decisões de crédito.

Introdução

A API Credit Rating - Quod fornece dados essenciais sobre a capacidade de pagamento e o perfil de risco de indivíduos ou empresas, baseando-se em dados de score de crédito. Esse serviço é amplamente utilizado por empresas do setor financeiro, jurídico e de auditoria para avaliar o risco de crédito e tomar decisões fundamentadas.

URL Base

A API está hospedada no seguinte endereço:

https://api.directd.com.br

Endpoint

GET /api/Score

Descrição: Endpoint para realizar consultas ao serviço de análise de crédito Credit Rating - Quod.

Nota: Esta consulta não oferece opção de gerar comprovantes.

Autenticação

Para acessar esta API, é necessário fornecer um token de autenticação.

Regras de Autenticação:

1. O token deve ser enviado como parâmetro na URL da requisição.
2. O token é obrigatório para realizar consultas.

Campos da API

Informações Gerais

• Data da Consulta: Data em que a análise foi realizada.
• Documento Consultado: CPF ou CNPJ associado à consulta.

Para Pessoa Física

• Score: Pontuação de crédito atribuída à pessoa física.
• Capacidade de Pagamento: Indicador da capacidade financeira do indivíduo.
• Perfil: Classificação de perfil financeiro do indivíduo.

Para Pessoa Jurídica

• Score: Pontuação de crédito atribuída à pessoa jurídica.
• Motivos: Razões que justificam o score atribuído.
• Indicadores de Negócio: Dados adicionais, como status, risco e observações relacionadas à empresa.

Parâmetros

Exemplo de Requisição

Usando cURL

curl 'https://api.directd.com.br/api/Score?CPF=12345678909&TOKEN=seu_token_aqui'

Respostas

Sucesso (200)

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Credit Rating - Quod",
    "consultaUid": "quod-123456",
    "usuario": "Amanda",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 1100
  },
  "retorno": {
    "dataConsulta": "01/12/2024",
    "documentoConsultado": "123.456.789-09",
    "pessoaFisica": {
      "score": 750,
      "capacidadePagamento": "Alta",
      "perfil": "Conservador"
    },
    "observacao": "Cliente com bom histórico de crédito."
  }
}

Erros Comuns

Notas Importantes

• Informe apenas um documento por requisição (CPF ou CNPJ).
• Certifique-se de que o token de autenticação está ativo e válido.
• Em caso de dúvidas ou suporte, entre em contato pelo e-mail suporte@directd.com.br.