Skip to main content
POST
Submit a one-or-two proposal set to the payroll rail

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Required durable replay key, scoped by authenticated tenant and bounded like the service's other indexed opaque request references.

Required string length: 1 - 128
Example:

"idem-bid-2026-07-31-0001"

Path Parameters

id_solicitacao
string
required

Canonical positive int64 Dataprev solicitação identifier, bounded by 9223372036854775807. Leading-zero aliases are normalized before idempotency fingerprinting.

Required string length: 1 - 19
Pattern: ^([1-9][0-9]{0,17}|[1-8][0-9]{18}|9[01][0-9]{17}|92[01][0-9]{16}|922[0-2][0-9]{15}|9223[0-2][0-9]{14}|92233[0-6][0-9]{13}|922337[01][0-9]{12}|92233720[0-2][0-9]{10}|922337203[0-5][0-9]{9}|9223372036[0-7][0-9]{8}|92233720368[0-4][0-9]{7}|922337203685[0-3][0-9]{6}|9223372036854[0-6][0-9]{5}|92233720368547[0-6][0-9]{4}|922337203685477[0-4][0-9]{3}|9223372036854775[0-7][0-9]{2}|922337203685477580[0-6]|9223372036854775807)$
Example:

"18406"

Body

application/json
matricula
string
required

Employment bond matrícula echoed from the discovered solicitação and checked against its durable snapshot.

Required string length: 1 - 30
Example:

"EMP-7K9M2P"

propostas
object[]
required
Required array length: 1 - 2 elements
portalBaseUrl
string

Optional formalization portal base URL for this bid alone, for a tenant that originates through several partners and formalizes each bid on that partner's portal. It overrides the tenant's registered portal base URL. Must be an absolute HTTPS URL with no credentials and no fragment; an invalid value is refused with rule PORTAL_URL and nothing is submitted to the rail. The server still mints the type 0 contact itself, appending id_solicitacao and numero_proposta. Omit it to use the tenant's registered portal.

Maximum string length: 255
Example:

"https://partner.example.com/formalizacao"

Response

OK

idSolicitacao
string
required

Dataprev solicitação identifier addressed by the bid.

Example:

"18406"

propostas
object[] | null
required
submittedAt
string<date-time>
required

UTC instant when the full rail outcome was durably recorded.

Example:

"2026-07-31T12:00:00Z"