Applies to integrated customers using the RecoveryConnect APIAttach a photo to the 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/v130/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/v130/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 } } |
Attach the document to the 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/v130/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/v130/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" } |
Create Assignment Address
Description: This endpoint creates a new address record associated with a specific assignment.
Assignment addresses represent locations related to an assignment, such as borrower addresses, investigation locations, or other relevant sites connected to the assignment workflow. This endpoint allows users to add a new address and provide details including address lines, unit number, geographic coordinates, and address category.
URL: /api/v130/assignments/{assignment_id}/addresses
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
name | Name or label used to identify the address | Yes | Home Address |
address_1 | Primary address line | Yes | 3620 W Greenway Rd |
address_2 | Secondary address line or additional address information | No | 3620 W Cliffland Phoenix, AZ Phoenix AZ 85014 |
zip | Zip or postal code of the address | Yes | 83012 |
unit | Apartment, suite, or unit number within the address | No | 1234 |
type_id | Identifier representing the address type (refer to Address Type IDs reference table) | No | 1 |
category_id | Identifier representing the address category (refer to Address Category ID Mapping table) | No | 1 |
latitude | Latitude coordinate of the address location | No | 0 |
longitude | Longitude coordinate of the address location | No | 0 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/assignments/57075006/addresses |
Request Body:
{ "name": "Home Address", "address_1": "4600 W Greenway Rd", "address_2": "36220 W Cliffland Phoenix, AZ Phoenix AZ 85014", "zip": 83012, "unit": 1234, "type_id": 1, "category_id": 1, "latitude": 0, "longitude": 0 } |
Response:
{ "data": { "id": 219115412, "created_at": "2026-03-10 17:53:43", "dwelling_type": "Unknown Type", "category": "3rd Party Address", "category_type": "3rdparty2", "address_id": 120094473, "name": "Home Address", "address_1": "4600 W Greenway Rd", "address_2": "36220 W Cliffland Phoenix, AZ Phoenix AZ 85014", "state_abbr": "WY", "city_name": "Moose", "zip_code": "83012", "county_name": "Teton", "longitude": -112.072549, "latitude": 33.448295, "unit": 1234 }, "status": "success" } |
Create Assignment Address
Description: This endpoint creates a new address record associated with a specific assignment.
Assignment addresses represent locations related to an assignment, such as borrower addresses, investigation locations, or other relevant sites connected to the assignment workflow. This endpoint allows users to add a new address and provide details including address lines, unit number, geographic coordinates, and address category.
URL: /api/v130/assignments/{assignment_id}/addresses
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
name | Name or label used to identify the address | Yes | Home Address |
address_1 | Primary address line | Yes | 3620 W Greenway Rd |
address_2 | Secondary address line or additional address information | No | 3620 W Cliffland Phoenix, AZ Phoenix AZ 85014 |
zip | Zip or postal code of the address | Yes | 83012 |
unit | Apartment, suite, or unit number within the address | No | 1234 |
type_id | Identifier representing the address type (refer to Address Type IDs reference table) | No | 1 |
category_id | Identifier representing the address category (refer to Address Category ID Mapping table) | No | 1 |
latitude | Latitude coordinate of the address location | No | 0 |
longitude | Longitude coordinate of the address location | No | 0 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/assignments/57075006/addresses |
Request Body:
{ "name": "Home Address", "address_1": "4600 W Greenway Rd", "address_2": "36220 W Cliffland Phoenix, AZ Phoenix AZ 85014", "zip": 83012, "unit": 1234, "type_id": 1, "category_id": 1, "latitude": 0, "longitude": 0 } |
Response:
{ "data": { "id": 219115412, "created_at": "2026-03-10 17:53:43", "dwelling_type": "Unknown Type", "category": "3rd Party Address", "category_type": "3rdparty2", "address_id": 120094473, "name": "Home Address", "address_1": "4600 W Greenway Rd", "address_2": "36220 W Cliffland Phoenix, AZ Phoenix AZ 85014", "state_abbr": "WY", "city_name": "Moose", "zip_code": "83012", "county_name": "Teton", "longitude": -112.072549, "latitude": 33.448295, "unit": 1234 }, "status": "success" } |
Create Assignment Case Alert
Description: This endpoint creates a case alert associated with a specific assignment.
The alert can be configured with a message content, a scheduled date and time, and an intrusive flag indicating whether the alert should be displayed prominently to the user.
URL: /api/v130/assignments/{assignment_id}/casealerts
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
content | Message or description of the case alert | No | Test Content |
scheduled_at | Date and time when the alert should be triggered | Yes | 2026-03-20 05:50:00
|
is_intrusive | Indicates whether the alert is intrusive (1 = Intrusive alert, 0 = Non-intrusive alert) | Yes | 1 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v130/assignments/57075642/casealerts |
Request Body:
{ "content": "Case alert reach out to admin", "scheduled_at": "2026-03-20 05:50:00", "is_intrusive": 1 } |
Response:
{ "data": { "id": 130529, "order_id": 57075642, "added_by": 408564, "viewable_by_id": null, "viewable_by": "all", "content": "Case alert reach out to admin", "scheduled_at": "2026-03-20 05:50:00", "is_intrusive": 1, "created_at": "2026-03-11 10:17:27", "updated_at": "2026-03-11 10:17:27", "deleted_at": null }, "meta": { "fixme": { "message": "GenericResource: create specific resource object", "source": { "file": "/var/www/mobile_dev/releases/20210210171746/versions/v140/app/Http/Controllers/Api/Mixins/Actions/Get/Assignments.php", "line": 138, "function": "__construct", "class": "App\\Http\\Resources\\GenericResource", "type": "->" } } } } |