Skip to main content
GET
Leer una página del estado de efectivación de una portabilidad

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

page
integer<int64>
predeterminado:1

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

Rango requerido: x >= 1
Ejemplo:

1

codigo_origem
string

OPTIONAL filter: the origin institution's code.

Ejemplo:

"899"

numero_unico
string

OPTIONAL filter: the portability's NSU.

Maximum string length: 21
Pattern: ^[0-9]{0,21}$
Ejemplo:

"100000000000000000001"

matricula
string

OPTIONAL filter: worker registration number.

Maximum string length: 30
Ejemplo:

"99999999999-A"

codigo_inscricao_empregador
string

OPTIONAL filter: 1 CNPJ, 2 CPF.

Pattern: ^[12]?$
Ejemplo:

"1"

numero_inscricao_empregador
string

OPTIONAL filter: employer inscription number.

Maximum string length: 15
Ejemplo:

"99999999999881"

data_inicio_operacao
string<date-time>

OPTIONAL filter: operation window start.

Ejemplo:

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

data_fim_operacao
string<date-time>

OPTIONAL filter: operation window end.

Ejemplo:

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

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]?$
Ejemplo:

"1"

Respuesta

OK

has_more
boolean
requerido

Whether a further page exists.

Ejemplo:

false

page
integer<int64>
requerido

1-based page number, echoed from the rail.

Ejemplo:

1

registros
object[] | null
requerido
size
integer<int64>
requerido

Page size the rail is paginating with.

Ejemplo:

10