Crédito do Trabalhador (CLT) - API

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 2 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. Envio e aceite da proposta: Endpoint que gera o link de assinatura de contrato e fluxo de KYC, e envia por WhatsApp e SMS.

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

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

Exemplo de aplicação:

Endpoint: /external/clt/contato/sincrono

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

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

POST

{
    "cpf": "cpf",
    "celular" : "celular",
    "datanascimento": "12/10/1991",
    "acceptMessage": true,
    "acceptTerms": true
}

200 - Response

400 - Response

Personalizar simulação

Endpoint: external/clt/simulacao

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

POST

{
"uuid":"95cf39db-9511-4fcf-a469-a88606d93ac7",
"parcela" : 12,
"valor" : 2500
}

200 - Response

400 - Response

Aceite da simulação

Após o aceite da simulação, uma proposta será criada e o cliente receberá o link por WhatsApp e SMS.

Endpoint: external/clt/proposta/criar

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

nacionalidade : "Brasileira" ou "Estrangeiro"

estadocivil: ["Single", "Married", "Widowed", "Separated","Divorced"]

POST

{
"uuid": "f03b7a74-1fa5-4a04-9697-02ca8ccdc14d",
"cep": "40026-170",
"endereconumero": "56",
"uf": "BA",
"cidade": "Salvador",
"enderecocomplemento": "",
"bairro": "Centro Histórico",
"rua": "Rua do Tabuão",
"agencia": "0000",
"conta": "7000285-2",
"tipoconta": "Savings",
"banco": "Caixa",
"nacionalidade": "Brasileira",
"estadocivil": "Single"
}

200 - Response

400 - Response

Lista de bancos

Aceitamos somente os bancos abaixo:

bank = {
        "Banco do Brasil": "001",
        "Santander": "033",
        "Inter": "077",
        "Caixa": "104",
        "Bradesco": "237",
        "Nubank": "260",
        "Itaú": "341",
        "C6": "336",
        "Pan": "623",
        "Bmg": "318",
        "Banrisul": "041",
        "Banese": "047",
        "Banco Real de Brasilia": "070",
        "Sicoob": "756",
        "Banco Banestes": "021",
        "Agibank": "121",
        "BMP": "274",
        "Sicredi": "748",
        "Banco BV": "655"
        }

Reapresentação de pagamento

Endpoint: external/clt/dadosbancarios

Endpoint utilizado para reapresentação de pagamento

Post

{
"uuid": "d4fbebe9-5eee-46b5-bffc-3b938bc7b66f",
"bank_name": "Bradesco",
"bank_account_type": "Checking",
"bank_account": "00084146-3",
"bank_agency": "2065"
}

200 - Response

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
proposta_cadastrada	Proposta criada e sms sendo enviado	{"uuid":"XXXXX", "status" : "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", "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", "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", "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" }