> ## 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.

# Consignado privado

> Lender's flagship Brazilian journey — payroll-deducted lending, from active origination (contratação ativa) through CCB signing and averbação lifecycle tracking.

export const GReconciliation = ({children}) => <Tooltip headline="Reconciliation" tip="The process of comparing two sets of records — for example, your internal ledger against bank statements — to verify they match and flag discrepancies." cta="See glossary" href="/en/glossary">
    {children}
  </Tooltip>;

export const GICPBrasil = ({children}) => <Tooltip headline="ICP-Brasil" tip="Infraestrutura de Chaves Públicas Brasileira — Brazil's official public key infrastructure for digital certificates. e-Financeira submissions must be signed with a valid ICP-Brasil certificate." cta="See glossary" href="/en/glossary">
    {children}
  </Tooltip>;

**Consignado privado** is payroll-deducted private-sector lending: installments are withheld at source from the borrower's salary by the paying employer. It is the deepest journey Lender ships today — a full Brazilian bounded context on top of the [Brazil regulatory pack](/en/lender/brazil-regulatory-pack), with its own origination flow, credit instrument, and lifecycle events.

## The vocabulary

***

| Term            | Gloss                                                                                                   |
| --------------- | ------------------------------------------------------------------------------------------------------- |
| **Consignado**  | Payroll-deducted credit — repayments are withheld from salary at source.                                |
| **Averbação**   | Registration of the payroll deduction with the paying entity, so installments are withheld each period. |
| **Margem**      | The consignable margin — the portion of salary available for deduction.                                 |
| **Vínculo**     | The employment link between borrower and employer that the loan is deducted against.                    |
| **Competência** | The payroll period (a `YYYYMM` reference) an installment is deducted in.                                |
| **CCB**         | *Cédula de Crédito Bancário* — the bank credit instrument issued and signed for the contract.           |

## Contratação ativa — origination in one call

***

Active origination happens through a single endpoint:

`POST /api/v1/br/consignado/contracts`

That one call orchestrates the whole origination:

<Steps>
  <Step title="Re-check the margin">
    Lender re-checks the borrower's consignable **margem** against the employment **vínculo** before committing, so a contract is never originated beyond the available margin.
  </Step>

  <Step title="Render and sign the CCB">
    The **CCB** is rendered as a PDF and signed with an <GICPBrasil>ICP-Brasil</GICPBrasil> digital signature, producing the legally binding credit instrument.
  </Step>

  <Step title="Create and approve the core application">
    Lender creates and approves the core loan application — carrying its BR consignado extension — and persists it, reusing the same origination machinery as every other loan.
  </Step>

  <Step title="Request averbação">
    Lender emits `consignado.averbacao.requested` so an external payroll-deduction gateway performs the real averbação with the paying entity.
  </Step>
</Steps>

The response reflects the **core origination** progress — approved on contratação. The **averbação lifecycle** is tracked separately through events, because it depends on the paying entity acting.

## The averbação lifecycle

***

Because averbação happens at an external payroll rail, Lender models it as an asynchronous conversation over the streaming backbone rather than a synchronous call. On top of the core [event catalog](/en/lender/lender-in-the-platform), the consignado context contributes its own signals:

| Event                                                              | Direction | Meaning                                                  |
| ------------------------------------------------------------------ | --------- | -------------------------------------------------------- |
| `consignado.margin.requested` / `consignado.margin.fetched`        | out / in  | Ask the rail for the consignable margin, and receive it. |
| `consignado.proposal.accepted`                                     | in        | The borrower accepted the proposal.                      |
| `consignado.averbacao.requested`                                   | out       | Ask the rail to register the payroll deduction.          |
| `consignado.averbacao.confirmed` / `consignado.averbacao.rejected` | in        | The rail confirmed or refused the averbação.             |
| `consignado.exclusao.requested`                                    | out       | Ask the rail to remove a registered deduction.           |
| `consignado.reconciliation.received`                               | in        | A reconciliation verdict arrived for the contract.       |

Money and rate fields cross the wire as decimal strings (never floats), consistent with the ledger's money model.

## Optional: reconciliation with Matcher

***

<Warning>
  This integration is **off by default** and gated by configuration. Document and enable it only when your deployment has explicitly turned it on.
</Warning>

Consignado contracts can optionally be reconciled against [Matcher](/en/matcher/what-is-matcher). When enabled, a Matcher <GReconciliation>reconciliation</GReconciliation> verdict on a contract is translated into a downstream effect on the loan — a PDD stage transition and a corresponding ledger posting intent. With the integration disabled, the reconciliation consumer is a no-op: nothing is required for the core consignado journey to work.

## Next steps

***

<Card title="Brazil regulatory pack" icon="brazilian-real-sign" href="/en/lender/brazil-regulatory-pack" horizontal>
  CET, IOF, capitalization consent, PDD staging, and the rest of the BR profile.
</Card>

<Card title="Lender in the platform" icon="sitemap" href="/en/lender/lender-in-the-platform" horizontal>
  How the events and postings behind this journey are delivered.
</Card>