💡A API Nível Socioeconômico e Renda Estimada 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 e Renda Estimada 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://apiv3.directd.com.br
Endpoint
Nível Socioeconômico e Renda Estimada
GET /api/NivelSocioeconomico
Descrição: Endpoint para realizar a consulta Nível Socioeconômico e Renda Estimada. Obs: esta consulta não possui comprovante.
Nível Socioeconômico e Renda Estimada Crypt
GET /api/NivelSocioeconomico/Crypt
Descrição: Endpoint para realizar a consulta de Nível Socioeconômico Crypt. Obs: esta consulta não possui comprovante.
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.
- Em caso de dúvidas sobre o token, entre em contato com: suporte@directd.com.br
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
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CPF | string | Sim | CPF da pessoa a ser consultada. Pode ser enviado com ou sem formatação. |
| TOKEN | string | Sim | Token de autenticação necessário para a consulta. Em caso de dúvidas, entre em contato com: suporte@directd.com.br |
Consulta Crypt
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| query | string | Sim | O parâmetro query deve estar encriptado para realizar a consulta. |
Exemplos de Requisição
Usando cURL - Consulta Padrão
curl 'https://apiv3.directd.com.br/api/NivelSocioeconomico?CPF=12345678909&TOKEN=seu_token_aqui'
Usando cURL - Consulta Crypt
curl 'https://apiv3.directd.com.br/api/NivelSocioeconomico/Crypt?query=encrypted_string'
Respostas
Sucesso (200)
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"cpf": "string",
"rendaEstimada": "string",
"rendaFaixaSalarial": "string",
"rendaMinimaCBO": "string",
"rendaMediaCBO": "string",
"rendaMaximaCBO": "string",
"rendaIBGE": "string",
"cbo": "string",
"classeSocial": "string",
"escolaridade": "string"
}
}
Outros Códigos de Resposta
| Código | Descrição |
|---|---|
| 201 | Sucesso: a requisição async foi criada com sucesso e está em processamento. |
| 202 | Em Processamento: a requisição async ainda está em processamento. |
| 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. |
Aplicações
- Onboarding de Clientes e Fornecedores
- Prevenção de Lavagem de Dinheiro
- Análise de Risco/Crédito
Notas Importantes
- O valor da consulta é de R$ 0,36
- A API está na versão v3
- Esta consulta não gera comprovantes
- Para suporte técnico, entre em contato com suporte@directd.com.br