Início Rápido

Esta seção descreve as etapas básicas para integrar e utilizar o CaaS (Credit as a Service). Este guia é um ponto de partida para que os processos de simulação, cadastro, propostas e formalização sejam implementados de forma eficiente.

Etapa 1 - Autenticação (Auth)

A autenticação é o primeiro passo para acessar os recursos do CaaS (Credit as a Service). Este processo garante que apenas aplicações devidamente autorizadas possam interagir com as APIs, assegurando segurança e conformidade em todas as operações.

Método: POST

Descrição: O cliente deve enviar as credenciais fornecidas (client_id e client_secret) para obter um token de acesso. Este token é do tipo Bearer Token e deve ser incluído no cabeçalho das requisições subsequentes como parte do processo de autenticação.

ℹ️

informações:

• Inclua o token no cabeçalho Authorization de todas as requisições subsequentes no formato Bearer .
• Certifique-se de armazenar o token de forma segura e renová-lo conforme necessário.
• O uso de um token expirado resultará em erros de autorização.
• Este método é request-response, não há webhook.

Etapa 2 - Simulação de Crédito (Simulation CaaS)

A simulação de crédito é utilizada para prever as condições de uma operação, como valores de parcelas, taxas de juros, prazos e encargos. Esta etapa não cria uma proposta formal, mas fornece informações detalhadas que auxiliam na tomada de decisão. Para ser utilizada, é necessário já ter um produto criado e configurado do tipo CaaS, e que seja passado na requisição o productId- Id do produto.

Método: POST

Descrição: O cliente deve enviar os dados da simulação, como valor do crédito, número de parcelas, taxa mensal, id do produto, dentre outras no corpo da requisição para o endpoint correspondente. A API retorna um detalhamento das condições previstas para o crédito solicitado.

Como Funciona:

• Envio de Dados: Informações como valor solicitado, número de parcelas, taxa de juros e datas de início e vencimento devem ser enviadas no corpo da requisição.
• Cálculo dos Valores: A API realiza o cálculo das condições do crédito, incluindo amortização, juros, valores das parcelas e encargos adicionais, caso existam.
• Retorno de Dados: O sistema retorna uma previsão detalhada, permitindo ao cliente avaliar se as condições atendem às suas necessidades.

ℹ️

informações:

• A simulação não cria um registro formal no sistema, sendo apenas um cálculo baseado nos dados fornecidos.
• Certifique-se de enviar informações completas e válidas para evitar erros de validação.

Etapa 3 - Cadastro simples (Simple Signup)

O cadastro de usuários é um passo fundamental para que as operações de crédito possam ser realizadas. Essa etapa registra os dados pessoais e financeiros do usuário no sistema, que serão utilizados para análise de crédito e criação de propostas.

Método: POST

Descrição: O cliente deve enviar as informações do usuário no corpo da requisição para o endpoint de cadastro. Após a validação, o sistema registra o usuário e retorna um identificador único que será usado nas próximas etapas.

Como Funciona:

• Coleta de Dados: Informações básicas, como nome, CPF, data de nascimento, e-mail e telefone, são enviadas no corpo da requisição.
• Validação das Informações: O sistema verifica a consistência dos dados fornecidos, aplicando validações como formatação correta e ausência de duplicidade.
• Registro no Sistema: Após a validação, o usuário é registrado, e um identificador único é gerado para associá-lo a futuras operações.

ℹ️

informações:

• Os campos obrigatórios devem ser preenchidos corretamente para evitar erros de validação.
• Caso o CPF, número de telefone ou e-mail já esteja cadastrado, o sistema retornará um erro informando a duplicidade.
• Existem limites de chamadas para o mesmo CPF em um intervalo de tempo para prevenir abusos.
• Nesta etapa, o status será retornado para “SIGNUP_ANALYSIS”, e após a verificação, um webhook será retornado com o status atualizado, que pode ser “SIGNUP_CREATED” para cadastro criado OU “SIGNUP_DENIED” para cadastro negado.

Exemplo de Cenário:

Após realizar a simulação de crédito, o usuário interessado em prosseguir deve ser cadastrado no sistema. O identificador gerado será usado nas etapas seguintes, como criação de propostas e formalização de contratos.

Etapa 4 - PROPOSAL - PROPOSTA

A criação de uma proposta formaliza os dados do usuário e as condições do crédito, registrando-os no sistema para análise e processamento. Nesta etapa, as informações fornecidas durante o cadastro e a simulação são utilizadas para gerar uma proposta que poderá ser submetida para aprovação.

Método: POST

Descrição: O cliente deve enviar os dados complementares do usuário e as condições do crédito no corpo da requisição para o endpoint de criação de proposta. O sistema valida e registra a proposta, retornando um identificador único e o status atual.

Como Funciona:

Envio de Dados do Usuário: Informações adicionais, como nome da mãe, gênero, nacionalidade, profissão e renda, devem ser enviadas nesta etapa para complementar o cadastro.

Definição das Condições do Crédito: Detalhes como valor solicitado, número de parcelas e taxa de juros são fornecidos para criar a proposta.

Validação e Registro: O sistema valida as informações e aplica as políticas configuradas para determinar a elegibilidade do usuário. Após a validação, a proposta é registrada e vinculada ao usuário.

ℹ️

Informações

