SOBRE A "API PROPOSTA"

Características Gerais:

A “API Proposta” inicia a segunda fase do fluxo de contratação do crédito. Após criar uma cotação e essa cotação atingir o resultado de “Cotação Aprovada”, será enviado um retorno com as condições e opções de parcelas aprovadas para a cotação. Cada opção de parcela estará vinculada à um ID (installments_option_id). Na API de Proposta deve ser informado qual é o ID de opção de parcela escolhido pelo solicitante do crédito (“borrower”). Será criada então uma proposta, vinculada à cotação aprovada anteriormente e aplicando a opção de parcela informada.

Após a criação da proposta, será enviado um retorno que pode assumir diferentes valores. Destacamos os seguintes "response_type":

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

O “RETORNO_PROPOSTA_ENVIADA”, é enviado quando o Requisitante não deseja receber sincronamente o resultado da criação e aprovação da proposta. O “RETORNO_PROPOSTA_RECEBIDA”, indica que a requisição foi devidamente recebida e, conforme configuração do produto, não tem um fluxo completamente automático, podendo por exemplo, ter fases de aprovação de documentação. Portanto, o retorno será efetivado posteriormente. O “RETORNO_PROPOSTA_CONFIRMAR_CONTRATO”, indica que a proposta foi criada com sucesso e o processo de formalização foi iniciado e, conforme configuração do produto, aguarda liberação do contrato. O “RETORNO_PROPOSTA_EM_ASSINATURA”, indica que a proposta foi criada, foi iniciada a formalização da operação e um contrato foi gerado, aguardando a assinatura dos signatários definidos anteriormente.

Outra característica da API Proposta é que, além de informar a opção de parcela escolhida pelo “Borrower”, podem ser enviados os dados cadastrais, documentos e dados de desembolso que não foram informados na API Cotação.

Como consumir ?

Segue um exemplo de requisição para consumir essa API, ou clique aqui para seguir a documentação com exemplos e outras rotas.

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\" } } }"
}

Histórico de edições

Version	Data	Notes
1.10	2023-05-25	Inclusão em todos os webhooks e proposal/status, exceto webhook de proposta quitada os atributos negotiation_original_proposal_id_1 e negotiation_original_proposal_id_2 como exemplos.
1.11	2022-06-23	Inclusão de motivo de cancelamento/reprovação em responses e webhooks correspondentes (response_type_reason e proposal_status_reason)