Consulta Offline de Saldo

Consulta os dados de saldo mais recentes salvos no nosso banco, de forma instantânea.

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

document_numberstringobrigatórioCPF do beneficiário (apenas números, 11 dígitos).benefit_numberstringobrigatórioNúmero do benefício INSS.

Python
curl

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

ENDPOINT
curl -X GET \
  'https://api-auth.sandbox.qitech.app/social_security/balance_request/offline?document_number=14950479032&benefit_number=22255220' \
  -H 'AUTHORIZATION: eyJhbGciOiJFUzUxMiJ9.eyJwYXlsb2FkX21kNSI6...' \
  -H 'API-CLIENT-KEY: YOUR_API_CLIENT_KEY' \
  -H 'Content-Type: application/json'

Response

STATUS

200

Atributos

last_successful_balance_requestobject | nullÚltima consulta bem-sucedida. null se nunca houve sucesso.

Atributos de last_successful_balance_request

consulted_atstringData e hora da consulta (ISO 8601).dataobjectDados completos de saldo do benefício. Mesma estrutura do webhook de consulta de saldo. Veja detalhamento dos campos.

Atributos de data

namestringNome do beneficiário.document_numberstringCPF do beneficiário.benefit_numberstringStatus do benefício (elegible, inelegible).block_typestringTipo de bloqueio (not_blocked, blocked_by_tbm, etc.).benefit_situationstringSituação do benefício (active, inactive, etc.).assistance_typestringTipo de assistência/aposentadoria.available_total_balancenumberMargem total disponível para consignação.consigned_creditobjectSaldo de crédito consignado (balance).payroll_cardobjectCartão consignado (balance, limit).benefit_cardobjectCartão benefício (balance, limit).number_of_active_reservationsintegerNúmero de reservas ativas.disbursement_bank_accountobjectDados da conta bancária de desembolso (bank_code, account_digit, account_branch, account_number).

last_blocked_statusobject | nullStatus de bloqueio mais recente. null se não há informação disponível. Derivado automaticamente da fonte mais recente — seja consulta de saldo, tentativa de reserva ou verificação do benefício.

Atributos de last_blocked_status

consulted_atstringData e hora da verificação mais recente (ISO 8601).statusstring"blocked" ou "unblocked".

信息

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.

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"
    }
}

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

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`

Exemplo de resposta 404

{
    "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"
}