Crédito, renda e birô

Nível Socioeconômico e Renda Estimada

O serviço de Nível Socioeconômico e Renda Estimada sintetiza os dados socioeconômicos de um indivíduo a partir de múltiplas fontes.

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O serviço de 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, proporcionando uma análise abrangente do perfil socioeconômico.

Requisição

Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.

POST /api/v1/{tenant}/pessoas/nivel-socioeconomico-e-renda-estimada

Campo	Obrigatório	Descrição
`document`	sim	CPF da pessoa, com ou sem máscara.

{
  "document": "000.000.000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

Campo	Tipo
`metaDados.consultaNome`	texto
`metaDados.consultaUid`	texto
`metaDados.chave`	texto
`metaDados.usuario`	texto
`metaDados.mensagem`	texto
`metaDados.ip`	texto
`metaDados.resultadoId`	número
`metaDados.resultado`	texto
`metaDados.apiVersao`	texto
`metaDados.gerarComprovante`	booleano
`metaDados.urlComprovante`	texto
`metaDados.assincrono`	booleano
`metaDados.data`	texto
`metaDados.tempoExecucaoMs`	número
`retorno.cpf`	texto
`retorno.rendaEstimada`	texto
`retorno.rendaFaixaSalarial`	texto
`retorno.rendaMinimaCBO`	texto
`retorno.rendaMediaCBO`	texto
`retorno.rendaMaximaCBO`	texto
`retorno.rendaIBGE`	texto
`retorno.cbo`	texto
`retorno.classeSocial`	texto
`retorno.escolaridade`	texto

Exemplo de resposta

Estrutura real da resposta, com valores fictícios.

{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "Nível Socioeconômico e Renda Estimada",
  "query_slug": "nivel-socioeconomico-e-renda-estimada",
  "data": {
    "metaDados": {
      "consultaNome": "texto",
      "consultaUid": "texto",
      "chave": "texto",
      "usuario": "texto",
      "mensagem": "texto",
      "ip": "texto",
      "resultadoId": 0,
      "resultado": "texto",
      "apiVersao": "texto",
      "gerarComprovante": false,
      "urlComprovante": null,
      "assincrono": false,
      "data": "texto",
      "tempoExecucaoMs": 0
    },
    "retorno": {
      "cpf": "texto",
      "rendaEstimada": "texto",
      "rendaFaixaSalarial": "texto",
      "rendaMinimaCBO": "texto",
      "rendaMediaCBO": "texto",
      "rendaMaximaCBO": "texto",
      "rendaIBGE": "texto",
      "cbo": "texto",
      "classeSocial": "texto",
      "escolaridade": "texto"
    }
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.810"
}

Cobrança e respostas

O valor é cobrado por consulta bem-sucedida.
200 — consulta processada (veja status no corpo da resposta)
401 — token ausente, inválido, inativo ou expirado
403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
429 — limite de requisições por minuto da chave excedido
504 — tempo máximo de execução do serviço excedido