Applies to integrated customers using the RecoveryConnect APIUpdate Condition Form
Description: This endpoint updates the condition details of a recovered vehicle (e.g., damages, drivable status, interior access, mileage, color, etc.) for a specific recovery record associated with an order.
Only the fields provided in the request body will be updated; unspecified fields remain unchanged.
URL: /api/v130/orders/{order_id}/recoveries/{recovery_id}
Method: PUT
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| collateral_id | Unique identifier of the collateral being recovered | Yes | 2423221 |
| recovered_by | Employee ID of the recovery agent | Yes | 10098 |
| recovered_at | Identifier of the yard/location where collateral was recovered | Yes | 212 |
| recovery_date | Date and time of the recovery (YYYY-MM-DD HH:mm: ss) | Yes | 2019-10-17 23:23:00 |
| lpr_recovery | Flag indicating if recovery was through License Plate Recognition (LPR) | No | 0 |
| lpr_type | Type of LPR used | No | 1 |
| lpr_company | Identifier of the LPR company | No | 2424 |
| police_agency_id | The identifier of the police agency notified | Yes | 2421313 |
| recovery_police_notified_date | Date and time when police were notified | Yes | 2019-10-17 23:23:00 |
| police_badge_id | Badge ID of the officer notified | No | 2424 |
| client_notes | Notes provided by the client | No | notes |
| client_estimated_fee | Estimated fee from the client | No | 3 |
| access_to_interior | Flag indicating if the vehicle’s interior was accessed | No | 0 |
| keys | Flag indicating if keys were present | Yes | 0 |
| personals | Indicator of personal items found in the collateral | No | 2 |
| is_push_to_start | Flag indicating if the vehicle has push-to-start functionality | No | 1 |
| driveable | Indicator if the vehicle is drivable | Yes | 2 |
| color | Color of the recovered vehicle | Yes | white |
| miles | Odometer reading of the vehicle | Yes | 5000 |
| plate_number | Vehicle plate number | No | 2423221 |
| plate_state | State of the vehicle plate | No | OH |
| lpexpire_month | License plate expiration month | No | 2 |
| lpexpire_year | License plate expiration year | No | 2020 |
| damage_locations | List of damages with type/location IDs | No | [ { … } ] |
| id | Unique identifier of the damage record | No | 10024617 |
| recovery_id | Identifier of the associated recovery record | No | 10098777 |
| damage_type_location_id | Identifier for the location of the damage on the asset | No | 29 |
| damage_type_id | Identifier for the type of damage (e.g., scratch, dent) | Yes | 1 |
| created_at | Date and time when the damage record was created | No | 2025-02-14 20:47:21 |
| updated_at | Date and time when the damage record was last updated | No | 2025-02-14 20:47:21 |
| damage_id | Identifier for the type of damage reported | Yes | 2 |
| additional_damage | Free-text or extended description of any additional damage | No | null |
| hail_damage | Boolean/flag indicating if the asset has hail damage (0 = No, 1 = Yes) | Yes | 0 |
| stored_at | Identifier of the storage facility/location where the asset is kept | Yes | 22323 |
| keys_cut | Boolean/flag indicating if new keys were cut (0 = No, 1 = Yes) | No | 0 |
| airbags_deployed | Boolean/flag indicating if airbags were deployed (0 = No, 1 = Yes) | Yes | 0 |
| service_provider | Identifier of the service provider who handled the recovery | No | 141482 |
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/recoveries/10113682 |
Request Body:
{ "collateral_id": 2521229, "recovered_by": 86042, "recovered_at": 2743491, "recovery_date": "May 26, 2020", "lpr_recovery": 0, "lpr_type": null, "lpr_company": null, "police_agency_id": 10791, "recovery_police_notified_date": "May 26, 2020", "police_badge_id": null, "client_notes": null, "client_estimated_fee": 0, "access_to_interior": 1, "keys": 1, "personals": 2, "is_push_to_start": 1, "driveable": 1, "color": "Yellow", "miles": 0, "plate_number": null, "plate_state": null, "lpexpire_month": null, "lpexpire_year": null, "damage_locations": [ { "id": 10024617, "recovery_id": 10098777, "damage_type_location_id": 29, "damage_type_id": 1, "created_at": "2025-02-14 20:47:21", "updated_at": "2025-02-14 20:47:21" } ], "damage_id": 6, "additional_damage": null, "hail_damage": 0, "stored_at": 2170809, "keys_cut": 1, "airbags_deployed": 0, "service_provider": 141482 } |
Response:
{ "data": { "success": true, "recovery_id": 354644, "order_id": 805792 } } |
Get the Condition Form of Collateral
Description: This endpoint retrieves the condition report documents (PDFs) associated with a specific recovery record under an order. The response includes metadata such as file name, upload details, and document URL.
URL: /api/v130/orders/{order_id}/recoveries/{recovery_id}/documents
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/recoveries/10113682/documents |
Request Body: NA
Response:
{ "data": [ { "id": 12323, "type": { "id": 1, "name": "Default", "always_show": 0, "is_required": 0, "type": null, "created_at": "2014-10-29 19:01:18", "updated_at": "2014-10-29 19:01:18", "deleted_at": "2014-10-29 19:01:18" }, "order_attachment_type_id": 2, "order_id": 231533, "name": "Asset Recovery Condition Report", "document_url": "https://dev-myrecovery.s3.us-east-2.amazonaws.com/documents/10001/10000/2020/05/25/kJsyMP0H5kXr/asset_recovery_condition_report.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARNJXFDAYINFZWO2G%2F20200722%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20200722T091641Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=bf41463ea82752d5c4004e486a80bfa2fbf256fe976f59eb239262f1a692a424", "filename": "asset_recovery_condition_report.pdf", "uploaded_by": { "id": 2423767, "firstname": "Neelima", "lastname": "Maheshwari" }, "created_at": "2020-05-25", "meta": { "lat": "10.00000000", "long": "-10.00000000", "generated_at": "2019-10-17 23:23:00", "created_at": "2020-07-22T06:28:49.000000Z" } } ], "meta": { "total": 1 } } |
Get Recovery Personal Items
Description: This endpoint retrieves the personal items recovered from a vehicle, including item details, location, and metadata.
URL: /api/v130/orders/{order_id}/recoveries/{recovery_id}/personals
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/recoveries/10113682/personals |
Request Body: NA
Response:
{ "data": { "personals": 2, "personals_by": null, "personals_witnessed_by": null, "personals_spacenumber": null, "personals_numcontainers": null, "personals_address_id": 1, "personal_items": { "passengercabin": [ "test passengercabin" ], "glove": [ "test glove" ], "trunk": [ "test trunk" ] } } } |
Add Recovery Personals
Description: This endpoint adds personal items recovered from a vehicle to a recovery record. Items can be categorized by storage location (e.g., trunk, glove compartment, cabin).
URL: /api/v130/orders/{order_id}/recoveries/{recovery_id}/personals
Method: POST
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| property_location | Identifier of the property/location where items are stored | Yes | 1 |
| space_number | Space or locker number where personal items are stored | Yes | null |
| bin_count | Number of bins/containers used to store personal items | No | null |
| trunk | Array of items recovered from the trunk | No | ["test trunk"] |
| glove | Array of items recovered from the glove compartment | No | ["test glove"] |
| cabin | Array of items recovered from the passenger cabin | No | ["test cabin"] |
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/recoveries/10113682/personals |
Request Body:
{ "property_location": 1, "space_number": null, "bin_count": null, "trunk": [ "test trunk" ], "glove": [ "test glove" ], "cabin": [ "test cabin" ] } |
Response:
{ "data": [ { "id": 145916, "company_id": 10001, "name": "Test trunk", "pivot": { "recovery_id": 805807, "item_id": 145916, "address_id": 1, "id": 495007, "location": "trunk" } } ] } |