Skip to main content
POST
Responder a uma solicitação recebida de leilão de portabilidade

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Required transport replay key, scoped by authenticated tenant.

Required string length: 1 - 128
Exemplo:

"idem-portability-2026-08-10-0001"

Parâmetros de caminho

id_solicitacao_proposta
string
obrigatório

Portability solicitação identity, echoed from the initiating fact. A digit string — Manual 011 v1.6 §3.2.1 publishes 32 algarismos, which overflows an int64.

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

"221"

Corpo

application/json
dataHoraValidadeProposta
string<date-time>
obrigatório

This proposal's own validity instant — a SEPARATE validity from dataHoraValidadeSolicitacao above, informed by the client (Manual 011 v1.6 §3.2.1).

Exemplo:

"2030-01-01T10:00:00Z"

dataHoraValidadeSolicitacao
string<date-time>
obrigatório

The portability solicitação's own validity instant from Manual 011 v1.6 §3.1.3. The cataloged consignado.portability_proposal.received fact is designed to carry this value, but that fact has no production producer on develop yet. The value is authoritative per record and is judged against the gateway's clock before the rail is called.

Exemplo:

"2025-10-30T23:45:29Z"

numeroParcelas
integer<int64>
obrigatório

Number of instalments.

Intervalo obrigatório: 1 <= x <= 999
Exemplo:

12

numeroProposta
string
obrigatório

Proposal identifier this gateway mints.

Required string length: 1 - 20
Exemplo:

"7K9M2P4R6T8V3W5X2Y4Z"

temGarantias
boolean
obrigatório

Whether this proposal pledges FGTS collateral.

Exemplo:

false

valorCETAnual
string
obrigatório

Annual total effective cost in percent.

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

"11.00"

valorCETMensal
string
obrigatório

Monthly total effective cost in percent.

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

"0.90"

valorEmprestimo
string
obrigatório

Principal plus financed costs as an exact decimal string.

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

"2160.00"

valorParcela
string
obrigatório

Instalment amount as an exact decimal string.

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

"180.00"

valorTaxaAnual
string
obrigatório

Annual interest rate in percent.

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

"10.00"

valorTaxaMensal
string
obrigatório

Monthly interest rate in percent.

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

"0.80"

contatos
object[] | null

Client contacts.

Maximum array length: 4
percVerbaRescisoriaGarantia
string

Optional severance-pay percentage pledged as collateral.

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

"15.00"

valorMultaRescisoriaGarantiaFgts
string

Optional rescission-penalty amount pledged as collateral.

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

"300.00"

valorSaldoDisponivelGarantiaFgts
string

Optional consignable FGTS balance pledged as collateral.

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

"600.00"

Resposta

OK

accepted
boolean
obrigatório

True only when the rail's codigo equalled the observed success code.

Exemplo:

true

codigo
string
obrigatório

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

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

"BD"

dataHoraValidadeProposta
string<date-time>
obrigatório

Proposal validity echoed by Dataprev.

Exemplo:

"2030-01-01T10:00:00Z"

idSolicitacaoProposta
string
obrigatório

The solicitação identity addressed by this response.

Exemplo:

"221"

numeroProposta
string
obrigatório

Proposal identifier echoed by Dataprev.

Exemplo:

"7K9M2P4R6T8V3W5X2Y4Z"

submittedAt
string<date-time>
obrigatório

UTC instant the gateway submitted this proposal.

Exemplo:

"2025-10-28T00:00:00Z"

hashOperacao
string

Opaque rail audit identifier, when published.

Exemplo:

"34027710"