Crédito, renda e birô

Quod Gasto Estimado PF

Faixa do gasto mensal estimado da pessoa física (CPF), comprometimento da renda e indicadores de cartão, parcelados e financiamentos.

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O serviço Quod Gasto Estimado PF retorna, em faixas, o gasto médio mensal da pessoa e o percentual da renda comprometido com ele, além do gasto e do comprometimento no cartão de crédito e em parcelados, do nível de confiança da estimativa e da indicação de financiamento imobiliário, financiamento de veículo, consórcio e outros parcelamentos.

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/quod-gasto-estimado-pf

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
`PresumedIncomeResponseEx.Response.Header.Status`	número
`PresumedIncomeResponseEx.Response.Header.Message`	texto
`PresumedIncomeResponseEx.Response.Header.QueryId`	texto
`PresumedIncomeResponseEx.Response.Header.TransactionId`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].SpentIncome`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].IncomeCommitmentValuePercentage`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].ConfidenceLevel`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].AmountSpentCreditCard`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].PercentageSpentOnCreditCard`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].SpentInInstallments`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].PercentageSpentOnInstallments`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].RealEstateFinancing`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].VehicleFinancing`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].Consortia`	texto
`PresumedIncomeResponseEx.Response.Records.PresumedIncomeOutput[].OtherInstallments`	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": "Quod Gasto Estimado PF",
  "query_slug": "quod-gasto-estimado-pf",
  "data": {
    "PresumedIncomeResponseEx": {
      "Response": {
        "Header": {
          "Status": 0,
          "Message": "texto",
          "QueryId": "texto",
          "TransactionId": "texto",
          "Exceptions": {
            "Item": [

            ]
          }
        },
        "Records": {
          "PresumedIncomeOutput": [
            {
              "SpentIncome": "texto",
              "IncomeCommitmentValuePercentage": "texto",
              "ConfidenceLevel": "texto",
              "AmountSpentCreditCard": "texto",
              "PercentageSpentOnCreditCard": "texto",
              "SpentInInstallments": "texto",
              "PercentageSpentOnInstallments": "texto",
              "RealEstateFinancing": "texto",
              "VehicleFinancing": "texto",
              "Consortia": "texto",
              "OtherInstallments": "texto"
            }
          ]
        }
      }
    }
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "3.740"
}

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