Read one averbado contract's loan status on the rail

curl --request GET \
  --url https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan', 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/contracts/{numero_contrato}/rail-loan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "aceito_em": "2026-02-18T15:22:24Z",
  "cetAnual": "25.34",
  "cet_mensal": "1.90",
  "contrato": "199971600000",
  "cpf": "99971699990",
  "garantia": {
    "tem_garantias": true,
    "perc_verba_rescisoria_garantia": "10.00",
    "valor_multa_rescisoria_garantia_fgts": "400.25",
    "valor_saldo_disponivel_garantia_fgts": "1000.50"
  },
  "garantia_present": true,
  "matricula": "MATCEN716",
  "numero_inscricao_empregador": "42422253000101",
  "numero_proposta": "12345678901234567890",
  "outcome": "won",
  "proposal_ref": "12345678901234567890",
  "quantidade_parcelas": 24,
  "situacao_descricao": "Ativo",
  "situacao_emprestimo": 0,
  "situacao_present": true,
  "taxaAnual": "23.87",
  "taxa_mensal": "1.80",
  "valor_iof": "100.00",
  "valor_liberado": "20000.00",
  "valor_parcela": "1116.31",
  "valor_principal": "21600.00",
  "atualizado_em": "2026-02-18T15:22:24Z",
  "cnpj_empregador_completo": true,
  "cnpj_operador": "31061847000100",
  "competencia_fim_desconto": "202609",
  "competencia_inicio_desconto": "202601",
  "data_fim_contrato": "2027-01-20T00:00:00Z",
  "data_inicio_contrato": "2026-02-20T00:00:00Z",
  "data_primeiro_desconto": "2026-01-20T00:00:00Z",
  "excluido_em": "2026-03-01T09:00:00Z",
  "if_concessora": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "info_contrato_enviada_em": "2026-02-19T08:30:00Z",
  "inscricao_empregador": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "motivo_exclusao": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "nome_empregador": "EMPREGADOR TESTE LTDA",
  "nome_trabalhador": "Teste Homo_716999",
  "origem_averbacao": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "origem_exclusao": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "portabilidade_codigo_origem": "237",
  "portabilidade_codigo_proponente": "999",
  "portabilidade_numero_unico_averbacao": "20260731000000123",
  "portabilidade_numero_unico_exclusao": "20260731000000456",
  "portabilidade_situacao": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "portabilidade_valor_pago": "12500.00",
  "qtd_escrituracoes": "0",
  "qtd_pagamentos": "0",
  "situacao_bloqueio_garantia": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "valor_troco": "100.00"
}

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

GET

consignado

contracts

{numero_contrato}

rail-loan

Read one averbado contract's loan status on the rail

curl --request GET \
  --url https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan', 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/contracts/{numero_contrato}/rail-loan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://consignado.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/rail-loan")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "aceito_em": "2026-02-18T15:22:24Z",
  "cetAnual": "25.34",
  "cet_mensal": "1.90",
  "contrato": "199971600000",
  "cpf": "99971699990",
  "garantia": {
    "tem_garantias": true,
    "perc_verba_rescisoria_garantia": "10.00",
    "valor_multa_rescisoria_garantia_fgts": "400.25",
    "valor_saldo_disponivel_garantia_fgts": "1000.50"
  },
  "garantia_present": true,
  "matricula": "MATCEN716",
  "numero_inscricao_empregador": "42422253000101",
  "numero_proposta": "12345678901234567890",
  "outcome": "won",
  "proposal_ref": "12345678901234567890",
  "quantidade_parcelas": 24,
  "situacao_descricao": "Ativo",
  "situacao_emprestimo": 0,
  "situacao_present": true,
  "taxaAnual": "23.87",
  "taxa_mensal": "1.80",
  "valor_iof": "100.00",
  "valor_liberado": "20000.00",
  "valor_parcela": "1116.31",
  "valor_principal": "21600.00",
  "atualizado_em": "2026-02-18T15:22:24Z",
  "cnpj_empregador_completo": true,
  "cnpj_operador": "31061847000100",
  "competencia_fim_desconto": "202609",
  "competencia_inicio_desconto": "202601",
  "data_fim_contrato": "2027-01-20T00:00:00Z",
  "data_inicio_contrato": "2026-02-20T00:00:00Z",
  "data_primeiro_desconto": "2026-01-20T00:00:00Z",
  "excluido_em": "2026-03-01T09:00:00Z",
  "if_concessora": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "info_contrato_enviada_em": "2026-02-19T08:30:00Z",
  "inscricao_empregador": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "motivo_exclusao": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "nome_empregador": "EMPREGADOR TESTE LTDA",
  "nome_trabalhador": "Teste Homo_716999",
  "origem_averbacao": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "origem_exclusao": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "portabilidade_codigo_origem": "237",
  "portabilidade_codigo_proponente": "999",
  "portabilidade_numero_unico_averbacao": "20260731000000123",
  "portabilidade_numero_unico_exclusao": "20260731000000456",
  "portabilidade_situacao": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "portabilidade_valor_pago": "12500.00",
  "qtd_escrituracoes": "0",
  "qtd_pagamentos": "0",
  "situacao_bloqueio_garantia": {
    "codigo": 1,
    "descricao": "CNPJ"
  },
  "valor_troco": "100.00"
}

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

