API Docs Início Documentação Referência de API Copiar para LLM
CaaS Massificados · Consignado privado

Consignado privado — Visão geral

Desconto em folha do setor privado. O Consignado privado é a operação de crédito do trabalhador com carteira assinada (o termo interno de uso corrente na UY3 é CLT): as parcelas são descontadas na folha de pagamento do empregador privado, e a margem consignável do trabalhador é averbada antes da liberação do dinheiro.

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 Consignado privado é um empréstimo com garantia de margem em folha. O que o diferencia de um empréstimo sem garantia é que a concessão não depende só do cadastro e da análise de crédito: depende de a UY3 conseguir reservar a margem consignável do trabalhador junto ao empregador, pelo Crédito do Trabalhador (CTPS Digital).

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

O lastro da operação é registrado como garantia do tipo DataprevEmployee — ou DataprevEmployeeRefinance, quando a operação substitui um contrato consignado vigente. Quando os parâmetros do produto contratado permitem, saldo e multa rescisória do FGTS entram como reforço dessa mesma garantia (não como produto FGTS separado — para antecipar saque-aniversário, o produto é FGTS).

Para quem serve

Perfil Serve? Por quê
Trabalhador com carteira assinada no setor privado Sim É o público do produto: existe vínculo ativo e margem consignável averbável.
Servidor público, aposentado ou pensionista do INSS Não Produtos próprios, fora do escopo desta versão da documentação.
Trabalhador sem margem livre Não A consulta de margem devolve margem insuficiente e a proposta é barrada antes da operação.
Pessoa Jurídica Não Não há folha de pagamento a consignar.

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. Vale a pena reparar em um ponto que costuma surpreender: a autorização de margem é o primeiro passo, e ela acontece antes de o trabalhador existir como cadastro na UY3.

  1. Autorização de margem. O consentimento do trabalhador se identifica por CPF e telefone — não exige tomador cadastrado. É o que permite capturar o aceite no seu funil, antes de qualquer cadastro. → 2.1 Autorização de margem
  2. 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 tomador. → 2.2 Conta de liquidação
  3. Cadastrar o tomador (Pessoa Física). É aqui que o trabalhador passa a existir e a estar vinculado ao seu usuário/correspondente, com a conta do passo anterior no mesmo corpo. → 2.3 Cadastro do tomador
  4. Consultar a margem livre e simular. A margem define o teto da parcela. A simulação tem dois caminhos possíveis — ofertas ou amortização (ver abaixo). → 3. Operação
  5. Enviar a proposta e criar a operação de crédito. A operação nasce em rascunho, com a garantia de margem anexada. → 3. Operação
  6. 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
  7. 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] Autorização de margem            (CPF + telefone — sem tomador cadastrado)
   |
[2.2] Dados da conta de liquidação     (preparados)
   |
[2.3] Cadastro do tomador (PF)         (com a conta no mesmo corpo -> personId)
   |
[3] Consulta de margem livre
   |
   +--> Caminho A: simulação de ofertas ---> proposta ao empregador
   |
   +--> Caminho B: simulação por amortização (plano de pagamento)
   |
[3] Criação da operação de crédito (garantia de margem anexada)
   |
[3] Envio para aprovação -> Crédito -> Garantia (averbação) -> Assinatura
   |
[3] Liquidação (Pix/TED na conta do tomador)
   |
[4] Acompanhamento: status, parcelas, comprovante

Os dois caminhos de simulação

Este é um ponto em que a documentação anterior induzia ao erro: dava a impressão de que o fluxo de ofertas era o único possível. Não é. Os dois caminhos são válidos, levam à mesma criação de operação, e a escolha é sua.

Caminho A — Simulação de ofertas Caminho B — Simulação por amortização
Pergunta que responde Quais produtos e condições cabem na margem deste trabalhador? Como fica o plano de pagamento desta condição que eu já escolhi?
Rota POST /v1/Amortization/DataprevEmployeeOffers POST /v1/Amortization
Você informa CPF, vínculo e uma faixa (valor, prazo, parcela) produto, valor, taxa e prazo exatos
Você recebe uma lista de ofertas elegíveis, com prazo, parcela, taxa, CET e IOF um plano de pagamento completo, parcela a parcela
Quando usar vitrine para o trabalhador escolher; você não sabe ainda a condição condição já definida (tabela negociada, escolha do cliente, recontratação)
Leva à proposta ao empregador? Sim — a oferta escolhida gera o offerRequestId da proposta Não passa pela proposta: vai direto à criação da operação

Detalhe e exemplos dos dois caminhos em 3. Operação. Ainda dentro do caminho A, é possível simular um valor menor que a margem total disponível — ver a seção de simulação abaixo da margem na mesma página.

Regras de negócio que decidem o produto

Regra Por que existe Efeito na integração
Periodicidade mensal obrigatória O desconto acompanha a folha de pagamento, que é mensal. Não há folha quinzenal nem anual a consignar. paymentPeriodicity precisa ser { "every": 1, "periodicity": "Monthly" }. Qualquer outro valor é recusado.
Modelo de cálculo Price ou SAC A averbadora precisa de um cronograma de parcelas previsível para reservar margem mês a mês. O amortizationType enviado precisa coincidir com o do produto contratado. As rotas de oferta do Crédito do Trabalhador listam apenas produtos Price.
Margem livre suficiente A parcela é descontada da folha: se não couber na margem, o empregador não tem de onde descontar. A parcela simulada é validada contra a margem no momento da proposta — e revalidada quando o empregador aceita.
Garantia obrigatória para envio à aprovação Sem a garantia de margem informada, não há o que averbar. Sem ao menos uma garantia no corpo, o envio para aprovação é recusado.

Os parâmetros de averbação (averbadora, faixa de taxa, faixa de prazo, dia de repasse) são provisionados pela UY3 e referenciados por um identificador de produto. Você não os cria pela API: você recebe o productId 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 é

Antes desta etapa

Próxima etapa

Downloads