Como funciona

O fluxo envolve quatro participantes: o seu sistema (o canal), o Corban (API e página de contratação), o cliente e o banco. O seu sistema não se comunica com o banco: o Corban faz essa intermediação.

webhooks enviados ao seu sistema chamadas ao banco (feitas pelo Corban)

1. Você cria o link

O seu sistema chama POST /v1/links com o CPF do cliente e, opcionalmente, o celular e uma referência própria (por exemplo, o identificador do promotor). A resposta traz a url do link, de uso pessoal e válida por 24 horas.

A entrega da URL ao cliente é feita pelo seu sistema, pelo meio que preferir (WhatsApp, SMS, notificação no aplicativo, e-mail).

Nota

A url só é devolvida na resposta da criação. Guarde o id do link: é com ele que você consulta a situação do link e relaciona os webhooks.

2. O cliente faz a jornada na página do Corban

O link abre uma página web que funciona em celular e em computador. O cliente percorre estas etapas:

1. 1

   Abre o link

   Vê o CPF mascarado e inicia a jornada.

2. 2

   Confirma o celular

   Recebe um código por SMS do banco e o informa na página.

3. 3

   Elegibilidade

   O banco verifica se há vínculo elegível ao consignado privado.

4. 4

   Escolhe a oferta

   Vê valor, parcelas, juros e CET de cada oferta simulada.

5. 5

   Envia os dados

   Informa e-mail, endereço (com busca por CEP), documento e conta para o crédito.

6. 6

   Assina no banco

   Recebe o link de formalização e conclui a assinatura no ambiente do banco.

O CPF é sempre o informado na criação do link e não pode ser alterado pelo cliente. A titularidade do celular é confirmada por um código enviado por SMS pelo banco.

3. O Corban consulta o banco

Cada etapa da jornada corresponde a uma chamada do Corban ao banco: envio e validação do código, consulta de elegibilidade, simulação de ofertas, criação da proposta e geração do link de assinatura. As credenciais do banco ficam apenas no Corban: não passam pelo seu sistema nem pelo navegador do cliente.

4. Você acompanha a proposta

A cada mudança de status, o Corban envia um webhook para a URL que você cadastrou:

1. CRIADAProposta criada no bancoproposta.criada
2. AGUARDANDO_FORMALIZACAOLink de assinatura geradoproposta.aguardando_formalizacao
3. FORMALIZADACliente assinouproposta.formalizada
4. APROVADABanco aprovouproposta.aprovada

Estados finais fora do caminho principal

• RECUSADARecusada pelo banco (a partir de qualquer etapa ativa)proposta.recusada
• CANCELADACancelada (a partir de qualquer etapa ativa)proposta.cancelada
• FALHACriação recusada pelo banco; o cliente pode tentar novamenteproposta.falha

O status só avança, nunca volta, e o banco pode pular etapas (por exemplo, de AGUARDANDO_FORMALIZACAO direto para APROVADA). Além dos webhooks, GET /v1/links/{id} devolve a situação do link e da proposta a qualquer momento.

Sandbox e produção

No momento, apenas o sandbox está disponível: banco simulado, sem envio de SMS e sem propostas registradas de verdade. O ambiente de produção, com o banco real, será liberado em breve.

Primeiros passosExecute esse fluxo no sandbox, passo a passo.