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

# Atualização do contrato de API do gateway do Consignado

> Três novas operações do Consignado, um portal de formalização opcional, um estorno de refinanciamento mais restrito e o prefixo CLT nos códigos de erro.

<Badge stroke icon="calendar-days" iconType="regular">2 de setembro de 2026</Badge> <Badge stroke icon="file-code" iconType="regular">Atualização da referência da API</Badge> <Badge color="purple" size="lg" stroke icon="eye" iconType="regular">Ação necessária</Badge>

## Afeta

***

Equipes que integram com a API do Lerian Consignado — Dataprev e equipes que operam o deploy dela.

## O que mudou

***

**Três operações são novas.** Registre uma correção em um contrato já registrado e baixe o recurso corrigido que ela nomeia — isso conserta uma CCB errada ou uma confirmação de desembolso com evidência errada, e não cruza nenhuma fronteira do governo. Exclua um contrato da sua instituição porque o trabalhador o portou para fora, a contraparte do lado de origem da averbação de portabilidade que você já tinha.

**O estorno de refinanciamento ficou mais restrito e o corpo da requisição mudou.** O campo opcional `dataRefinanciamento` não existe mais. A janela de 7 dias úteis agora é avaliada contra o registro do próprio gateway sobre quando o refinanciamento foi confirmado, nunca contra uma data na requisição. Apenas um refinanciamento que este gateway registrou pode ser estornado por ele; qualquer outro é recusado com `404` antes de a Dataprev ser chamada.

**O portal de formalização é opcional.** Um tenant com uma URL base de portal do trabalhador registrada continua recebendo essa URL injetada como o contato do tipo 0 de cada proposta de lance. Um tenant sem portal registrado agora dá o lance mesmo assim, levando apenas os contatos do próprio cliente, e o lance apenas é recusado quando não há nem portal registrado nem um único contato. Um lance também pode levar seu próprio `portalBaseUrl` para sobrescrever o portal registrado do tenant apenas naquele envio. Contatos do tipo 0 fornecidos pelo cliente continuam proibidos em todos os casos.

**Os códigos de erro agora usam o prefixo `CLT-`.** Os números não mudaram: o que era `MYS-0006` é `CLT-0006`.

**Correções no guia de operações publicado.** O gateway roda onze loops agendados, não oito — os três que faltavam são o poller de descoberta de portabilidade e os dois loops de recuperação de desfecho, ambos desabilitados por padrão. O stream de comandos do Lender carrega três chaves, não duas, e as chaves usam underscore no segmento de recurso (`consignado_margin.requested`). Todos os 25 fatos de negócio têm um ponto de emissão em produção; a afirmação anterior de que dois desfechos de portabilidade dependiam de uma declaração no manifesto estava errada. `AWS_REGION` não tem padrão, de propósito, para que o AWS SDK resolva a sua própria região.

## Impacto

***

**Classificação: Ação necessária.**

## O que você precisa fazer

***

<Steps>
  <Step>Remova `dataRefinanciamento` das requisições de estorno de refinanciamento e confirme que cada refinanciamento que você pretende estornar foi registrado por este gateway.</Step>
  <Step>Atualize qualquer tratamento de erros que casa com o prefixo `MYS-` para casar com `CLT-`.</Step>
  <Step>Se o seu tenant não tem uma URL base de portal registrada, confirme que cada proposta de lance leva pelo menos um contato do tipo 1 a 4.</Step>
  <Step>Habilite os loops de recuperação de averbação e de comandos do trilho em qualquer deploy que envie comandos ao trilho, e defina `AWS_REGION` explicitamente para a região em que seus dados devem ficar.</Step>
</Steps>

### Prazo

Antes do seu próximo deploy de integração do Consignado.