Pular para o conteúdo principal

Consulta de Benefício

info

Descrição​

Realiza a consulta de benefício do cliente.

Endpoint​

POST /inss/v1/balance

Headers​

{
  "Authorization": "Bearer {TOKEN_DO_LOGIN}",
}

Payload (Body)​

{
  "cpf": "string",
  "beneficio": "string",}

Obs: ‘beneficio’ aqui é o “benefit_number” da response anterior

Exemplo de Resposta :​

{
  "name": "",
  "state": "SP",
  "alimony": "not_payer",
  "birth_date": "07021961",
  "block_date": "2024-02-12",
  "block_type": "blocked_by_tbm",
  "grant_date": "2022-09-02",
  "credit_type": "checking_account",
  "benefit_card": {
    "limit": 2083.2,
    "balance": 0
  },
    "benefit_number": "2052711150",
    "benefit_status": "elegible",
    "consigned_card": {
      "limit": 2083.2,
      "balance": 0
  },
    "assistance_type": "retirement_by_age",
    "document_number": "12241019011",
    "benefit_end_date": "2020-12-01",
    "consigned_credit": {
      "balance": 1000
  },
    "benefit_situation": "active",
    "max_total_balance": 2000,
    "used_total_balance": 1000,
    "politically_exposed": {
      "type": "not_politically_exposed",
      "is_politically_exposed": false
  },
    "has_power_of_attorney": false,
    "available_total_balance": 1502.72,
    "has_judicial_concession": false,
    "number_of_portabilities": 0,
    "disbursement_bank_account": {
      "bank_code": "341",
      "account_digit": "6",
      "account_branch": "0155",
      "account_number": "000059923"
  },
  "has_entity_representation": false,
  "social_benefit_max_balance": 2000,
  "social_benefit_used_balance": 1000,
  "benefit_quota_expiration_date": "2040-09-12",
  "number_of_active_reservations": 0,
  "number_of_suspended_reservations": 0,
  "number_of_refinanced_reservations": 0,
  "number_of_active_suspended_reservations": 3
}