Eventos e Jornada da Proposta

1. Estrutura Base

Todos os eventos seguem este padrão para facilitar o seu processamento:

Payload	Descrição
`ID`	ID da proposta.
`Name`	Nome do evento (ex: PREQUALIFIED, PAID).
`Data`	Objeto com detalhes específicos do evento

2. Jornada do Cliente — Happy Path

Na imagem abaixo, apresentamos as macro etapas da esteira de Auto Equity, trazemos os eventos disponíveis em nosso webhook e fazemos a contextualização desses eventos na jornada do empréstimo.

3. Descrição dos Eventos

Evento Recebido	Explicação
-	Após a proposta ser criada, ela automaticamente está na etapa inicial `PRE_QUALIFICATION`, em que é executado o motor da pré-qualificação.
`PREQUALIFIED`	Este evento notifica que o cliente foi aprovado nas regras de pré-qualificação. Agora, ele será redirecionado para o processamento, que é a preparação para as análises de crédito e da garantia.
`PROCESSED`	Receber este evento indica que o cliente está nas fases de análise de crédito e vistoria do veículo.
`CREDIT_ANALYSED`	Significa que a análise de crédito já foi concluída e o cliente teve o crédito aprovado. Agora, ele segue para a validação de documentos.
`INSPECTION_CREATED`	Início do procedimento da vistoria do veículo
`INSPECTION_PERFORMED`	Disparado após realização da vistoria
`INSPECTION_FINALIZED`	Conclusão dos processos de inspeção
`DOCUMENTS_REVIEWED`	Andamento da proposta na esteira: (`DOCUMENTS` → `CONTRACT`)
`PAID`	O recurso foi liberado na conta do cliente: (`CONTRACT` → `LOAN_PAYMENT`)

4. Jornada no Cenário de Rejeição de Proposta

No caso de haver rejeição da proposta em alguma etapa (ex: rejeição na etapa LOAN_PROPOSAL_ANALYSIS) a jornada ficaria da seguinte maneira:

Evento Recebido	Desdobramento
-	A proposta é criada e automaticamente está na etapa inicial `PRE_QUALIFICATION`
PREQUALIFIED	Andamento da proposta na esteira:(`PRE_QUALIFICATION` → `PROCESSING`)
PROCESSED	Andamento da proposta na esteira: (`PROCESSING` → `LOAN_PROPOSAL_ANALYSIS`)
REJECTED	A proposta foi reprovada na etapa `LOAN_PROPOSAL_ANALYSIS`

5. Exemplos

5.1. `PREQUALIFIED` — Proposta Pré-Qualificada

Este evento é disparado uma única vez, após a execução da nossa política de pré-qualificação.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "PREQUALIFIED"
}

5.2. `PROCESSED` — Proposta Processada

Este evento é disparado uma única vez, após a Creditas coletar mais informações necessárias da ficha para a análise de crédito.

{
	"id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
	"name": "PROCESSED"
}

5.3. `CREDIT_ANALYSED` — Proposta com Análise de Crédito Finalizada

Evento disparado após a análise que considera o perfil de crédito do cliente e as condições de empréstimo desejadas.

O resultado das condições comerciais da proposta pode variar após a vistoria ou se houver troca do carro, uma vez que o valor do carro poderá ser alterado - este caso será notificado em outro evento.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "CREDIT_ANALYSED",
  "data": {
    "approvedAt": "2022-08-19",
    "application": {
      "installment": {
        "value": {
          "currency": "BRL",
          "amount": 647.68
        },
        "maturity": 12
      },
      "approvedCredit": {
        "currency": "BRL",
        "amount": 5000.0
      },
      "netValues": {
        "currency": "BRL",
        "amount": 7772.16
      },
      "iof": {
        "currency": "BRL",
        "amount": 139.58
      },
      "registrationFee": {
        "currency": "BRL",
        "amount": 600.0
      },
      "cet": {
        "monthlyPercentage": 6.28,
        "yearlyPercentage": 0.0
      },
      "interestRate": {
        "monthlyPercentage": 3.65,
        "yearlyPercentage": 53.76
      }
    }
  }
}

5.4. `INSPECTION_STARTED` — Vistoria Iniciada

Este evento é disparado após o inicio dos procedimentos de inspeção de veículos.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "INSPECTION_STARTED"
}

5.5. INSPECTION_PERFORMED — Vistoria Realizada

