CaaS Massificados · FGTS

FGTS — Visão geral

Antecipação do saque-aniversário. O produto FGTS antecipa, em uma única liberação hoje, parcelas anuais futuras do saque-aniversário do titular. A garantia é o próprio saldo do FGTS: a cada ano o valor do saque-aniversário é debitado na origem e amortiza a operação.

Contexto para LLMTodo o módulo em um arquivo de texto, na ordem do fluxo. Cole no seu assistente antes de escrever código.Collection do PostmanRequisições prontas, em pastas na ordem das etapas, com {{baseUrl}} e {{token}} declarados.Integração via MCPConecte seu assistente de IA direto nesta documentação: ele consulta os guias e a Referência enquanto escreve o código.

Esta página abre o módulo. Ela responde o que é o produto, para quem ele serve e qual é o caminho completo — do primeiro cadastro à consulta final. Cada passo do fluxo abaixo é um link para a página que o executa.

O que é

O FGTS é um crédito lastreado em saldo já existente, não em renda futura. O titular que aderiu à modalidade saque-aniversário troca o direito de sacar nos próximos anos por dinheiro agora.

Três consequências práticas para quem integra:

Não há margem consignável nem comprovação de renda. O teto da operação vem do saldo disponível e do número de saques que podem ser antecipados.
A averbação acontece antes da liquidação. A operação entra em uma etapa de garantia dedicada e aguarda o retorno do órgão, respeitando a janela de manutenção dele.
O objeto de cálculo é o mais enxuto do catálogo. Prazo, valor e mês do saque bastam: não há dia de vencimento, carência nem periodicidade a informar.

Diferente do Consignado privado, aqui não se envia objeto de garantia por tipo: a averbação é uma etapa própria da esteira, que fala direto com o órgão. Não existe tipo de garantia FGTS na lista de tipos de garantia — FGTS é o produto, não um tipo de garantia.

Para quem serve

Perfil	Serve?	Por quê
Pessoa Física titular de conta FGTS, com adesão ao saque-aniversário	Sim	É o público do produto: existe saldo antecipável e o débito anual é automático na origem.
Titular de FGTS na modalidade saque-rescisão	Não	Sem adesão ao saque-aniversário não há parcela anual a antecipar.
Trabalhador que quer desconto em folha	Não	Isso é Consignado privado. Aqui o FGTS não passa pela folha.
Pessoa Jurídica	Não	Não há conta FGTS de PJ.

Quem consome esta documentação: times de integração de correspondentes bancários, fintechs parceiras e squads internas da UY3.

Fluxo ponta a ponta

Passo a passo

A ordem abaixo não é arbitrária: é a ordem em que o negócio permite executar cada etapa. Ela espelha a do Consignado privado — o consentimento primeiro, o cadastro completo depois — com uma diferença de mecânica explicada no passo 1.

Consentimento de consulta ao FGTS. É o termo assinado pelo titular, coletado antes de qualquer cadastro. Aqui ele é um documento, não um registro com endpoint próprio. → 2.1 Consentimento de consulta
Cadastrar a conta de liquidação. É a conta que vai receber o dinheiro liberado. Os dados são preparados aqui e enviados junto do cadastro do titular. → 2.2 Conta de liquidação
Cadastrar o titular (Pessoa Física). É aqui que o titular passa a existir e a estar vinculado ao seu usuário/correspondente, com a conta e o consentimento no mesmo corpo. → 2.3 Cadastro do titular
Simular a antecipação. Valor, prazo em meses e mês do saque definem o plano de pagamento. → 3. Operação
Criar a operação de crédito. A operação nasce em rascunho, com o modelo de cálculo do FGTS. → 3. Operação
Enviar para aprovação, assinar e aguardar a averbação. A operação percorre as etapas de crédito, garantia e assinatura. → 3. Operação
Acompanhar status, liquidação e comprovante. Do envio até o encerramento, o acompanhamento é por consulta. → 4. Consultas e acompanhamento

