Applies to integrated customers using the RecoveryConnect API
Attach Tags to Order
Description: This endpoint attaches one or more tags to a specified order. Tags are used for the classification, tracking, or grouping of orders.
URL: /api/v150/orders/{order_id}/tags
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
tags | |||
id | Unique identifier of the tag | Yes | 3790 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57070223/tags |
Request Body:
{ "tags": [ { "id": 3790 } ] } |
Response:
{ "data": [ { "id": 3790, "company_id": 10004, "name": "shilpa test tag" } ] } |
Delete Order Tag
Description: This endpoint removes a specific tag associated with an order.
URL: /api/v150/orders/{order_id}/tags/{tag_id}
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57070223/tags/3790 |
Request Body: NA
Response:
{ "data": [] } |
Retrieve Recon Orders – Filtering endpoint
Description: This endpoint retrieves orders with limited parameters. It is primarily used for reconciliation purposes and allows filtering orders using several query parameters such as order status, client ID, VIN, and creation date range.
URL: /api/v150/recon/orders
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | EXAMPLE |
status | Filters orders by collateral status ID | 1 |
acct_no | Filters orders by client account number | 122121 |
client_id | Filters orders by client identifier | 65690 |
owner_id | Filters orders by owner company ID | 10001 |
other_refno | Filters orders by other reference number | Aab121 |
order_type | Filters orders by order type | 1 |
vin | Filters orders by VIN | 1HGCM82633A123456 |
ids | Filters orders by specific order IDs (comma-separated list) | 109773,109774 |
per_page | Number of records per page. Default value is 250 | 100 |
page | Specifies the page number for paginated results | 2 |
created_at_start | Start of the order creation date range. Must be used together with created_at_end | 2022-01-31 01:11:14 |
created_at_end | End of the order creation date range. Must be used together with created_at_start | 2022-03-31 01:11:14 |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/recon/orders?client_id=65690&status=1&order_type=2&page=1 |
Request Body: NA
Response:
{ "data": [ { "id": 28501398, "other_refno": null, "client_id": 65690, "lienholder": 65690, "status_date": "2022-03-02T09:59:00.000000Z", "accepted_date": "2022-02-09 03:26:00", "tier_level": "Placement2", "placement_level": 2, "created_at": "2022-01-31 01:11:14", "company_orderno": "18255-1", "order_type": 2, "status": 1, "vin": "4C5FY406132T72853", "borrower_firstname": "Eldred", "borrower_middle_initial": "", "borrower_lastname": "Hane", "mass_hold_tags": [], "violent_event_details": [] }, { "id": 34647200, "other_refno": null, "client_id": 65690, "lienholder": 65690, "status_date": "2022-07-16T09:59:00.000000Z", "accepted_date": "2022-07-15 05:46:00", "tier_level": "Tier2", "placement_level": 2, "created_at": "2022-07-15 03:25:37", "company_orderno": "20185-1", "order_type": 2, "status": 1, "vin": "1N6BA07C38N334329", "borrower_firstname": "Gerald", "borrower_middle_initial": "", "borrower_lastname": "Marquardt", "mass_hold_tags": [], "violent_event_details": [] }, { "id": 51608760, "other_refno": null, "client_id": 65690, "lienholder": 65690, "status_date": "2023-07-03T21:40:14.000000Z", "accepted_date": "2023-07-03 21:11:32", "tier_level": "Placement 1", "placement_level": 1, "created_at": "2023-07-03 21:11:32", "company_orderno": "22393-1", "order_type": 2, "status": 1, "vin": "WAUED24B1YN136182", "borrower_firstname": "Gillian", "borrower_middle_initial": "M", "borrower_lastname": "Davis", "mass_hold_tags": [], "violent_event_details": [] }, { "id": 56542446, "other_refno": null, "client_id": 65690, "lienholder": 65690, "status_date": "2025-01-06T22:35:00.000000Z", "accepted_date": "2024-11-22 15:00:00", "tier_level": "Placemen1", "placement_level": 1, "created_at": "2024-11-22 13:40:35", "company_orderno": "67067-1", "order_type": 2, "status": 1, "vin": "WA1DGAFP4EA014325", "borrower_firstname": "AMBROISE", "borrower_middle_initial": "", "borrower_lastname": "NATALIE2", "mass_hold_tags": [], "violent_event_details": [] } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/recon/orders?q=%2Fapi%2Fv140%2Frecon%2Forders&client_id=65690&status=1&order_type=2&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/recon/orders?q=%2Fapi%2Fv140%2Frecon%2Forders&client_id=65690&status=1&order_type=2&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/recon/orders", "per_page": "20", "to": 4, "total": 4, "orderby": "id", "direction": "asc", "orderby_options": [ "id" ] }, "warnings": [] } |
Retrieve Recon Assignments – Filtering endpoint
Description: This endpoint retrieves assignments with limited parameters. It allows filtering assignment records using query parameters such as status, client ID, account number, and assignment IDs. The endpoint also supports pagination.
URL: /api/v150/recon/assignments
Method: GET
Query Parameters:
PARAMETER | DESCRIPTION | EXAMPLE |
status | Filters orders by collateral status ID | 1 |
acct_no | Filters orders by client account number | 122121 |
client_id | Filters orders by client identifier | 65690 |
owner_id | Filters orders by owner company ID | 10001 |
ids | Filters assignments by specific assignment IDs (comma-separated list) | 109773,109774 |
per_page | Number of records per page. Default value is 250 | 100 |
page | Specifies the page number for paginated results | 2 |
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/recon/assignments?client_id=65690&status=1 |
Request Body: NA
Response:
{ "data": [ { "id": 30554, "other_refno": null, "client_id": 65690, "lienholder": null, "status_date": null, "accepted_date": null, "tier_level": null, "placement_level": null, "created_at": "2016-02-26 18:32:33", "company_orderno": "1031-1", "order_type": 1, "status": 1, "vin": null, "borrower_firstname": null, "borrower_middle_initial": null, "borrower_lastname": null, "mass_hold_tags": [], "violent_event_details": [] } ], "links": { "first": "http://stg-api.mbsisystems.com/api/v140/recon/assignments?q=%2Fapi%2Fv140%2Frecon%2Fassignments&client_id=65690&status=1&page=1", "last": "http://stg-api.mbsisystems.com/api/v140/recon/assignments?q=%2Fapi%2Fv140%2Frecon%2Fassignments&client_id=65690&status=1&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://stg-api.mbsisystems.com/api/v140/recon/assignments", "per_page": "20", "to": 1, "total": 1, "orderby": "id", "direction": "asc", "orderby_options": [ "id" ] }, "warnings": [] } |
Add Office Employee to Order
Description: This endpoint assigns one or more office employees to a specific order.
URL: /api/v150/orders/{order_id}/office_employees
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
employee_ids | An array containing the employee IDs to be assigned to the order | Yes | 131709 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v150/orders/57070212/office_employees |
Request Body:
{ "employee_ids": [ 78830, 80034 ] } |
Response:
{ "data": [ { "id": 124941377, "order_id": 57070212, "employee_id": 78830, "person_id": 1971583, "firstname": "William", "middlename": null, "lastname": "Sheehan", "role": null, "is_violent": 0, "is_primary": 0 }, { "id": 124941378, "order_id": 57070212, "employee_id": 80034, "person_id": 2046199, "firstname": "Erika", "middlename": null, "lastname": "Clark", "role": null, "is_violent": 0, "is_primary": 0 } ], "status": "success" } |