Path Parameters

numero_contrato

string

required

The averbado contract number to read (rail numeroContrato, Texto 2..15 alphanumerics — Manual 005 v1.13 §3.2.1 p.13).

Example:

"199971600000"

Query Parameters

numero_proposta

string

OPTIONAL. The proposal identifier this gateway minted for your bid. It is NEVER sent to the rail — the published query is codigoSolicitante + numeroContrato only. It is the LOCAL comparison key for the win classification: supply it and 'outcome' reports won/lost/pending for that proposal; omit it and 'outcome' is 'pending' because the classification has no subject. The rail's own verdict is always in 'situacao_emprestimo' and 'situacao_descricao', which are relayed verbatim.

Example:

"12345678901234567890"

Response

aceito_em

string<date-time>

required

dataHoraInclusaoEmprestimo — the instant the rail recorded the loan, RFC 3339 UTC. The rail publishes it as a ddMMyyyyHHmmss Texto (the Manual 005 example sends "18022026152224").

Example:

"2026-02-18T15:22:24Z"

cetAnual

string

required

valorCetAnual — Custo Efetivo Total as a PERCENT-per-year decimal string (the effective compounding of cet_mensal).

Example:

"25.34"

cet_mensal

string

required

valorCetMensal — Custo Efetivo Total as a PERCENT-per-month decimal string. NOTE the rail's casing: the RESPONSE spells it valorCetMensal while the inclusão REQUEST spells it valorCETMensal.

Example:

"1.90"

contrato

string

required

The contract number the loan was averbado under (rail field contrato, Texto).

Example:

"199971600000"

cpf

string

required

The worker the contract belongs to, 11 digits. The rail publishes it as a Número (the Manual 005 example sends 99971699990), so the adapter restores any digit JSON dropped.

Example:

"99971699990"

garantia

object

required

Show child attributes

garantia_present

boolean

required

Whether the 2xx actually carried a garantia block, under EITHER the singular or plural rail key. Gate on THIS, never on garantia.tem_garantias: temGarantias=false is an authoritative "this averbado contract has NO collateral" and is indistinguishable from the zero value of an absent block.

Example:

true

matricula

string

required

The worker's payroll registration at the employer (Texto). The rail DOES publish it on this read — row 1 of the Manual 005 p.15 field table, and the §3.2.3.2 example sends "MATCEN716".

Example:

"MATCEN716"

numero_inscricao_empregador

string

required

The employer inscription the contract belongs to (Texto — CNPJ, CEI or CAEPF).

Example:

"42422253000101"

numero_proposta

string

required

The read's numeroProposta (Manual 005 §3.2.2 p.15, Texto): the proposta that owns this contract. The win classification compares it against the one you minted.

Example:

"12345678901234567890"

outcome

enum<string>

required

The adapter-derived win classification, never a fabricated win. It compares numero_proposta against the proposal you supplied: won means the rail's contract belongs to YOUR proposta, lost means it belongs to another, pending means the classification has no subject (you omitted numero_proposta) or the rail's situação was absent. The rail's own verdict is always in situacao_emprestimo / situacao_descricao.

