Proposal API

Overview

The "Proposal API" starts the second phase of the credit contracting flow. After a quotation is created and reaches the "Approved Quotation" result, a response is sent with the approved conditions and installment options for that quotation. Each installment option is linked to an ID (installments_option_id). In the Proposal API, you must provide the installment option ID chosen by the credit applicant ("borrower"). A proposal is then created, linked to the previously approved quotation and applying the selected installment option.

After the proposal is created, a response is sent that can take different values. The main "response_type" values are:

• (i) "RETORNO_PROPOSTA_ENVIADA";
• (ii) "RETORNO_PROPOSTA_RECEBIDA";
• (iii) "RETORNO_PROPOSTA_CONFIRMAR_CONTRATO"; or
• (iv) "RETORNO_PROPOSTA_EM_ASSINATURA".

RETORNO_PROPOSTA_ENVIADA is sent when the Requester does not want to receive the result of the proposal's creation and approval synchronously.

RETORNO_PROPOSTA_RECEBIDA indicates that the request was received and, depending on the product configuration, the flow is not fully automatic — for example, it may include document approval stages. The final response will therefore be delivered later.

RETORNO_PROPOSTA_CONFIRMAR_CONTRATO indicates that the proposal was created successfully and the formalization process has started and, depending on the product configuration, is waiting for the contract to be released.

RETORNO_PROPOSTA_EM_ASSINATURA indicates that the proposal was created, the formalization of the operation has started, and a contract was generated, awaiting signature by the previously defined signers.

Another feature of the Proposal API is that, in addition to the installment option chosen by the "Borrower", you can send registration data, documents, and disbursement data that were not provided in the Quotation API.

Specification