This flow is a suggested interpretation of the Dataprev manuals for Crédito do Trabalhador. The manuals prevail over this page. Your institution validates the flow and implements it on the Lerian APIs. See how to read the diagrams.
Participants
- Your institution. The financial institution that takes the loan from the origin institution.
- Lerian. Lerian Consignado. It exchanges the requests with Dataprev, and exposes the API and the events your institution uses.
- Dataprev. Runs the Crédito do Trabalhador system: the portability requests and the registry of payroll loans.
- Worker. The employee who asks for portability proposals in the Carteira de Trabalho Digital app.
Diagram
Answer the portability request
Lerian refuses a proposal after the validity of the request, before it calls Dataprev. A request that admits a second proposal, with and without FGTS collateral, takes two calls.
Register the ported loan
The exclusion at the origin institution must come first, with or without FGTS collateral. Dataprev refuses an averbação sent before the exclusion with rule
PT, and one sent after the portability closed with rule PW. After either refusal, the contract number is free for a new averbação.
When you send dataExclusaoOrigem, Lerian refuses an averbação after the 20 calendar days that follow that date, before it calls Dataprev. Without it, Lerian skips only that check, and Dataprev judges the order and the window.
classificadorSituacao reads 0 open, 1 closed by deadline, 2 closed by averbação or 3 closed by a change of the número único.
An accepted averbação records the contract as waiting for its documentation, and starts the Lerian outstanding-balance reports. GET /v1/consignado/contracts/{numero_contrato}/averbacao reads attachment_pending. Lerian publishes no consignado.averbacao.accepted for it. The documentation follows the rules of Register a payroll loan.
For the booking fields and validation, see the portability averbação.
With booking, consignado.contract.registered carries a portability_in block once Dataprev accepts the documentation. The block holds origins[], transferred_principal and effective_at. Lerian sends it when the Dataprev status record of the portability shows exactly the booked origins. If the record shows another origin, or still lacks some 20 calendar days after the confirmed documentation, Lerian parks the contract and publishes no fact. Without booking, Lerian keeps the signed CCB and publishes no Lender fact.
A 503 or 500 answer with X-Idempotency-Fenced: true may have reached Dataprev. For a proposal, send the same body with the same numeroProposta under a new key, before the validity of the request. A 422 that names SE means that the first proposal reached Dataprev.
Lerian claims the numeroContrato before it calls Dataprev. While the outcome is open, a resend under a new key never submits the averbação again: it answers 409 CLT-0007 while the first call may still run, then 503 OUTCOME_UNKNOWN. Lerian then reads the contract at Dataprev, and records it as accepted or frees the number. That read needs averbação recovery (DATAPREV_AVERBACAO_RECOVERY_ENABLED, off by default). A numeroContrato that your institution already holds answers 409 CONTRACT_ALREADY_REGISTERED, before Lerian calls Dataprev.
How you know it finished
The documentation answers
confirmed, and the status of the portability reads 2.