Read a worker's consignable FGTS balance

curl --request POST \
  --url https://consignado.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"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo"

payload = {
    "authorization": {
        "canalAutorizacaoDigital": "2",
        "dataHoraAutorizacaoDigital": "2025-05-14T10:00:00Z",
        "nsuAutorizacaoDigital": "1234567890123456789"
    },
    "codigoInscricaoEmpregador": "1",
    "cpf": "99999999999",
    "matricula": "99999999999-A",
    "numeroInscricaoEmpregador": "42422253000101"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    authorization: {
      canalAutorizacaoDigital: '2',
      dataHoraAutorizacaoDigital: '2025-05-14T10:00:00Z',
      nsuAutorizacaoDigital: '1234567890123456789'
    },
    codigoInscricaoEmpregador: '1',
    cpf: '99999999999',
    matricula: '99999999999-A',
    numeroInscricaoEmpregador: '42422253000101'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'authorization' => [
        'canalAutorizacaoDigital' => '2',
        'dataHoraAutorizacaoDigital' => '2025-05-14T10:00:00Z',
        'nsuAutorizacaoDigital' => '1234567890123456789'
    ],
    'codigoInscricaoEmpregador' => '1',
    'cpf' => '99999999999',
    'matricula' => '99999999999-A',
    'numeroInscricaoEmpregador' => '42422253000101'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo"

	payload := strings.NewReader("{\n  \"authorization\": {\n    \"canalAutorizacaoDigital\": \"2\",\n    \"dataHoraAutorizacaoDigital\": \"2025-05-14T10:00:00Z\",\n    \"nsuAutorizacaoDigital\": \"1234567890123456789\"\n  },\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authorization\": {\n    \"canalAutorizacaoDigital\": \"2\",\n    \"dataHoraAutorizacaoDigital\": \"2025-05-14T10:00:00Z\",\n    \"nsuAutorizacaoDigital\": \"1234567890123456789\"\n  },\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authorization\": {\n    \"canalAutorizacaoDigital\": \"2\",\n    \"dataHoraAutorizacaoDigital\": \"2025-05-14T10:00:00Z\",\n    \"nsuAutorizacaoDigital\": \"1234567890123456789\"\n  },\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

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 MYS-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

consignado

fgts

saldo

Read a worker's consignable FGTS balance

curl --request POST \
  --url https://consignado.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"
}
'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo"

payload = {
    "authorization": {
        "canalAutorizacaoDigital": "2",
        "dataHoraAutorizacaoDigital": "2025-05-14T10:00:00Z",
        "nsuAutorizacaoDigital": "1234567890123456789"
    },
    "codigoInscricaoEmpregador": "1",
    "cpf": "99999999999",
    "matricula": "99999999999-A",
    "numeroInscricaoEmpregador": "42422253000101"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    authorization: {
      canalAutorizacaoDigital: '2',
      dataHoraAutorizacaoDigital: '2025-05-14T10:00:00Z',
      nsuAutorizacaoDigital: '1234567890123456789'
    },
    codigoInscricaoEmpregador: '1',
    cpf: '99999999999',
    matricula: '99999999999-A',
    numeroInscricaoEmpregador: '42422253000101'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'authorization' => [
        'canalAutorizacaoDigital' => '2',
        'dataHoraAutorizacaoDigital' => '2025-05-14T10:00:00Z',
        'nsuAutorizacaoDigital' => '1234567890123456789'
    ],
    'codigoInscricaoEmpregador' => '1',
    'cpf' => '99999999999',
    'matricula' => '99999999999-A',
    'numeroInscricaoEmpregador' => '42422253000101'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo"

	payload := strings.NewReader("{\n  \"authorization\": {\n    \"canalAutorizacaoDigital\": \"2\",\n    \"dataHoraAutorizacaoDigital\": \"2025-05-14T10:00:00Z\",\n    \"nsuAutorizacaoDigital\": \"1234567890123456789\"\n  },\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authorization\": {\n    \"canalAutorizacaoDigital\": \"2\",\n    \"dataHoraAutorizacaoDigital\": \"2025-05-14T10:00:00Z\",\n    \"nsuAutorizacaoDigital\": \"1234567890123456789\"\n  },\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/fgts/saldo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authorization\": {\n    \"canalAutorizacaoDigital\": \"2\",\n    \"dataHoraAutorizacaoDigital\": \"2025-05-14T10:00:00Z\",\n    \"nsuAutorizacaoDigital\": \"1234567890123456789\"\n  },\n  \"codigoInscricaoEmpregador\": \"1\",\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\",\n  \"numeroInscricaoEmpregador\": \"42422253000101\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Body

application/json

authorization

object

required

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

Show child attributes

codigoInscricaoEmpregador

enum<string>

required

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.

Available options:

1,

2

Example:

"1"

cpf

string

required

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

Example:

"99999999999"

matricula

string

required

Employment registration at the employer.

Minimum string length: 1

Example:

"99999999999-A"

numeroInscricaoEmpregador

string

required

Employer inscription number matching codigoInscricaoEmpregador.

Minimum string length: 1

Example:

"42422253000101"

Response

dataHoraConsulta

string<date-time>

required

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

Example:

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

valorMultaRescisoriaConsignado

string

required

Rescission-penalty portion (decimal string, BRL).

Example:

"400.25"

valorSaldoDisponivelConsignado

string

required

Consignable FGTS balance (decimal string, BRL).

Example:

"1000.50"

⌘I

Pix — Lerian SPI (native messaging)

Pix — JD (interface, direct)

Pix — BTG (interface, indirect)

TED — Lerian SPB (native messaging)

TED — JD (interface)

Boletos — BTG (interface)

Lerian SILOC (native messaging)

Lerian SLC (native messaging)

Lerian STA (native messaging)

Lerian SISBAJUD (native messaging)

Lerian Consignado — Dataprev

Read a worker's consignable FGTS balance

Authorizations

Body

Response