Consignado Privado com Averbação e Linhas de Crédito

Nesta seção, vamos detalhar o passo a passo para integrar Produtos de Crédito que necessitam de aprovação. O exemplo em particular lida com o Consignado Privado, para exemplificar todas as funções da plataforma. Porém, cada um dos componentes apresentados pode ser utilizado isoladamente, de maneira modular.

Para um overview dos conceitos e mecânicas, consulte o Guia sobre Qualificações, Linhas de Crédito e Condições.

Exemplo:

Passo 1-3: Cadastro de Pessoa e Empresa

Nesta etapa vamos criar uma empresa e uma pessoa. A empresa será o Empregador, e a pessoa será um Tomador. Para orientações gerais para cadastrar Pessoas, e uma descrição detalhada da Jornada, confira nosso guia para o Cadastro de Tomadores no Crédito Pessoal Clean. Lembre-se de indicar a Empresa como empregadora da Pessoa utilizando o campo employer.id.

Passo 4: Criar uma Linha de Crédito para o Empregador

Após o cadastro da Empresa, é necessário caracterizá-la no sistema como um Empregador. Para isso, é necessário criar uma Linha de Crédito para a Empresa. Você precisa prover uma referência para a Empresa no campo employer.id, assim como indicar o Funding específico para o qual essa linha de crédito deve ser criada, no campo funding.id. Por fim, não se esqueça de indicar o identificador do produto na URL, e enviar o campo role com o valor EMPLOYER.

Passo 5: Aprovar a Linha de Crédito para o Empregador

Por padrão, a Linha de Crédito será criada no primeiro status da esteira disponível para o produto indicado. Para consultar a esteira do produto, você pode utilizar o endpoint de consulta de esteira. O campo employer_onboarding trará a lista de status cadastrados para a jornada de Cadastro de Empregador, com um identificador único (identifier), uma breve descrição (description) e um nome de exibição (display_name), que você pode utilizar em suas UIs.

📘

Lembre-se:

Caso a lista de status esteja vazia, a Linha de Crédito será considerada aprovada assim que criada.

Você pode transitar a Qualificação para qualquer status para realizar a gestão do cadastro dentro da sua jornada de aquisição de Empregadores. Para realizar uma transição de status, utilize o endpoint de atualização de status de qualificação, informando o identificador da qualificação gerada no passo 4. Ao fim do processo, antes de permitir a geração de Solicitações para Tomadores que tenham o empregador específico vinculado, é necessário aprovar a Linha de Crédito, invocando o mesmo endpoint com o status=QUALIFIED.

Passo 6: Criar uma linha de Crédito para o Tomador

Em seguida, você vai precisar cadastrar uma Linha de Crédito para o Tomador. Utilizando o mesmo endpoint de cadastro de linha de crédito, informe: O identificador da pessoa no campo borrower.id, role=BORROWER e o identificador do credor desejado em funding.id. Lembre-se de guardar o identificador da Qualificação retornada para atualizar o status e condições posteriormente.

Passo 7: Configurar Condições para o Tomador

Para configurar as condições para o Tomador, utilize o endpoint de configuração de condições. Nesse endpoint, é necessário informar, ao menos:

1. Prazo mínimo: min_payment_number
2. Prazo máximo: max_payment_number
3. Limite total: line_of_credit.credit_limit
4. Limite de parcela: line_of_credit.max_payment_amount
5. Taxa de juros: schedule_based_conditions[0].interest_rate
6. Rating: rating.identifier

Outras opções estão disponíveis, como carência, valor mínimo de solicitação, dia de vencimento, entre outros.

📘

Ratings

Os ratings são configurados pelo credor (Funding) para o produto. Para saber os ratings disponíveis, consulte este endpoint. O Rating é apenas informativo, não possuindo impacto no processamento de Solicitações.

Passo 8: Aprovar a Linha de Crédito para o Tomador

Por padrão, a Linha de Crédito será criada no primeiro status da esteira disponível para o produto indicado. Para consultar a esteira do produto, você pode utilizar o endpoint de consulta de esteira. O campo borrower_onboarding trará a lista de status cadastrados para a jornada de Cadastro de Empregador, com um identificador único (identifier), uma breve descrição (description) e um nome de exibição (display_name), que você pode utilizar em suas UIs.

📘

Lembre-se:

Caso a lista de status esteja vazia, a Linha de Crédito será considerada aprovada assim que criada.

Você pode transitar a Qualificação para qualquer status para realizar a gestão do cadastro dentro da sua jornada de aquisição de Empregadores. Para realizar uma transição de status, utilize o endpoint de atualização de status de qualificação, informando o identificador da qualificação gerada no passo 6. Ao fim do processo, antes de permitir a geração de Solicitações para Tomadores, é necessário aprovar a Linha de Crédito, invocando o mesmo endpoint com o status=QUALIFIED.

Passo 9-11: Criar e Assinar Solicitação

Para orientações gerais para criar e assinar Solicitações, assim como uma descrição detalhada da Jornada confira nosso guia para o Criação e Assinatura de Solicitações no Crédito Pessoal Clean.

Passo 12: Aprovar Solicitações

Uma vez assinada, para produtos com Qualificações habilitadas uma Solicitação entra no primeiro status da esteira configurada para o Produto. Para consultar a esteira do produto, você pode utilizar o endpoint de consulta de esteira. O campo application_approval trará a lista de status cadastrados para a jornada de Solicitação, com um identificador único (identifier), uma breve descrição (description) e um nome de exibição (display_name), que você pode utilizar em suas UIs.