> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Registrar um empréstimo consignado

> Como a averbação de um empréstimo consignado e a documentação do contrato chegam ao Dataprev pela Lerian.

Registre o desconto em folha de um empréstimo no Dataprev e depois envie a documentação do contrato.

> [!NOTE]
>
> Este fluxo é uma interpretação sugerida dos manuais do Dataprev para o Crédito do Trabalhador. Os manuais prevalecem sobre esta página. Sua instituição valida o fluxo e o implementa sobre as APIs da Lerian. Veja [como ler os diagramas](https://docs.lerian.studio/pt/diagrams/introduction.md).

## Participantes

***

* **Sua instituição.** A instituição financeira que concede o empréstimo.
* **Lerian.** Lerian Consignado. Troca as requisições com o Dataprev e expõe a API e os eventos que sua instituição usa.
* **Dataprev.** Opera o sistema do Crédito do Trabalhador: os leilões de empréstimo e o registro dos empréstimos consignados.

## Diagrama

***

![Registrar um empréstimo consignado](https://mintcdn.com/lerian-49cb71fc/WuRfbo_y9uSbzyyX/images/pt/d2/id-register-a-payroll-loan.svg?fit=max\&auto=format\&n=WuRfbo_y9uSbzyyX\&q=85\&s=c3ab322390c7ae277a0acef04ab78eca)

## Passo a passo

***

| # | Origem | Destino | Mensagem | API da Lerian | O que acontece |
| - | - | - | - | - | - |
| 1 | Sua instituição | Lerian | API da Lerian | [`POST /v1/consignado/contracts/{numero_contrato}/averbacao`](https://docs.lerian.studio/pt/reference/rails/consignado/averbar-consignado-contract) | Envie a averbação do contrato, sem nenhum documento. Você escolhe o `numero_contrato`: de 2 a 15 letras ou dígitos. |
| 2 | Lerian | Dataprev | API do Dataprev | | A Lerian envia a averbação ao Dataprev (Manual 003). |
| 3 | Dataprev | Lerian | API do Dataprev | | O Dataprev aceita a averbação e passa a deter o mandato de desconto em folha. |
| 4 | Lerian | Sua instituição | API da Lerian | [`POST /v1/consignado/contracts/{numero_contrato}/averbacao`](https://docs.lerian.studio/pt/reference/rails/consignado/averbar-consignado-contract) | A operação responde `attachment_pending`: o contrato aguarda a documentação. |
| 5 | Lerian | Sua instituição | API da Lerian | Evento `consignado.averbacao.accepted` | A Lerian publica a averbação aceita. |
| 6 | Sua instituição | Lerian | API da Lerian | [`POST /v1/consignado/contracts/{numero_contrato}/ccb-attachment`](https://docs.lerian.studio/pt/reference/rails/consignado/attach-consignado-ccb) | Envie a documentação sob a própria chave `X-Idempotency`: a CCB assinada, a evidência de assinatura e `data_hora_assinatura`, o instante em que o trabalhador assinou. |
| 7 | Lerian | Dataprev | API do Dataprev | | A Lerian envia as informações do contrato ao Dataprev (Manual 004). |
| 8 | Dataprev | Lerian | API do Dataprev | | O Dataprev aceita a documentação e devolve o hash da operação. |
| 9 | Lerian | Sua instituição | API da Lerian | [`POST /v1/consignado/contracts/{numero_contrato}/ccb-attachment`](https://docs.lerian.studio/pt/reference/rails/consignado/attach-consignado-ccb) | A operação responde `confirmed`. |
| 10 | Lerian | Sua instituição | API da Lerian | Evento `consignado.averbacao.confirmed` | A Lerian publica a averbação confirmada. |

O Manual 004 do Dataprev dá à sua instituição 7 dias após a averbação para enviar a documentação. [`GET /v1/consignado/contracts/{numero_contrato}/averbacao`](https://docs.lerian.studio/pt/reference/rails/consignado/get-consignado-contract-averbacao-operation) mostra `documentation_due_at` e `documentation_overdue`.

Um contrato aceita uma única documentação aceita. A Lerian informa o saldo devedor do contrato ao Dataprev a partir da averbação aceita.

Quando o Dataprev recusa a averbação com um código que a Lerian reconhece, a operação lê `rejected`, e a Lerian publica `consignado.averbacao.rejected`. Quando o Dataprev responde à averbação com qualquer outro código, ou a resposta dele não chega, a operação lê `averbacao_unknown`. Não a envie de novo sob uma nova chave. Leia a averbação e contate a Lerian com o número do contrato se ela continuar `averbacao_unknown`.

A documentação enviada antes de o Dataprev aceitar a averbação responde `409` `AVERBACAO_NOT_ACCEPTED`, e nada chega ao Dataprev. Se o Dataprev recusar a documentação, a resposta é `422` com os códigos do Dataprev em `upstream`. Envie a documentação corrigida sob uma nova chave `X-Idempotency`. Se a chamada terminar sem veredito, envie a mesma documentação de novo.

## Como saber que terminou

***

A documentação responde `confirmed`, e a Lerian publica `consignado.averbacao.confirmed`.

## Relacionados

***

* [Responder a um pedido de empréstimo consignado](https://docs.lerian.studio/pt/diagrams/native-rails/answer-a-payroll-loan-request.md)
* [Refinanciar um empréstimo consignado](https://docs.lerian.studio/pt/diagrams/native-rails/refinance-a-payroll-loan.md)
* [Como funciona o Lerian Consignado](https://docs.lerian.studio/pt/rails/consignado/how-consignado-works.md)
* [Eventos do Consignado](https://docs.lerian.studio/pt/reference/events/consignado.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.