Applies to integrated customers using the RecoveryConnect APICollateral Operations
The Collateral Operations section contains endpoints used to retrieve, create, update, and manage collateral records associated with an order. Collateral represents the asset (typically a vehicle or equipment) tied to the recovery case.
These endpoints allow users to manage collateral information and track collateral location history.
All requests must include a valid Bearer token in the request header.
Retrieve Collateral Location Records
Description: Retrieves all location records associated with a specific collateral within an order.
URL: /api/v140/orders/{order_id}/collaterals/{collateral_id}/locations
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57070279/collaterals/58850064/locations |
Request Body: NA
Response:
{ "data": [ { "loc_type": "Stored", "notes": null, "created_at": "2026-03-02 10:59:56", "updated_at": "2026-03-02 10:59:56", "location_date": "2026-03-02 10:59:00", "recovery": { "id": 10120168, "order_id": 57070279, "parent_id": null, "order_collaterals_id": 58850064, "color_id": 1, "damage_code": 6, "recovery_police": 10778, "pd_name": null, "access_to_interior": 0, "is_push_to_start": 0, "lpr_company": null, "lpr_type": null, "hail_damage": 0, "additional_damage": null, "airbags_deployed": 0, "accepted_at": null, "asset_recovery_photo": 1, "created_at": "2026-03-02 10:59:56", "deleted_at": null, "is_active": "1", "updated_at": "2026-03-02 11:10:48", "collateral_miles": 1000, "drivable": "No", "keys": "No", "keys_cut": 0, "recovery_police_badge": "", "recovery_police_notified_date": "2026-03-02 10:59:00", "client_estimated_fee": "20.00", "client_notes": "Automation Test", "recovery_date": "2026-03-02 10:59:00", "added_by": 87798, "lpnum": null, "lpstate": null, "lpexpire": null, "personals": 1, "personals_by": 87798, "personals_witnessed_by": 11765, "personals_spacenumber": "2", "personals_numcontainers": "12", "personals_completed": 1, "source": "W", "migration": null, "is_condition_completed": 1, "was_tow_dolly_used": 0, "privacy_data_removed": null, "privacy_data_removal_information": null, "ticket": null, "police_report": null, "days_stored": "5 days", "personal_items": { "passengercabin": [ "papers" ], "glove": [ "Glovebox" ], "trunk": [ "Car Seat" ] }, "recovered_by": [ { "id": 93200021, "recovery_id": 10120168, "employees_id": 188832, "created_at": "2026-03-02 10:59:56", "deleted_at": null, "company_id": 180338 } ], "recovery_assignment_id": null, "damage_locations": [ { "id": 10036255, "recovery_id": 10120168, "damage_type_location_id": 45, "damage_type_id": 7, "created_at": "2026-03-02 11:00:01", "updated_at": "2026-03-02 11:00:01" } ], "personals_address_id": "6076174", "lpr_recovery": 0, "client_id": 65690, "client_name": "Demo Bank & Trust MRS", "company_orderno": 103097, "vin": "2C3CDXHG7FH777831", "recovery_police_details": { "id": 10778, "name": "105 New York Police Department", "address": { "id": 778, "name": null, "address_1": "7660 Elias Mews Suite 266", "address_2": "", "state_abbr": "NA", "city_name": "Unknown", "zip_code": "00000", "county_name": "Unknown", "longitude": "11.15739536", "latitude": "47.26394272", "unit": null }, "phones": [ { "id": 2340, "type": 2, "mobile_carrier_id": null, "number": "630-384-6632", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2023-09-28 08:50:06", "deleted_at": null, "migration": null, "address_with_number": "630-384-6632 - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2340 } }, { "id": 2341, "type": 3, "mobile_carrier_id": null, "number": "", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2014-06-21 07:05:45", "deleted_at": null, "migration": null, "address_with_number": " - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2341 } }, { "id": 2342, "type": 4, "mobile_carrier_id": null, "number": "", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2014-06-21 07:05:45", "deleted_at": null, "migration": null, "address_with_number": " - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2342 } }, { "id": 8593598, "type": 4, "mobile_carrier_id": null, "number": "364-780-6245", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-11-03 01:30:22", "updated_at": "2023-09-28 10:51:37", "deleted_at": null, "migration": null, "address_with_number": "364-780-6245 - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 8593598 } } ] }, "service_provider": { "id": 49171, "order_id": 57070279, "recovery_id": 10120168, "service_provider_id": 180338, "address_id": 6076174, "created_at": "2026-03-02 10:59:56", "updated_at": "2026-03-02 10:59:56" } }, "address": { "id": 6076174, "name": "Shawn's Test Lot - 2307", "address_1": "2369 Mueller Center Apt. 876", "address_2": "", "state_abbr": "AZ", "city_name": "Phoenix", "zip_code": "85021", "county_name": "Maricopa", "longitude": "-112.10837180", "latitude": "33.56568520", "unit": null } }, { "loc_type": "Recovered", "notes": null, "created_at": "2026-03-02 10:59:56", "updated_at": "2026-03-02 10:59:56", "location_date": "2026-03-02 10:59:00", "recovery": { "id": 10120168, "order_id": 57070279, "parent_id": null, "order_collaterals_id": 58850064, "color_id": 1, "damage_code": 6, "recovery_police": 10778, "pd_name": null, "access_to_interior": 0, "is_push_to_start": 0, "lpr_company": null, "lpr_type": null, "hail_damage": 0, "additional_damage": null, "airbags_deployed": 0, "accepted_at": null, "asset_recovery_photo": 1, "created_at": "2026-03-02 10:59:56", "deleted_at": null, "is_active": "1", "updated_at": "2026-03-02 11:10:48", "collateral_miles": 1000, "drivable": "No", "keys": "No", "keys_cut": 0, "recovery_police_badge": "", "recovery_police_notified_date": "2026-03-02 10:59:00", "client_estimated_fee": "20.00", "client_notes": "Automation Test", "recovery_date": "2026-03-02 10:59:00", "added_by": 87798, "lpnum": null, "lpstate": null, "lpexpire": null, "personals": 1, "personals_by": 87798, "personals_witnessed_by": 11765, "personals_spacenumber": "2", "personals_numcontainers": "12", "personals_completed": 1, "source": "W", "migration": null, "is_condition_completed": 1, "was_tow_dolly_used": 0, "privacy_data_removed": null, "privacy_data_removal_information": null, "ticket": null, "police_report": null, "days_stored": "5 days", "personal_items": { "passengercabin": [ "papers" ], "glove": [ "Glovebox" ], "trunk": [ "Car Seat" ] }, "recovered_by": [ { "id": 93200021, "recovery_id": 10120168, "employees_id": 188832, "created_at": "2026-03-02 10:59:56", "deleted_at": null, "company_id": 180338 } ], "parent": null, "police_agency": { "id": 10778, "district_id": null, "parent_company": null, "type": 9, "status": 1, "created_by": 10000, "created_by_employee": 10000, "merged_from": null, "owned_by": 131083128, "name": "105 New York Police Department", "legal_name": null, "website": "http://police.gov", "is_global": 1, "tin": null, "current_caseno": 0, "current_transid": 70, "signup_code": 0, "htmlhead": null, "allow_provider_change": 1, "allow_client_personal_items": 1, "allow_bk_scrub": 0, "allow_ssn_hide": null, "auto_purchase_plates": 0, "lienholder_verification": 0, "ssn_digits": null, "password_expiration": 0, "password_expiration_days": 180, "previous_passwords": 0, "previous_passwords_number": 2, "allow_cln_hide": null, "cln_digits": null, "scorecard_enabled": 0, "scorecard_enabled_at": null, "login_type": null, "service_provider_custom_fees": 0, "allow_sp_add": 1, "auto_sp_add": 0, "store_number": null, "disable_adding_ssn": 0, "disable_adding_loan_payment": 0, "service_provider_allow_sp_add": 0, "only_approved_invoiceprint": 0, "parent_approval_invoice_exp": 0, "address_is_public_by_default": 1, "preferred_billing": "Credit Card", "invoices_created_due_after": 30, "recovery_acknowledgement_lockout": null, "company_wide_hold": 0, "auto_ack_plate_share_web": 0, "filter_sp_by_cvt": 0, "fieldvisit_ackn": 1, "repo_ackn": 1, "bulk_recharge": 1, "use_company_email": 1, "validate_case_import_vin": 0, "search_data_staging_member_companies": 0, "charge_transaction_fees": null, "geo_assignment_restriction": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2023-04-10 16:38:30", "deleted_at": null, "manual_contract": 0, "client_invoicing_requirements": 0, "deliver_to_auction": 0, "release_to_auction": 0, "donot_contact_flag": 0, "enable_contracted_fees": null, "allow_vin_hide": null, "vin_digits": null, "has_claims": 0, "pre_approved_auto_invoice": 1, "bill_to_debtor": 0, "bill_to_debtor_days": null, "sla_enforced": 0, "sla_enforced_days": null, "sla_allowed_invoice": null, "gl_code_require": 0, "main_company_address": { "id": 778, "address_id": 778, "company_id": 10778, "invoice_daily_target_amount": "0.00", "recovery_daily_target": "0.00", "is_primary": 1, "is_cars_certified": 1, "created_at": "2014-06-21 07:05:46", "updated_at": "2014-06-21 07:05:46", "is_risc_certified": 0, "risc_lot_expiration": null, "deleted_at": null, "risc_inspection_id": null, "risc_certification_date": null, "address_details": { "id": 778, "name": null, "address_1": "7660 Elias Mews Suite 266", "address_2": "", "unit": null, "zip": 10, "type": 1, "latitude": "47.26394272", "longitude": "11.15739536", "date_delay": null, "available_from": "00:00:00", "available_to": "23:59:00", "priority": 0, "hits": 0, "no_contact": 0, "created_at": "2014-06-21 07:05:46", "updated_at": "2023-09-29 06:30:30", "deleted_at": null, "migration": null, "phones": [ { "id": 2340, "type": 2, "mobile_carrier_id": null, "number": "630-384-6632", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2023-09-28 08:50:06", "deleted_at": null, "migration": null, "address_with_number": "630-384-6632 - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2340 } }, { "id": 2341, "type": 3, "mobile_carrier_id": null, "number": "", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2014-06-21 07:05:45", "deleted_at": null, "migration": null, "address_with_number": " - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2341 } }, { "id": 2342, "type": 4, "mobile_carrier_id": null, "number": "", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2014-06-21 07:05:45", "deleted_at": null, "migration": null, "address_with_number": " - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2342 } }, { "id": 8593598, "type": 4, "mobile_carrier_id": null, "number": "364-780-6245", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-11-03 01:30:22", "updated_at": "2023-09-28 10:51:37", "deleted_at": null, "migration": null, "address_with_number": "364-780-6245 - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 8593598 } } ], "zip_code_details": { "zip_code_id": 10, "zip_code": "00000", "zip_code_city_id": 10, "city_name": "Unknown", "zip_code_state_id": 10, "state_name": "Unknown", "state_abbr": "NA", "state_county": "ZZ-Unknown", "zip_code_county_id": 10, "county_name": "Unknown", "latitude": "0.000000", "longitude": "0.000000", "system_msg": 0, "country": "Unknown", "country_code": "ZZ", "trigger_msg": 0, "shape_data": null } } } }, "recovery_assignment_id": null, "damage_locations": [ { "id": 10036255, "recovery_id": 10120168, "damage_type_location_id": 45, "damage_type_id": 7, "created_at": "2026-03-02 11:00:01", "updated_at": "2026-03-02 11:00:01" } ], "personals_address_id": "6076174", "lpr_recovery": 0, "client_id": 65690, "client_name": "Demo Bank & Trust MRS", "company_orderno": 103097, "vin": "2C3CDXHG7FH777831", "recovery_police_details": { "id": 10778, "name": "105 New York Police Department", "address": { "id": 778, "name": null, "address_1": "7660 Elias Mews Suite 266", "address_2": "", "state_abbr": "NA", "city_name": "Unknown", "zip_code": "00000", "county_name": "Unknown", "longitude": "11.15739536", "latitude": "47.26394272", "unit": null }, "phones": [ { "id": 2340, "type": 2, "mobile_carrier_id": null, "number": "630-384-6632", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2023-09-28 08:50:06", "deleted_at": null, "migration": null, "address_with_number": "630-384-6632 - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2340 } }, { "id": 2341, "type": 3, "mobile_carrier_id": null, "number": "", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2014-06-21 07:05:45", "deleted_at": null, "migration": null, "address_with_number": " - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2341 } }, { "id": 2342, "type": 4, "mobile_carrier_id": null, "number": "", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2014-06-21 07:05:45", "deleted_at": null, "migration": null, "address_with_number": " - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2342 } }, { "id": 8593598, "type": 4, "mobile_carrier_id": null, "number": "364-780-6245", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-11-03 01:30:22", "updated_at": "2023-09-28 10:51:37", "deleted_at": null, "migration": null, "address_with_number": "364-780-6245 - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 8593598 } } ] }, "service_provider": { "id": 49171, "order_id": 57070279, "recovery_id": 10120168, "service_provider_id": 180338, "address_id": 6076174, "created_at": "2026-03-02 10:59:56", "updated_at": "2026-03-02 10:59:56" } }, "address": { "id": 120092338, "name": "Home Address", "address_1": "A_Raeann2384 E Browning Pl Chandler", "address_2": "", "state_abbr": "AZ", "city_name": "Phoenix", "zip_code": "85001", "county_name": "Maricopa", "longitude": "0.00000000", "latitude": "0.00000000", "unit": "" } } ] } |
Create Collateral Location
Description: This endpoint is used to create a location event for a specific collateral within an order.
It records actions related to authorization, transport, or redemption of the collateral.
Depending on the loc_type, the request body parameters may vary. Some parameters are common across all location events, while others are specific to redemption or transport workflows.
Typical use cases include:
- Authorizing redemption of collateral
- Authorizing transport of collateral
- Recording completed transport
- Recording completed redemption (release)
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/collaterals/{collateral_id}/locations
Method: POST
Request Body Parameters:
Common Parameters
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
loc_type | Defines the type of collateral location event (authorization, transport, or release). Refer to Location Type Values below | Yes | Transported |
location_date | Date and time when the location event occurred | Yes | 2026-01-17 07:59:00 |
addresses_id | Unique identifier of the address where the collateral is located or being transported to | Yes | 262552 |
notes | Additional remarks or comments related to the collateral location event | No | Transport initiated by logistics team |
notification_email | List of email addresses to notify regarding the collateral movement or authorization | No | ["xyca123@gmail.com "] |
transport_company_id | Company ID of the transport company responsible for moving the collateral | Yes | 140702 |
Redemption Specific Parameters:
These parameters are used during the redemption (release) workflow.
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
release_to | Identifier of the person or entity to whom the collateral is released (borrower id) | Yes | 136702306 |
delivery_required | Indicates whether delivery of the collateral is required (0 = No, 1 = Yes) | Yes | 0 |
Transport Specific Parameters
These parameters apply to transport-related events.
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
destination_company_id | Company receiving the collateral (auction company id) | Yes | 191368 |
transport_company_id | The company responsible for transporting the collateral (transport company id) | Yes | 140702 |
Location Type Values
Location Type | Description |
Complete Auth and Release | Authorization completed and collateral released to the recipient. |
Complete Auth and Transport | Authorization completed and collateral transported. |
Authorized to Release | Indicates partial authorization has been granted to release the collateral, but the release has not yet been completed. |
Authorized to Transport | Indicates partial authorization has been granted to transport the collateral, but the transport has not yet been completed. |
Transported | Indicates that the collateral has been successfully transported to the destination. This action can only be recorded after Authorized to Transport has been performed. |
Released | Indicates that the collateral has been fully released as part of the redemption process. This action can only be recorded after Authorized to Release has been performed. |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57062885/collaterals/58842868/locations |
Request Body:
{ "addresses_id": 120092338, "loc_type": "Complete Auth and Transport", "destination_company_id": 191368, "location_date": "2026-01-17 07:59:00", "transport_company_id": 140702, "notification_email":[ "vinay.band@esgit.com"], "notes": "vinay is testing" } |
Response:
{ "data": [ { "id": 105735175, "parent_id": null, "recovery_id": 10119986, "order_collateral_id": 58842868, "addresses_id": 66391424, "address_id_by": 2589556, "collateral_release_id": null, "collateral_status": null, "to_obj": 0, "lotnum": null, "added_by": 408564, "loc_type": "Authorized to Transport", "notes": "vinay is testing", "object_by": "Company", "object_id_by": 140702, "object": "Company", "object_id": 191368, "changes_location": 0, "sync_to_mmi": null, "delivery_required": null, "location_date": "2026-01-17T07:59:00.000000Z", "other_hold_type_id": null, "created_at": "2026-03-07 11:09:35", "updated_at": "2026-03-07 11:09:35", "recovery": { "id": 10119986, "order_id": 57062885, "parent_id": 10119985, "order_collaterals_id": 58842868, "color_id": 17, "damage_code": 1, "recovery_police": 10778, "pd_name": null, "access_to_interior": 0, "is_push_to_start": 0, "lpr_company": null, "lpr_type": null, "hail_damage": 0, "additional_damage": null, "airbags_deployed": 0, "accepted_at": null, "asset_recovery_photo": 0, "created_at": "2026-02-17 10:48:34", "deleted_at": null, "is_active": "1", "updated_at": "2026-02-17 10:48:39", "collateral_miles": 1000, "drivable": "Yes", "keys": "No", "keys_cut": 0, "recovery_police_badge": "", "recovery_police_notified_date": "2026-02-17 10:47:00", "client_estimated_fee": "20.00", "client_notes": "Automation Test", "recovery_date": "2026-02-17 10:47:00", "added_by": 119399, "lpnum": null, "lpstate": null, "lpexpire": null, "personals": 0, "personals_by": null, "personals_witnessed_by": null, "personals_spacenumber": null, "personals_numcontainers": null, "personals_completed": 0, "source": "W", "migration": null, "is_condition_completed": 1, "was_tow_dolly_used": 0, "privacy_data_removed": null, "privacy_data_removal_information": null, "ticket": null, "police_report": null, "days_stored": "19 days", "personal_items": { "passengercabin": [], "glove": [], "trunk": [] }, "recovered_by": [ { "id": 93199819, "recovery_id": 10119986, "employees_id": 119399, "created_at": "2026-02-17 10:48:34", "deleted_at": null, "company_id": 10001 } ], "recovery_assignment_id": 57062886, "damage_locations": [], "personals_address_id": 0, "lpr_recovery": 0, "client_id": 65690, "client_name": "Demo Bank & Trust MRS", "company_orderno": 102930, "vin": "1GCEK19B75Z271554", "recovery_police_details": { "id": 10778, "name": "105 New York Police Department", "address": { "id": 778, "name": null, "address_1": "7660 Elias Mews Suite 266", "address_2": "", "state_abbr": "NA", "city_name": "Unknown", "zip_code": "00000", "county_name": "Unknown", "longitude": "11.15739536", "latitude": "47.26394272", "unit": null }, "phones": [ { "id": 2340, "type": 2, "mobile_carrier_id": null, "number": "630-384-6632", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2023-09-28 08:50:06", "deleted_at": null, "migration": null, "address_with_number": "630-384-6632 - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2340 } }, { "id": 2341, "type": 3, "mobile_carrier_id": null, "number": "", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2014-06-21 07:05:45", "deleted_at": null, "migration": null, "address_with_number": " - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2341 } }, { "id": 2342, "type": 4, "mobile_carrier_id": null, "number": "", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2014-06-21 07:05:45", "updated_at": "2014-06-21 07:05:45", "deleted_at": null, "migration": null, "address_with_number": " - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 2342 } }, { "id": 8593598, "type": 4, "mobile_carrier_id": null, "number": "364-780-6245", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2020-11-03 01:30:22", "updated_at": "2023-09-28 10:51:37", "deleted_at": null, "migration": null, "address_with_number": "364-780-6245 - 105 New York Police Department (7660 Elias Mews Suite 266 Unknown NA 00000) ", "pivot": { "address_id": 778, "phone_id": 8593598 } } ] }, "service_provider": null }, "address": { "id": 66391424, "name": null, "address_1": "2301 W Dunlap ave", "address_2": null, "state_abbr": "AZ", "city_name": "Phoenix", "zip_code": "85021", "county_name": "Maricopa", "longitude": "-112.10865000", "latitude": "33.56673800", "unit": null } } ] } |
Remove Collateral Location
Description: This endpoint removes a collateral location record associated with an order.
It is used to delete authorization stage records, specifically:
- Authorized to Release
- Authorized to Transport
These authorization records may need to be removed if they were created incorrectly or need to be reversed before the process is completed.
Note:
This endpoint is intended only for removing authorization-stage location records.
Removal of completed actions, such as Transported or Released, is not allowed with this endpoint.
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/collaterals/{collateral_id}/locations
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57062885/collaterals/58842868/locations |
Request Body: NA
Response:
{ "data": { "success": true } } |
Retrieve Order Collaterals
Description: This endpoint retrieves the list of collaterals associated with a specific order.
URL: /api/v140/orders/{order_id}/collaterals
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/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": [] } |
Retrieve Single Order Collateral
Description: This endpoint retrieves the details of a specific collateral associated with an order.
URL: /api/v140/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/v140/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 } } |
4.6 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/v140/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 |
status | Numeric value representing the status (0 = Open, 1 = Close) | No | 1 |
status_note | Additional remarks explaining the status update | No | This case is no longer needed |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/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" } |
Place Redemption Hold on Order
Description: This endpoint is used to place or update a redemption hold on a specific collateral associated with an order.
A redemption hold is applied when the collateral should not be released or redeemed until further instructions. The request allows adding a note/update message and sending notification emails to specified recipients.
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/collaterals/{collateral_id}/redemptionhold
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
update | Description or note explaining the redemption hold update | Yes | Sample Hold |
notification_email | List of email addresses that should receive notification about the redemption hold update | No | Xya1234@gmail.com |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57074673/collaterals/58854304/redemptionhold |
Request Body:
{ "update": "Sample", "notification_email": [ "examplemail@gmail.com" ] } |
Response:
[ { "id": 43855, "other_hold_type_id": 2, "order_id": 57074673, "company_id": 10004, "created_by_id": 408564, "created_at": "2026-03-13 14:27:19", "updated_at": "2026-03-13 14:34:57", "deleted_at": null }, { "id": 43856, "other_hold_type_id": 2, "order_id": 57074672, "company_id": 10004, "created_by_id": 408564, "created_at": "2026-03-13 14:27:19", "updated_at": "2026-03-13 14:34:57", "deleted_at": null } ] |
Remove Redemption Hold on Order
Description: This endpoint is used to remove an existing redemption hold placed on a specific collateral associated with an order.
Once the redemption hold is removed, the collateral becomes eligible for further redemption or release processes based on the order workflow.
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/collaterals/{collateral_id}/redemptionhold
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57074673/collaterals/58854304/redemptionhold |
Request Body: NA
Response:
{ "success": true } |