Criar Proposta de Auto Equity

1. Visão Geral

Para criar uma proposta na Creditas, é necessário fornecer algumas informações gerais sobre o cliente e sua garantia. Como alguns campos requiridos para criar uma proposta também são necessários para gerar uma oferta, oferecemos hoje duas possibilidades de criação de proposta: uma reaproveitando os dados já fornecidos para solicitação e consulta da Simulação Assertiva, outra enviando novamente os dados já informados nesses endpoints anteriores.

❗️
Caso opte por seguir reaproveitando os dados informados na oferta, você precisará realizar o envio de algumas informações adicionais, como telefone, e-mail, titularidade do veículo (ownerKinshipDegree), autorização Bacen e WhatsappOptin. Esses dados adicionais são obrigatórios para criação de uma proposta na Creditas.

2. Recomendações Importantes

Para criar uma proposta na Creditas, é necessário a autorização do cliente para consulta ao Bacen. Sem essa autorização, o cliente não avança na esteira. Já o opt-in do Whatsapp é necessário para que consigamos enviar comunicações sobre o processo diretamente no telefone do cliente, o que facilita a negociação e agiliza a esteira de contratação.

Por isso, recomendamos que ambas as autorizações sejam enviadas no header da requisição.

3. Implementação Técnica

3.1. Request HTTP

Tipo da Requisição	URL	Exemplo
`POST`	{{url_base}}/proposals	https://stg-api.creditas.io/b2b/proposals

3.2. Request Headers

Header	Valor
`Accept`	application/vnd.creditas.v1+json
`Content-Type`	application/json;charset=UTF-8
`Authorization`	Bearer `{{AUTHENTICATION_TOKEN}}`

3.3. Request Body

Campo	Tipo	Obrigatório	Descrição
`productType`	string	Sim	AUTO_REFI
`offerId`	string	Não	Id da oferta usada como referência para gerar a proposta. Consulte como Solicitar e Consultar uma Oferta. Se este campo for enviado, evitaremos a duplicação das informações já fornecidas para a geração da oferta. Assim, restam apenas alguns campos a serem coletados e enviados nesta etapa da experiência.
`conditions`	object	Sim	Condições de parcelamento do empréstimo — número de parcelas selecionado. Consulte o objeto do conditions
`borrower`	object	Sim	Informações pessoais do solicitante do empréstimo. Consulte o objeto do borrower. Se ausente, iremos usar o valor herdado da oferta, quando passado o offerId.
`collateral`	object	Sim	Dados sobre a garantia (veículo) do solicitante do empréstimo. Consulte o objeto do collateral. Se passado o offerId, o único campo que precisa ser enviado neste momento de criação é proposta é o de titularidade do veículo - consultar valores possíveis para o campo ownerKinshipDegree
`purpose`	string	Sim	Motivos para solicitação de empréstimo. Consulte os motivos de empréstimo. Se ausente, iremos usar o valor herdado da oferta, quando passado o offerId.
`intendedCredit`	object	Sim	Valor crédito solicitado. Consulte o formato requirido em objeto do intendedCredit. Se ausente, iremos usar o valor herdado da oferta, quando passado o offerId.
`metadata`	object	Não	As informações disponibilizadas nesse campo são necessárias para o rastreamento da informação e análise de dados.

3.4. Request Response

Campo	Tipo	Descrição
`id`	string	Id da proposta
`legacyId`	string	Id (Esse campo ira ser depreciado e sera removido)
`productType`	string	Produto referente a proposta enviada

3.5. Exemplo de Request e Response


curl --location --request POST '{{url_base}}/proposals' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{access_token}}' \
--data-raw '{"productType":"AUTO_REFI","offerId":"OFR-D8FCB7C4-E127-493C-9154-63932289761D", "purpose":"VEHICLE_FINANCING", "metadata": "{"version": "V2024"}", "borrower":{"fullName":"complete name", "email":"[email protected]", "birthDate":"1991-01-29", "cellphone":"999999999", "cellphoneCode":"31", "monthlyIncome":12345.6, "professionalStatus":"SELF_EMPLOYED", "authorizationTerms":"Eu autorizo...", "postalCode":"91770552", "cpf":12345678900, "optIns":{"whatsApp":true, "sms":false, "email":false}, "intendedCredit":{"currency":"BRL", "amount":5001.0}, "conditions":{"installment":{"term":24}}, "collateral":{"value":57198.0, "brand":"HYUNDAI", "model":"VISION", "modelYear":2021, "manufacturingYear":2007, "modelVersion":"HB20 VISION 1.0 12V MT5", "borrowerVehicleOwner":true, "debt":0, "licensePlate":"abc1234", "numberOfDoors":4, "fuelType":"ALCO/GASOL.", "accessoryPackage":"Basico", "pricingDetail":{"type":"MOLICAR", "code":"XXXXX-X"}}}'

-----Exemplo com os dados herdados da offers
{
  "borrower": {
    "fullName": "John Doe",
    "optIns": {
      "whatsApp": true
    }
  },
  “conditions”: {
     “installment”: 24
  },
  "offerId": "OFR-581AAD36-BD10-40B9-88B7-4374B5E917D4"
}

{
    "id": "B2B-DBC79D7F-E5D7-45B9-B9DD-A60C2561EA06",
    "legacyId": "68e7e502-2e71-4c4c-a868-9c8c438fe19d",
    "productType": "AUTO_REFI"
}

4. Orientações Desenvolvimento em Staging

🚧
Com o intuito de auxiliar nos testes de integração, foi criada uma regra em ambiente de staging em que:

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.

5. Erros

Para gerenciar os erros no momento do desenvolvimento, ou posteriormente em produção, consulte esta página com o detalhamento sobre os erros relacionados ao endpoint de Criação de Proposta.