Crédito do Trabalhador (CLT) - API V3

A API do CT permite que a plataforma simule e gere propostas dessa modalidade de empréstimo para o seu cliente final.

Funcionamento geral da API

A API é separada em 3 simples etapas:

  1. Consulta de Elegibilidade e Margem: Endpoint vai verificar se o usuário está dentro dos critérios de elegibilidade e se tem margem disponível.

  2. Personalização: Endpoint para personalizar a oferta do usuário

  3. Envio da pré oferta: Endpoint que gera o link de pré-oferta de contrato

O cliente acessando o link de pré-oferta irá confirmar seu pedido e receber o link para fluxo de KYC e assinatura de contrato.

O retorno e acompanhamento do status da proposta serão enviados por webhook e por relatórios/dashboards.

Basta pedir para o seu contato comercial disponibilizar isso.

Criando contato e verificando margem disponível

Descrição

Envio de dados básicos do cliente para consulta de elegibilidade e margem.

Importante

circle-info

Antes de chamar o endpoint de contato, o cliente deverá autorizar a consulta de margem através de opt in do seguinte termo:

Termo de Autorização

Eu, portador do CPF XXX.XXX.XXX-XX, autorizo o MTE/DATAPREV a disponibilizar as informações abaixo indicadas para apoiar a contratação/simulação de empréstimo consignado, a fim de subsidiar a proposta pelos bancos BMP SOCIEDADE DE CRÉDITO DIRETO S.A . e UY3 SOCIEDADE DE CRÉDITO DIRETO S.A. (doravante denominados simplesmente como “Instituições Financeiras”).

Informações a serem disponibilizadas:

• CPF

• Matrícula

• Inscrição do empregador (código e descrição)

• Número da inscrição do empregador

• Nome

• Sexo (código e descrição)

• Data de nascimento

• Código da categoria do trabalhador

• Elegibilidade (sim/não)

• Motivo de inelegibilidade (caso aplicável)

• Valor total dos vencimentos

• Valor base da margem

• Valor da margem disponível

• Data de admissão

• Data de desligamento

• Código do motivo do desligamento

• Pessoa exposta politicamente (código e descrição)

• Quantidade de empréstimos ativos ou suspensos

• Alertas de afastamento, aviso prévio e desligamento

• Informações sobre empréstimos existentes que foram informados previamente pela instituição financeira, quais sejam:

• empréstimo com descontos em folha de pagamento, com parcelas vincendas;

• empréstimo não consignado, sem garantia (créditos pessoais, também chamados de empréstimos pessoais), com parcelas vincendas.

Este termo autoriza estas Instituições Financeiras a consultar as informações acima descritas durante um período de 30 dias. Este pedido poderá ser efetuado pelas Instituições Financeiras em até 45 dias após o aceite deste documento.

Declaro, para os devidos fins, que sou o legítimo titular do CPF informado, não estando utilizando dados de terceiros, assumindo integral responsabilidade civil e penal por quaisquer prejuízos ou implicações legais decorrentes do uso indevido de informações.

Este termo também confirma que estou de acordo com os Termos de Uso, Política de Privacidade e Condições de Assinatura de Contratos do Juca, disponíveis em https://vemprojuca.com/termos/arrow-up-right.

Exemplo de aplicação:

Endpoint: /external/clt/v3/contato/sincrono

Esse endpoint começa o processo de simulação do cliente.

ip e useragent são exigências da Dataprev como evidências da autorização do cliente para consulta de margem

circle-info

A data de aniversário permitida é entre 18 e 55 anos.

circle-info

1 - Os valores estão em reais

2- uuid , na segunda linha do json, é o id que deverá ser armazenado e referenciado nos outros endpoints.

3- margem_max é o valor máximo de parcela permitido para o cliente

4- max_value é o valor máximo liquido que o cliente pode receber em conta

5 - max_installments é o número máximo de parcelas permitido para o cliente