• O identificador do usuário gerado na etapa de cadastro é obrigatório para associar a proposta ao solicitante correto.
• É necessário que já tenha um produto criado e configurado do tipo CaaS.
• A proposta criada será analisada conforme as regras definidas no sistema, como critérios de renda mínima, limites de crédito e políticas internas.
• Um status inicial, como "PROPOSAL_ANALYSIS", será retornado indicando que a análise está em andamento. Após isso, o status atualizado será retornado via WebHook, podendo ser: “PROPOSAL_DENIED”, quando a proposta é negada para o usuário ou “PROPOSAL_CREATED”, quando a proposta é criada, retornando a mesma.

Exemplo de Cenário:

Após o cadastro do usuário e a simulação das condições do crédito, é criada uma proposta formal que reúne todos os dados necessários para a aprovação e formalização do contrato.

Etapa 5 - ENVIO DE DOCUMENTOS (SENDING DOCUMENTS)

O envio de documentos é uma etapa fundamental para validar as informações fornecidas pelo solicitante durante o processo de cadastro e análise de crédito. Essa etapa garante a consistência dos dados e permite a continuidade do fluxo de aprovação.

Método: PUT

Descrição: O cliente deve enviar os documentos necessários individualmente no corpo da requisição. Cada documento enviado é processado e vinculado ao identificador do pipeline da operação de crédito.

Como Funciona:

Os seguintes documentos podem ser enviados durante o processo:

• Selfie: O tipo desse arquivo deve ser nos formatos PNG ou JPG, ambos encondados em base64 (formato PDF não é permitido).
• Documentos Complementares: Arquivos, como comprovante de residência ou documento de identificação, devem ser convertidos e enviados em Base64.

Validação dos Documentos:

• O sistema valida o formato e a consistência dos documentos enviados.
• Cada documento é associado a um Pipeline ID único, que referência a operação em andamento.
• Caso um documento seja reenviado, a versão mais recente será considerada válida, mas o histórico completo de envios permanecerá disponível.

ℹ️

Informações;

• Os documentos devem ser enviados individualmente; não é permitido o envio de múltiplos arquivos em uma única requisição.
• Caso um documento seja reenviado, apenas o mais recente será considerado válido para análise.
• O sistema utiliza o modelo request-response nesta etapa, ou seja, não há acionamento de webhook.
• Documentos enviados fora dos formatos especificados ou com inconsistências serão rejeitados.

Exemplo de Cenário:

Após a criação da proposta, é necessário enviar uma selfie e um comprovante de residência do solicitante para validação. A selfie é enviada no formato JPG ou PNG encondada em Base64, o comprovante de residência também é convertido em Base64. O sistema processa os arquivos e os vincula ao Pipeline ID da proposta em análise.

Etapa 6 - CONTRATO (CONTRACT)

A formalização do contrato é a etapa em que as condições do crédito aprovado são documentadas em um contrato formal, garantindo validade jurídica para a operação. Esta etapa inclui a geração, entrega e registro do contrato, que deve ser assinado pelo usuário para completar o processo.

Método: GET (para consulta do contrato gerado)

Descrição: Após a aprovação da proposta, o sistema gera o contrato com base nas condições definidas. O cliente pode acessar o contrato por meio de um identificador único associado à proposta.

Como Funciona:

• Geração do Contrato: O sistema utiliza os dados da proposta e as políticas configuradas para gerar o contrato em formato eletrônico, como PDF ou arquivo base64.
• Consulta do Documento: O contrato gerado pode ser acessado via API utilizando o identificador único da proposta – CustomServiceNumber enviado no retorno da proposta. Este contrato inclui todas as condições, como valor do crédito, prazo, taxa de juros e encargos.
• Registro e Armazenamento: Após a geração, o contrato é armazenado e, quando necessário, registrado em órgãos competentes para garantir validade jurídica.

Importante:

ℹ️

Informações:

• O contrato só é gerado após a análise e aprovação completa da proposta.
• É essencial que os dados do usuário e da operação estejam corretos, pois são utilizados diretamente na geração do contrato.
• O contrato pode ser visualizado e revisado antes de ser enviado para assinatura.
• Este método é request-response, não há webhook.

Exemplo de Cenário:

Após a aprovação de uma proposta de crédito no sistema, o contrato é gerado com todas as condições previamente acordadas. O usuário final deve revisar o documento antes de realizar a assinatura eletrônica, que formaliza a operação.

Etapa 6.1 - Assinatura do Contrato (Sign Contract)

A assinatura do contrato é a etapa final do processo de crédito, na qual o usuário formaliza sua concordância com os termos do documento gerado. Este processo ocorre de forma eletrônica, garantindo agilidade, segurança e validade jurídica.

Método: POST

Descrição: O cliente deve enviar a confirmação da assinatura, incluindo o checksum do contrato gerado e informações adicionais de registro, para concluir a formalização do crédito.

Como Funciona:

Verificação do Contrato: Antes da assinatura, o contrato gerado deve ser validado pelo sistema, garantindo que todas as informações estejam consistentes.

Registro da Assinatura: O usuário confirma a assinatura eletrônica, e o sistema registra o evento, incluindo dados como local (latitude e longitude), data e hora.

Importante:

ℹ️

Informações:

• A assinatura deve incluir o checksum do contrato gerado (retornado na etapa de Get Contracts), garantindo a integridade do documento.
• Dados de localização e data/hora são obrigatórios para registro do evento, atendendo a requisitos de conformidade.
• Contratos assinados eletronicamente possuem validade jurídica conforme a legislação aplicável.
• Esta etapa é request-response.

Exemplo de Cenário:

Após o envio do contrato para o usuário final, a assinatura eletrônica é capturada por meio da API. O sistema registra a assinatura, associando-a ao contrato correspondente e concluindo o processo de formalização do crédito.