Crédito Pessoal Clean

Como integrar na Plataforma um Produto de Crédito PF sem garantias, anuentes ou avalistas

Etapa 1 - Cadastro de Tomador

Utilize o endpoint de Cadastro de Pessoas para cadastrar o tomador. Para saber mais sobre os campos usados no cadastro de pessoa, consulte a Tabela dos Campos de Pessoa. O integrador deve se certificar de guardar o identificador único da Pessoa retornado. Esse identificador é usado em seguida para a criação da Solicitação.

🚧

Variáveis personalizadas no cadastro

Variáveis personalizadas são um aspecto importante do cadastro de Tomadores. Elas são usadas para preencher o contrato com campos específicos da sua operação. Caso uma variável obrigatória não tenha sido preenchida até o momento da criação da Solicitação, a requisição será rejeitada com erro BAD_REQUEST (status=400).

Para consultar as variáveis necessárias, utilize o endpoint de consulta de produto e inspecione a propriedade variables_configuration.

Exemplo: variables_configuration.borrower.person lista as variáveis esperadas no cadastro de Tomadores Pessoa Física no produto.

Você deve enviar as variáveis personalizadas utilizando o campo custom_variables no cadastro de Pessoas.

Para saber mais, consulte a seção sobre Variáveis Personalizadas no Guia.

Etapa 2 - Envio de Documentos

Para cadastrar documentos para o Tomador, você usará o endpoint para Cadastro de Documento para Pessoas. Ao menos um documento de identificação com foto do tomador é necessário no cadastro.

Etapa 3 - Solicitação

Invocando o endpoint de Criação de Solicitação, você dá início ao processo de geração do Empréstimo. Para saber detalhes dos campos disponíveis, consulte a Tabela dos Campos de Solicitação.

Antes dessa etapa, é comum também realizar um processo de Simulação da Solicitação junto ao Tomador. Na seção sobre Simulação, descrevemos melhor os métodos de simulação e endpoints disponíveis.

Após criar uma solicitação com sucesso, o integrador deve guardar o identificador único da Solicitação, pois é importante nas etapas subsequentes.

Etapa 4 - Solicitação pronta pra Assinar

Ao fim dos processos de geração do Documento e validação das políticas internas de PLD/CFT, o integrador receberá um webhook indicando que a assinatura está pronta para assinatura na URL previamente cadastrada com a Celcoin. Na seção sobre webhooks, descrevemos em mais detalhes os webhooks.

Etapa 5 - Consulta de links para assinatura digital.

Neste exemplo, descrevemos o processo de assinatura utilizando links gerados pela Plataforma de Crédito.

Estes links podem ser consultados no endpoint de consulta de assinaturas da solicitação específica.

Na seção sobre Assinaturas, detalhamos todos os fluxos de assinatura disponíveis.

Etapa 6 - Evento de assinatura

Utilizando o link disponibilizado, o Tomador assina a Solicitação.

Etapa 7 - Notificação de início de desembolso

Considerando que o integrador seja optante do Desembolso Gerenciado, após a assinatura do Tomador, o sistema cliente deve receber um webhook de início do processo de desembolso.

A Plataforma irá realizar a reserva de fundos junto ao credor, a cessão do título e desembolso Pix em até 5 minutos.

Em caso de problemas no pagamento, a solicitação poderá ser cancelada. Consulte a seção Desembolso Gerenciado para saber mais sobre as mecânicas de desembolso instantâneo utilizando Pix.

Etapa 8 - Notificação de conclusão

Ao fim do processamento do pagamento, o integrador recebe a notificação de conclusão da Solicitação de Crédito via Webhook, que sinaliza o título como pago e emitido.