6 - last_simulation é uma primeira simulação que fazemos mostrando o máximo que esse cliente poderia receber

7- mes_primeira_parcela é o mês competência que será cobrado a primeira parcela. Exemplo, se estiver 01/2026, significa que o salário referente ao trabalho realizado em janeiro de 2026 será abatido para pagar a primeira parcela. O dia vai depender se o cliente recebe no final de janeiro ou inicio de fevereiro.

Personalizar simulação

Endpoint: /external/calculadora/clt

Esse endpoint altera os parâmetros da simulação do cliente.

circle-info

1 - É extremamente importante que você armazene os valores de "margem_max", "max_installments" e "max_value " e não permita o cliente simular usando valores acima disso.

2- Use "value" quando você quiser simular o valor que o cliente deseja receber na conta.

3- Use "pmt" quando você quiser simular o valor que o cliente deseja pagar por parcela.

Pré oferta

circle-info

Após o aceite da simulação, uma pré oferta será criada e o cliente deverá acessar pelo link disponibilizado

Endpoint: external/clt/preproposta

circle-info

tipoconta: "Savings" para poupança, "Checking" para conta corrente. Deve ser no CPF do cliente e não pode ser conta salário.

No link de pré oferta o cliente vai passar por uma última validação, onde caso seja aprovado, ele vai conseguir acessar a oferta simulada na API e gerar um link de assinatura/biometria.

A pré-oferta tem validade de 72 horas. Após isso, é necessário gerar uma nova.

Lista de bancos

Aceitamos somente os bancos abaixo:

Reapresentação de pagamento

Endpoint: external/clt/dadosbancarios

Endpoint utilizado para reapresentação de pagamento

Status das propostas

Será recebido via Webhook. Para cadastro, fale com nossa equipe comercial.

Lista de Status

A lista de status abaixo está em ordem de fluxo, começando com proposta aberta para simulação e terminando com em proposta paga.

Status
Descrição
Observação

pre_aprovado

quando a pre proposta é criada

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07",

"status" : "pre_aprovado", "message" : "Usuário pré aprovado", "link" : "link"}

expirada

quando a pre proposta expira

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07", "status" : "expirada", "message" : "Proposta expirada" }

proposta_solicitada

Quando uma solicitação de proposta é realizada para o banco

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07",

"status" : "proposta_solicitada", "message" : "Proposta solicitada ao banco" }

proposta_cadastrada

Proposta criada e sms sendo enviado

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07",

"proposta_cadastrada", "message" : "O SMS está sendo enviado para o cliente. Aguardando a assinatura e envio de fotos.", "link" : "XXXX"}

proposta_aprovada_pagamento

Proposta aprovada e na fila de pagamento

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07",

"status" : "proposta_aprovada_pagamento", "message" : "Proposta aprovada e enviada para a fila de pagamento." }

pago

Proposta paga na conta bancária indicada

return {"uuid":"XXX",

"created_at":"2026-02-05 11:24:07", "status" : "pago", "message" : "Sucesso! Proposta fechada e o dinheiro já foi depositado na conta indicada." }

pagamento_falhou_dados

Tentativa de pagamento falhou pois dados bancários estavam incorretos pois dados bancários estavam incorretos.

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07",

"status" : "pagamento_falhou_dados", "message" : "Tentativa de pagamento falhou pois dados bancários estavam incorretos. Confirmar abaixo os dados bancários e enviar para pagamento novamente" }

reprovado

Quando a pré proposta cai pois o cliente é reprovado no motor

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07",

"status" : "reprovado", "message" : "Não aprovada" }

proposta_revisao

Quando a proposta entra em em revisão manual pelo banco

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07", "status" : "proposta_revisao", "message" : "Proposta em revisão pelo banco" }

proposta_cancelada

quando a proposta é cancelada

{"uuid":"XXX",

"created_at":"2026-02-05 11:24:07", "status" : "proposta_cancelada", "message" : "Proposta cancelada." }

Fluxograma e Status da API

Last updated