Applies to integrated customers using the RecoveryConnect APIDescription: Creates a new recovery record for a specific order, capturing details such as collateral, recovery agent, location, police involvement, vehicle condition, and damages.
URL: /api/v130/orders/{order_id}/recoveries
Method: POST
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 | |
| police_agency_id | The identifier of the police agency was notified | Yes | 2424 |
| 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 | notesss |
| 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://test-api.mbsisystems.com/api/v130/orders/16644931/recoveries |
Request Body:
{ "collateral_id": 2423221, "recovered_by": 10098, "recovered_at": 212, "recovery_date": "2019-10-17 23:23:00", "lpr_recovery": 0, "lpr_type": 1, "lpr_company": 2424, "police_agency_id": 2421313, "recovery_police_notified_date": "2019-10-17 23:23:00", "police_badge_id": 2424, "client_notes": "client note", "client_estimated_fee": 3, "access_to_interior": 0, "keys": 0, "personals": 2, "is_push_to_start": 1, "driveable": 2, "color": "white", "miles": 24, "plate_number": "2423221", "plate_state": "OH", "lpexpire_month": 2, "lpexpire_year": 2020, "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": 2, "additional_damage": null, "hail_damage": 0, "stored_at": 22323, "keys_cut": 0, "airbags_deployed": 0, "service_provider": 141482 } |
Response:
{ "data": { "success": true, "recovery_id": 354644, "order_id": 805792 } } |