Applies to integrated customers using the RecoveryConnect API
Document Operations
The Document Operations section provides endpoints used to manage documents associated with orders and recovery records. These endpoints allow users to upload, retrieve, update, and transfer documents such as condition reports, invoices, receipts, and other supporting files related to an order.
All requests must include a valid Bearer token in the request header.
Retrieve Order Documents
Description: This endpoint retrieves the list of documents associated with a specific order.
Order documents may include case-related files such as reports, instructions, agreements, or other attachments uploaded during the order lifecycle. This endpoint returns all documents that have been attached to the specified order.
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/documents
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57066341/documents |
Request Body: NA
Response:
{ "data": [ { "id": 182214604, "type": { "id": 1005, "name": "Drop-off Form", "always_show": 0, "is_required": 0, "type": "documents", "created_at": "2024-01-05 08:42:48", "updated_at": "2024-01-05 08:42:48", "deleted_at": null }, "order_attachment_type_id": 1005, "order_id": 57066341, "name": "Untitled", "document_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/orders/documents/10004/424549/2026/03/12/MnHEAhVwKyse/download.jpeg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEK7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIAC%2BSqcqZA0QGzvoAYY1lOWIe%2Be7BAdP6Dn90KJ1LPJ9AiAvY5esXprnCwtEdMS2c2NpaTKtLDslOrz%2BteSIioGhPCq5BQh3EAMaDDk1NjEzMjAyMTE4NyIM1P09pIgHzCEi4h28KpYFvGNed%2BHL6pxAwrEU1kK6yaJYocWcJP3ByJIYWIagoCztGKLRoaby%2BCGT4bAQT%2FSe9lG7OhH9C5NLyoryjsf1%2BKCr4ExYcVnYeUtvCpJCIztphXorChGyx9%2FgixyydlG7odhcffBjWOljok3xLTSyL%2BqEVplubQlQq9TtgmYWU910c%2F77h%2FKNhPx%2F9ZRYropXXIcY6jI4dm05sUS36P5cVtgsLeT8EoqkajJKeEEg179G8lV9rRvwNEJ79A6cL0txIHDWjWlLl%2F6LBLnQQbE1vFUgjsnJghN6nkzoowwKC5jO325tTOWDvD6UDNW3ze4u96oTvtNFlTwaicIzLcAfGVitoct3tQKJHeCtNyyLo%2Fan2NL32l6UHIYaJzl5CFPCmc5dSjRDXXRHNrQh0TOaVYZf81PH1uveX6OpuE9BH8eQAgEdq7JQmtzLNztAJi7GjcUA7qBYCRkGYVmnxGxAe0AigvrxbeM8qZFHVfzf6%2BehnR53OmoZbclNsiM0BtdkNsHn3f65bmafoe9aFnqa0PkV5WVzdZ098EL9hIvAcWKVKFMMdYYz8drVY%2FXR%2FjGQAnE0WTULENK0PojS01by2vxNwSSpJIk3VNo7qszJ7Dyb3fPMPUD%2BGloXL5GMvzlJCRCiYqdUEvJn8gouCVwv9P%2B%2BLFjs6NxFitEvVy%2F6groUiv2ZsTSnK1ezxl1H2k78BYl1R6UXVT0TLffTMlFOsZj5m85l47JJhs7LgmLM1myxZqx4izsXfjJYeTPmonHr0GzG3x9SmUQaGTG6Px3FHpXLydG5R26Hk8i3IIz01iCXil7JMY6HwFs3e56ITN2wc%2BckJVE7ETJcmb9NRthDrpgfQOEkT4vuUGFxIW6bfOvP1Sj5muAw7IjLzQY6sgGzVvWraJb2g66lol8PAJeFQd4tIXj673mIGMyJqNlMlYcVtmulDOCR6OtHcMGl6eK8rMTSKi1cPyWcVNQnhxV%2BQ4V21YDFHnYO7loi0nY%2F8Vdg51ZIrNPieoJQjOkfA2Nwr52wItCy2oaY%2F7A3SuH8bpL6SWy5JZYguM5Zk8CBq%2BG%2FA21Nr8atI3Qts2BtsUvwXipVExX0ZKuYKl36NnkW0CkERonuAfsN89FeX7TuQoI0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PB6Y5SXYKD%2F20260312%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260312T143551Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=92532bd84f38ad1a9d56e625d25ecbe1ccbeb50b21f4d540eed67c9d8a5d92b5", "filename": "download.jpeg", "uploaded_by": { "id": 424549, "company_id": 10004, "name": "Vinay Forwarder", "firstname": "Vinay", "lastname": "Forwarder", "contact": { "email": "vinay.band@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Compliance Officer FWD ", "Field Agent", "Accountant", "MBSiQ", "Transportation FWD" ], "self": "http://stg-api.mbsisystems.com/api/employees/424549", "expand": "employee" }, "parent_attachment_order_id": null, "created_at": "2026-03-12 14:32:26", "meta": null }, { "id": 182214605, "type": { "id": 38, "name": "Misc. Document", "always_show": 0, "is_required": 0, "type": "documents", "created_at": "2020-06-27 04:30:24", "updated_at": "2020-06-27 06:26:39", "deleted_at": null }, "order_attachment_type_id": 38, "order_id": 57066341, "name": "Untitled", "document_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/orders/documents/10004/424549/2026/03/12/YknGYOa3zGjE/images.jpeg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEK7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIAC%2BSqcqZA0QGzvoAYY1lOWIe%2Be7BAdP6Dn90KJ1LPJ9AiAvY5esXprnCwtEdMS2c2NpaTKtLDslOrz%2BteSIioGhPCq5BQh3EAMaDDk1NjEzMjAyMTE4NyIM1P09pIgHzCEi4h28KpYFvGNed%2BHL6pxAwrEU1kK6yaJYocWcJP3ByJIYWIagoCztGKLRoaby%2BCGT4bAQT%2FSe9lG7OhH9C5NLyoryjsf1%2BKCr4ExYcVnYeUtvCpJCIztphXorChGyx9%2FgixyydlG7odhcffBjWOljok3xLTSyL%2BqEVplubQlQq9TtgmYWU910c%2F77h%2FKNhPx%2F9ZRYropXXIcY6jI4dm05sUS36P5cVtgsLeT8EoqkajJKeEEg179G8lV9rRvwNEJ79A6cL0txIHDWjWlLl%2F6LBLnQQbE1vFUgjsnJghN6nkzoowwKC5jO325tTOWDvD6UDNW3ze4u96oTvtNFlTwaicIzLcAfGVitoct3tQKJHeCtNyyLo%2Fan2NL32l6UHIYaJzl5CFPCmc5dSjRDXXRHNrQh0TOaVYZf81PH1uveX6OpuE9BH8eQAgEdq7JQmtzLNztAJi7GjcUA7qBYCRkGYVmnxGxAe0AigvrxbeM8qZFHVfzf6%2BehnR53OmoZbclNsiM0BtdkNsHn3f65bmafoe9aFnqa0PkV5WVzdZ098EL9hIvAcWKVKFMMdYYz8drVY%2FXR%2FjGQAnE0WTULENK0PojS01by2vxNwSSpJIk3VNo7qszJ7Dyb3fPMPUD%2BGloXL5GMvzlJCRCiYqdUEvJn8gouCVwv9P%2B%2BLFjs6NxFitEvVy%2F6groUiv2ZsTSnK1ezxl1H2k78BYl1R6UXVT0TLffTMlFOsZj5m85l47JJhs7LgmLM1myxZqx4izsXfjJYeTPmonHr0GzG3x9SmUQaGTG6Px3FHpXLydG5R26Hk8i3IIz01iCXil7JMY6HwFs3e56ITN2wc%2BckJVE7ETJcmb9NRthDrpgfQOEkT4vuUGFxIW6bfOvP1Sj5muAw7IjLzQY6sgGzVvWraJb2g66lol8PAJeFQd4tIXj673mIGMyJqNlMlYcVtmulDOCR6OtHcMGl6eK8rMTSKi1cPyWcVNQnhxV%2BQ4V21YDFHnYO7loi0nY%2F8Vdg51ZIrNPieoJQjOkfA2Nwr52wItCy2oaY%2F7A3SuH8bpL6SWy5JZYguM5Zk8CBq%2BG%2FA21Nr8atI3Qts2BtsUvwXipVExX0ZKuYKl36NnkW0CkERonuAfsN89FeX7TuQoI0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PB6Y5SXYKD%2F20260312%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260312T143551Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=a39367cf392e3c52dff9032fa79a77b854c783e770d588c1ca218a8553dada1e", "filename": "images.jpeg", "uploaded_by": { "id": 424549, "company_id": 10004, "name": "Vinay Forwarder", "firstname": "Vinay", "lastname": "Forwarder", "contact": { "email": "vinay.band@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Compliance Officer FWD ", "Field Agent", "Accountant", "MBSiQ", "Transportation FWD" ], "self": "http://stg-api.mbsisystems.com/api/employees/424549", "expand": "employee" }, "parent_attachment_order_id": null, "created_at": "2026-03-12 14:32:27", "meta": null } ], "meta": { "total": 2 } } |
Attach Document to Order
Description: This endpoint uploads and attaches a document to a specific order.
Order documents may include case instructions, reports, agreements, or other supporting files associated with the order. The document must be provided as a Base64 encoded string along with metadata such as the file name and document name.
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/documents
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
file_name | Name of the uploaded document including the 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 | No | 2 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57066341/documents |
Request Body:
{ "file_name": "generaldocument.pdf", "document_name": "interior-document", "data": "CiVQREYtMS43CiXDpMO8w7bDnwoyIDAgb2Jq……, |
Response:
{ "data": { "order_id": "57066341", "type": 2, "attachment_id": 180461136, "case_attachment_type_id": 1, "id": 182214626 }, "status": "success" } |
Retrieve Order Document
Description: This endpoint retrieves the details of a specific document attached to an order.
Order documents may include instructions, reports, agreements, or other supporting files associated with the order. By providing the order ID and document ID, this endpoint returns the metadata and information for the specified document.
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/documents/{document_id}
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57066341/documents/182214604 |
Request Body: NA
Response:
{ "data": { "id": 182214604, "type": { "id": 1005, "name": "Drop-off Form", "always_show": 0, "is_required": 0, "type": "documents", "created_at": "2024-01-05 08:42:48", "updated_at": "2024-01-05 08:42:48", "deleted_at": null }, "order_attachment_type_id": 1005, "order_id": 57066341, "name": "Untitled", "document_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/orders/documents/10004/424549/2026/03/12/MnHEAhVwKyse/download.jpeg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEK7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIAC%2BSqcqZA0QGzvoAYY1lOWIe%2Be7BAdP6Dn90KJ1LPJ9AiAvY5esXprnCwtEdMS2c2NpaTKtLDslOrz%2BteSIioGhPCq5BQh3EAMaDDk1NjEzMjAyMTE4NyIM1P09pIgHzCEi4h28KpYFvGNed%2BHL6pxAwrEU1kK6yaJYocWcJP3ByJIYWIagoCztGKLRoaby%2BCGT4bAQT%2FSe9lG7OhH9C5NLyoryjsf1%2BKCr4ExYcVnYeUtvCpJCIztphXorChGyx9%2FgixyydlG7odhcffBjWOljok3xLTSyL%2BqEVplubQlQq9TtgmYWU910c%2F77h%2FKNhPx%2F9ZRYropXXIcY6jI4dm05sUS36P5cVtgsLeT8EoqkajJKeEEg179G8lV9rRvwNEJ79A6cL0txIHDWjWlLl%2F6LBLnQQbE1vFUgjsnJghN6nkzoowwKC5jO325tTOWDvD6UDNW3ze4u96oTvtNFlTwaicIzLcAfGVitoct3tQKJHeCtNyyLo%2Fan2NL32l6UHIYaJzl5CFPCmc5dSjRDXXRHNrQh0TOaVYZf81PH1uveX6OpuE9BH8eQAgEdq7JQmtzLNztAJi7GjcUA7qBYCRkGYVmnxGxAe0AigvrxbeM8qZFHVfzf6%2BehnR53OmoZbclNsiM0BtdkNsHn3f65bmafoe9aFnqa0PkV5WVzdZ098EL9hIvAcWKVKFMMdYYz8drVY%2FXR%2FjGQAnE0WTULENK0PojS01by2vxNwSSpJIk3VNo7qszJ7Dyb3fPMPUD%2BGloXL5GMvzlJCRCiYqdUEvJn8gouCVwv9P%2B%2BLFjs6NxFitEvVy%2F6groUiv2ZsTSnK1ezxl1H2k78BYl1R6UXVT0TLffTMlFOsZj5m85l47JJhs7LgmLM1myxZqx4izsXfjJYeTPmonHr0GzG3x9SmUQaGTG6Px3FHpXLydG5R26Hk8i3IIz01iCXil7JMY6HwFs3e56ITN2wc%2BckJVE7ETJcmb9NRthDrpgfQOEkT4vuUGFxIW6bfOvP1Sj5muAw7IjLzQY6sgGzVvWraJb2g66lol8PAJeFQd4tIXj673mIGMyJqNlMlYcVtmulDOCR6OtHcMGl6eK8rMTSKi1cPyWcVNQnhxV%2BQ4V21YDFHnYO7loi0nY%2F8Vdg51ZIrNPieoJQjOkfA2Nwr52wItCy2oaY%2F7A3SuH8bpL6SWy5JZYguM5Zk8CBq%2BG%2FA21Nr8atI3Qts2BtsUvwXipVExX0ZKuYKl36NnkW0CkERonuAfsN89FeX7TuQoI0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PB6Y5SXYKD%2F20260312%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260312T145019Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=1eaf651d51d744d7273adf002b66c094fde07c623c83543a75ae3390655647ae", "filename": "download.jpeg", "uploaded_by": { "id": 424549, "company_id": 10004, "name": "Vinay Forwarder", "firstname": "Vinay", "lastname": "Forwarder", "contact": { "email": "vinay.band@esgit.com", "mobile_phone": null }, "roles": [ "Administrator FWD", "Billing Manager", "Billing Staff ", "Billing Supervisor", "Case Worker FWD", "Compliance Officer FWD ", "Field Agent", "Accountant", "MBSiQ", "Transportation FWD" ], "self": "http://stg-api.mbsisystems.com/api/employees/424549", "expand": "employee" }, "parent_attachment_order_id": null, "created_at": "2026-03-12 14:32:26", "meta": null } } |
Transfer Order Documents
Description: This endpoint transfers documents associated with a specific order to another order.
The target order must be specified using the client order ID. The transfer_to value represents the client order ID of the order where the documents will be transferred, not the internal system order ID.
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/documents/transfer
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE | |
transfer_to | Array containing the client order ID(s) of the order(s) to which the documents will be transferred | Yes | 57066350
|
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57066351/documents/transfer |
Request Body:
{ "transfer_to": [ 57066350 ] } |
Response:
{ |
Transfer Specific Document of Order
Description: This endpoint transfers a specific document associated with an order to Client order.
The target order must be specified using the client order ID. The transfer_to field represents the client order ID of the destination order.
All requests must include a valid Bearer Token in the request header.
URL: /api/v140/orders/{order_id}/documents/{document_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE | |
transfer_to | Array containing the client order ID(s) of the order(s) to which the documents will be transferred | Yes | 57066329
|
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57066351/documents/182214748 |
Request Body:
{ "transfer_to": [ 57066329 ] } |
Response:
{ "orders": [ { "id": 57066329, "attachments": [ { "id": 180461229, "status": "success" } ] } ] } |