Applies to integrated customers using the RecoveryConnect API
Get Case Tags for Company
Description: This endpoint retrieves the list of case tags configured for a specific company.
Case tags are used to categorize and label assignments or cases for easier tracking, filtering, and workflow management. By providing the company ID, this endpoint returns all tags that are available for use within that company.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/companies/{company_id}/tags
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/companies/10001/tags |
Request Body: NA
Response:
{ "data": [ { "id": 4, "company_id": 10001, "employee_id": 10100, "name": "Test tag ", "seq": 13, "created_at": "2014-10-28 09:43:02", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 5, "company_id": 10001, "employee_id": 201364, "name": "", "seq": 0, "created_at": "2014-10-28 13:56:57", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 6, "company_id": 10001, "employee_id": null, "name": "Hold for paperwork", "seq": 6, "created_at": "2014-10-28 13:58:47", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 7, "company_id": 10001, "employee_id": null, "name": "Do not deliver to auction", "seq": 4, "created_at": "2014-10-28 13:59:18", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 12, "company_id": 10001, "employee_id": null, "name": "Pending", "seq": 10, "created_at": "2015-04-13 22:29:19", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 15, "company_id": 10001, "employee_id": null, "name": "Active", "seq": 1, "created_at": "2015-04-15 22:38:36", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 19, "company_id": 10001, "employee_id": null, "name": "Assign Agent", "seq": 3, "created_at": "2015-05-11 16:52:08", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 28, "company_id": 10001, "employee_id": 10044, "name": "test", "seq": 11, "created_at": "2015-06-23 11:28:17", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 595, "company_id": 10001, "employee_id": 10009, "name": "Active Military (SCRA) Hit", "seq": 2, "created_at": "2016-12-11 00:37:14", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 607, "company_id": 10001, "employee_id": 10013, "name": "Holiday Hold", "seq": 7, "created_at": "2016-12-12 18:48:27", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 1974, "company_id": 10001, "employee_id": 10163, "name": "No Contact", "seq": 9, "created_at": "2018-06-27 21:54:27", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 2319, "company_id": 10001, "employee_id": 66978, "name": "Hold for Debtor Redemption", "seq": 5, "created_at": "2019-03-14 21:56:44", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 2433, "company_id": 10001, "employee_id": 10058, "name": "Need to cut key", "seq": 8, "created_at": "2019-06-26 16:57:31", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 2561, "company_id": 10001, "employee_id": 10100, "name": "test 123", "seq": 12, "created_at": "2020-02-06 20:14:27", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 2610, "company_id": 10001, "employee_id": 83269, "name": "test-duplicate key", "seq": 14, "created_at": "2020-04-15 16:58:06", "updated_at": "2023-11-03 02:02:35", "deleted_at": null }, { "id": 4261, "company_id": 10001, "employee_id": 420698, "name": "shilpa test tag", "seq": null, "created_at": "2024-01-17 13:20:46", "updated_at": "2024-01-17 13:20:46", "deleted_at": null }, { "id": 4314, "company_id": 10001, "employee_id": 423495, "name": "bonus", "seq": null, "created_at": "2024-11-27 11:28:26", "updated_at": "2024-11-27 11:28:26", "deleted_at": null }, { "id": 4317, "company_id": 10001, "employee_id": null, "name": "Bonus Program", "seq": null, "created_at": "2024-12-02 12:07:18", "updated_at": "2024-12-02 12:07:18", "deleted_at": null }, { "id": 4345, "company_id": 10001, "employee_id": 423270, "name": "Borrower Violent", "seq": null, "created_at": "2025-01-21 12:21:01", "updated_at": "2025-01-21 12:21:01", "deleted_at": null } ], "meta": { "fixme": { "message": "GenericCollectionResource: create specific resource collection object", "source": { "file": "/var/www/mobile_dev/releases/20210210171746/versions/v140/app/Http/Resources/GenericResource.php", "line": 19, "function": "__construct", "class": "App\\Http\\Resources\\GenericCollectionResource", "type": "->" } } } } |
Get Special Instructions for Company
Description: This endpoint retrieves the special instructions configured for a specific company.
Special instructions are used to store important operational guidelines, notes, or requirements that should be followed when handling cases, assignments, or recoveries associated with the company. These instructions help ensure that all agents and service providers follow the company's specific procedures and policies.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/companies/{company_id}/special_instuctions
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/companies/65690/special_instructions |
Request Body: NA
Response:
{ "data": [ { "id": 2473, "created_by": 408564, "created_by_company": 10004, "created_for_company": 65690, "case_lienholder": 65690, "collateral_status": 0, "content": "special instruction test", "display_to_serviceprovider": 0, "created_at": "2026-03-12 11:23:54", "updated_at": "2026-03-12 11:23:54" }, { "id": 2474, "created_by": 408564, "created_by_company": 10004, "created_for_company": 65690, "case_lienholder": null, "collateral_status": 0, "content": "special instruction test", "display_to_serviceprovider": 0, "created_at": "2026-03-12 11:43:53", "updated_at": "2026-03-12 11:43:53" }, { "id": 2475, "created_by": 408564, "created_by_company": 10004, "created_for_company": 65690, "case_lienholder": 65690, "collateral_status": 0, "content": "special instruction test", "display_to_serviceprovider": 0, "created_at": "2026-03-12 11:44:22", "updated_at": "2026-03-12 11:44:22" }, { "id": 2476, "created_by": 408564, "created_by_company": 10004, "created_for_company": 65690, "case_lienholder": 65690, "collateral_status": 0, "content": "special instruction test", "display_to_serviceprovider": 0, "created_at": "2026-03-12 11:44:31", "updated_at": "2026-03-12 11:44:31" } ], "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/ShowCompanySpecInstruct.php", "line": 29, "function": "__construct", "class": "App\\Http\\Resources\\GenericResource", "type": "->" } } } } |
Create Special Instruction for Company
Description: This endpoint creates a new special instruction for a specific company.
Special instructions are used to define operational guidelines, requirements, or notes that must be followed when handling cases associated with the company. These instructions can be configured based on lienholder or collateral status conditions and may optionally be displayed to service providers.
All requests must include a valid Bearer Token in the request header.
URL: /api/v150/companies/{company_id}/special_instuctions
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
case_lienholder | Identifier of the lienholder associated with the case | No | 65690 |
collateral_status | Identifier representing the collateral status for which the instruction applies | Yes | 0 |
content | Text content of the special instruction | Yes | special instruction |
display_to_serviceprovider | Indicates whether the instruction should be displayed to service providers (0 = No, 1 = Yes) | No | 0 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/companies/65690/special_instructions |
Request Body:
{ "case_lienholder": 65690, "collateral_status": 0, "content": "special instruction test", "display_to_serviceprovider": 0 } |
Response:
{ "data": { "id": 2476, "created_by": 408564, "created_by_company": 10004, "created_for_company": 65690, "case_lienholder": 65690, "collateral_status": 0, "content": "special instruction test", "display_to_serviceprovider": 0, "created_at": "2026-03-12 11:44:31", "updated_at": "2026-03-12 11:44:31" }, "status": "success" } |