Read one averbado contract's loan status on the rail

Reads the rail’s consultar-emprestimo-trabalhador (Manual 005 v1.16 §3.2.1) for one averbado contract: situação do empréstimo, the proposta that owns it, the money terms and the FGTS collateral block. It REPORTS status only — it creates or resolves no durable proposal witness and emits no handoff fact.

GET /v1/consignado/contracts/{numero_contrato}/rail-loan

Read one averbado contract's loan status on the rail

cURL

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

200

{
  "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",
  "codigo_inscricao_empregador": "1",
  "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"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

numero_contrato · string · requerido

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

Ejemplo:

"199971600000"

Parámetros de consulta

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.

Ejemplo:

"12345678901234567890"

Respuesta

200

application/json

OK

aceito_em · string<date-time> · requerido

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

Ejemplo:

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

cetAnual · string · requerido

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

Ejemplo:

"25.34"

cet_mensal · string · requerido

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.

Ejemplo:

"1.90"

contrato · string · requerido

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

Ejemplo:

"199971600000"

cpf · string · requerido

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.

Ejemplo:

"99971699990"

garantia · object · requerido

Show child attributes

garantia_present · boolean · requerido

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.

Ejemplo:

true

matricula · string · requerido

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

Ejemplo:

"MATCEN716"

numero_inscricao_empregador · string · requerido

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

Ejemplo:

"42422253000101"

numero_proposta · string · requerido

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

Ejemplo:

"12345678901234567890"

outcome · enum<string> · requerido

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.

Opciones disponibles: pending, won, lost

Ejemplo:

"won"

proposal_ref · string · requerido

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.

Ejemplo:

"12345678901234567890"

quantidade_parcelas · integer<int64> · requerido

totalParcelas — the number of instalments.

Ejemplo:

24

situacao_descricao · string · requerido

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

Ejemplo:

"Ativo"

situacao_emprestimo · integer<int64> · requerido

situacaoEmprestimo.codigo, surfaced verbatim. Manual 005 v1.16 §3.2.2 p.19 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.

Ejemplo:

0

situacao_present · boolean · requerido

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.

Ejemplo:

true

taxaAnual · string · requerido

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

Ejemplo:

"23.87"

taxa_mensal · string · requerido

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

Ejemplo:

"1.80"

valor_iof · string · requerido

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

Ejemplo:

"100.00"

valor_liberado · string · requerido

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

Ejemplo:

"20000.00"

valor_parcela · string · requerido

The instalment amount (decimal string, BRL).

Ejemplo:

"1116.31"

valor_principal · string · requerido

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

Ejemplo:

"21600.00"

atualizado_em · string<date-time>

dataHoraAtualizacao — Dataprev's own update timestamp as the rail reports it (RFC 3339 UTC). An antecipação does not move it.

Ejemplo:

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

cnpj_empregador_completo · boolean

The rail's cnpjEmpregadorCompleto flag, relayed as sent: false means numero_inscricao_empregador is the 8-digit CNPJ raiz, true a 14-digit CNPJ. Absent means the rail sent no flag: the number is then relayed as the rail sent it, and a JSON number is still widened to 14 digits.

Ejemplo:

true

cnpj_operador · string

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

Ejemplo:

"31061847000100"

codigo_inscricao_empregador · string

The employer-inscription TYPE code as decimal digits (Manual 005 v1.16 §3.2.2 p.18: "1" CNPJ, "2" CPF) — the same shape the averbação write carries it in, so it can be persisted or re-sent without reshaping. Empty means the rail published no readable pair; it never means code 0.

Ejemplo:

"1"

competencia_fim_desconto · string

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

Ejemplo:

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

Ejemplo:

"202601"

data_fim_contrato · string<date-time>

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

Ejemplo:

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

Ejemplo:

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

Ejemplo:

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

Ejemplo:

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

Ejemplo:

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

inscricao_empregador · object

Which kind of identity numero_inscricao_empregador is (Manual 005 v1.16 §3.2.2 p.18: 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 v1.16 §3.2.2 p.18: 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).

Ejemplo:

"EMPREGADOR TESTE LTDA"

nome_trabalhador · string

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

Ejemplo:

"Teste Homo_716999"

origem_averbacao · object

How the contract came to be averbado (Manual 005 v1.16 §3.2.2 p.18: 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, 8 migração automática de contrato per Manual 018 v1.5 txt:581). Code 0 is LIVE: absence is the absent pair, never a zero.

Show child attributes

origem_exclusao · object

Who excluded the contract (Manual 005 v1.16 §3.2.2 p.18: 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.

Ejemplo:

"237"

portabilidade_codigo_proponente · string

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

Ejemplo:

"999"

portabilidade_numero_unico_averbacao · string

informacoesPortabilidade.numeroUnicoAverbacao — the portability's NSU, minted by CIP (Manual 008). Relayed, never parsed.

Ejemplo:

"20260731000000123"

portabilidade_numero_unico_exclusao · string

informacoesPortabilidade.numeroUnicoExclusao — the portability's NSU, minted by CIP (Manual 008), relayed when M005 carries the block. Never parsed.

Ejemplo:

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

Ejemplo:

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

Ejemplo:

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

Ejemplo:

"0"

situacao_bloqueio_garantia · object

State of the FGTS collateral BLOCK (Manual 005 v1.16 §3.2.2 p.20: 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).

Ejemplo:

"100.00"