Início rápido

No Marketplace de Crédito, toda solicitação seque o seguinte ciclo de vida:

Etapa 1 - Auth (Autenticação)

A autenticação é o primeiro passo importante para garantir a segurança ao acessar os endpoints de nossa API de crédito. Utilizamos um sistema baseado em tokens para autenticar solicitações, garantindo que apenas clientes autorizados possam acessar nossos serviços.

Passo 1: Usando suas credenciais fornecidas, solicite um token de autenticação através do método POST.

Passo 2: Após a solicitação bem-sucedida, você receberá um token JWT como token de acesso. Este deve ser usado como Bearer Token em todas as chamadas subsequentes para autenticar sua sessão, incluindo o token de acesso como um cabeçalho de autorização em todas as solicitações.

ℹ️

Informações:

• Bearer Token: Um tipo de token de acesso usado em autenticações HTTP para permitir acesso a recursos específicos.
• Nesta etapa, é utilizado o modelo request-response.

Etapa 2 - Signup (Cadastro)

A API de crédito oferece dois principais endpoints de cadastro via método POST: o signupMatch e o signupSimples. Ambos são projetados para registrar usuários na plataforma, mas com diferentes finalidades e características.

Passo 3: Escolha entre SignupSimple para registro básico ou SignupMatch para incluir informações detalhadas do usuário e suas preferências de produtos financeiros, neste ultimo, retornamos a pré-disposição do cliente a produtos específicos.

Passo 4: Após o cadastro, é retornado o Pipeline ID, um identificador de referência do processo usado nas etapas subsequentes. Neste passo, é onde se inicia o ciclo de vida do pipeline, retornando neste passo o status indicando que o processo está em análise (SignUp Analysis).

Passo 5: Via Webhook, é retornado o status, que pode ser: SignUp Denied ou SignUp Completed, do processo de cadastro referenciado pelo Pipeline ID, aqui é informado se o cadastro foi concluído ou negado. Neste passo, nosso ciclo de vida do pipeline continua, caso o status retornar SignUp Completed o processo pode prosseguir para a Etapa 3 Proposal (Proposta), caso retorne SignUp Denied, o processo é finalizado.

ℹ️

Informações:

• Pipeline ID: Identificador usado para acompanhar e referenciar processos específicos ao longo de diferentes etapas da jornada do cliente.
• Webhook: Utilizado para notificar sistemas de eventos ocorridos, como a análise de uma proposta.
• Status: Utilizado para gerenciar e exibir informações específicas em cada etapa do processo, variando conforme o produto e o contexto.

Etapa 3 - Proposal (Proposta)

A etapa de proposta é projetada para coletar e validar os dados necessários para a criação de propostas de produtos de empréstimo ou abertura de contas bancárias digitais.

Passo 6: Envie informações detalhadas do solicitante via método POST; os dados são organizados e analisados pelo pipeline.

Passo 7: Neste passo, o status do pipeline é retornado em Proposal Analysis, indicando que estamos chamando as API's dos parceiros para criar as propostas.

Passo 8: Um Webhook retorna o status do pipeline que pode ser Proposal Completed retornando todas as propostas, ou Proposal Denied, quando não é possível criar propostas de crédito para aquele CPF.

Etapa 4 - Sending Documents (Envio de Documentos)

Esta etapa permite o envio de documentos para análise, essencial para a validação de dados e processos de aprovação de crédito.

Passo 9: Utilize o método PUT para enviar individualmente os documentos necessários durante o processo de solicitação de crédito. Cada documento enviado recebe um Pipeline ID para referenciar o processo.

ℹ️

Informações:

• Nesta etapa, a selfie deve ser enviada nos formatos PNG ou JPG; arquivos em PDF não são permitidos.
• O Documento deve ser encriptado em base 64.
• É necessário enviar um documento por vez. Caso o mesmo documento seja enviado duas vezes, o mais recente será o utilizado; no entanto, o cliente terá acesso a todos os documentos enviados.
• Nesta etapa, é utilizado o modelo request-response, não há webhook.

Etapa 5 - Contract (Contrato)

Esta seção trata do processo de obtenção e assinatura de contratos relacionados a propostas de crédito.

Passo 10: Utilize o método GET para obter contratos que precisam ser revisados e assinados pelo cliente. O Customer Service Number (CSN) é utilizado para referenciar cada proposta específica no processo de contratação.

Passo 11: O Checksum (usado para referenciar o contrato em questão) será retornado.

Passo 12: Utilize o método POST para enviar dados que confirmam a assinatura de um contrato associado a uma proposta de crédito. Inclua o checksum, empregado para referenciar especificamente o contrato mencionado, no corpo da solicitação. Essa inclusão é necessária para verificar a autenticidade do contrato assinado, conforme registrado pelo logdata.

ℹ️

Informações:

• Customer Service Number (CSN): Usado para identificar propostas específicas dentro de um processo, importante para a geração e assinatura de contratos.
• Neste etapa é utilizado o modelo request-response, não há webhook.
• A chamada de envio de contrato não é uma chamada obrigatória, apenas utilizada caso a proposta tenha a necessidade de contrato, para verificar é necessário observar a variável HasContracts = true dentro das informações da proposta.