Crédito Pessoal com Avalista e/ou Anuentes
Como integrar na Plataforma um Produto de Crédito PF sem garantias, com avalistas e/ou anuentes
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.
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 - Cadastro de Avalista
Utilize o endpoint de Cadastro de Pessoas para cadastrar o(s) avalistas(s). Não se esqueça de guardar o identificador para possibilitar o envio dos documentos e o vínculo à solicitação.
Etapa 4 - Envio de Documentos
Para cadastrar documentos para o Avalista, você usará o endpoint para Cadastro de Documento para Pessoas. Ao menos um documento de identificação com foto do avalista é necessário no cadastro.
Solicitações com mais de um Avalista
Você pode cadastrar quantos Avalistas sejam necessários para sua operação repetindo as etapas 3 e 4 para cada Avalista participante.
Solicitações com Anuentes
O processo para inclusão de Anuentes é análogo ao de avalistas, até o momento da solicitação, detalhado abaixo.
Variáveis personalizadas no cadastro de Tomadores, Avalistas e Anuentes
Variáveis personalizadas são um aspecto importante do cadastro de Tomadores, Avalistas e Anuentes. 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 ou no cadastro de Empresas.Para saber mais, consulte a seção sobre Variáveis Personalizadas no Guia.
Etapa 5 - 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.
Em específico para este caso de uso, os identificadores dos Avalistas e Anuentes (caso existam) precisam ser informados nos campos guarantors
(Avalistas) e co_signers
(Anuentes), como no exemplo:
{
... (demais campos)
"borrower": {
"id": "c3fa8f96-732a-4bbd-8f98-8b423f0da290"
},
"guarantors": [
{
"type": "PERSON",
"guarantor_id": "0483b7a6-da5e-4f73-89a5-bd8e63559179"
},
{
"type": "PERSON",
"guarantor_id": "e79066ad-b77f-49ad-9b2d-16d8506d3218"
}
],
"co_signers": [
{
"type": "PERSON",
"co_signer_id": "e79066ad-b77f-49ad-9b2d-16d8506d3218"
}
]
}
Após criar uma solicitação com sucesso, o integrador deve guardar o identificador único da Solicitação, pois é utilizado nas etapas subsequentes.
Simulações
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.
Etapa 6 - 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 7 - 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.
Note que: O endpoint de consulta de assinaturas retorna uma lista de todos os participantes signatários da Solicitação. Cada um dos signatários possui seu próprio link de assinatura, indicado na propriedade collect_sign_link
.
A Solicitação só é considerada assinada e passa para a próxima etapa uma vez que todos os signatários concluíram seu processo de assinatura.
Na seção sobre Assinaturas, detalhamos todos os fluxos de assinatura disponíveis.
Etapa 8 e 9 - Eventos de assinatura
Utilizando o link disponibilizado, os signatários assinam a Solicitação.
Etapa 10 - 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 11 - 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.
Updated 4 months ago