API - Indicadores Sociodemográficos

✨ A API Indicadores Sociodemográficos oferece uma análise detalhada do Score de uma Pessoa Física e realiza uma análise do risco de crédito, além de seus indicadores sociodemográficos.

---

Introdução

A API Indicadores Sociodemográficos é essencial para análise de risco de crédito e validação cadastral. Os dados incluem pontuação de crédito, indicadores sociodemográficos e históricos financeiros detalhados.

Aplicações principais:

• Prevenção de Autuações Fiscais
• Onboarding de Clientes e Fornecedores
• Prevenção de Lavagem de Dinheiro
• Análise de Risco/Crédito

Fonte: Base de Dados

---

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

---

Endpoint

Consulta de Indicadores Sociodemográficos

GET /api/IndicadoresSociodemograficos

Descrição: Endpoint para realizar consultas detalhadas de indicadores sociodemográficos.

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:

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 Cadastrais

• CPF: Cadastro de Pessoa Física
• CPF Origem: CPF de origem da consulta
• Nome: Nome completo da pessoa
• Data de Nascimento: Data de nascimento
• Idade: Idade atual

Dados Demográficos

• Faixa Etária
• Sexo
• Estado Civil
• Escolaridade:
  • Descrição
  • Grupo

Dados Socioeconômicos

• Classe Social
• Renda Presumida
• Renda Salário
• Profissão:
  • CBO: Classificação Brasileira de Ocupações
  • Descrição
• Flag Sócio Empresa
• Ano de Entrada na Sociedade
• Quantidade Empresa Sócio
• Qualificação do Sócio

Dados Públicos

• Flag Homônimo
• Flag Tem Óbito
• Banco
• Flag PEP
• Auxílio Emergencial

Status Financeiro

• Quantidade de Dívidas Bancárias
• Quantidade de Bancos com Dívidas Bancárias
• Quantidade CCF
• Probabilidade de Inadimplência

Registro de Protesto

• Quantidade de Cidades com Protesto
• Tendência:
  • Andamento
  • Encerrado
  • Consolidado
• Histórico:
  • Valor Médio:
    • Andamento
    • Encerrado
    • Consolidado
  • Valor Total:
    • Andamento
    • Encerrado
    • Consolidado
  • Quantidade:
    • Em Andamento
    • Encerrado
    • Consolidado
• Últimos Doze Meses
• Maior que Doze Meses

Pontuação de Crédito

• Pontuação Sociodemográfica
• Faixa de Pontuação Sociodemográfica
• Score de Crédito
• Nível de Crédito

---

Parâmetros

---

Exemplos de Requisição

Consulta por CPF:

curl -X 'GET' \
  'https://api.directd.com.br/api/IndicadoresSociodemograficos?CPF=12345678909&TOKEN=seu_token_aqui' \
  -H 'accept: application/json'

---

Respostas

Sucesso (200)

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Indicadores Sociodemográficos",
    "consultaUid": "indicadores-123456",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 180
  },
  "retorno": {
    "cpf": "123.456.789-09",
    "cpfOrigem": "987.654.321-00",
    "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",
      "registroProtesto": {
        "quantidadeCidadesComProtesto": 0,
        "tendencia": {
          "andamento": "Estável",
          "encerrado": "Decrescente",
          "consolidado": "Estável"
        },
        "historico": {
          "valorMedio": {
            "andamento": "0,00",
            "encerrado": "1.500,00",
            "consolidado": "1.500,00"
          },
          "valorTotal": {
            "andamento": "0,00",
            "encerrado": "3.000,00",
            "consolidado": "3.000,00"
          },
          "quantidadeAndamento": 0,
          "quantidadeEncerrado": 2,
          "quantidadeConsolidado": 2
        }
      },
      "pontuacaoCredito": {
        "pontuacaoSocioDemografica": 750,
        "faixaPontuacaoSocioDemografica": "Alta",
        "scoreCredito": 820,
        "nivelCredito": "Muito Bom"
      }
    }
  }
}

---

Códigos de Resposta

---

Notas Importantes

• O valor da consulta é de R$ 0,72 por requisição
• Este endpoint não gera comprovantes
• Apenas um CPF deve ser enviado por consulta
• Para dúvidas ou suporte, entre em contato pelo e-mail: suporte@directd.com.br