> ## 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 una página del estado de efectivación de una portabilidad > Lee una página de consultar-portabilidade-trabalhador (Manual 008 v1.10 §5.4), la vista de estado publicada por la institución proponente para una portabilidad. classificadorSituacao se retransmite sin reinterpretación: 0 Aberto, 1 Encerrado por prazo, 2 Encerrado por averbação o 3 Encerrado por alteração do Número Único. El código 1 indica que el plazo de portabilidad de 20 días naturales se cerró y se retiraron los bloques de garantía FGTS. codigoProponente se inyecta desde la credencial Dataprev del tenant y nunca se acepta del llamante. Esta lectura no modifica el estado del gateway. ## OpenAPI ````yaml es/openapi/v3-current/consignado.yaml get /v1/consignado/portabilidade/efetivacoes 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/portabilidade/efetivacoes: get: tags: - Consignado Rail summary: Leer una página del estado de efectivación de una portabilidad description: >- Lee una página de consultar-portabilidade-trabalhador (Manual 008 v1.10 §5.4), la vista de estado publicada por la institución proponente para una portabilidad. classificadorSituacao se retransmite sin reinterpretación: 0 Aberto, 1 Encerrado por prazo, 2 Encerrado por averbação o 3 Encerrado por alteração do Número Único. El código 1 indica que el plazo de portabilidad de 20 días naturales se cerró y se retiraron los bloques de garantía FGTS. codigoProponente se inyecta desde la credencial Dataprev del tenant y nunca se acepta del llamante. Esta lectura no modifica el estado del gateway. operationId: listConsignadoPortabilidadeEfetivacoes parameters: - description: 1-based page number, relayed to the rail's nroPagina. explode: false in: query name: page schema: default: 1 description: 1-based page number, relayed to the rail's nroPagina. examples: - 1 format: int64 minimum: 1 type: integer - description: 'OPTIONAL filter: the origin institution''s code.' explode: false in: query name: codigo_origem schema: description: 'OPTIONAL filter: the origin institution''s code.' examples: - '899' type: string - description: 'OPTIONAL filter: the portability''s NSU.' explode: false in: query name: numero_unico schema: description: 'OPTIONAL filter: the portability''s NSU.' examples: - '100000000000000000001' maxLength: 21 pattern: ^[0-9]{0,21}$ type: string - description: 'OPTIONAL filter: worker registration number.' explode: false in: query name: matricula schema: description: 'OPTIONAL filter: worker registration number.' examples: - 99999999999-A maxLength: 30 type: string - description: 'OPTIONAL filter: 1 CNPJ, 2 CPF.' explode: false in: query name: codigo_inscricao_empregador schema: description: 'OPTIONAL filter: 1 CNPJ, 2 CPF.' examples: - '1' pattern: ^[12]?$ type: string - description: 'OPTIONAL filter: employer inscription number.' explode: false in: query name: numero_inscricao_empregador schema: description: 'OPTIONAL filter: employer inscription number.' examples: - '99999999999881' maxLength: 15 type: string - description: 'OPTIONAL filter: operation window start.' explode: false in: query name: data_inicio_operacao schema: description: 'OPTIONAL filter: operation window start.' examples: - '2026-01-01T00:00:00Z' format: date-time type: string - description: 'OPTIONAL filter: operation window end.' explode: false in: query name: data_fim_operacao schema: description: 'OPTIONAL filter: operation window end.' examples: - '2026-02-01T00:00:00Z' format: date-time type: string - description: >- OPTIONAL filter: 0 Aberto, 1 Encerrado por prazo, 2 Encerrado por averbação, 3 Encerrado por alteração do Número Único. explode: false in: query name: classificador_situacao schema: description: >- OPTIONAL filter: 0 Aberto, 1 Encerrado por prazo, 2 Encerrado por averbação, 3 Encerrado por alteração do Número Único. examples: - '1' pattern: ^[0-3]?$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PortabilidadeConsultaResponseBody' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: PortabilidadeConsultaResponseBody: additionalProperties: false properties: has_more: description: Whether a further page exists. examples: - false type: boolean page: description: 1-based page number, echoed from the rail. examples: - 1 format: int64 type: integer registros: items: $ref: '#/components/schemas/PortabilidadeEfetivacaoResponse' type: - array - 'null' size: description: Page size the rail is paginating with. examples: - 10 format: int64 type: integer required: - registros - page - size - has_more 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 PortabilidadeEfetivacaoResponse: additionalProperties: false properties: classificadorSituacao: $ref: '#/components/schemas/PortabilidadeCodigoDescricaoResponse' description: >- 0 Aberto, 1 Encerrado por prazo, 2 Encerrado por averbação, 3 Encerrado por alteração do Número Único — relayed verbatim, never re-derived. codigoInscricaoEmpregador: description: >- 1 CNPJ, 2 CPF. ABSENT when the rail's value was unreadable — never reported as 0, which is not a published code. examples: - 1 format: int64 type: integer codigoProponente: $ref: '#/components/schemas/PortabilidadeCodigoDescricaoResponse' contratosExcluidos: items: $ref: '#/components/schemas/PortabilidadeExclusaoRegistradaResponse' type: - array - 'null' cpfTrabalhador: description: >- Worker CPF, relayed verbatim in the response BODY — never a path or query parameter. examples: - '99999999999' type: string dataAverbacao: description: >- UTC instant of the averbação, when it has occurred. Absent until then: omitempty never elides a zero time.Time, omitzero does. examples: - '2026-01-05T00:00:00Z' format: date-time type: string dataInclusaoPortabilidade: description: UTC instant the portability was included on the rail. examples: - '2026-01-01T00:00:00Z' format: date-time type: string matricula: description: Worker registration number. examples: - 99999999999-A type: string numeroContratoAverbado: description: The destination contract number, once averbado. examples: - '199971600000' type: string numeroInscricaoEmpregador: description: Employer inscription number. examples: - '99999999999881' type: string numeroUnico: description: The portability's NSU. examples: - '100000000000000000001' type: string numeroUnicoNovo: description: >- The new NSU, when this portability was redirected by an alteration of the number único. examples: - '100000000000000000002' type: string required: - numeroUnico - cpfTrabalhador - matricula - numeroInscricaoEmpregador - dataInclusaoPortabilidade 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 PortabilidadeCodigoDescricaoResponse: additionalProperties: false properties: codigo: description: The rail's code, relayed verbatim. examples: - 1 format: int64 type: integer descricao: description: The rail's own label for the code, relayed verbatim. examples: - Encerrado por prazo type: string required: - codigo - descricao type: object PortabilidadeExclusaoRegistradaResponse: additionalProperties: false properties: codigoOrigem: $ref: '#/components/schemas/PortabilidadeCodigoDescricaoResponse' dataExclusao: description: UTC instant of the origin exclusion. examples: - '2026-01-02T00:00:00Z' format: date-time type: string numeroContratoExcluido: description: The origin contract number this portability excluded. examples: - '199971600001' type: string ultimaParcelaPaga: description: >- Last instalment paid on the excluded contract. 0 is a live value (exclusion before any instalment was paid), so the field is always present. examples: - 3 format: int64 type: integer required: - numeroContratoExcluido - dataExclusao - ultimaParcelaPaga type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````