Skip to main content
POST
Averbate a portability whose origin exclusion already ran

Authorizations

​
Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

​
X-Idempotency
string
required

Required transport replay key, scoped by authenticated tenant.

Required string length: 1 - 128
Example:

"idem-portabilidade-averbacao-2026-01-21-0001"

Path Parameters

​
numero_unico
string
required

The portability's NSU (Manual 008 v1.10 publishes 21 algarismos, which overflows int64/float64 — carried and validated as a digit string only).

Required string length: 1 - 21
Pattern: ^[0-9]{1,21}$
Example:

"100000000000000000001"

Body

application/json
​
codigoInscricaoEmpregador
string
required

1 CNPJ, 2 CPF.

Pattern: ^[12]$
Example:

"1"

​
cpfTrabalhador
string
required

Worker CPF, 11 digits.

Pattern: ^[0-9]{11}$
Example:

"99999999999"

​
dataFimContrato
string<date-time>
required

Contract end date.

Example:

"2031-01-01T00:00:00Z"

​
dataInicioContrato
string<date-time>
required

Contract start date.

Example:

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

​
dataPrimeiroDesconto
string<date-time>
required

First payroll discount date.

Example:

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

​
matricula
string
required

Worker registration number at the employer.

Required string length: 1 - 30
Example:

"99999999999-A"

​
nomeTrabalhador
string
required

Worker's full name. Manual 008 §5.3.1 publishes 90 characters; the mirrored Swagger publishes maxLength 100 for the same field — the wider bound is accepted here for the same reason as numeroContrato above.

Required string length: 1 - 100
Example:

"Trabalhador 99999999999"

​
numeroContrato
string
required

Contract number being averbado. Manual 008 §5.3.1 publishes 2-15 characters; the mirrored Swagger publishes maxLength 20 for the same field — the wider bound is accepted here so a value the rail itself would honour is never rejected first.

Required string length: 2 - 20
Example:

"199971600000"

​
numeroInscricaoEmpregador
string
required

Employer inscription number.

Required string length: 1 - 15
Example:

"99999999999881"

​
numeroParcelas
integer<int64>
required

Number of instalments.

Required range: 1 <= x <= 999
Example:

48

​
temGarantias
boolean
required

Whether this averbação pledges FGTS collateral.

Example:

false

​
valorCETAnual
string
required

Annual total effective cost in percent.

Maximum string length: 10
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"11.00"

​
valorCETMensal
string
required

Monthly total effective cost in percent.

Maximum string length: 10
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"0.90"

​
valorEmprestimo
string
required

Principal plus financed costs as an exact decimal string.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"2160.00"

​
valorPago
string
required

Settlement amount for the ORIGINAL contract(s) being ported — a field unique to this averbação.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"2000.00"

​
valorParcela
string
required

Instalment amount as an exact decimal string.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"180.00"

​
valorTaxaAnual
string
required

Annual interest rate in percent.

Maximum string length: 10
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"10.00"

​
valorTaxaMensal
string
required

Monthly interest rate in percent.

Maximum string length: 10
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"0.80"

​
cnpjOperador
string

OPTIONAL correspondent/cooperado CNPJ.

Maximum string length: 14
Example:

"12345678000199"

​
competenciaInicioDesconto
string

OPTIONAL. yyyyMM.

Pattern: ^[0-9]{6}$
Example:

"202602"

​
dataExclusaoOrigem
string<date-time>

OPTIONAL. Origin exclusion date the client tracks, NEVER sent to Dataprev. When present, the gateway's own 20-calendar-day pre-rail refusal is judged against it. When absent, this averbação is submitted as occurring BEFORE the origin exclusion (Manual 008 §4 permits either order).

Example:

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

​
numeroProposta
string

OPTIONAL. Manual-only field of undocumented referent — see the operation description.

Maximum string length: 20
Example:

"7K9M2P4R6T8V3W5X2Y4Z"

​
percVerbaRescisoriaGarantia
string

OPTIONAL severance-pay percentage pledged as collateral.

Maximum string length: 6
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"15.00"

​
valorMultaRescisoriaGarantiaFgts
string

OPTIONAL rescission-penalty amount pledged as collateral.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"300.00"

​
valorSaldoDisponivelGarantiaFgts
string

OPTIONAL consignable FGTS balance pledged as collateral.

Maximum string length: 13
Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"600.00"

Response

OK

​
codigoSucesso
string
required

Bounded rail outcome code, relayed verbatim. Free-form provider text is never returned.

Maximum string length: 32
Pattern: ^[A-Za-z0-9_-]*$
Example:

"BD"

​
competenciaInicioDesconto
integer<int64>
required

First payroll-discount competência (yyyyMM) echoed by Dataprev.

Example:

202602

​
numeroContrato
string
required

Contract number echoed by Dataprev.

Example:

"199971600000"

​
numeroUnico
string
required

The portability identity addressed by this averbação.

Example:

"100000000000000000001"

​
submittedAt
string<date-time>
required

UTC instant the gateway submitted this averbação.

Example:

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

​
mensagem
string

Rail message, relayed verbatim.

Example:

"Averbacao realizada com sucesso"