Applies to integrated customers using the RecoveryConnect APIRetrieve Order Collaterals
Description: This endpoint retrieves the list of collaterals associated with a specific order.
URL: /api/v130/orders/{order_id}/collaterals
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/orders/57062885/collaterals |
Request Body: NA
Response:
{ "data": [ { "id": 58842868, "is_primary": 1, "vehicle_type_id": 2, "vehicle_type": "Truck", "year": "2005", "make": "Chevrolet", "model": "Silverado 1500", "color": "Unknown Color", "drive_train": "Four-Wheel Drive", "fuel_type": "Gasoline", "engine": "5.3L V8", "selling_dealer": "", "original_loan_amount": "0", "payment_amount": "0", "past_due_amount": "0", "unpaid_balance": "0", "chargeoff_date": "No Data", "key_codes": "-undefined", "maximum_bailout": null, "additional_info": "No Data", "contract_date": "No Data", "license_no": "", "license_state": "", "license_exp": null, "vin": "1GCEK19B75Z271554", "status": "Repossessed", "status_id": 3, "status_date": "2026-02-17 10:48:34", "status_reason": null, "status_note": null, "on_hook_by": null, "assignment_on_hook_by": { "id": 119399, "company_id": 10001, "name": "Priya Jayakumar", "firstname": "Priya", "lastname": "Jayakumar", "contact": { "email": null, "mobile_phone": null }, "roles": [ "Field Agent", "Field Agent Supervisor ", "Investigator", "Alpha Tester", "API Connection", "Case Worker", "Compliance Officer", "API Connection", "API Connection", "Accountant", "Alpha Tester", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker", "Compliance Officer", "Field Agent", "Field Agent Supervisor ", "Investigator", "Lot Person", "Lot Supervisor", "Manager Recovery Pro", "Owner", "Remarketing", "Skip Tracer", "Spotter", "Transportation", "Administrator" ], "self": "http://stg-api.mbsisystems.com/api/employees/119399", "expand": "employee", "employee_id": 119399, "latitude": "0.00000000", "longitude": "0.00000000", "created_at": "2026-02-17 10:47:17", "updated_at": "2026-02-17 10:47:17" }, "vehicle_value": null, "created_at": "2026-02-17 10:45:02", "updated_at": "2026-02-17 10:48:35", "meta": [] } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/orders/57062885/collaterals?q=%2Fapi%2Fv140%2Forders%2F57062885%2Fcollaterals&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/orders/57062885/collaterals?q=%2Fapi%2Fv140%2Forders%2F57062885%2Fcollaterals&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/orders/57062885/collaterals", "per_page": "20", "to": 1, "total": 1, "count": 1, "available_filters": { "vin": { "vin_attribute": { "name": "VIN filter", "description": "Matches vehicle VINs", "has_valid_options": false, "valid_options": [] } }, "search": { "vin_attribute": { "name": "VIN filter", "description": "Matches vehicle VINs", "has_valid_options": false, "valid_options": [] }, "make_attribute": { "name": "Vehicle Make filter", "description": "Matches vehicle make", "has_valid_options": true, "valid_options": [ "Chevrolet" ] }, "model_attribute": { "name": "Vehicle Model filter", "description": "Matches vehicle model", "has_valid_options": false, "valid_options": [] }, "proptery_license_no": { "name": "Vehicle License filter", "description": "Matches vehicle license number", "has_valid_options": false, "valid_options": [] } }, "make": { "make_attribute": { "name": "Vehicle Make filter", "description": "Matches vehicle make", "has_valid_options": true, "valid_options": [ "Chevrolet" ] } }, "model": { "model_attribute": { "name": "Vehicle Model filter", "description": "Matches vehicle model", "has_valid_options": false, "valid_options": [] } }, "license_no": { "proptery_license_no": { "name": "Vehicle License filter", "description": "Matches vehicle license number", "has_valid_options": false, "valid_options": [] } }, "collateral_status": { "collateral_status": { "name": "Collateral Status", "description": "Matches collateral status", "has_valid_options": true, "valid_options": [ "Repossessed" ] } }, "on_hook_by": { "on_hook_by": { "name": "OnHook By filter", "description": "Matches OnHook By", "has_valid_options": false, "valid_options": [] } } } }, "warnings": [] } |
3.4 Retrieve Single Order Collateral
Description: This endpoint retrieves the details of a specific collateral associated with an order.
URL: /api/v130/orders/{order_id}/collaterals/{collateral_id}
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/orders/57062885/collaterals/58842868 |
Request Body: NA
Response:
{ "data": { "id": 58842868, "is_primary": 1, "vehicle_type_id": 2, "vehicle_type": "Truck", "year": "2005", "make": "Chevrolet", "model": "Silverado 1500", "color": "Unknown Color", "drive_train": "Four-Wheel Drive", "fuel_type": "Gasoline", "engine": "5.3L V8", "selling_dealer": "", "original_loan_amount": "0", "payment_amount": "0", "past_due_amount": "0", "unpaid_balance": "0", "chargeoff_date": "No Data", "key_codes": "-undefined", "maximum_bailout": null, "additional_info": "No Data", "contract_date": "No Data", "license_no": "", "license_state": "", "license_exp": null, "vin": "1GCEK19B75Z271554", "status": "Repossessed", "status_id": 3, "status_date": "2026-02-17 10:48:34", "status_reason": null, "status_note": null, "on_hook_by": null, "assignment_on_hook_by": { "id": 119399, "company_id": 10001, "name": "Priya Jayakumar", "firstname": "Priya", "lastname": "Jayakumar", "contact": { "email": null, "mobile_phone": null }, "roles": [ "Field Agent", "Field Agent Supervisor ", "Investigator", "Alpha Tester", "API Connection", "Case Worker", "Compliance Officer", "API Connection", "API Connection", "Accountant", "Alpha Tester", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker", "Compliance Officer", "Field Agent", "Field Agent Supervisor ", "Investigator", "Lot Person", "Lot Supervisor", "Manager Recovery Pro", "Owner", "Remarketing", "Skip Tracer", "Spotter", "Transportation", "Administrator" ], "self": "http://stg-api.mbsisystems.com/api/employees/119399", "expand": "employee", "employee_id": 119399, "latitude": "0.00000000", "longitude": "0.00000000", "created_at": "2026-02-17 10:47:17", "updated_at": "2026-02-17 10:47:17" }, "vehicle_value": null, "created_at": "2026-02-17 10:45:02", "updated_at": "2026-02-17 10:48:35", "meta": [], "collateral_value": null, "collateral_value_added": null } } |
Update Collateral
Description: This endpoint updates the details of an existing collateral associated with an order.
Only the fields provided in the request body will be updated. Fields not included in the request will remain unchanged.
URL: /api/v130/orders/{order_id}/collaterals/{collateral_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
year | Manufacturing year of the collateral (vehicle) | No | 2008 |
make | Manufacturer or brand of the vehicle | No | Ford |
model | Model name of the vehicle | No | Silverado 1500 |
color | Vehicle color | No | Yellow |
drive_train | Type of drivetrain used in the vehicle | No | Rear Wheel Drive |
fuel_type | Type of fuel used by the vehicle | No | Gasoline |
engine | Engine specification of the vehicle | No | 8 Cylinder Engine |
key_codes | Key code information for the vehicle | No | ABC123 |
additional_info | Additional information or remarks related to the collateral | No | color could be blue |
plate_number | Vehicle license plate number | No | DLNRCO |
plate_state | State where the license plate is registered | No | CA |
identification_number | Vehicle Identification Number (VIN) or unique identification number of the collateral | No | 2GCEC19T921286485 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/orders/57062885/collaterals/58842868 |
Request Body: NA
Response:
{ "data": { "id": 58842868, "is_primary": 1, "vehicle_type_id": 2, "vehicle_type": "Truck", "year": "2008", "make": "Ford", "model": "Nissan 1500", "color": "Yellow", "drive_train": "Rear Wheel Drive", "fuel_type": "Gasoline", "engine": "8 Cylinder Engine", "selling_dealer": "", "original_loan_amount": "0", "payment_amount": "0", "past_due_amount": "0", "unpaid_balance": "0", "chargeoff_date": "No Data", "key_codes": "-undefined", "maximum_bailout": "0.00", "additional_info": "color could be blue", "contract_date": "No Data", "license_no": "DLNRCO", "license_state": "CA", "license_exp": null, "vin": "2GCEC19T921286485", "status": "Repossessed", "status_id": 3, "status_date": "2026-02-17 10:48:34", "status_reason": null, "status_note": null, "on_hook_by": null, "assignment_on_hook_by": { "id": 119399, "company_id": 10001, "name": "Priya Jayakumar", "firstname": "Priya", "lastname": "Jayakumar", "contact": { "email": null, "mobile_phone": null }, "roles": [ "Field Agent", "Field Agent Supervisor ", "Investigator", "Alpha Tester", "API Connection", "Case Worker", "Compliance Officer", "API Connection", "API Connection", "Accountant", "Alpha Tester", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker", "Compliance Officer", "Field Agent", "Field Agent Supervisor ", "Investigator", "Lot Person", "Lot Supervisor", "Manager Recovery Pro", "Owner", "Remarketing", "Skip Tracer", "Spotter", "Transportation", "Administrator" ], "self": "http://stg-api.mbsisystems.com/api/employees/119399", "expand": "employee", "employee_id": 119399, "latitude": "0.00000000", "longitude": "0.00000000", "created_at": "2026-02-17 10:47:17", "updated_at": "2026-02-17 10:47:17" }, "vehicle_value": null, "created_at": "2026-02-17 10:45:02", "updated_at": "2026-03-07 12:06:19", "meta": [], "collateral_value": null, "collateral_value_added": null }, "status": "success" } |