Applies to integrated customers using the RecoveryConnect API
Retrieve Assignments
Description: This endpoint retrieves the list of assignments associated with the authenticated user's company.
Assignments represent orders or tasks assigned to the company for processing. This endpoint allows users to retrieve all assignments and optionally filter the results using various query parameters such as collateral status, account number, client ID, or owner ID.
Pagination is supported to control the number of records returned per request.
URL: /api/v150/orders/{order_id}/assignments
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
status | Filter assignments by collateral status ID | No | ?status=1 |
acct_no | Filter assignments by assignment client account number | No | ?acct_no=123456 |
client_id | Filter assignments by assignment client ID | No | ?client_id=65690 |
owner_id | Filter assignments by assignment owner ID | No | ?owner_id=10004 |
per_page | Number of records returned per page. Default value is 250 | No | ?per_page=100 |
page | Specifies the page number of the results to retrieve | No | ?page=2 |
ids | Filter assignments by specific assignment IDs. Multiple IDs can be provided | No | ?ids=2649530,2649531 |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/assignments?status=1&client_id=65690 |
Request Body: NA
Response:
{ "data": [ { "id": 30554, "has_mbsi_source": null, "source": null, "other_refno": null, "client_id": 65690, "parent_order_id": 28758, "status_date": "2026-03-10 14:52:58", "is_violent": 0, "accepted_date": null, "tier_level": null, "placement_level": null, "created_at": "2016-02-26 18:32:33", "reopen_num": 1, "is_latest_case": 1, "client_accountno": "56545", "company_orderno": "1031-1", "agreement_type": null, "order_type": "Involuntary Repossession", "order_type_id": 1, "owner": { "meta": [], "id": 10002, "name": "Limited User Version Demo", "is_global": true, "phones": [ { "type": "Phone", "number": "111-111-1111", "extension": null }, { "type": "Toll-free", "number": "333-333-3333", "extension": null }, { "type": "Fax", "number": "222-222-2222", "extension": null } ], "self": "http://stg-api.mbsisystems.com/api/v140/companies/10002", "created_at": "2014-06-12 11:07:00", "updated_at": "2024-03-19 10:20:17" }, "client": { "meta": [], "id": 65690, "name": "Demo Bank & Trust MRS", "is_global": true, "phones": [], "self": "http://stg-api.mbsisystems.com/api/v140/companies/65690", "created_at": "2015-04-08 22:23:30", "updated_at": "2026-03-10 08:46:38" }, "lien_holder": { "meta": [], "id": 65690, "name": "Demo Bank & Trust MRS", "is_global": true, "phones": [], "self": "http://stg-api.mbsisystems.com/api/v140/companies/65690", "created_at": "2015-04-08 22:23:30", "updated_at": "2026-03-10 08:46:38" }, "collector": { "id": 12040, "company_id": 65690, "name": "Sam D", "firstname": "Sam", "lastname": "D", "contact": { "email": "anzenbrainard@gmail.com", "mobile_phone": null }, "roles": [ "Administrator Client", "Supervisor", "Alpha Tester", "Client Extended Permissions", "Claims Administrator" ], "self": "http://stg-api.mbsisystems.com/api/employees/12040", "expand": "employee" }, "tags": [], "mass_hold_tags": [], "borrower_details": [], "violent_event_details": [], "collateral_details": [ { "id": 28314, "is_primary": 1, "vehicle_type_id": 80, "vehicle_type": "Convertible", "year": "2014", "make": "Ford", "model": "Mustang", "color": "White Sand Tri-Coat Meta", "drive_train": "Rear Wheel Drive", "fuel_type": "Gasoline Fuel", "engine": "8 Cylinder Engine", "selling_dealer": "", "original_loan_amount": "0.00", "payment_amount": "0.00", "past_due_amount": "0.00", "unpaid_balance": "0.00", "chargeoff_date": "No Data", "key_codes": "-", "maximum_bailout": "0.00", "additional_info": "No Data", "contract_date": "No Data", "license_no": "133rtt", "license_state": "AZ", "license_exp": null, "vin": "1ZVBP8JZ9E5262008", "status": "Closed", "status_id": 1, "status_date": "2016-08-30 20:10:00", "status_reason": 19, "status_note": "", "on_hook_by": null, "assignment_on_hook_by": null, "vehicle_value": null, "created_at": "2016-02-26 18:32:33", "updated_at": "2019-10-31 13:55:05", "meta": [] } ], "address_details": [ { "id": 60104, "lpr_hit_id": null, "company_id": 10004, "parent_id": 56684, "orders_id": 30554, "address_id": 116080, "order_person": null, "category": 28, "dwelling": 4, "object_id": 0, "dwelling_type": 1, "employee": 11765, "created_at": "2016-02-26 18:32:33", "updated_at": "2019-01-04 18:47:41", "valid": 1, "invalid_address_reason": null, "order_collaterals_id": null, "is_accepted": 1, "is_public": 1, "is_pickup": 0, "is_reference": false, "last_update_by": null, "invalid_reason": null, "deleted_at": null, "address_details": { "id": 116080, "name": "Sister", "address_1": "48915 Schowalter Springs", "address_2": "", "unit": "", "zip": 48042, "type": 6, "latitude": "32.78612400", "longitude": "-116.96896800", "date_delay": null, "available_from": "00:00:00", "available_to": "23:59:00", "priority": 0, "hits": 0, "no_contact": 0, "created_at": "2016-02-19 18:08:23", "updated_at": "2023-09-29 06:31:36", "deleted_at": null, "migration": null, "phones": [], "zip_code_details": { "zip_code_id": 48042, "zip_code": "92020", "zip_code_city_id": 48041, "city_name": "El Cajon", "zip_code_state_id": 47459, "state_name": "California", "state_abbr": "CA", "state_county": "CA-San Diego", "zip_code_county_id": 47992, "county_name": "San Diego", "latitude": "32.793886", "longitude": "-116.965928", "system_msg": 0, "country": "United States of America", "country_code": "US", "trigger_msg": 0, "shape_data": "[[[\"-117.005957\",\"32.79439\",\"0.0\"],[\"-117.009807\",\"32.816385\",\"0.0\"],[\"-116.961418\",\"32.825183\",\"0.0\"],[\"-116.944372\",\"32.79494\",\"0.0\"],[\"-116.944922\",\"32.756999\",\"0.0\"],[\"-116.988911\",\"32.780093\",\"0.0\"],[\"-117.005957\",\"32.79439\",\"0.0\"]]]" } }, "category_details": { "id": 28, "name": "SISTER", "friendlyname": "Sister", "created_at": "2021-12-09 02:47:49", "updated_at": "2021-12-09 02:47:49", "deleted_at": null }, "dwelling_details": { "id": 4, "name": "single_family_unverified", "friendlyname": "Single Family (Unverified)", "created_at": null, "updated_at": null, "deleted_at": null } } ], "special_instructions": [], "number_of_runs": 0, "client_office_location": { "id": 4, "name": "Main", "address_1": "2345 Forwarding Comp Strret", "address_2": "", "state_abbr": "SD", "city_name": "Watertown", "zip_code": "57201", "county_name": "Codington", "longitude": "-27.18551000", "latitude": "24.11170100", "unit": null }, "order_location": { "id": 2, "name": null, "address_1": "1222 N Main Ave", "address_2": "", "state_abbr": "CA", "city_name": "San Diego", "zip_code": "92120", "county_name": "San Diego", "longitude": null, "latitude": null, "unit": null } } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/assignments?q=%2Fapi%2Fv140%2Fassignments&status=1&client_id=65690&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/assignments?q=%2Fapi%2Fv140%2Fassignments&status=1&client_id=65690&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/assignments", "per_page": "20", "to": 1, "total": 1, "orderby": "id", "direction": "asc", "orderby_options": [ "id" ] }, "warnings": [] } |
9.6 Attach Photo on Assignment
Description: This endpoint uploads and attaches a photo to a specific assignment.
Assignment photos are used to capture visual evidence or supporting information related to the assignment, such as vehicle condition, recovery location, or other relevant documentation. The image must be provided as a Base64 encoded string along with metadata including the file name, image name, capture time, and photo type.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/assignments/{assignment_id}/photos
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
file_name | Name of the uploaded image | Yes | test |
document_name | Display name or label used to identify the photo | Yes | instruction-document |
data | Base64 encoded image data representing the photo file | Yes | iVBORw0KGgoAAAANSUhEUgAAAAE |
type | Identifier representing the photo type | No | 2 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/assignments/2649530/photos |
Request Body:
{ "file_name": "test", "image_name": "image name", "picture_time": "2019-10-17 23:23:00", "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=", "type": 2 } |
Response:
{ "data": { "order_id": 2571069, "type": 0, "case_attachment_type_id": 1, "recovery_has_damage_type_location_id": null, "attachment_id": 6928498, "recovery_id": null } } |
9.7 Attach Document on Assignment
Description: This endpoint uploads and attaches a document to a specific assignment.
Documents can be added to support assignment-related activities such as instructions, reports, legal documents, invoices, or other supporting files. The document file must be provided as a Base64 encoded string, along with metadata such as file name, document name, and attachment type.
URL: /api/v150/assignments/{assignment_id}/documents
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
file_name | Name of the uploaded file including extension | Yes | test.pdf |
document_name | Display name or label used to identify the document | Yes | instruction-document |
data | Base64 encoded image data representing the photo file | Yes | iVBORw0KGgoAAAANSUhEUgAAAAE |
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/assignments/57075006/photos |
Request Body:
{ "file_name": "testing.pdf", "document_name": "instruction-documentfile", "data": "SFRUUC8xLjAgMjAwIE9LDQpDYWNoZS1Db250cm9sO………..”, "type": 2 } |
Response:
{ "data": { "order_id": "57075006", "type": 2, "attachment_id": 180460833, "case_attachment_type_id": 1, "id": 182214265 }, "status": "success" } |