> ## 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. # Leer el saldo consignable FGTS de un trabajador > Esta operación actúa como proxy de consultar-saldo-fgts (Manual 002 §3.4): el saldo FGTS consignable del trabajador y la porción de penalización por rescisión, el origen de los valores de garantía que lleva una averbação o una oferta de subasta. POST, no GET, porque la lectura está controlada por consentimiento: la evidencia de autorización grupo-1 del trabajador es un objeto anidado y CPF nunca debe aparecer en una ruta o cadena de consulta. El token de consentimiento que la gateway acuña o reutiliza nunca se devuelve. El dinero es una cadena decimal, nunca un flotante. VENTANA DE CONSENTIMIENTO (Manual 002 v1.15 §5.6). DataHoraAutorizacaoDigital pone en marcha dos relojes, medidos en días calendario a partir de la firma del trabajador: la autorización puede ser CONSULTADA por 30 días, y una solicitud puede ser PRESENTADA en su contra por 45. Ambos límites son inclusivos: el instante exactamente 30 o 45 días después de que la firma todavía está dentro de su ventana, y solo el siguiente nanosegundo está afuera. fuera de cualquiera de las ventanas, la gateway rechaza localmente, antes de que un byte llegue a la red: 422 con el código MYS-0006 y un detalle que le indica que obtenga una nueva autorización de trabajador. Esa negativa es no REINTENTABLE. Al repetir la solicitud se realiza la misma lectura de la autorización caducada y retirada; sólo nueva evidencia de autorización hace que tenga éxito. Un dataHoraAutorizacaoDigital que lleva un desplazamiento que no es UTC, o que tiene una fecha anterior al reloj de la gateway, es el mismo 422 con un detalle diferente: corrija la marca de tiempo; el consentimiento del trabajador no está en duda. compare el rechazo de consentimiento propio de la red (Dataprev ex/iv en un tokenAutorizacao obsoleto): es 503 y se puede volver a intentar, porque la gateway descarta el token almacenado en caché y el siguiente intento abre un nuevo consentimiento a partir de la misma evidencia. ## OpenAPI ````yaml es/openapi/v3-current/consignado.yaml post /v1/consignado/fgts/saldo 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/fgts/saldo: post: tags: - Consignado Rail summary: Leer el saldo consignable FGTS de un trabajador description: >- Esta operación actúa como proxy de consultar-saldo-fgts (Manual 002 §3.4): el saldo FGTS consignable del trabajador y la porción de penalización por rescisión, el origen de los valores de garantía que lleva una averbação o una oferta de subasta. POST, no GET, porque la lectura está controlada por consentimiento: la evidencia de autorización grupo-1 del trabajador es un objeto anidado y CPF nunca debe aparecer en una ruta o cadena de consulta. El token de consentimiento que la gateway acuña o reutiliza nunca se devuelve. El dinero es una cadena decimal, nunca un flotante. VENTANA DE CONSENTIMIENTO (Manual 002 v1.15 §5.6). DataHoraAutorizacaoDigital pone en marcha dos relojes, medidos en días calendario a partir de la firma del trabajador: la autorización puede ser CONSULTADA por 30 días, y una solicitud puede ser PRESENTADA en su contra por 45. Ambos límites son inclusivos: el instante exactamente 30 o 45 días después de que la firma todavía está dentro de su ventana, y solo el siguiente nanosegundo está afuera. fuera de cualquiera de las ventanas, la gateway rechaza localmente, antes de que un byte llegue a la red: 422 con el código MYS-0006 y un detalle que le indica que obtenga una nueva autorización de trabajador. Esa negativa es no REINTENTABLE. Al repetir la solicitud se realiza la misma lectura de la autorización caducada y retirada; sólo nueva evidencia de autorización hace que tenga éxito. Un dataHoraAutorizacaoDigital que lleva un desplazamiento que no es UTC, o que tiene una fecha anterior al reloj de la gateway, es el mismo 422 con un detalle diferente: corrija la marca de tiempo; el consentimiento del trabajador no está en duda. compare el rechazo de consentimiento propio de la red (Dataprev ex/iv en un tokenAutorizacao obsoleto): es 503 y se puede volver a intentar, porque la gateway descarta el token almacenado en caché y el siguiente intento abre un nuevo consentimiento a partir de la misma evidencia. operationId: readConsignadoFgtsSaldo requestBody: content: application/json: schema: $ref: '#/components/schemas/FgtsSaldoRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FgtsSaldoResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: FgtsSaldoRequestBody: additionalProperties: false properties: authorization: $ref: '#/components/schemas/ConsentAuthorizationBody' description: >- Worker grupo-1 digital-authorization evidence used to open or reuse the data-consult consent. codigoInscricaoEmpregador: description: >- Employer inscription type. Manual 003 §3.1.1 p.10 and Manual 002 §3.3.1 p.14 publish exactly two codes: 1 = CNPJ, 2 = CPF. enum: - '1' - '2' examples: - '1' type: string cpf: description: >- Worker CPF, exactly 11 digits (Manual 002 §3.2.2 p.12: Número, 11 algarismos). In the BODY, never a path or query parameter. examples: - '99999999999' pattern: ^[0-9]{11}$ type: string matricula: description: Employment registration at the employer. examples: - 99999999999-A minLength: 1 type: string numeroInscricaoEmpregador: description: Employer inscription number matching codigoInscricaoEmpregador. examples: - '42422253000101' minLength: 1 type: string required: - cpf - matricula - codigoInscricaoEmpregador - numeroInscricaoEmpregador - authorization type: object FgtsSaldoResponse: additionalProperties: false properties: dataHoraConsulta: description: >- Instant the rail computed the balance, RFC 3339 UTC. It is the balance's as-of moment, not the moment you called. examples: - '2026-07-30T12:00:00Z' format: date-time type: string valorMultaRescisoriaConsignado: description: Rescission-penalty portion (decimal string, BRL). examples: - '400.25' type: string valorSaldoDisponivelConsignado: description: Consignable FGTS balance (decimal string, BRL). examples: - '1000.50' type: string required: - dataHoraConsulta - valorSaldoDisponivelConsignado - valorMultaRescisoriaConsignado type: object 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 ConsentAuthorizationBody: additionalProperties: false properties: canalAutorizacaoDigital: description: >- Digital authorization channel. Published enumeration (Manual 002 §3.1.1 p.9): 1 = ATM, 2 = Agência, 3 = Web Cliente, 4 = Web Correspondente, 5 = Mobile. enum: - '1' - '2' - '3' - '4' - '5' examples: - '2' type: string dataHoraAutorizacaoDigital: description: >- Instant the worker authorized, RFC 3339. Rendered to the rail's ddMMyyyyHHmmss by the adapter. examples: - '2025-05-14T10:00:00Z' format: date-time type: string nsuAutorizacaoDigital: description: >- Unique sequential number of the authorization (Número, up to 19 digits). Kept as digits end to end — 19 digits overflow a signed 64-bit integer at the top of the range. examples: - '1234567890123456789' pattern: ^[0-9]{1,19}$ type: string required: - canalAutorizacaoDigital - dataHoraAutorizacaoDigital - nsuAutorizacaoDigital 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 ````