Orientações e respostas da equipe da Direct Data

💡A API Nível Socioeconômico (NSE) permite sintetizar características socioeconômicas de indivíduos, como renda, ocupação e escolaridade. É amplamente utilizada para segmentação de perfis em análises de risco, onboarding e compliance.

---

Introdução

A API Nível Socioeconômico (NSE) classifica indivíduos com base em critérios socioeconômicos, como faixa de renda, escolaridade e ocupação. Essa ferramenta é útil para instituições financeiras, empresas de marketing e organizações de análise de risco.

---

URL Base

A API está hospedada no seguinte endereço:

https://api.directd.com.br

---

Endpoint

Nível Socioeconômico

GET /api/NivelSocioeconomico

Descrição: Consulta para obter dados socioeconômicos de uma pessoa física.

Nível Socioeconômico Crypt

GET /api/NivelSocioeconomico/Crypt

Descrição: Consulta semelhante ao endpoint principal, mas com suporte para parâmetros encriptados.

Nota: Nenhuma consulta 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

Dados Socioeconômicos

• CPF: Cadastro de Pessoa Física (obrigatório).
• Classe Social: Classificação da classe socioeconômica.
• Escolaridade: Nível de escolaridade do indivíduo.
• Renda Estimada: Estimativa de renda mensal.
• Renda e Faixa Salarial: Faixa salarial do indivíduo.
• Renda IBGE: Baseada nos dados do IBGE.
• Classificação Brasileira de Ocupações (CBO): Código CBO associado à ocupação do indivíduo.
  • Renda Mínima CBO
  • Renda Média CBO
  • Renda Máxima CBO

---

Parâmetros

Consulta Padrão

Consulta Crypt

---

Exemplos de Requisição

Usando cURL - Consulta Padrão

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

Usando cURL - Consulta Crypt

curl 'https://api.directd.com.br/api/NivelSocioeconomico/Crypt?query=encrypted_string&TOKEN=seu_token_aqui'

---

Respostas

Sucesso (200)

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Nível Socioeconômico",
    "consultaUid": "nse-123456",
    "usuario": "Carlos Silva",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 250
  },
  "retorno": {
    "cpf": "123.456.789-09",
    "rendaEstimada": "R$ 4.500,00",
    "rendaFaixaSalarial": "R$ 4.001 - R$ 5.000",
    "rendaMinimaCBO": "R$ 3.000,00",
    "rendaMediaCBO": "R$ 4.500,00",
    "rendaMaximaCBO": "R$ 6.000,00",
    "rendaIBGE": "R$ 4.200,00",
    "cbo": "2525-05",
    "classeSocial": "B2",
    "escolaridade": "Ensino Superior Completo"
  }
}

---

9. Erros Comuns

---

10. Notas Importantes

• Informar o CPF e o token é obrigatório para a consulta padrão.
• Para a consulta Crypt, certifique-se de enviar o parâmetro query devidamente encriptado.
• A classe social segue padrões estabelecidos por dados demográficos e ocupacionais.