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.

POST /v1/consignado/portabilidade/efetivacoes

Read one page of a portability's efetivação status

cURL

curl --request POST \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/portabilidade/efetivacoes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "classificador_situacao": "1",
  "codigo_inscricao_empregador": "1",
  "codigo_origem": "899",
  "data_fim_operacao": "2026-02-01T00:00:00Z",
  "data_inicio_operacao": "2026-01-01T00:00:00Z",
  "matricula": "99999999999-A",
  "numero_inscricao_empregador": "99999999999881",
  "numero_unico": "100000000000000000001",
  "page": 1
}
'

200

{
  "has_more": false,
  "page": 1,
  "registros": [
    {
      "cpfTrabalhador": "99999999999",
      "dataInclusaoPortabilidade": "2026-01-01T00:00:00Z",
      "matricula": "99999999999-A",
      "numeroInscricaoEmpregador": "99999999999881",
      "numeroUnico": "100000000000000000001",
      "classificadorSituacao": {
        "codigo": 1,
        "descricao": "Encerrado por prazo"
      },
      "codigoInscricaoEmpregador": 1,
      "codigoProponente": {
        "codigo": 1,
        "descricao": "Encerrado por prazo"
      },
      "contratosExcluidos": [
        {
          "dataExclusao": "2026-01-02T00:00:00Z",
          "numeroContratoExcluido": "199971600001",
          "ultimaParcelaPaga": 3,
          "codigoOrigem": {
            "codigo": 1,
            "descricao": "Encerrado por prazo"
          }
        }
      ],
      "dataAverbacao": "2026-01-05T00:00:00Z",
      "numeroContratoAverbado": "199971600000",
      "numeroUnicoNovo": "100000000000000000002"
    }
  ],
  "size": 10
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Body

application/json

classificador_situacao · string

OPTIONAL filter: 0 Aberto, 1 Encerrado por prazo, 2 Encerrado por averbação, 3 Encerrado por alteração do Número Único.

Pattern: ^[0-3]?$

Example:

"1"

codigo_inscricao_empregador · string

OPTIONAL filter: 1 CNPJ, 2 CPF.

Pattern: ^[12]?$

Example:

"1"

codigo_origem · string

OPTIONAL filter: the origin institution's code.

Example:

"899"

data_fim_operacao · string<date-time>

OPTIONAL filter: operation window end.

Example:

"2026-02-01T00:00:00Z"

data_inicio_operacao · string<date-time>

OPTIONAL filter: operation window start.

Example:

"2026-01-01T00:00:00Z"

matricula · string

OPTIONAL filter: worker registration number.

Maximum string length: 30

Example:

"99999999999-A"

numero_inscricao_empregador · string

OPTIONAL filter: employer inscription number.

Maximum string length: 15

Example:

"99999999999881"

numero_unico · string

OPTIONAL filter: the portability's NSU.

Maximum string length: 21

Pattern: ^[0-9]{0,21}$

Example:

"100000000000000000001"

page · integer<int64> · default: 1

1-based page number, relayed to the rail's nroPagina.

Required range: x >= 1

Example:

1

Response

200

application/json

OK

has_more · boolean · required

Whether a further page exists.

Example:

false

page · integer<int64> · required

1-based page number, echoed from the rail.

Example:

1

registros · object[] | null · required

Show child attributes

size · integer<int64> · required

Page size the rail is paginating with.

Example:

10