Consulta Offline de Saldo

Veja também

Consulta os dados de um benefício de forma instantânea, sem depender da Dataprev.

Vantagens Técnicas

Retorno síncrono — sem fila de processamento ou espera por webhook;
Acesso a benefícios bloqueados — retorna os últimos dados salvos no sistema, mesmo que o benefício esteja bloqueado;
Consulta em cache — independe da disponibilidade da Dataprev e não gera consumo de chamadas.

Request

ENDPOINT

/social_security/balance_request/offline

MÉTODO

GET

Query Params

Campo	Tipo	Descrição
`document_number` *	string	CPF do beneficiário (apenas números, 11 dígitos).
`benefit_number` *	string	Número do benefício INSS.

Exemplo:

GET /social_security/balance_request/offline?document_number=14950479032&benefit_number=22255220

Response

STATUS

200

Response Body

{
  "last_successful_balance_request": {
    "consulted_at": "2025-01-15T14:32:10-03:00",
    "data": {
      "name": "NOME BENEFICIARIO",
      "state": "RS",
      "alimony": "not_payer",
      "birth_date": "18021978",
      "block_type": "not_blocked",
      "grant_date": "2006-05-22",
      "credit_type": "checking_account",
      "benefit_card": {
        "limit": 2259.20,
        "balance": 0
      },
      "benefit_number": "22255220",
      "benefit_status": "elegible",
      "payroll_card": {
        "limit": 2259.20,
        "balance": 0
      },
      "assistance_type": "retirement_invalidity_social_security",
      "document_number": "14950479032",
      "benefit_end_date": null,
      "consigned_credit": {
        "balance": 0
      },
      "benefit_situation": "active",
      "last_inquiry_date": "2018-06-18",
      "max_total_balance": 635.40,
      "used_total_balance": 635.40,
      "politically_exposed": {
        "type": "not_politically_exposed",
        "is_politically_exposed": false
      },
      "has_power_of_attorney": false,
      "available_total_balance": 0,
      "has_judicial_concession": false,
      "number_of_portabilities": 0,
      "disbursement_bank_account": {
        "bank_code": "748",
        "account_digit": "4",
        "account_branch": "0155",
        "account_number": "000070963"
      },
      "has_entity_representation": false,
      "social_benefit_max_balance": 635.40,
      "social_benefit_used_balance": 635.40,
      "benefit_quota_expiration_date": null,
      "number_of_active_reservations": 3,
      "number_of_suspended_reservations": 0,
      "number_of_refinanced_reservations": 0,
      "number_of_active_suspended_reservations": 3
    }
  },
  "last_blocked_status": {
    "consulted_at": "2025-01-15T14:32:10-03:00",
    "status": "unblocked"
  }
}

Response Params

Campo	Tipo	Descrição
`last_successful_balance_request`	object/null	Última consulta bem-sucedida. `null` se nunca houve sucesso.
`last_blocked_status`	object/null	Status de bloqueio mais recente do benefício. `null` se não há informação disponível.

info

Ao menos um dos dois campos será preenchido em uma resposta 200. Caso não exista nenhum dado para a combinação informada, o endpoint retorna 404.

Objeto last_successful_balance_request

Campo	Tipo	Descrição
`consulted_at`	string	Data e hora da consulta (ISO 8601).
`data`	object	Dados completos do benefício. Detalhes

Objeto last_blocked_status

O status de bloqueio é derivado automaticamente da informação mais recente disponível no sistema — seja de uma consulta de saldo, uma tentativa de reserva ou uma verificação do benefício. Isso permite saber se o benefício está bloqueado sem precisar realizar uma nova consulta ao Dataprev.

Campo	Tipo	Descrição
`consulted_at`	string	Data e hora da verificação mais recente (ISO 8601).
`status`	string	`"blocked"` ou `"unblocked"`.

Objeto data

Mesma estrutura retornada no webhook de consulta de dados do benefício.

Detalhamento dos campos

Campo	Tipo	Descrição
`name`	string	Nome do beneficiário.
`document_number`	string	CPF do beneficiário.
`benefit_number`	string	Número do benefício INSS.
`benefit_status`	string	Status do benefício (`elegible`, `inelegible`).
`block_type`	string	Tipo de bloqueio (`not_blocked`, `blocked_by_tbm`, etc.).
`benefit_situation`	string	Situação do benefício (`active`, `inactive`, etc.).
`assistance_type`	string	Tipo de assistência/aposentadoria.
`available_total_balance`	number	Margem total disponível para consignação.
`consigned_credit`	object	Saldo de crédito consignado (`balance`).
`payroll_card`	object	Cartão consignado (`balance`, `limit`).
`benefit_card`	object	Cartão benefício (`balance`, `limit`).
`number_of_active_reservations`	integer	Número de reservas ativas.
`disbursement_bank_account`	object	Dados da conta bancária de desembolso.

Cenários de resposta

Cenário	`last_successful_balance_request`	`last_blocked_status.status`
Apenas consultas com sucesso	Dados da última consulta	`"unblocked"`
Apenas consultas com bloqueio	`null`	`"blocked"`
Consulta com sucesso seguida de bloqueio posterior	Dados da última consulta	`"blocked"`
Bloqueio seguido de consulta com sucesso	Dados da última consulta	`"unblocked"`

Erros

STATUS

404

Response Body: Nenhum dado de consulta encontrado

{
  "title": "Offline Balance Not Found",
  "description": "No balance data found for document_number {document_number} and benefit_number {benefit_number}.",
  "translation": "Nenhum dado de saldo encontrado para document_number {document_number} e benefit_number {benefit_number}",
  "code": "SSC000101"
}

Código HTTP	Código QI	Descrição
401/403	(padrão)	Headers de autenticação ausentes ou inválidos.
404	SSC000101	Nenhum dado encontrado para a combinação de `document_number` + `benefit_number`.

Request​

Query Params​

Response​

Response Params​

Objeto last_successful_balance_request​

Objeto last_blocked_status​

Objeto data​

Cenários de resposta​

Erros​