> ## 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. # Descargar el documento de la red para un contrato > Esta operación actúa como proxy de consultar-informacoes-contrato-trabalhador (Manual 004 §2.2): el documento que la red de nómina conserva para un contrato, seleccionado por tipoArquivo (2..5). La respuesta es el documento en sí, transmitido con el tipo de contenido declarado por la red, no un sobre JSON con base64. tipoArquivo es obligatorio y se valida localmente, por lo que un valor fuera del dominio nunca consume la cuota de la red. No se almacena nada en caché: el valor de esta operación es ofrecer la verdad actual de la red. La ruta no acepta CPF porque la operación de la red no tiene ese parámetro. ## OpenAPI ````yaml es/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: >- Superficie OpenAPI 3.1 para Lerian Consignado — Dataprev. API cubre las credenciales y la configuración de red de tenant, el margen de los trabajadores, las subastas y ofertas de préstamos, el registro y el ciclo de vida de los contratos, la confirmación de desembolsos, la portabilidad, la refinanciación, la renegociación, las garantías de FGTS, la conciliación, los fondos, las asignaciones, el uso, el rendimiento y las suscripciones a eventos. El material secreto se escribe en el almacén secreto tenant y ninguna operación lo devuelve nunca. 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: >- Custodia de credenciales de Dataprev y configuración pública del rail por tenant (carga, estado, rotación, revocación, código del solicitante y URL base del portal del trabajador) name: Credentials - description: >- Uso de la gateway del consignado en el ámbito del tenant: agregación de unidades facturables con precio por competencia name: Consignado Usage - description: >- Plano de control de suscripción al hub de streaming per-tenant (enumerar, crear, obtener, rotar, revocar y probar la entrega) name: Subscriptions - description: >- Superficie de rail de nómina Dataprev: lecturas de saldo y autorización FGTS, ejecución de garantía FGTS, suspensión de contrato, reactivación y cambios de términos, documentos de contrato propios de la red y lecturas bajo demanda de leilão solicitações, escriturações, repasses y terminaciones de empleo. name: Consignado Rail - description: >- Superficie de comando de red síncrona: las operaciones de un bancarizador sin que el prestamista conduzca sobre HTTP. Cada uno comparte su implementación de comando con el activador de evento de prestamista equivalente. name: Consignado Rail Commands - description: >- Confirmación de desembolso propiedad de la gateway: un banco cliente que registra el dinero que ya pagó a un trabajador. No cruza ninguna frontera gubernamental y no representa ninguna operación Dataprev. name: Consignado Disbursement - description: > Rendimiento de red Dataprev saliente de autoservicio per-tenant: lea y configure el requests-per-second propio de este tenant, incluida una pausa deliberada en cero name: Consignado Throughput paths: /v1/consignado/contracts/{numero_contrato}/rail-document: get: tags: - Consignado Rail summary: Descargar el documento de la red para un contrato description: >- Esta operación actúa como proxy de consultar-informacoes-contrato-trabalhador (Manual 004 §2.2): el documento que la red de nómina conserva para un contrato, seleccionado por tipoArquivo (2..5). La respuesta es el documento en sí, transmitido con el tipo de contenido declarado por la red, no un sobre JSON con base64. tipoArquivo es obligatorio y se valida localmente, por lo que un valor fuera del dominio nunca consume la cuota de la red. No se almacena nada en caché: el valor de esta operación es ofrecer la verdad actual de la red. La ruta no acepta CPF porque la operación de la red no tiene ese parámetro. 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: -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 ````