Read a worker's consignable FGTS balance

Proxies consultar-saldo-fgts (Manual 002 §3.4): the worker’s consignable FGTS balance and rescission-penalty portion, the SOURCE of the collateral values an averbação or an auction bid carries. POST, not GET, because the read is consent-gated: the worker’s grupo-1 authorization evidence is a nested object and the CPF must never appear in a path or query string. The consent token the gateway mints or reuses is never returned. Money is a decimal string, never a float.

CONSENT WINDOW (Manual 002 v1.15 §5.6). dataHoraAutorizacaoDigital starts two clocks, measured in calendar days from the worker’s signature: the authorization may be CONSULTED for 30 days, and a request may be MADE against it for 45. Both boundaries are INCLUSIVE — the instant exactly 30 or 45 days after the signature is still inside its window, and only the next nanosecond is outside.

Outside either window the gateway refuses LOCALLY, before a byte reaches the rail: 422 with code CLT-0006 and a detail telling you to obtain a fresh worker authorization. THAT REFUSAL IS NOT RETRYABLE. Repeating the request performs the very read the lapsed authorization withdrew; only new authorization evidence makes it succeed. A dataHoraAutorizacaoDigital carrying a non-UTC offset, or dated ahead of the gateway’s clock, is the same 422 with a different detail — correct the timestamp; the worker’s consent is not in question.

Contrast the rail’s OWN consent rejection (Dataprev EX/IV on a stale tokenAutorizacao): that is 503 and IS retryable, because the gateway drops the cached token and the next attempt opens a fresh consent from the same evidence.

POST /v1/consignado/fgts/saldo

Read a worker's consignable FGTS balance

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/fgts/saldo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authorization": {
    "canalAutorizacaoDigital": "2",
    "dataHoraAutorizacaoDigital": "2025-05-14T10:00:00Z",
    "nsuAutorizacaoDigital": "1234567890123456789"
  },
  "codigoInscricaoEmpregador": "1",
  "cpf": "99999999999",
  "matricula": "99999999999-A",
  "numeroInscricaoEmpregador": "42422253000101"
}
'

200

{
  "dataHoraConsulta": "2026-07-30T12:00:00Z",
  "valorMultaRescisoriaConsignado": "400.25",
  "valorSaldoDisponivelConsignado": "1000.50"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

authorization · object · requerido

Worker grupo-1 digital-authorization evidence used to open or reuse the data-consult consent.

Show child attributes

codigoInscricaoEmpregador · enum<string> · requerido

Employer inscription type. Manual 003 §3.1.1 p.10 and Manual 002 §3.3.1 p.14 publish exactly two codes: 1 = CNPJ, 2 = CPF.

Opciones disponibles: 1, 2

Ejemplo:

"1"

cpf · string · requerido

Worker CPF, exactly 11 digits (Manual 002 §3.2.2 p.12: Número, 11 algarismos). In the BODY, never a path or query parameter.

Pattern: ^[0-9]{11}$

Ejemplo:

"99999999999"

matricula · string · requerido

Employment registration at the employer.

Minimum string length: 1

Ejemplo:

"99999999999-A"

numeroInscricaoEmpregador · string · requerido

Employer inscription number matching codigoInscricaoEmpregador.

Minimum string length: 1

Ejemplo:

"42422253000101"

Respuesta

200

application/json

OK

dataHoraConsulta · string<date-time> · requerido

Instant the rail computed the balance, RFC 3339 UTC. It is the balance's as-of moment, not the moment you called.

Ejemplo:

"2026-07-30T12:00:00Z"

valorMultaRescisoriaConsignado · string · requerido

Rescission-penalty portion (decimal string, BRL).

Ejemplo:

"400.25"

valorSaldoDisponivelConsignado · string · requerido

Consignable FGTS balance (decimal string, BRL).

Ejemplo:

"1000.50"