Skip to main content
GET
Leia uma página do status de efetivação da portabilidade

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

page
integer<int64>
padrão:1

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

Intervalo obrigatório: x >= 1
Exemplo:

1

codigo_origem
string

OPTIONAL filter: the origin institution's code.

Exemplo:

"899"

numero_unico
string

OPTIONAL filter: the portability's NSU.

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

"100000000000000000001"

matricula
string

OPTIONAL filter: worker registration number.

Maximum string length: 30
Exemplo:

"99999999999-A"

codigo_inscricao_empregador
string

OPTIONAL filter: 1 CNPJ, 2 CPF.

Pattern: ^[12]?$
Exemplo:

"1"

numero_inscricao_empregador
string

OPTIONAL filter: employer inscription number.

Maximum string length: 15
Exemplo:

"99999999999881"

data_inicio_operacao
string<date-time>

OPTIONAL filter: operation window start.

Exemplo:

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

data_fim_operacao
string<date-time>

OPTIONAL filter: operation window end.

Exemplo:

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

"1"

Resposta

OK

has_more
boolean
obrigatório

Whether a further page exists.

Exemplo:

false

page
integer<int64>
obrigatório

1-based page number, echoed from the rail.

Exemplo:

1

registros
object[] | null
obrigatório
size
integer<int64>
obrigatório

Page size the rail is paginating with.

Exemplo:

10