Download the rail's document for a contract

Proxies consultar-informacoes-contrato-trabalhador (Manual 004 §2.2): the document the payroll rail holds for a contract, selected by tipoArquivo (2..5). The response is the document itself, streamed in the content type the rail declared — not a JSON envelope with base64. tipoArquivo is required and validated locally, so an out-of-domain value never spends rail quota. Nothing is cached: the value of this operation is being the rail’s current truth. The route accepts no CPF, because the rail operation has no such parameter.

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

Download the rail's document for a contract

cURL

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

200

"<string>"

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

numero_contrato · string · requerido

Rail contract number (Manual 004 §2.2.2 p.18: Texto, 15).

Required string length: 1 - 15

Ejemplo:

"99999999999AN1"

Parámetros de consulta

tipoArquivo · integer<int64> · requerido

Document selector, published domain 2..5 (Manual 004 §2.2.2 p.18). REQUIRED — there is no default.

Rango requerido: 2 <= x <= 5

Ejemplo:

2

Respuesta

200

application/octet-stream

The contract document, in the content type the rail declared.

The response is of type file.