Este evento é disparado logo após a realização inspeção de veículos.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "INSPECTION_PERFORMED"
}

5.6. `INSPECTION_FINALIZED` — Vistoria Concluída

Este evento é disparado após o fim dos procedimentos de inspeção de veículos.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "INSPECTION_FINALIZED"
}

5.7. `DOCUMENTS_REVIEWED` — Revisão de Documentos

Este evento é disparado uma única vez, após a análise dos documentos do cliente e da vistoria do veículo.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "DOCUMENTS_REVIEWED"
}

5.8. `PAID` — Proposta paga

Este evento é disparado uma única vez, após a liberação do recurso na conta do cliente

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "PAID",
  "data": {
    "loan": {
      "installment": {
        "value": {
          "currency": "BRL",
          "amount": 414.05
        },
        "maturity": 12
      },
      "paidValue": {
        "currency": "BRL",
        "amount": 5000.0
      },
      "netValues": {
        "currency": "BRL",
        "amount": 4968.5996
      },
      "iof": {
        "currency": "BRL",
        "amount": 469.74
      },
      "registrationFee": {
        "currency": "BRL",
        "amount": 600.0
      },
      "cet": {
        "monthlyPercentage": 1.74
      },
      "interestRate": {
        "monthlyPercentage": 3.65
      }
    }
  }
}

5.9. `CREDIT_UPDATED` — Atualização da Proposta de Crédito

Ao longo da esteira, é possível que as condições do crédito aprovado sejam alteradas. Por isso, este evento tem o intuito de notificar essa mudança, sendo disparado sempre que houver uma reanálise de crédito e condições do cliente.

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "CREDIT_UPDATED",
  "data": {
    "approvedAt": "2022-08-21",
    "application": {
      "installment": {
        "value": {
          "currency": "BRL",
          "amount": 900.68
        },
        "maturity": 12
      },
      "approvedCredit": {
        "currency": "BRL",
        "amount": 15000.0
      },
      "netValues": {
        "currency": "BRL",
        "amount": 8772.16
      },
      "iof": {
        "currency": "BRL",
        "amount": 139.58
      },
      "registrationFee": {
        "currency": "BRL",
        "amount": 600.0
      },
      "cet": {
        "monthlyPercentage": 6.28,
        "yearlyPercentage": 0.0
      },
      "interestRate": {
        "monthlyPercentage": 3.65,
        "yearlyPercentage": 53.76
      }
    }
  }
}

5.10. `REJECTED` — Proposta Rejeitada

Este evento pode ser enviado em qualquer momento da esteira e indica que a proposta foi rejeitada na etapa atual.

Indepentende da etapa, o título do evento se mantém o mesmo REJECTED e o campo (data → rejectionReason) detalha o motivo da rejeição, podendo ser qualquer um listado em motivos de recusa

{
  "id": "B2B-36C2FCBF-8422-46D5-B94F-F1A2EB756D53",
  "name": "REJECTED",
  "data": {
    "rejectionReason": "AGE_RESTRICTION"
  }
}

6. Testando a Integração em Staging

Para conseguir testar ambos os cenários foi criada uma regra em ambiente de staging, onde:

Propostas com CPF começando com 2 terão a oferta automaticamente negada.
Exemplo: 2XXXXXXXXXX
Propostas com CPF começando com 7 terão a oferta automaticamente aprovada.
Exemplo: 7XXXXXXXXXX
Propostas sem o campo collateral.pricingDetail não serão processadas

Certifique-se de seguir essas regras no ambiente de testes (staging) para validar corretamente a integração.

1. Estrutura Base

2. Jornada do Cliente — Happy Path

3. Descrição dos Eventos

4. Jornada no Cenário de Rejeição de Proposta

5. Exemplos

5.1. PREQUALIFIED — Proposta Pré-Qualificada

5.2. PROCESSED — Proposta Processada

5.3. CREDIT_ANALYSED — Proposta com Análise de Crédito Finalizada

5.4. INSPECTION_STARTED — Vistoria Iniciada

5.5. INSPECTION_PERFORMED — Vistoria Realizada

5.6. INSPECTION_FINALIZED — Vistoria Concluída

5.7. DOCUMENTS_REVIEWED — Revisão de Documentos

5.8. PAID — Proposta paga

5.9. CREDIT_UPDATED — Atualização da Proposta de Crédito

5.10. REJECTED — Proposta Rejeitada