Edit Current Collateral

This request allows you to edit the current collateral on a loan.

   Click here to learn more about this request

Many lenders use collateral to secure their loans:

• The Collateral object is nested within the Loans entity.
• Up to 50 items can be collateralized on a single loan. Loans can also have no collateral.
• The system uses VIN information to check for duplicates. It is impossible to add a new collateralized item with a VIN that matches an existing one.

For an example of how collateral works within the UI, take a look at our Add Collateral Information article.

Database

For information on collateral database tables, see the following articles:

• Database – Collateral Entity (collateral_entity)
• Database – Collateral Field Entity (collateral_field_entity)

Basic payload

{
    "Collateral": {
        "results": [
            {
                "a": "2017",
                "b": "Suzuki",
                "c": "VS750GLP",
                "d": "Base",
                "additional": "Informational text",
                "collateralType": "collateral.type.car",
                "vin": "JS1VR51A5H2151359",
                "distance": "25000",
                "bookValue": "2408.59",
                "color": "White",
                "gpsStatus": "collateral.gpsstatus.notinstalled",
                "gpsCode": "NONE",
                "licensePlate": "License Plate Number",
                "gap": "1125.25",
                "warranty": "1254",
                "positionId": null,
                "__update": true,
                "__id": 853
            }
        ]
    }
}

📘

Try It Instructions

Our requests often provide sample payload information so that you can receive a 200 response from simply hitting the Try It button. This request is ready for you—expand the object by clicking the "+" symbol and hit Try It to send the request.

If you would like to try this request with your own tenant account, make sure to change the headers to match your own authentication information.