Crédito, renda e birô

Informações Financeiras

O serviço de Informações Financeiras retorna estimativas de renda, patrimônio e histórico de restituição do imposto de renda com base em dados públicos e inferências estatísticas.

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O serviço de Informações Financeiras fornece uma visão abrangente sobre a situação econômica do indivíduo, incluindo estimativas de renda provenientes de diferentes fontes e modelos estatísticos, uma estimativa de patrimônio total, e um histórico da restituição do imposto de renda.

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/informacoes-financeiras

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
`TaxReturns[].Year`	texto
`TaxReturns[].Status`	texto
`TaxReturns[].Bank`	texto
`TaxReturns[].Branch`	texto
`TaxReturns[].Batch`	texto
`TaxReturns[].IsVipBranch`	booleano
`TaxReturns[].CaptureDate`	data
`TaxReturns[].CreationDate`	data
`TaxReturns[].LastUpdateDate`	data
`IncomeEstimates.MTE`	texto
`IncomeEstimates.IBGE`	texto
`IncomeEstimates.<chave>`	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": "Informações Financeiras",
  "query_slug": "informacoes-financeiras",
  "data": {
    "TaxReturns": [
      {
        "Year": "texto",
        "Status": "texto",
        "Bank": "texto",
        "Branch": "texto",
        "Batch": "texto",
        "IsVipBranch": false,
        "CaptureDate": "2026-01-01",
        "CreationDate": "2026-01-01",
        "LastUpdateDate": "2026-01-01"
      }
    ],
    "IncomeEstimates": {
      "MTE": "texto",
      "IBGE": "texto",
      "<chave>": "texto"
    }
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.100"
}

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