Como funciona o crédito consignado

Antes de integrar, vale entender o produto. O crédito consignado do trabalhador é um empréstimo cujas parcelas são descontadas diretamente da folha de pagamento ou da margem do trabalhador. Por ter essa garantia, costuma ter taxas menores e exige um processo específico de verificação e averbação.

A API automatiza esse processo. Para conversar com ela com fluência, conheça os termos abaixo.

Glossário essencial

Margem consignável : O quanto da renda do trabalhador pode ser comprometido com parcelas de consignado. É o teto que limita o valor das prestações. A margem é apurada no Dataprev.

Dataprev : A fonte oficial dos dados do trabalhador (vínculos, salário, margem disponível). A Socinal consulta o Dataprev por você — cada consulta tem custo, então a API reaproveita consultas recentes quando possível.

Autorização do trabalhador : O consentimento (LGPD) que permite consultar os dados do trabalhador no Dataprev. Sem autorização válida, não há consulta de margem. Veja Autorização do trabalhador.

Vínculo : A relação de trabalho entre o trabalhador e um empregador. Um trabalhador pode ter mais de um vínculo; a margem é apurada por empregador.

Consulta de margem : O resultado da apuração para um par trabalhador + empregador: salário, margem disponível, já comprometido. Gera um consulta_margem_id, que amarra a simulação e o empréstimo a uma apuração concreta.

CCB (Cédula de Crédito Bancário) : O documento que formaliza o empréstimo. É emitida pela Socinal e assinada pelo trabalhador (via D4Sign ou no ambiente do parceiro).

Averbação : O registro da operação junto ao órgão consignante (via Dataprev), que “reserva” a margem e garante o desconto das parcelas. Só depois de averbada a operação pode ser desembolsada.

Desembolso : A liberação do dinheiro ao trabalhador, via PIX. É o passo que move dinheiro — por isso exige escopo dedicado e idempotência.

CET (Custo Efetivo Total) : O custo anual da operação incluindo juros, IOF e encargos. Retornado nas simulações.

Sobre a taxa: a API recebe a taxa mensal em percentual (ex.: 1.79 significa 1,79% ao mês). Internamente ela é convertida para decimal — você não precisa se preocupar com isso, basta enviar o percentual.

Como isso vira chamadas de API

Cada termo acima corresponde a uma etapa concreta da integração:

Autorização → o trabalhador consente (/v1/margem/autorizacao)
Vínculos + margem → você apura no Dataprev (/v1/margem/vinculos, /v1/margem/consulta)
Simulação → testa cenários (/v1/simulacao)
Empréstimo + CCB → emite o documento diretamente (/v1/emprestimos)
Assinatura → coleta a assinatura (/v1/emprestimos/{id}/assinatura)
Averbação → registra no consignante (automática ou /v1/emprestimos/{id}/averbacao)
Desembolso → libera o PIX (/v1/emprestimos/{id}/desembolso)

A ordem e as transições entre essas etapas estão detalhadas no Ciclo de vida da operação.