Available options:

pending,

won,

lost

Example:

"won"

proposal_ref

string

required

The handoff's dedupe key, sourced from the read's numeroProposta — the identifier THIS gateway minted and the rail echoes. There is no propostaRef key on this rail.

Example:

"12345678901234567890"

quantidade_parcelas

integer<int64>

required

totalParcelas — the number of instalments.

Example:

24

situacao_descricao

string

required

situacaoEmprestimo.descricao — the rail's own label for the code above, relayed verbatim so an unmapped code is still diagnosable.

Example:

"Ativo"

situacao_emprestimo

integer<int64>

required

situacaoEmprestimo.codigo, surfaced verbatim. Manual 005 §3.2.2 p.17 publishes the full table: 0 Ativo, 2 Excluído, 3 Encerrado, 7 Contrato suspenso, 8 Suspenso banco, 15 Encerrado por término do vínculo, 16 Encerrado com renegociação, 17 Contrato suspenso por antecipação de parcela. Meaningful ONLY when situacao_present is true.

Example:

0

situacao_present

boolean

required

Whether the 2xx actually carried situacaoEmprestimo.codigo. false on a 2xx is a malformed or unexpected read: the outcome is forced to pending rather than guessed.

Example:

true

taxaAnual

string

required

valorTaxaAnual as a PERCENT-per-year decimal string. "23.87" is 23.87 %/year, NOT the fraction 0.2387.

Example:

"23.87"

taxa_mensal

string

required

valorTaxaMensal as a PERCENT-per-month decimal string. "1.80" is 1.80 %/month, NOT the fraction 0.018.

Example:

"1.80"

valor_iof

string

required

valorIOF — the IOF charged (decimal string, BRL). Unlike the CET pair, this key is spelled identically on both the request and the response.

Example:

"100.00"

valor_liberado

string

required

valorLiberado — the net amount released to the worker (decimal string, BRL). The rail DOES publish it on this read (Manual 005 p.17 field table, example 20000). It is NOT derivable from valor_principal minus valor_iof.

Example:

"20000.00"

valor_parcela

string

required

The instalment amount (decimal string, BRL).

Example:

"1116.31"

valor_principal

string

required

valorEmprestimo — the amount actually lent (decimal string, BRL).

Example:

"21600.00"

atualizado_em

string<date-time>

dataHoraAtualizacao — when the rail last changed this contract (RFC 3339 UTC).

Example:

"2026-02-18T15:22:24Z"

cnpj_empregador_completo

boolean

The rail's cnpjEmpregadorCompleto flag, relayed verbatim. UNVERIFIABLE-UNTIL-HOMOLOG: the source pins its form (Booleano) and not its meaning, so it is passed through and NOT interpreted. Absent means the rail sent no flag — never read absence as false.

Example:

true

cnpj_operador

string

The operator CNPJ the rail holds for this contract (Texto 14; the Manual 005 example sends "31061847000100").

Example:

"31061847000100"

competencia_fim_desconto

string

Last payroll competência the discount runs in, as the rail's verbatim AAAAMM literal.

Example:

"202609"

competencia_inicio_desconto

string

First payroll competência the discount runs in, as the rail's verbatim AAAAMM literal — never reparsed into a date.

Example:

"202601"

data_fim_contrato

string<date-time>

Last day of the contract (RFC 3339 UTC). Absent when the rail omitted it.

Example:

"2027-01-20T00:00:00Z"

data_inicio_contrato

string<date-time>

First day of the contract (RFC 3339 UTC). Absent when the rail omitted it.

Example:

"2026-02-20T00:00:00Z"

data_primeiro_desconto

string<date-time>

Date of the first payroll discount (RFC 3339 UTC). Absent when the rail omitted it.

Example:

"2026-01-20T00:00:00Z"

excluido_em

string<date-time>

dataHoraExclusao — when the contract was excluded (RFC 3339 UTC). Absent on a contract that was not excluded.

Example:

"2026-03-01T09:00:00Z"

if_concessora

object

