Proposal API

The Proposal API begins the second step of credit's flow. After you get a quotation and then this quotation becomes approved, it will be send a response with the conditions and installments options of this quotation. Each installment option will be related to a ID (installments_option_id). It should be informed to the Proposal API which installment option was choose by the borrower. Then it will be created a proposal, related to the approved quotation and the installment option id.

After the proposal creation, it will be send a value that can assume different values. We highlight the following "response_type":

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

The “RETORNO_PROPOSTA_ENVIADA” is sent when the Requester does not want to synchronously receive the result of the proposal creation or approval. The “RETORNO_PROPOSTA_RECEBIDA”, indicates that the request was received and, according to the product's configuration, it does not have a completely automatic flow, and may, for example, have documentation analysis step. Therefore, the return will be effective later. The “RETORNO_PROPOSTA_CONFIRMAR_CONTRATO”, indicates that the proposal was successfully created and the formalization step was started and, according to the product configuration, it is waiting for the contract to be released. The “RETORNO_PROPOSTA_EM_ASSINATURA”, indicates that the proposal was created, the formalization of the operation was started and a contract was generated, awaiting the signature of the previously defined signatories.

Another feature of the Proposal API is that, in addition to informing the installment option chosen by the Borrower, registration data, documents and disbursement data that were not informed in the Quotation API can be sent.

Integration

There is an example to consume the API, or click here to follow the full documentation.

application/json

