Applies to integrated customers using the RecoveryConnect APIGet Order Documents
Description: This endpoint retrieves all documents associated with a specific order. Documents may include reports, PDFs, or other order-related files.
URL: /api/v130/orders/{order_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/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", "company_id": 10001 }, "created_at": "2020-05-25", "parent_attachment_order_id": 17362633, "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 } } |
Add Order Documents
Description: This endpoint uploads and associates documents with a specific order. Documents may include PDFs, reports, or other order-related files.
URL: /api/v130/orders/{order_id}/documents
Method: POST
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| file_name | Original name of the uploaded file | Yes | test.pdf |
| document_name | Display name or title of the document | Yes | instruction-document |
| data | Base64-encoded string of the document file | Yes | dGhpcyBpcyBzYW1wbGUgcGRm |
| type | Numeric code representing document type | Yes | 2 |
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/documents |
Request Body:
{ "file_name": "test.pdf", "document_name": "instruction-document", "data": "dGhpcyBpcyBzYW1wbGUgcGRm", "type": 2 } |
Response:
{ "data": { "id": 12323, "case_attachment_type_id": 2, "order_id": 231533, "attachment_id": 6929015, "type": 2 }, "status": "success" } |
View Particular Document of Order
Description: This endpoint retrieves a specific document associated with a particular order.
URL: /api/v130/orders/{order_id}/documents/{document_id}
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/documents/182164733 |
Request Body: NA
Response:
{ "data": { "id": 182164733, "type": { "id": 20, "name": "Personal Property", "always_show": 1, "is_required": 0, "type": "documents", "created_at": "2020-01-20 15:12:16", "updated_at": "2020-06-27 06:26:39", "deleted_at": null }, "order_attachment_type_id": 20, "order_id": 56934626, "name": "Personal Property Completion", "document_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/documents/10001/10000/2025/09/25/W2rcKRl0bgbD/personal_property_completion.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEO3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCICSlhU4qhvTjCOR0%2BA4sxDJMwM%2FX4JgnfTn6YFxXsWADAiB4o7M1gjfSslehy%2FWGXbQhNazCWnkhIsxEWB8z5FwiFyq5BQh2EAMaDDk1NjEzMjAyMTE4NyIMm1pmWl7gqYMnEl4aKpYFbEW9vrl2CileVeVapXVbNmZjze7yYkNRDJIzFOxX2PmpgRbDmnkWiln8G1UkcFLBsM2WcCRa6gBJGNE2cy%2BcPc8pUG%2Boq3ToSyON62%2FnTiUsJhVo3edL%2BP%2BNQWLxk%2FUXj47%2BJAqWRwPqkO0McnFpGWHrlecAcS3rdZn8yaMy17pUJdvHoonaUJZoivJdZGskcWwSPov99sFOcYQDqxcuYuGVwWjiq09j5wU0V8C4%2BYK4mhyk%2FGRmdTEjCIcojvhWXNAMFPy7No31YDSZ%2BTSnCt6nsNyIEUXveSYZGxWY37FsD4t7X3cwn%2BUjwJiYXFEjpq8PPgJUiyzW4%2F55b0FpdX6HIIPT0Wl5hqDPF1SK6iCLG9VcCxR7aadC0Giz70NXWxhp2eGK7Y%2FiWovEkpTG4ksSzdqUlv9%2BHeD8oyTFYLMaqLp5Nx63ZpbkuhMlIxxRjhJLOxoErMapb66UILoN2NoZClb6%2FelIl8EAgw0YKzH58dBDj9%2BkQI5biMkyCjGP2Fx8dUm%2Bq%2BPB4RTBi9fn4Ox2Op2I8JCQhwtDxfcLWwru%2FdUyoUXMt2CdMJbxUKBsqUpIQnTGIKKKD8kiyEcnOtl%2FHsmCtMZVF2NCnveVgvFo4q7Wbgp%2Bz1RVOx1YlkRgxS4wLR7wYgclCQMnChR7DexGBIXD8IM3sMg8j1g34xibWYcxtEiOQwdNzvaWXm3CoWxBB%2B9gcdRiGj52UsaqZUu53j%2FuRvTpRQjAN5Z0n9WOsBIHf%2FP6MijIcbJDg1NYjgQ9JQOrHFYPpwBTJr%2FPqcDxnRryJfraxY04%2BhZAK7s2BllzlogH8AM0ycGDxYdXwwnW34Ho3id9VxL9ZCLvtKb3W1oUFohsRwHMTfkM2imc6JQat18wxvbUxgY6sgGqIUop8yWKTc64qZfUtlgy4W7fDfskkUDhnuiWLwh1z16YFAAd6toT2NSxf28tE1Ndivas%2BMb516lGF0MLlKmSbzbC4wmlvnpog11Z2%2BNien9RFQcd5KLr0bgR2NZaWJ79bDtyuVMOrzXjebaaI0274op1KybRXgjl1G5B2NAvx91ytVy1JmpMx8UejHuXXx4e5KxRgfIivxjhNhlHmkhzEC3kP7G8B9BaMRGkd%2BviLQ9c&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PBQJWMAL53%2F20250925%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250925T131823Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=13c12755956aff790dac38784c8cd989a4c400c68bba1da1336198caa3c2902b", "filename": "personal_property_completion.pdf", "uploaded_by": { "id": 10000, "company_id": 10000, "name": "Root Account", "firstname": "Root", "lastname": "Account", "contact": { "email": "ruthermasiglat@gmail.com", "mobile_phone": null }, "roles": [ "MRS Admin Owner", "Super User", "Case Worker FWD" ], "self": "http://stg-api.mbsisystems.com/api/employees/10000", "expand": "employee" }, "parent_attachment_order_id": null, "created_at": "2025-09-25 09:01:42", "meta": null } } |
Transfer Particular Document of Order
Description: This endpoint transfers a specific document of an order to another order.
URL: /api/v130/orders/{order_id}/documents/transfer
Method: PUT
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| transfer_to | Array of order IDs to transfer the document to | Yes | [262552] |
Success Code: 200 OK – Request Successful
Example:
URL: https://stg-api.mbsisystems.com/api/v130/orders/56934626/documents/transfer |
Request Body:
{ "transfer_to": [ 262552 ] } |
Response:
{ "orders": [ { "id": 262552, "attachments": [ { "id": 6299652, "status": "fail" } ] } ] } |