Edição de Propostas

Esta funcionalidade permite a alteração dos dados de uma proposta tais como: dados do cliente, da garantia, das condições de pagamento em um único request.
O endpoint responsável por esta funcionalidade pode ser encontrado aqui. O processo de edição ocorre de forma assíncrona, portanto ao submeter os dados da proposta para edição a resposta será um HTTP status 202 (ACCEPTED) com o corpo da resposta vazio, apenas confirmando que a API de Financiamento recebeu a solicitação.

Verificando o status da edição e seus respectivos steps.

Após a submissão dos dados para o endpoint de edição, será necessário fazer polling no endpoint de status da proposta para saber se o processo de edição terminou, e qual o seu resultado. Você deve procurar pelo campo steps na resposta deste endpoint.

{
    "status": "ONGOING",
    "steps": [
        ...,
        {
            "type": "PROPOSAL_EDIT_EXTERNAL",
            "status": "WAITING_FOR_ANALYSIS"
        }
    ]
}

O processo de edição propriamente dito possui quatro steps principais que indicam em qual etapa a edição se encontra e qual o resultado da mesma.

PROPOSAL_EDIT_EXTERNAL::WAITING_FOR_ANALYSIS: Este step indica que a requisição feita para editar esta proposta foi aceita e que a mesma está na fila de processamento.

 {"type": "PROPOSAL_EDIT_EXTERNAL", "status": "WAITING_FOR_ANALYSIS", "when": DATA_DE_CRIACAO_DO_STEP}

PROPOSAL_EDIT_EXTERNAL::SUCCESS: Este step indica que a edição foi processada, validada e a proposta foi atualizada com sucesso.

 {"type": "PROPOSAL_EDIT_EXTERNAL", "status": "SUCCESS", "when": DATA_DE_CRIACAO_DO_STEP}

PROPOSAL_EDIT_EXTERNAL::REJECTED: Este step indica que a edição foi processada, e os dados enviados para edição foram rejeitados devido a nossas políticas.

 {"type": "PROPOSAL_EDIT_EXTERNAL", "status": "REJECTED", "when": DATA_DE_CRIACAO_DO_STEP}

PROPOSAL_EDIT_EXTERNAL::ERROR: Este step indica que obtivemos algum erro inesperado ao realizar a alteração dos dados e será necessário uma nova requisição para editar os dados.

 {"type": "PROPOSAL_EDIT_EXTERNAL", "status": "ERROR", "when": DATA_DE_CRIACAO_DO_STEP}

Quando é possível editar uma proposta?

Uma proposta pode ser editada a qualquer momento antes de ser iniciada a etapa de formalização, que ocorre quando é feita uma submissão para o endpoint /underwriting, ou durante a etapa de formalização, quando a proposta estiver pendenciada: neste caso, a proposta estará com o step de UNDERWRITING::PENDING.

No caso de uma edição ocorrida em qualquer etapa antes do processo de formalização, após o término da mesma, basta seguir o fluxo da proposta de acordo com esta documentação (se você hoje já integra com a nossa API, basta seguir o fluxo a partir do ponto que estava antes da edição ter iniciado).

No caso de edições durante o processo de formalização, será necessário submeter a proposta novamente para análise de formalização através do endpoint /underwriting, a fim de sinalizar para os analistas que as pendências foram resolvidas através da edição de uma proposta.

Fluxos alternativos após editar uma proposta

Após a conclusão com sucesso de uma edição, dependendo de quais dados foram alterados, pode ser que algumas análises automáticas sejam disparadas ou que novos documentos sejam solicitados na checklist.

Análise de crédito: Quando uma edição de proposta resultar em uma nova análise de crédito ao consultar o endpoint de status da proposta, você verá que novos steps referentes a esta análise CREDIT_ANALYSIS serão criados após o step de confirmação da edição PROPOSAL_EDIT_EXTERNAL::SUCCESS. A reanálise de crédito é um efeito colateral da edição e não é considerada na decisão de aprovação/rejeição de uma edição. Quando este caso ocorrer basta seguir o fluxo da API de acordo com o resultado da análise de crédito. No caso de uma análise de crédito rejeitada, é possível realizar uma nova edição para reverter este processo, respeitando o limite de edições de propostas.
Alteração da Checklist: Em caso de alteração na checklist, com novo(s) documento(s) solicitado(s), é possível consultá-la neste endpoint e fazer o upload dos documentos necessários de acordo com esta documentação.

Limite de edição de propostas

A funcionalidade de edição possui um limite na quantidade de edições que uma proposta pode ter. Este limite é dinâmico e leva em conta uma série de variáveis e análises, portanto o valor exato da quantidade de edições não é informado, mas é possível saber se uma proposta ainda pode ser editada ou quando ela está na última tentativa de edição. Para isso, basta acessar o endpoint de consulta e verificar o campo editingInfo, onde canEdit indica se a proposta pode ser editada e o campo isLastAttempt indica se a proposta possui apenas mais uma tentativa de edição disponível.

  {
    "editingInfo": {
        "canEdit": true,
        "isLastAttempt": false
    }
  }

Fluxo de edição da API de Financiamento

O diagrama abaixo apresenta como ocorre o fluxo de edição dentro da nossa API de Financiamento