{"request_info": {"operation_tracking_id": "12547853gFtBgDtuGGjYVFBkubyf000002871",
"installments_option_id": "444547853gFtBgDtuGGjYVFBkubyf000002871",
"external_id": "MKTPLACECompra0021345",
"contract_settlement": false,
"new_contract_settlement_is_financial": false
},
"borrower_info": {"person_type": "pf",
"cpf_cnpj": "11122233344",
"birth_opening_date": "1990-05-30",
"name": "João Alegre da Silva",
"email": "[email protected]",
"cell_phone": "11955551111",
"terms_agreement": true,
"address": {"postal_code": "05400222",
"street": "Rua da Alegria",
"number": "77",
"complement": "casa",
"neighborhood": "Pinheiros",
"city": "São Paulo",
"state": "SP"
}
},
"natural_borrower_complement_info": {"gender": "Masculino",
"mother_name": "Maria da Alegria",
"father_name": "José Silva",
"nationality": "Brasileiro",
"place_birth": "São Paulo",
"profession": "Empresário",
"marital_status": "Casado(a)",
"separation_of_goods": true,
"spouse_name": "Joana Ferreira Gomes",
"pep": false,
"resident_abroad": false,
"monthly_income": 10000.55,
"net_worth": 500000.11,
"id_document": {"document_type": "RG",
"document_number": "22457845X",
"date_issue": "1999-06-30",
"document_authority": "SSP",
"document_uf": "SP"
}
},
"legal_borrower_complement_info": {"foundation_date": "1990-06-25",
"company_type": "LTDA",
"cnae_code": 4541207,
"estate_code": "4.82757-8",
"city_code": "123456789-10",
"trade_name": "Pizzaria do João",
"annual_revenue": 1000000.55
},
"legal_borrower_representatives": {"natural_representative_one": {"person_type": "pf",
"cpf_cnpj": "11122233344",
"birth_opening_date": "1990-05-30",
"name": "João Alegre da Silva",
"email": "[email protected]",
"cell_phone": "11955551111",
"terms_agreement": true,
"address": {"postal_code": "05400222",
"street": "Rua da Alegria",
"number": "77",
"complement": "casa",
"neighborhood": "Pinheiros",
"city": "São Paulo",
"state": "SP"
},
"gender": "Masculino",
"mother_name": "Maria da Alegria",
"father_name": "José Silva",
"nationality": "Brasileiro",
"place_birth": "São Paulo",
"profession": "Empresário",
"marital_status": "Casado(a)",
"separation_of_goods": true,
"spouse_name": "Joana Ferreira Gomes",
"pep": false,
"resident_abroad": false,
"monthly_income": 10000.55,
"net_worth": 500000.11,
"id_document": {"document_type": "RG",
"document_number": "22457845X",
"date_issue": "1999-06-30",
"document_authority": "SSP",
"document_uf": "SP"
}
},
"natural_representative_two": {"person_type": "pf",
"cpf_cnpj": "11122233344",
"birth_opening_date": "1990-05-30",
"name": "José Alegre da Silva",
"email": "[email protected]",
"cell_phone": "11955551111",
"terms_agreement": true,
"address": {"postal_code": "05400222",
"street": "Rua da Alegria",
"number": "78",
"complement": "casa",
"neighborhood": "Pinheiros",
"city": "São Paulo",
"state": "SP"
},
"gender": "Masculino",
"mother_name": "Maria da Alegria",
"father_name": "José Silva",
"nationality": "Brasileiro",
"place_birth": "São Paulo",
"profession": "Empresário",
"marital_status": "Casado(a)",
"separation_of_goods": true,
"spouse_name": "Ana Ferreira Gomes",
"pep": false,
"resident_abroad": false,
"monthly_income": 10000.55,
"net_worth": 500000.11,
"id_document": {"document_type": "RG",
"document_number": "22457845X",
"date_issue": "1999-06-30",
"document_authority": "SSP",
"document_uf": "SP"
}
}
},
"natural_guarantors_info": [{"person_type": "pf",
"cpf_cnpj": "11122233344",
"birth_opening_date": "1990-05-30",
"name": "João Alegre da Silva",
"email": "[email protected]",
"cell_phone": "11955551111",
"terms_agreement": true,
"address": {"postal_code": "05400222",
"street": "Rua da Alegria",
"number": "77",
"complement": "casa",
"neighborhood": "Pinheiros",
"city": "São Paulo",
"state": "SP"
},
"gender": "Masculino",
"mother_name": "Maria da Alegria",
"father_name": "José Silva",
"nationality": "Brasileiro",
"place_birth": "São Paulo",
"profession": "Empresário",
"marital_status": "Casado(a)",
"separation_of_goods": true,
"spouse_name": "Joana Ferreira Gomes",
"pep": false,
"resident_abroad": false,
"monthly_income": 10000.55,
"net_worth": 500000.11,
"id_document": {"document_type": "RG",
"document_number": "22457845X",
"date_issue": "1999-06-30",
"document_authority": "SSP",
"document_uf": "SP"
},
"spouse": {"person_type": "pf",
"cpf_cnpj": "55522233344",
"birth_opening_date": "string",
"name": "Joana Ferreira Gomes",
"email": "[email protected]",
"cell_phone": "11955552222",
"terms_agreement": true,
"address": {"postal_code": "05400222",
"street": "Rua da Alegria",
"number": "77",
"complement": "casa",
"neighborhood": "Pinheiros",
"city": "São Paulo",
"state": "SP"
},
"gender": "Feminino",
"mother_name": "Juliana Maria Silva",
"father_name": "Rodrigo Gomes",
"nationality": "Brasileiro",
"place_birth": "Jundiaí",
"profession": "professora",
"marital_status": "Casado(a)",
"spouse_name": "João Alegre da Silva",
"pep": false,
"resident_abroad": false,
"monthly_income": 5000.22,
"net_worth": 200000.55,
"id_document": {"document_type": "CNH",
"document_number": "012445785245632",
"date_issue": "2007-06-30",
"document_authority": "DETRAN",
"document_uf": "RS"
}
}
}
],
"disbursement_info": {"beneficiary_type": "BORROWER",
"name": "João Alegre da Silva",
"cpf_cnpj": "11122233344",
"bank_code": "077",
"branch_number": "001",
"account_number": "7299004",
"account_digit": "5",
"account_type": "corrente",
"pix_key": "00020101021227790014br.gov.bcb.pix2557invoice.xbank.com/v2/b96053853d388d09b87808ea63dac2ab5204000053039865802BR5924marketplace6753Sao Paulo62070503***55546539",
"disbursement_type": "TRANSFERENCIA_CONTA",
"use_type": "conta_desembolso_credito"
},
"documents": {"person_documents": [{"person_type": "pf",
"cpf_cnpj": "11122233344",
"document_type": "rg ou cnh (frente)",
"document_subtype": "documento",
"document_complement_info": "cnh",
"document_location": "https://marketplace.com.br/integrations/garantia/api/v1/documents/d8c9bab9-5941-55b6-8e14-5581b9gg3302"
}
],
"operation_documents": [{"document_type": "documento_veiculo",
"document_subtype": "documento",
"document_location": "https://marketplace.com.br/integrations/garantia/api/v1/documents/d8c9bab9-5941-55b6-8e14-5581b9gg3302"
}
]
},
"additional_fields": {"operation_costs_amount_stakeholder": {"value": 200.55
},
"operation_costs_net_share_stakeholder": {"value": 0.01511
},
"rent_contract_amount": {"value": 5000.55
},
"rent_contract_sign_date": {"value": "2022-04-16T16:03:04Z"
},
"rent_contract_id": {"value": "676418941698"
},
"rent_contract_property_id": {"value": "45421134"
},
"rent_address_street": {"value": "Rua da Alegria"
},
"rent_address_number": {"value": "89"
},
"rent_address_complement": {"value": "casa"
},
"rent_address_neighborhood": {"value": "Pinheiros"
},
"rent_address_city": {"value": "São Paulo"
},
"rent_address_region": {"value": "SP"
},
"rent_address_postal_code": {"value": "05401000"
},
"installment_amount_1": {"value": 107.8
},
"installment_due_date_1": {"value": "10/02/2024"
},
"installment_external_id_1": {"value": "abcd1234-1234abcd"
},
"installment_info_1": {"value": "72901580000107"
},
"installment_other_1": {"value": "25753334000167"
},
"installment_amount_2": {"value": 500.8
},
"installment_due_date_2": {"value": "10/02/2024"
},
"installment_external_id_2": {"value": "efgh5678-5678efgh"
},
"installment_info_2": {"value": "58711370000117"
},
"installment_other_2": {"value": "67385366000105"
},
"payment_amount_1": {"value": 500.8
},
"payment_due_date_1": {"value": "10/02/2024"
},
"payment_external_id_1": {"value": "ijkl9012-9012ijkl"
},
"payment_info_1": {"value": "Sit minima iusto exercitationem rem sunt temporibus qui in"
},
"payment_other_1": {"value": "Aliquam est sunt commodi quam id non saepe"
}
},
"device_info": "{ \"device\": { \"id\": \"DEVICE_ID2010101010101\", \"ip_address\": \"00.00.0.000\", \"headers\": [ { \"name\": \"Connection\", \"value\": \"Keep-Alive\" }, { \"name\": \"X-Forwarded-For\", \"value\": \"00.00.0.001, 00.00.0.002, 00.00.0.003\" }, { \"name\": \"Via\", \"value\": \"1.1 google\" }, { \"name\": \"X-Cloud-Trace-Context\", \"value\": \"000000000000001/0000000000002\" }, { \"name\": \"Cf-Connecting-Ip\", \"value\": \"00.00.0.000\" }, { \"name\": \"Content-Type\", \"value\": \"application/json\" }, { \"name\": \"User-Agent\", \"value\": \"GuzzleHttp/7\" }, { \"name\": \"Cf-Visitor\", \"value\": \"{\\\"scheme\\\":\\\"https\\\"}\" }, { \"name\": \"X-Forwarded-Proto\", \"value\": \"https\" }, { \"name\": \"Content-Length\", \"value\": \"0000\" }, { \"name\": \"Cf-Ray\", \"value\": \"000000000000-ABC\" }, { \"name\": \"Accept-Encoding\", \"value\": \"gzip, br\" }, { \"name\": \"Cf-Ipcountry\", \"value\": \"BR\" }, { \"name\": \"Cdn-Loop\", \"value\": \"any\" }, { \"name\": \"Host\", \"value\": \"website.com\" } ], \"user_identity_cookies\": [], \"jsc\": \"abc20ska-2maba-X\", \"hdim\": { \"payload\": \"abc123-H\" } } }"
}

Document historic

Version	Data	Notes
1.0	2022-06-20	First version