> ## 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. # Read one page of a portability's efetivação status > Reads one page of consultar-portabilidade-trabalhador (Manual 008 v1.10 §5.4), the proponent's published status view for a portability. classificadorSituacao is relayed without reinterpretation: 0 Aberto, 1 Encerrado por prazo, 2 Encerrado por averbação, or 3 Encerrado por alteração do Número Único. Code 1 means that the 20-calendar-day portability window has closed and the FGTS collateral blocks were removed. codigoProponente is injected from the tenant's Dataprev credential and is never accepted from the caller. The filters travel in the request body. Send {} for the first page with no filter. This read does not mutate gateway state. It spends the tenant's write rate budget, which the tenant's commands share. ## OpenAPI ````yaml /pt/openapi/v3-current/consignado.yaml post /v1/consignado/portabilidade/efetivacoes 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, B3 instrument codes, disbursement confirmation, portability, refinancing, renegotiation, FGTS guarantees, reconciliation, funds, assignments, throughput, and event subscriptions. license: name: Lerian Studio General License title: Lerian Consignado API version: v1.0.0 servers: - url: https://br-consignado-gw.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: >- 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. 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 - description: >- The B3 instrument code (Código IF) of an averbado contract: informed once by the bancarizador after B3 registers the CCB, and read back name: Consignado Registro B3 paths: /v1/consignado/portabilidade/efetivacoes: post: tags: - Consignado Rail summary: Read one page of a portability's efetivação status description: >- Reads one page of consultar-portabilidade-trabalhador (Manual 008 v1.10 §5.4), the proponent's published status view for a portability. classificadorSituacao is relayed without reinterpretation: 0 Aberto, 1 Encerrado por prazo, 2 Encerrado por averbação, or 3 Encerrado por alteração do Número Único. Code 1 means that the 20-calendar-day portability window has closed and the FGTS collateral blocks were removed. codigoProponente is injected from the tenant's Dataprev credential and is never accepted from the caller. The filters travel in the request body. Send {} for the first page with no filter. This read does not mutate gateway state. It spends the tenant's write rate budget, which the tenant's commands share. operationId: listConsignadoPortabilidadeEfetivacoes requestBody: content: application/json: schema: $ref: '#/components/schemas/PortabilidadeConsultaRequestBody' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PortabilidadeConsultaResponseBody' description: OK '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Internal Server Error default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: PortabilidadeConsultaRequestBody: additionalProperties: false properties: classificador_situacao: 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 codigo_inscricao_empregador: description: 'OPTIONAL filter: 1 CNPJ, 2 CPF.' examples: - '1' pattern: ^[12]?$ type: string codigo_origem: description: 'OPTIONAL filter: the origin institution''s code.' examples: - '899' type: string data_fim_operacao: description: 'OPTIONAL filter: operation window end.' examples: - '2026-02-01T00:00:00Z' format: date-time type: string data_inicio_operacao: description: 'OPTIONAL filter: operation window start.' examples: - '2026-01-01T00:00:00Z' format: date-time type: string matricula: description: 'OPTIONAL filter: worker registration number.' examples: - 99999999999-A maxLength: 30 type: string numero_inscricao_empregador: description: 'OPTIONAL filter: employer inscription number.' examples: - '99999999999881' maxLength: 15 type: string numero_unico: description: 'OPTIONAL filter: the portability''s NSU.' examples: - '100000000000000000001' maxLength: 21 pattern: ^[0-9]{0,21}$ type: string page: default: 1 description: 1-based page number, relayed to the rail's nroPagina. examples: - 1 format: int64 minimum: 1 type: integer type: object 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: true properties: code: description: >- Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable. enum: - AUT-0033 - AUT-1021 - AVERBACAO_ARTIFACT_CONFLICT - AVERBACAO_CLAIM_CONFLICT - AVERBACAO_DOCUMENTATION_CONFLICT - AVERBACAO_EXCLUDED - AVERBACAO_HELD_BY_ANOTHER_SENDER - AVERBACAO_NOT_ACCEPTED - AVERBACAO_OPERATIONS_INTERNAL - AVERBACAO_OPERATIONS_INVALID_CURSOR - AVERBACAO_OPERATIONS_INVALID_QUERY - AVERBACAO_OPERATIONS_UNKNOWN_STATUS - AVERBACAO_OPERATION_NOT_FOUND - BID_NO_PROPOSTA_LEFT - BID_ORIGINADOR_INACTIVE - BID_ORIGINADOR_UNKNOWN - BID_PROPOSAL_SLOT_TAKEN - BID_SOLICITACAO_TAKEN - BID_SOLICITACAO_UNKNOWN - BID_SUBMISSIONS_INTERNAL - BID_SUBMISSIONS_INVALID_CURSOR - BID_SUBMISSIONS_UNKNOWN_SITUATION - BOOKING_FIELD_INVALID - CEDED_CREDIT_INTERNAL - CEDED_CREDIT_NO_FUND_ENTITLEMENT - CEDED_CREDIT_UNAVAILABLE - CESSAO_CEDED_TO_OTHER_FUND - CESSAO_CREDIT_NOT_ACCEPTED - CESSAO_CREDIT_NOT_FOUND - CESSAO_CREDIT_NOT_WITNESSED - CESSAO_CREDIT_PENDING - CESSAO_FUNDO_NOT_ATTRIBUTED - CESSAO_INTERNAL - CESSAO_INVALID_INPUT - CESSAO_UNAVAILABLE - CESSAO_UNWIRED - CLT-0001 - CLT-0002 - CLT-0003 - CLT-0004 - CLT-0005 - CLT-0006 - CLT-0007 - CLT-0008 - CLT-0009 - CLT-0010 - CLT-0011 - CONTRACT_ALREADY_REGISTERED - CONTRACT_NOT_BOOKABLE - CURSOR_EXPIRED - CURSOR_FENCE_MISMATCH - DATAPREV_CREDENTIAL_REJECTED - DATAPREV_CREDENTIAL_REQUIRED - DATAPREV_CREDENTIAL_REVOKED - DATAPREV_INVALID_RESPONSE - DATAPREV_TIMEOUT - DATAPREV_UNAVAILABLE - DECLARED_DATES_OUT_OF_ORDER - DECLARED_TERMS_INCONSISTENT - DISBURSEMENT_CONFIRMATIONS_INTERNAL - DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR - DISBURSEMENT_PAYMENT_CONFLICT - EVENT_DELIVERY_INTERNAL - EXCLUSION_AUTHORITY_CONFLICT - EXCLUSION_BOOKING_IDENTITY_INCOMPLETE - EXCLUSION_DOCUMENTATION_UNDERWAY - EXCLUSION_OPERATIONS_INTERNAL - EXCLUSION_OPERATIONS_INVALID_CURSOR - EXCLUSION_OPERATIONS_INVALID_QUERY - EXCLUSION_OPERATIONS_UNKNOWN_STATUS - EXCLUSION_OPERATION_NOT_FOUND - FGTS_EXECUTION_ALREADY_REFUSED - FGTS_EXECUTION_CONTRACT_TAKEN - FGTS_EXECUTION_OUTCOME_UNRESOLVED - FGTS_EXECUTION_PAYLOAD_MISMATCH - FIRST_DEDUCTION_BEFORE_COMPETENCIA - FORMALIZATION_DEADLINE_EXCEEDED - FUNDO_CNPJ_CONFLICT - FUNDO_DEACTIVATED - FUNDO_INTERNAL - FUNDO_INVALID_ID - FUNDO_INVALID_INPUT - FUNDO_NOT_FOUND - FUNDO_NOT_REGISTERED - FUNDO_REF_CONFLICT - FUNDO_UNAVAILABLE - IDEMPOTENCY_KEY_REUSE - IDEMPOTENCY_OUTCOME_UNRECORDED - IDEMPOTENCY_RECORD_UNREADABLE - IDEMPOTENCY_REPLAY_UNAVAILABLE - IDEMPOTENCY_STATE_UNRECOGNISED - INVALID_CONTRACT_NUMBER - INVALID_CURSOR - INVALID_EVENTS_INVALID_CURSOR - INVALID_EVENT_NOT_FOUND - INVALID_EVENT_NOT_REQUEUEABLE - INVALID_PAGE_LIMIT - INVENTORY_UNAVAILABLE - MARGIN_SNAPSHOT_INCONSISTENT - ORIGINADOR_INTERNAL - ORIGINADOR_INVALID_ID - ORIGINADOR_INVALID_INPUT - ORIGINADOR_NOT_FOUND - ORIGINADOR_REF_CONFLICT - ORIGINADOR_UNAVAILABLE - OUTCOME_UNKNOWN - PORTABILIDADE_WINDOW_EXPIRED - RAIL_COMMANDS_INTERNAL - RAIL_COMMANDS_INVALID_CURSOR - RAIL_COMMANDS_TENANT_REQUIRED - RAIL_COMMANDS_UNKNOWN_FILTER - RAIL_COMMAND_ALREADY_REFUSED - RAIL_COMMAND_ANSWER_NOT_RETAINED - RAIL_COMMAND_CLAIM_CONFLICT - RAIL_COMMAND_OUTCOME_UNRESOLVED - RAIL_COMMAND_PAYLOAD_MISMATCH - RATE_OUTSIDE_PRODUCT_RANGE - REGISTRATION_NOT_FOUND - REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA - REGISTRO_B3_CONTRATO_NAO_ENCONTRADO - REGISTRO_B3_DATA_REGISTRO_INVALIDA - REGISTRO_B3_INTERNAL - REGISTRO_B3_JA_INFORMADO - REGISTRO_B3_NAO_INFORMADO - REGISTRO_B3_UNAVAILABLE - REGISTRO_B3_UNWIRED - REPASSE_EXPECTATIONS_INTERNAL - REPASSE_EXPECTATIONS_INVALID_CURSOR - REPASSE_EXPECTATIONS_UNKNOWN_SITUATION - REVERSAO_WINDOW_EXPIRED - SALDO_DEVEDOR_INTERNAL - SALDO_DEVEDOR_INVALID_CURSOR - SALDO_DEVEDOR_NOT_FOUND - SALDO_DEVEDOR_TENANT_REQUIRED - SALDO_DEVEDOR_UNAVAILABLE - STREAMING_HUB_TIMEOUT - STREAMING_HUB_UNAVAILABLE - TENANT_MANAGER_TIMEOUT - TENANT_MANAGER_UNAVAILABLE - THROUGHPUT_HISTORY_INTERNAL - THROUGHPUT_HISTORY_INVALID_CURSOR - THROUGHPUT_HISTORY_TENANT_REQUIRED - THROUGHPUT_HISTORY_UNAVAILABLE - THROUGH_REQUIRED - UNKNOWN_QUERY_PARAMETER 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.