Get one contract's averbação operation
Returns ONE contract’s averbação operation, by the rail contract number.
It answers from a LOCAL table and never reaches the Dataprev rail. The tenant is derived from the validated identity: a contract that does not exist and a contract belonging to another tenant are the SAME answer, 404, so this read cannot be used to probe another tenant’s book.
A fund or originador credential reads only an averbação its own credential sent, or whose documentation it sent; any other contract answers the same 404. The bancarizador reads every contract of its tenant.
The body is the operation object itself, with no envelope, the same shape as one element of GET /v1/consignado/averbacao-operations. Every conditional instant is present and null until the step it names has happened.
This is the READ half of the address whose POST creates the payroll-deduction mandate. It creates nothing and changes nothing.
Partner route: the text above describes the party’s own route. Here the register id in the path names the party: it must be in the partner credential’s scope and registered under the caller’s tenant, and the call runs as that party, exactly as the party’s own credential would.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
The originador's register id, as returned in the id field of GET /v1/consignado/originadores. It must be in the partner credential's scope.
"6f1c2a3b-4d5e-4f60-8a7b-9c0d1e2f3a4b"
The rail contract number, exactly as it was registered. It is never trimmed or normalized.
2 - 15Response
OK
Who stamped averbacao_at. dataprev_response: the gateway clock on receiving Dataprev's acceptance, seconds after it. recovery_read: the recovery pass clock when its read proved the acceptance, at or after Dataprev's real acceptance, so the real due instant can be earlier than documentation_due_at. imported: the rail's own instant, declared at import. Null exactly when documentation_due_at is.
dataprev_response, recovery_read, imported, null Fixed by the averbação. booked: the documentation sends signature_evidence_ref and artifacts.biometrics_documents_pack. rail_only: it sends neither.
booked, rail_only When the averbação's documentation is due: averbacao_at plus 7 calendar days (Manual 004 v1.6 §1.1). Null until Dataprev accepted the averbação, and on a refusal. The real due instant can be earlier than this one: see averbacao_at_origin.
True while the averbação is attachment_pending and nobody sent its documentation, or is attachment_invoking past attachment_invocation_deadline_at (the call lost its process), exclusion_status is null or rejected under any evidenceSource but m005_observation, the contract has not left the registry (by a refinanciamento or renegociação no reversal undid, a portability exclusion, an exclusion dataprev_follow_up observed at Dataprev, or a termination the Manual 006 report listed), and documentation_due_at has passed. A signal only: the gateway excludes or changes nothing because of it.
The exclusion requested through this gateway that describes the contract now, by the rule of GET .../exclusion. Null when none was claimed here; an exclusion made outside the gateway leaves it null and shows in dataprev_follow_up. While the operation is attachment_pending, any value but rejected makes POST .../ccb-attachment answer 409 AVERBACAO_EXCLUDED, and so does a rejected whose GET .../exclusion evidenceSource is m005_observation: that read showed the contract already off the registry.
claimed, invoking, confirmed, rejected, outcome_unknown, null The CloudEvents id of the operation's terminal fact (confirmed or rejected). Null until the operation reaches one. GET /v1/consignado/event-delivery/invalid shows it as event_id, or as id for an outcome an older gateway recorded.
The rail's return code for the averbação call. Empty until the rail answered.
The rail's message for the averbação call. Empty until the rail answered.
The situation the operation is durably parked in. An attachment_invoking call past attachment_invocation_deadline_at lost its process: the contract takes documentation or an exclusion as in attachment_pending.
claimed, averbacao_invoking, averbacao_unknown, attachment_pending, attachment_invoking, attachment_unknown, confirmed, rejected What the gateway last read at Dataprev (Manual 005) while the contract waited for its documentation: one read a day, from one day after averbacao_at until the follow-up ends or observes the contract excluded or ended. Absent until the first read.
The newest documentation attempt Dataprev did not accept, which returned the contract to attachment_pending. Absent when none closed. A later accepted documentation does not clear it: compare closed_at with attachment_at.