Collateral

Propriedades do objeto collateral para a geração da Proposta.

O preenchimento de dados da garantia, possui diferença entre Propostas de Auto Equity e Home Equity, veja abaixo as diferenças:

Auto Equity - Informações do Veículo
Home Equity - Informações do Imóvel

Auto Equity - Informações do veículo

As informações do veículo (como ano de fabricação, ano do modelo, pacote etc) são autocompletadas por meio da placa. Outras informações como dono do veículo e débito devem ser informadas no momento da criação da proposta.

Request Body

Campo	Tipo	Obrigatório	Descrição
`licensePlate`	string	Sim	Placa do veículo
`debt`	double	Sim	Valor da dívida do veículo
`borrowerVehicleOwner`	boolean	Não	Se o lead é o proprietário do veículo
`ownerKinshipDegree`	string	Não	Proprietário do veículo Consulte os possíveis valores para ownerKinshipDegree. Caso não informado, é utilizado como padrão `SELF`.

Exemplo do objeto JSON

{
    "collateral": {
         "borrowerVehicleOwner": true,
         "debt": 0,
         "licensePlate": "abc1234",
         "ownerKinshipDegree": "SELF"
    }
}

Home Equity - Informações do Imóvel

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

Request Body

Campo	Tipo	Obrigatório	Descrição
`value`	double	Sim	Valor da garantia
`debt`	double	Não	Valor da dívida do imóvel.
`address`	string	Sim	Endereço do imóvel.
`number`	integer	Sim	Número do imóvel.
`complement`	string	Não	Complemento do imóvel.
`neighborhood`	string	Sim	Bairro do imóvel.
`city`	string	Sim	Cidade do imóvel.
`state`	string	Sim	Estado do imóvel.
`country`	string	Sim	País do imóvel (fixo `BR`)
`postalCode`	string	Sim	CEP do imóvel
`hasDeed`	string	Sim	Indicativo de o solicitante possuir a matrícula do imóvel utilizado como garantia. Opções: `YES`, `NO` ou `DO_NOT_KNOW`
`realEstateType`	string	Sim	Tipo do imóvel Opções: `HOUSE`, `APARTMENT`, `COMMERCIAL`, `LAND` ou `OTHERS`
`owners`	array	Sim	Tipo de proprietários Opções: `BORROWER`, `SPOUSE` ou `OTHER` Caso `SPOUSE` seja um dos proprietários do imóvel suas informações são obrigatórias

Exemplo do objeto JSON

{
    "collateral": {
        "value": 1500000,
        "hasDeed": "YES",
        "realEstateType": "HOUSE",
        "address": "Avenida Paulista",
        "neighborhood": "Vila Olímpia",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "number": "123",
        "complement": "",
        "postalCode": "01310-930",
        "owners": [
            "SPOUSE",
            "BORROWER"
        ]
    }
}

Updated 1 day ago