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

# Lender Consignado API and event contract

> Lender and Consignado documentation now covers new repair operations, a replacement portal URL endpoint, and corrected event and configuration contracts.

<Badge stroke icon="calendar-days" iconType="regular">August 12, 2026</Badge> <Badge stroke icon="file-code" iconType="regular">Documentation update</Badge> <Badge color="red" size="lg" stroke icon="triangle-exclamation" iconType="regular">Action required</Badge>

## Affects

***

Teams integrating with the **Lender** Consignado API or consuming its Consignado events, especially teams using the retired monthly-rate endpoint or the previous guarantee-recovery topic.

## What changed

***

The Consignado API replaces `PUT /v1/credentials/dataprev/taxa-mensal` with `PUT /v1/credentials/dataprev/portal-base-url`. Configure an HTTPS worker-portal URL with no credentials or fragment and no more than 255 characters. The gateway uses that URL as the type 0 contact in bid proposals.

The Lender reference now includes nine operations for Consignado contract divergences and compensating adjustments. It also documents the `lender.loan_account.debt_balance_changed` event and corrects the guarantee-recovery event to `lender.guarantee_recovery_cash.allocated` with CloudEvents type `studio.lerian.guarantee_recovery_cash.allocated`.

The documentation also clarifies that `CONSIGNADO_ENABLED` controls only the legacy inbound `consignado.averbacao.rejected` handling. The contratação route, CCB signer, and averbação-confirmed consumer are retired; replacement booking and payment paths configure independently.

These entries align the public documentation with the implemented contract; they do not announce a runtime release.

## Impact

***

**Classification: Action required.** Replace calls to the retired monthly-rate endpoint and review event subscriptions, deployment configuration, and operational runbooks against the corrected contract.

## What you need to do

***

<Steps>
  <Step>Replace use of `PUT /v1/credentials/dataprev/taxa-mensal` with `PUT /v1/credentials/dataprev/portal-base-url`.</Step>
  <Step>Validate the configured portal URL before sending it: HTTPS only, no credentials or fragment, and at most 255 characters.</Step>
  <Step>Update guarantee-recovery subscribers to `lender.guarantee_recovery_cash.allocated` and `studio.lerian.guarantee_recovery_cash.allocated`.</Step>
  <Step>Review any `CONSIGNADO_ENABLED` runbook: it no longer controls the retired contratação, signer, or averbação-confirmed paths.</Step>
  <Step>Use the documented divergence and compensating-adjustment operations where your integration repairs Consignado contracts.</Step>
</Steps>

### Deadline

Complete the endpoint and event-subscription review before your next Consignado deployment or integration release.

## Resources

***

* [Lender REST API](/en/lender/lender-rest-api)
* [Lender events](/en/lender/lender-events)
* [Consignado private](/en/lender/consignado-privado)