Os eventos que marcam cada transição estão em 4.1 Eventos e notificações. Quando algum passo falha, a causa e a ação corretiva estão em 5. Erros e troubleshooting.

Diagrama do fluxo

[2.1] Consentimento de consulta ao FGTS   (termo assinado — documento)
   |
[2.2] Dados da conta de liquidação        (preparados)
   |
[2.3] Cadastro do titular (PF)            (com conta e termo no mesmo corpo -> personId)
   |
[3] Simulação por amortização             (valor, prazo, mês do saque)
   |
[3] Criação da operação de crédito        (sem objeto de garantia)
   |
[3] Envio para aprovação -> Crédito -> Garantia (averbação no órgão) -> Assinatura
   |
[3] Liquidação (Pix/TED na conta do titular)
   |
[4] Acompanhamento: status, parcelas, comprovante

Os caminhos de simulação

No Consignado privado existem dois caminhos de simulação: ofertas e amortização. No FGTS existe um só: a simulação por amortização.

	Simulação por amortização	Simulação de ofertas
Existe neste produto?	Sim — é o caminho do FGTS	Não
Rota	`POST /v1/Amortization`	—
Você informa	valor, taxa, prazo e mês do saque	—
Você recebe	um plano de pagamento completo	—

A razão é de negócio, não de contrato: a simulação de ofertas existe para escolher entre produtos habilitados que caibam numa margem consignável, e no FGTS não há margem a consultar nem vitrine de produtos a comparar — o lastro é um saldo que já existe na conta do titular. O que resta é dimensionar valor e prazo, e isso é exatamente o que a simulação por amortização faz.

Detalhe e exemplos em 3. Operação.

Regras de negócio que decidem o produto

Regra	Por que existe	Efeito na integração
Modelo de cálculo exclusivo	O cronograma se ancora no mês do saque-aniversário, que nenhum outro produto tem.	`amortizationType` precisa ser `fgts`. Nenhum outro valor é aceito neste produto.
Somente Pessoa Física	Conta FGTS é de trabalhador, não de empresa.	O titular é sempre PF. Não há cadastro de PJ neste produto.
Etapa de averbação dedicada	O registro da garantia é feito junto ao órgão, que tem janela própria de atendimento.	A operação assume a etapa de garantia e aguarda. Não há rota de averbação para o parceiro chamar.
Limite anual de contratos por titular	Cada saque-aniversário só pode ser antecipado uma vez.	Exceder o limite bloqueia o envio para aprovação.
Consentimento de guarda obrigatória	A consulta ao saldo do titular depende de autorização expressa dele.	O termo faz parte do dossiê da operação, não é artefato descartável.
Liquidação por transferência	O valor vai para a conta do próprio titular.	Sai por Pix ou TED; não há liquidação por boleto.

O produto contratado (productId) é provisionado pela UY3 e carrega faixa de taxa e faixa de prazo. Você não o cria pela API: você recebe o identificador e trabalha dentro dos limites dele.

Formato de datas, de valores monetários e de taxas: Convenções de dados. É a mesma convenção em todos os campos deste módulo.

O que este produto não é

Não é consignado. Nada é descontado em folha. Para desconto em folha do setor privado, use Consignado privado.
Não é empréstimo sem garantia. Aqui existe lastro: o saldo do FGTS do titular.
Não é reforço de garantia de outro produto. Quando saldo e multa rescisória do FGTS entram como reforço da margem consignável, o produto é Consignado privado — não este.

Antes desta etapa

Primeiros passos — como obter acesso e o productId do seu produto contratado.
Autenticação — como emitir e renovar o token enviado em todas as chamadas.
Convenções de dados — formatos de data, valor e taxa usados em todo o módulo.

Próxima etapa

2. Pré-requisitos e cadastros — o que precisa estar pronto e em que ordem.

Downloads

Contexto para LLM deste módulo: llms-fgts.txt
Collection Postman do módulo: uy3-fgts.postman_collection.json
Collection completa (Consignado privado + FGTS): uy3-api-completa.postman_collection.json
Documentação consolidada para LLM: llms.txt