List a worker's authorized employment bonds

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

import requests

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

payload = {
    "authorization": {
        "canalAutorizacaoDigital": "2",
        "dataHoraAutorizacaoDigital": "2025-05-14T10:00:00Z",
        "nsuAutorizacaoDigital": "1234567890123456789"
    },
    "cpf": "99999999999",
    "matricula": "99999999999-A"
}
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'
    },
    cpf: '99999999999',
    matricula: '99999999999-A'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/fgts/autorizados', 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/autorizados",
  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'
    ],
    'cpf' => '99999999999',
    'matricula' => '99999999999-A'
  ]),
  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/autorizados"

	payload := strings.NewReader("{\n  \"authorization\": {\n    \"canalAutorizacaoDigital\": \"2\",\n    \"dataHoraAutorizacaoDigital\": \"2025-05-14T10:00:00Z\",\n    \"nsuAutorizacaoDigital\": \"1234567890123456789\"\n  },\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\"\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/autorizados")
  .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  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\"\n}"

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

{
  "vinculos": [
    {
      "codigoInscricaoEmpregador": "1",
      "cpf": "99999999999",
      "matricula": "99999999999-A",
      "numeroInscricaoEmpregador": "42422253000101",
      "elegivel": true,
      "motivoInelegibilidade": "Vínculo com data de desligamento"
    }
  ]
}

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

List a worker's authorized employment bonds

Proxies listar-autorizados-trabalhador (Manual 002 §3.2): the worker’s authorized employment bonds and, for an ineligible one, the rail’s reason. POST, not GET, for the same reason as the balance read — the operation is consent-gated and the CPF belongs in the body. An empty vinculos list is the rail’s answer, not an error, and is returned as 200.

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

autorizados

List a worker's authorized employment bonds

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

import requests

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

payload = {
    "authorization": {
        "canalAutorizacaoDigital": "2",
        "dataHoraAutorizacaoDigital": "2025-05-14T10:00:00Z",
        "nsuAutorizacaoDigital": "1234567890123456789"
    },
    "cpf": "99999999999",
    "matricula": "99999999999-A"
}
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'
    },
    cpf: '99999999999',
    matricula: '99999999999-A'
  })
};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/fgts/autorizados', 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/autorizados",
  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'
    ],
    'cpf' => '99999999999',
    'matricula' => '99999999999-A'
  ]),
  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/autorizados"

	payload := strings.NewReader("{\n  \"authorization\": {\n    \"canalAutorizacaoDigital\": \"2\",\n    \"dataHoraAutorizacaoDigital\": \"2025-05-14T10:00:00Z\",\n    \"nsuAutorizacaoDigital\": \"1234567890123456789\"\n  },\n  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\"\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/autorizados")
  .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  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"cpf\": \"99999999999\",\n  \"matricula\": \"99999999999-A\"\n}"

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

{
  "vinculos": [
    {
      "codigoInscricaoEmpregador": "1",
      "cpf": "99999999999",
      "matricula": "99999999999-A",
      "numeroInscricaoEmpregador": "42422253000101",
      "elegivel": true,
      "motivoInelegibilidade": "Vínculo com data de desligamento"
    }
  ]
}

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

Show child attributes

cpf

string

required

Worker CPF, exactly 11 digits. In the BODY, never a path or query parameter.

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

Example:

"99999999999"

matricula

string

required

Employment registration used to open or reuse the worker consent.

Minimum string length: 1

Example:

"99999999999-A"

Response

vinculos

object[] | null

required

Authorized employment bonds. An empty list means the rail returned none — it is not an error.

Show child attributes

⌘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

List a worker's authorized employment bonds

Authorizations

Body

Response