Applies to integrated customers using the RecoveryConnect API
Update Recovery
Description: This endpoint updates the details of an existing recovery associated with an order.
Recoveries represent events where collateral linked to an order has been recovered or repossessed. This endpoint allows users to modify recovery-related information such as recovery details, vehicle condition, police notification details, and other recovery metadata.
Only the fields included in the request body will be updated. Fields not provided will remain unchanged.
URL: /api/v150/orders/{order_id}/recoveries/{recovery_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE | |
recovery_date | Date when the recovery occurred | No | 2026-03-01 10:48:00
| |
recovery_police_notified_date | Date when the police agency was notified | No | 2026-03-01 10:48:00
| |
color | Color ID of the vehicle | No | yellow | |
driveable | Indicates whether the vehicle was driveable at recovery | No | 2 | |
miles | Odometer reading of the vehicle at the time of recovery.
| No | 56822
| |
keys | Flag indicating if keys were present (1= Yes and 0 = No) | No | 1 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57070277/recoveries/10120166 |
Request Body:
{
"recovery_date": "2026-03-10 10:48:00", "recovery_police_notified_date": "2026-03-09 10:48:00", "color_id":"yellow", "drivable": 2, "miles": 56811, "access_to_interior": 1 } |
Response:
{ "data": { "success": true, "recovery_id": 10120166, "is_condition_completed": true }, "status": "success" } |
Attach Recovery Condition Report PDF
Description: This endpoint uploads and attaches a Recovery Condition Report document (PDF) to a specific recovery record associated with an order.
The document must be provided as a Base64 encoded string along with metadata such as the file name and document name. This report is typically used to document the condition of the recovered collateral, including details such as vehicle status, damages, mileage, and other recovery-related information.
URL: /api/v150/orders/{order_id}/recoveries/{recovery_id}/documents
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE | |
file_name | Name of the uploaded document including file extension | Yes | test.pdf | |
document_name | Display name or label used to identify the document | Yes |
instruction-document | |
data | Base64 encoded string representing the PDF document content | Yes | dGhpcyBpcyBzYW1wbGUgcGRm…. | |
type | Identifier representing the document type (refer to Order Attachment Type IDs reference table) | No | 2 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57070277/recoveries/10120166/documents |
Request Body:
{ "file_name": "test.pdf", "document_name": "instruction-document", "data": "CiVQREYtMS43CiXDpMO8w7bDnwoyIDAgb2JqCjw……” } |
Response:
{ "data": { "order_id": "57070277", "type": 2, "attachment_id": 180461045, "recovery_id": "10120166", "case_attachment_type_id": 17, "id": 182214553 }, "status": "success" } |
Retrieve Condition Report PDFs
Description: This endpoint retrieves the list of condition report documents (PDFs) attached to a specific recovery record.
Condition report documents typically contain details about the condition of the recovered collateral, including damage information, mileage, and other recovery-related observations. This endpoint returns the documents that have been uploaded for the specified recovery.
URL: /api/v150/orders/{order_id}/recoveries/{recovery_id}/documents
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57070277/recoveries/10120166/documents |
Request Body: NA
Response:
{ "data": [ { "id": 182214551, "type": { "id": 17, "name": "Condition Report", "always_show": 1, "is_required": 1, "type": "documents", "created_at": "2020-06-27 06:26:39", "updated_at": "2020-06-27 06:26:39", "deleted_at": null }, "order_attachment_type_id": 17, "order_id": 57070277, "name": "instruction-document", "document_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/orders/documents/10004/408564/2026/03/11/zWO7Wukr5jnC/408564_test.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQCO2cYlZF1WZIjVTNHpeHdBGI%2FtN7es%2BQWx0nM%2B1j2CsAIhAJmZI53AnlwpkzGjY1iCGpvmtzsD4ErBkUzn27J1Q90dKrkFCGEQAxoMOTU2MTMyMDIxMTg3IgxWIZIT9rRwEmsdUBwqlgUeLvHcGp6jWSbYBW5vW6J9w6Uo0PK44xqPCf%2FgTe7QZ87qadngzhmWSNaV%2By73D2bzR%2FqGVjxghfdxnBkvPTKY3OeOuDoJXCUkngSwa31QD9t3RIQMWDyheF4hqRX6StXlhX8SAHU0ynaIN0H806CyfqW3EA2rUgEDCTUXMTCmCXZxNHxsR53VFzy0MNi1%2B247CnVXJ4iMwHGjo0pDhH1M8prKBNmGEckSEFz6pQ0OE2SmLCPAqDPiU3ppjpB%2BgzJ6ydlLHUkFLsrDQO8zBwBhuhCcbIvG0pExPa2dJxHhvz6V2KcWvC%2BQVFal2eYHc2BBD3bGhWHDTWEi1EvE5HmXXAxTyJXRxHwBJ4Y2vSNAsSq3LicSVzx0qFugr%2FwQ8xKuVEfs8L1EyAN61XbmjkqIa1w2KkVlgLbQi%2Bcc6BbR%2BL4BHM5EzJBuZyC5LXkjXbZqOWwmAHs22%2BxsI2dVys4q%2B%2BnvPZyxuwzGkm575wrnMfPBgvABU4WnPwPRGSit9HIUJy0IU7jworr5wrjmPOVzNT1LLErrJdDW7I3RLVm9mPmkOKV0LiWd63bJwCaF8BYnbQW3O4s7YQEk7qi5QWFfEMaZ4CX3C2Pnq4OBx9cHoUkY%2FsjHReaQeB%2ByMu1ZEK9uXloGlMhBtz%2BF8nGzy6hEAMoQsyQuksOd8D3sobOhk8tcrFlYTwEKyMJeF%2Bfm5bACzww6jsZGoFOB13mz5m6%2BBJ43KUOrzjdAbQfGoGbZJkgoP%2BCtlfvoQ6mr1eeAACEbUQtZE0ECbICJywqeSoj%2BCgnxBDHPYpzqb5WTfJkOIDZ5uvBWSstuwVLZFyuBIrUjDIgUDNDDtTdeLnnv27PaDHOq4BE04lbEAM%2BNedGvVSd%2BfHk7lTCnpsbNBjqwAWe9SV%2BxBKn%2FIPm9VYAfUG0X9EvbUzqKublLmwZ3ouqL%2B8j8ByvceFcOxt9wIHUtC3iHpl5mB3qIFoXJoLR68glVp8i%2Fhto%2BngabpvBw%2Bz83nSMUYPVJV9s4a0%2B4l1juWNg6s1NwlU0LDTYQfbaka1NA6p4eGL59lX45eFWkypIRfhTbBDVTMuhQrca6EB32AVGHaNVNAXkPpPeUuHoQt6Mqrru3n2M3qnEmvgM7xNr4&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PBYIQ4TECY%2F20260311%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260311T163915Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=a45a4444b81a594fed938a634dff6edba0f3ca6405166df5ce57f1f732939c57", "filename": "408564_test.pdf", "uploaded_by": { "id": 408564, "company_id": 10004, "name": "sunil Forwarder", "firstname": "sunil", "lastname": "Forwarder", "contact": { "email": "sunil.vootkuri@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Accountant", "Compliance Officer FWD ", "Field Agent", "MBSiQ", "Remarketing FWD", "Team Lead", "Transportation FWD", "Vendor Manager", "VendorConnect Client", "VendorConnect Service Provider" ], "self": "http://stg-api.mbsisystems.com/api/employees/408564", "expand": "employee" }, "parent_attachment_order_id": null, "created_at": "2026-03-11 16:32:51", "meta": { "lat": "0.00000000", "long": "0.00000000", "generated_at": "2026-03-11 16:32:51", "created_at": "2026-03-11T16:32:51.000000Z" } }, { "id": 182214552, "type": { "id": 17, "name": "Condition Report", "always_show": 1, "is_required": 1, "type": "documents", "created_at": "2020-06-27 06:26:39", "updated_at": "2020-06-27 06:26:39", "deleted_at": null }, "order_attachment_type_id": 17, "order_id": 57070277, "name": "instruction-document", "document_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/orders/documents/10004/408564/2026/03/11/m3Fw4FE4Pkg4/408564_testing.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQCO2cYlZF1WZIjVTNHpeHdBGI%2FtN7es%2BQWx0nM%2B1j2CsAIhAJmZI53AnlwpkzGjY1iCGpvmtzsD4ErBkUzn27J1Q90dKrkFCGEQAxoMOTU2MTMyMDIxMTg3IgxWIZIT9rRwEmsdUBwqlgUeLvHcGp6jWSbYBW5vW6J9w6Uo0PK44xqPCf%2FgTe7QZ87qadngzhmWSNaV%2By73D2bzR%2FqGVjxghfdxnBkvPTKY3OeOuDoJXCUkngSwa31QD9t3RIQMWDyheF4hqRX6StXlhX8SAHU0ynaIN0H806CyfqW3EA2rUgEDCTUXMTCmCXZxNHxsR53VFzy0MNi1%2B247CnVXJ4iMwHGjo0pDhH1M8prKBNmGEckSEFz6pQ0OE2SmLCPAqDPiU3ppjpB%2BgzJ6ydlLHUkFLsrDQO8zBwBhuhCcbIvG0pExPa2dJxHhvz6V2KcWvC%2BQVFal2eYHc2BBD3bGhWHDTWEi1EvE5HmXXAxTyJXRxHwBJ4Y2vSNAsSq3LicSVzx0qFugr%2FwQ8xKuVEfs8L1EyAN61XbmjkqIa1w2KkVlgLbQi%2Bcc6BbR%2BL4BHM5EzJBuZyC5LXkjXbZqOWwmAHs22%2BxsI2dVys4q%2B%2BnvPZyxuwzGkm575wrnMfPBgvABU4WnPwPRGSit9HIUJy0IU7jworr5wrjmPOVzNT1LLErrJdDW7I3RLVm9mPmkOKV0LiWd63bJwCaF8BYnbQW3O4s7YQEk7qi5QWFfEMaZ4CX3C2Pnq4OBx9cHoUkY%2FsjHReaQeB%2ByMu1ZEK9uXloGlMhBtz%2BF8nGzy6hEAMoQsyQuksOd8D3sobOhk8tcrFlYTwEKyMJeF%2Bfm5bACzww6jsZGoFOB13mz5m6%2BBJ43KUOrzjdAbQfGoGbZJkgoP%2BCtlfvoQ6mr1eeAACEbUQtZE0ECbICJywqeSoj%2BCgnxBDHPYpzqb5WTfJkOIDZ5uvBWSstuwVLZFyuBIrUjDIgUDNDDtTdeLnnv27PaDHOq4BE04lbEAM%2BNedGvVSd%2BfHk7lTCnpsbNBjqwAWe9SV%2BxBKn%2FIPm9VYAfUG0X9EvbUzqKublLmwZ3ouqL%2B8j8ByvceFcOxt9wIHUtC3iHpl5mB3qIFoXJoLR68glVp8i%2Fhto%2BngabpvBw%2Bz83nSMUYPVJV9s4a0%2B4l1juWNg6s1NwlU0LDTYQfbaka1NA6p4eGL59lX45eFWkypIRfhTbBDVTMuhQrca6EB32AVGHaNVNAXkPpPeUuHoQt6Mqrru3n2M3qnEmvgM7xNr4&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PBYIQ4TECY%2F20260311%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260311T163915Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=74e6df0f08b1ba7d595afe676d2ebca9e24743733fabd62d762541fc07bac23f", "filename": "408564_testing.pdf", "uploaded_by": { "id": 408564, "company_id": 10004, "name": "sunil Forwarder", "firstname": "sunil", "lastname": "Forwarder", "contact": { "email": "sunil.vootkuri@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Accountant", "Compliance Officer FWD ", "Field Agent", "MBSiQ", "Remarketing FWD", "Team Lead", "Transportation FWD", "Vendor Manager", "VendorConnect Client", "VendorConnect Service Provider" ], "self": "http://stg-api.mbsisystems.com/api/employees/408564", "expand": "employee" }, "parent_attachment_order_id": null, "created_at": "2026-03-11 16:34:37", "meta": { "lat": "0.00000000", "long": "0.00000000", "generated_at": "2026-03-11 16:34:36", "created_at": "2026-03-11T16:34:37.000000Z" } }, { "id": 182214553, "type": { "id": 17, "name": "Condition Report", "always_show": 1, "is_required": 1, "type": "documents", "created_at": "2020-06-27 06:26:39", "updated_at": "2020-06-27 06:26:39", "deleted_at": null }, "order_attachment_type_id": 17, "order_id": 57070277, "name": "instruction-document", "document_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/orders/documents/10004/408564/2026/03/11/kKe3MsJk5daX/408564_testing.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJj%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQCO2cYlZF1WZIjVTNHpeHdBGI%2FtN7es%2BQWx0nM%2B1j2CsAIhAJmZI53AnlwpkzGjY1iCGpvmtzsD4ErBkUzn27J1Q90dKrkFCGEQAxoMOTU2MTMyMDIxMTg3IgxWIZIT9rRwEmsdUBwqlgUeLvHcGp6jWSbYBW5vW6J9w6Uo0PK44xqPCf%2FgTe7QZ87qadngzhmWSNaV%2By73D2bzR%2FqGVjxghfdxnBkvPTKY3OeOuDoJXCUkngSwa31QD9t3RIQMWDyheF4hqRX6StXlhX8SAHU0ynaIN0H806CyfqW3EA2rUgEDCTUXMTCmCXZxNHxsR53VFzy0MNi1%2B247CnVXJ4iMwHGjo0pDhH1M8prKBNmGEckSEFz6pQ0OE2SmLCPAqDPiU3ppjpB%2BgzJ6ydlLHUkFLsrDQO8zBwBhuhCcbIvG0pExPa2dJxHhvz6V2KcWvC%2BQVFal2eYHc2BBD3bGhWHDTWEi1EvE5HmXXAxTyJXRxHwBJ4Y2vSNAsSq3LicSVzx0qFugr%2FwQ8xKuVEfs8L1EyAN61XbmjkqIa1w2KkVlgLbQi%2Bcc6BbR%2BL4BHM5EzJBuZyC5LXkjXbZqOWwmAHs22%2BxsI2dVys4q%2B%2BnvPZyxuwzGkm575wrnMfPBgvABU4WnPwPRGSit9HIUJy0IU7jworr5wrjmPOVzNT1LLErrJdDW7I3RLVm9mPmkOKV0LiWd63bJwCaF8BYnbQW3O4s7YQEk7qi5QWFfEMaZ4CX3C2Pnq4OBx9cHoUkY%2FsjHReaQeB%2ByMu1ZEK9uXloGlMhBtz%2BF8nGzy6hEAMoQsyQuksOd8D3sobOhk8tcrFlYTwEKyMJeF%2Bfm5bACzww6jsZGoFOB13mz5m6%2BBJ43KUOrzjdAbQfGoGbZJkgoP%2BCtlfvoQ6mr1eeAACEbUQtZE0ECbICJywqeSoj%2BCgnxBDHPYpzqb5WTfJkOIDZ5uvBWSstuwVLZFyuBIrUjDIgUDNDDtTdeLnnv27PaDHOq4BE04lbEAM%2BNedGvVSd%2BfHk7lTCnpsbNBjqwAWe9SV%2BxBKn%2FIPm9VYAfUG0X9EvbUzqKublLmwZ3ouqL%2B8j8ByvceFcOxt9wIHUtC3iHpl5mB3qIFoXJoLR68glVp8i%2Fhto%2BngabpvBw%2Bz83nSMUYPVJV9s4a0%2B4l1juWNg6s1NwlU0LDTYQfbaka1NA6p4eGL59lX45eFWkypIRfhTbBDVTMuhQrca6EB32AVGHaNVNAXkPpPeUuHoQt6Mqrru3n2M3qnEmvgM7xNr4&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PBYIQ4TECY%2F20260311%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260311T163915Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=037b7ed5486475bcd2c0b22c494a708c758f45bfa3fc7fcfd5f97f81f28d3e6d", "filename": "408564_testing.pdf", "uploaded_by": { "id": 408564, "company_id": 10004, "name": "sunil Forwarder", "firstname": "sunil", "lastname": "Forwarder", "contact": { "email": "sunil.vootkuri@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Accountant", "Compliance Officer FWD ", "Field Agent", "MBSiQ", "Remarketing FWD", "Team Lead", "Transportation FWD", "Vendor Manager", "VendorConnect Client", "VendorConnect Service Provider" ], "self": "http://stg-api.mbsisystems.com/api/employees/408564", "expand": "employee" }, "parent_attachment_order_id": null, "created_at": "2026-03-11 16:35:20", "meta": { "lat": "0.00000000", "long": "0.00000000", "generated_at": "2026-03-11 16:35:20", "created_at": "2026-03-11T16:35:20.000000Z" } } ], "meta": { "total": 3 } } |