Documentação Técnica

Modelo de Renda Estimada

Descrição

O Modelo de Renda Estimada é um modelo construído com técnicas de modelagem estatística e machine learning, que tenta inferir uma renda estimada (em valor numérico) para um indivíduo. Esse modelo pode ser utilizado em qualquer processo que tente realizar a validação da renda de um indivíduo.
O resultado dessa consulta é um valor numérico, que corresponde a renda inferida em R$. A estimativa de renda pode ser calculada para qualquer indivíduo, e não depende do envio de informações adicionais para o seu cálculo. Apenas com o CPF do indivíduo você pode obter o resultado.

Origem da Informação

O modelo de renda estimada é calculado pela DataRisk com base em informações contidas nos datasets da BigDataCorp.

Tabela de preços para esse dataset

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,600
10001 - 50000R$ 0,570
50001 - 100000R$ 0,541
100001 - 500000R$ 0,514
500001 - 1000000R$ 0,488
1000001 - 5000000R$ 0,464
5000001 - 10000000R$ 0,441
10000001 - 50000000R$ 0,419
50000001 e acimaR$ 0,398

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

CampoDescriçãoValores PossíveisTipo de Campo
docDocumento de identificaçãoCPF🛑 Obrigatório
referencedateData de referência para a consultaQualquer data válidaℹ️  Opcional
dateformatFormato da data informadaString de formatação da data, como yyyy-MM-dd ou similarℹ️  Opcional

Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.

Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:

{  
    "Datasets": "partner_datarisk_income_prediction_person",
    "q": "doc{CPF}"  
}  

Retornos Especiais

Este dataset contém uma mensagem de retorno especial, relacionada à casos aonde não possuímos informações suficientes para realizar o cálculo da inferência de renda para o CPF consultado. Nesse caso, o campo de "Status" será preenchido com o seguinte valor: NOT ENOUGH DATA TO GENERATE OUTPUT
No caso deste valor ser retornado, o cliente não será cobrado pela consulta.

Descrição dos campos do objeto principal de retorno

CampoDescrição
OriginFonte dos Dados Entregues
InputParametersParâmetros de entrada
QueryRawHTMLResultResultado JSON bruto da consulta ondemand
QueryDateData de consulta na fonte de dados
QueryResultData.PredictedIncomeResultado numérico do modelo
Language
Credentials
Click Try It! to start a request and see the response here!