Collateral - Auto

Esta seção descreve as propriedades do objeto Collateral, que representa os dados da garantia de quem solicita o empréstimo para Garantia de auto.


Informações do veículo

Para melhor preenchimento das informações do veículo disponibilizamos endpoints para consulta de marca, modelo e valores à partir do ano que deseja consultar.

Acesse e veja mais informações.



Informações sobre os campos do payload


Request Body

Campo

Tipo

Obrigatório

Descrição

value

double

Sim* (consulte informações)

Valor da garantia

debt

double

Sim

Valor da dívida do veículo

brand

string

Sim

Marca do veículo
Veja como consultar as marcas de veículos aceitas

model

string

Sim

Modelo do veículo
Veja como consultar os modelos de veículos aceitos

modelYear

integer

Sim

Ano modelo do veículo

manufacturingYear

integer

Sim

Ano de fabricação do veículo

modelVersion

string

Sim

Versão do modelo
Ex: HB20 VISION 1.0 12V MT5

borrowerVehicleOwner

boolean

Sim

Se o lead é o proprietário do veículo

licensePlate

string

Sim

Placa do veículo

numberOfDoors

integer

Sim

Número de portas

fuelType

string

Sim

Tipo de combustível
Ex: Alcool

accessoryPackage

string

Sim

Pacote de acessórios do carro
Ex: Basico ou Completo

molicarCode

string

Não

Código correspondente na tabela Molicar


Informações sobre o campo value

Se você utilizar os endoints de Informações do veículo para obter as informações e nos enviar igualmente, o campo value não deverá ser enviado na request.
Isso ocorre porque ao enviar o response da consulta do modelo do veículo, o campo value é obtido através de chamadas internas em nossa API no momento da criação do lead - usando o valor exato do modelo passado - o que resulta em uma análise correta da garantia em questão.

Caso você solicite ao seu cliente e nos envie essa informação na request da criação da proposta, o campo value sobrescreverá o valor correto da garantia de acordo com nossa busca interna.


Exemplo do objeto JSON

{
  "collateral": {
        "brand": "HYUNDAI",
        "model": "HB20",
        "modelYear": 2021,
        "manufacturingYear": 2020,
        "modelVersion": "VISION 1.0 12V MT5",
        "borrowerVehicleOwner": true,
        "debt": 0,
        "licensePlate": "abc1234",
        "numberOfDoors": 4,
        "fuelType": "ALCO/GASOL.",
        "accessoryPackage": "Basico"
    }
}