The institution that granted the loan, code and the rail's own label. Absent when the rail sent no pair.

Show child attributes

info_contrato_enviada_em

string<date-time>

dataHoraEnvioInfoContrato — when the contract information was sent to the rail (RFC 3339 UTC).

Example:

"2026-02-19T08:30:00Z"

inscricao_empregador

object

Which kind of identity numero_inscricao_empregador is (Manual 005 §3.2.2 p.16: 1 CNPJ, 2 CPF), code and the rail's own label. Absent when the rail sent no pair.

Show child attributes

motivo_exclusao

object

Why the contract was excluded (Manual 005 §3.2.2 p.17: 1 desistência do empréstimo, 2 falecimento, 3 liquidação antecipada, 7 ação judicial, 8 exclusão por fraude, 9 outros). Absent on a contract that was not excluded.

Show child attributes

nome_empregador

string

The employer's name as the rail holds it (Texto).

Example:

"EMPREGADOR TESTE LTDA"

nome_trabalhador

string

The worker's name as the rail holds it (Texto).

Example:

"Teste Homo_716999"

origem_averbacao

object

How the contract came to be averbado (Manual 005 §3.2.2 p.16: 0 Averbação banco, 1 troca de titularidade, 2 portabilidade, 3 refinanciamento, 4 reversão de refinanciamento, 5 renegociação, 6 renegociação de legado, 7 tombamento compulsório). Code 0 is LIVE: absence is the absent pair, never a zero.

Show child attributes

origem_exclusao

object

Who excluded the contract (Manual 005 §3.2.2 p.16: 1 APS, 2 Banco, 3 Sistema, 4 troca de titularidade, 5 portabilidade, 6 reversão de refinanciamento, 7 refinanciamento). Absent on a contract that was not excluded.

Show child attributes

portabilidade_codigo_origem

string

informacoesPortabilidade.codigoOrigem — the institution the contract was ported FROM, as the rail's verbatim literal. Never re-parsed as a number: an institution code with a leading zero does not survive that.

Example:

"237"

portabilidade_codigo_proponente

string

informacoesPortabilidade.codigoProponente — the institution that proposed the portability, verbatim.

Example:

"999"

portabilidade_numero_unico_averbacao

string

informacoesPortabilidade.numeroUnicoAverbacao — the rail-minted identifier of the portability averbação. Relayed, never parsed.

Example:

"20260731000000123"

portabilidade_numero_unico_exclusao

string

informacoesPortabilidade.numeroUnicoExclusao — the rail-minted identifier of the exclusion that closed the origin contract. Relayed, never parsed.

Example:

"20260731000000456"

portabilidade_situacao

object

informacoesPortabilidade.situacao — the state of the portability itself, code and label verbatim from the rail. Absent when the contract has no portability history; the code is never synthesised.

Show child attributes

portabilidade_valor_pago

string

informacoesPortabilidade.valorPago — the amount paid to settle the origin contract (decimal string, BRL). Empty means the rail sent nothing; it never means zero.

Example:

"12500.00"

qtd_escrituracoes

string

The rail's count of escriturações on this contract, verbatim. The escrituração DETAIL is not duplicated here — it reaches you as consignado.reconciliation.received — so this count is how you detect a short feed. "0" is a live count; empty means the rail sent none.

Example:

"0"

qtd_pagamentos

string

The rail's count of repasse payments on this contract, verbatim. Same purpose as qtd_escrituracoes: the detail arrives as consignado.reconciliation.received.

Example:

"0"

situacao_bloqueio_garantia

object

State of the FGTS collateral BLOCK (Manual 005 §3.2.2 p.17: 0 Pendente de bloqueio, 1 Bloqueio Realizado, 2 Falha de bloqueio, 3 Bloqueio em reprocessamento, 4 Bloqueio rejeitado). A contract quoting FGTS collateral whose block failed or was rejected is effectively unsecured. Code 0 is LIVE: absence is the absent pair, never a zero.

Show child attributes

valor_troco

string

valorTroco — the change returned to the worker (decimal string, BRL).

Example:

"100.00"

⌘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 one averbado contract's loan status on the rail

Authorizations

Path Parameters

Query Parameters

Response