> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

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



## OpenAPI

````yaml en/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/rail-document
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for Lerian Consignado — Dataprev. The API covers tenant
    credentials and rail configuration, worker margin, loan auctions and bids,
    contract registration and lifecycle, disbursement confirmation, portability,
    refinancing, renegotiation, FGTS guarantees, reconciliation, funds,
    assignments, usage, throughput, and event subscriptions. Secret material is
    written to the tenant secret store and is never returned by any operation.
  license:
    name: Lerian Studio General License
  title: Lerian Consignado API
  version: v1.0.0
servers:
  - url: https://consignado.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Per-tenant Dataprev credential custody and public rail configuration
      (upload, status, rotation, revoke, requester code, and worker portal base
      URL)
    name: Credentials
  - description: >-
      Tenant-scoped consignado gateway usage: priced billable-unit aggregation
      per competência
    name: Consignado Usage
  - description: >-
      Per-tenant streaming-hub subscription control-plane (list, create, get,
      rotate, revoke, and test delivery)
    name: Subscriptions
  - description: >-
      Dataprev payroll-rail surface: FGTS balance and authorization reads, the
      FGTS guarantee execution, contract suspension, reactivation and term
      changes, the rail's own contract documents, and the on-demand reads of
      leilão solicitações, escriturações, repasses and employment terminations
    name: Consignado Rail
  - description: >-
      Synchronous rail command surface: the operations a bancarizador without
      the lender drives over HTTP. Each shares its command implementation with
      the equivalent lender event trigger.
    name: Consignado Rail Commands
  - description: >-
      Gateway-owned disbursement confirmation: a client bank recording money it
      has ALREADY paid to a worker. It crosses no government boundary and
      proxies no Dataprev operation.
    name: Consignado Disbursement
  - description: >-
      Per-tenant self-service outbound Dataprev rail throughput: read and set
      this tenant's own requests-per-second, including a deliberate pause at
      zero
    name: Consignado Throughput
paths:
  /v1/consignado/contracts/{numero_contrato}/rail-document:
    get:
      tags:
        - Consignado Rail
      summary: Download the rail's document for a contract
      description: >-
        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.
      operationId: getConsignadoContractRailDocument
      parameters:
        - description: 'Rail contract number (Manual 004 §2.2.2 p.18: Texto, 15).'
          in: path
          name: numero_contrato
          required: true
          schema:
            description: 'Rail contract number (Manual 004 §2.2.2 p.18: Texto, 15).'
            examples:
              - 99999999999AN1
            maxLength: 15
            minLength: 1
            type: string
        - description: >-
            Document selector, published domain 2..5 (Manual 004 §2.2.2 p.18).
            REQUIRED — there is no default.
          explode: false
          in: query
          name: tipoArquivo
          required: true
          schema:
            description: >-
              Document selector, published domain 2..5 (Manual 004 §2.2.2 p.18).
              REQUIRED — there is no default.
            examples:
              - 2
            format: int64
            maximum: 5
            minimum: 2
            type: integer
      responses:
        '200':
          content:
            application/octet-stream:
              schema:
                contentMediaType: application/octet-stream
                format: binary
                type: string
          description: The contract document, in the content type the rail declared.
          headers:
            Cache-Control:
              schema:
                type: string
            Content-Type:
              schema:
                type: string
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````