Applies to integrated customers using the RecoveryConnect APIOn-Hook a Case
Description: This endpoint is used to mark a collateral item within an order as on-hook.
When a recovery agent secures (hooks) the collateral, this action is recorded in the system.
The request requires the case order ID and the collateral ID of the secured asset.
URL: /api/v130/orders/{order_id}/collaterals/{collateral_id}
Method: PUT
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| Is_on_hook | Boolean flag indicating whether the collateral is to be marked as on-hook (true = on-hook, false = off-hook). | Yes | true |
Success Code: 200 OK – Request Successful
Example:
URL: https://test-api.mbsisystems.com/api/v130/orders/16644858/collaterals/18732711 |
Request Body:
{ "is_on_hook": true } |
Response:
{ "data": { "id": 18725134, "is_primary": 1, "vehicle_type_id": 37, "vehicle_type": "Van", "year": "2011", "make": "Chevrolet", "model": "HHR", "color": "", "drive_train": "Front-Wheel Drive", "fuel_type": "Flex-Fuel FFV", "engine": "2.2-L L-4 DOHC 16V FFV", "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", "days_past_due": null, "license_no": null, "license_state": null, "license_exp": null, "vin": "3GNBACFU2BS658598", "status": "Repossession Pending - On Hook", "status_id": 26, "status_date": "2025-08-01 19:27:41", "status_reason": null, "status_note": null, "last_payment_date": "2025-08-01 19:27:42", "principal_amount": null, "on_hook_by": { "id": 354427, "company_id": 10001, "name": "rcm test", "firstname": "rcm", "lastname": "test", "contact": { "email": "sunil.vootkuri@esginc.us", "mobile_phone": "10651651" }, "roles": [ "Accountant", "Administrator", "Field Agent", "Field Agent Supervisor ", "Lot Person", "Lot Supervisor", "Case Worker", "Compliance Officer", "Investigator" ], "self": "http://test-api.mbsisystems.com/api/employees/354427", "expand": "employee", "employee_id": 354427, "latitude": "0.00000000", "longitude": "0.00000000", "created_at": "2025-08-01 19:27:41", "updated_at": "2025-08-01 19:27:41" }, "assignment_on_hook_by": null, "vehicle_value": null, "created_at": "2025-08-01 06:02:16", "updated_at": "2025-08-01 19:27:41", "meta": [] }, "status": "success" } |
View Updates On a Case
Description: Retrieves all updates and activity logs associated with a specific case, including status changes, notes, assignments, and other modifications.
URL: /api/v130/orders/{order_id}/updates
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://test-api.mbsisystems.com/api/v130/orders/16644858/updates |
Request Body: NA
Response:
{ "data": [ { "id": 72279802, "private": false, "priority": 0, "details": "Case update on-hook via Forwarder", "address": null, "date_at": "2025-08-01 19:27:41", "created_at": "2025-08-01 19:27:41", "company_orderno": "136196-1", "order_id": 16636875, "added_by": "rcm test", "type": "Misc", "update_type_id": 7, "author": { "id": 354427, "company_id": 10001, "name": "rcm test", "firstname": "rcm", "lastname": "test", "contact": { "email": "sunil.vootkuri@esginc.us", "mobile_phone": "10651651" }, "roles": [ "Accountant", "Administrator", "Field Agent", "Field Agent Supervisor ", "Lot Person", "Lot Supervisor", "Case Worker", "Compliance Officer", "Investigator" ], "self": "http://test-api.mbsisystems.com/api/employees/354427", "expand": "employee" }, "self": "http://test-api.mbsisystems.com/api/updates/72279802", "expand": "update" } ], "links": { "first": "http://test-api.mbsisystems.com/api/v2025/orders/16636875/updates?q=%2Fapi%2Fv2024%2Forders%2F16636875%2Fupdates&page=1", "last": "http://test-api.mbsisystems.com/api/v2025/orders/16636875/updates?q=%2Fapi%2Fv2024%2Forders%2F16636875%2Fupdates&page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "http://test-api.mbsisystems.com/api/v2025/orders/16636875/updates", "per_page": "10", "to": 1, "total": 1, "orderby": "id", "direction": "asc", "orderby_options": [ "id" ] }, "warnings": [] }
|
Add Updates
Description: Adds a new update (such as a note, status change, or message) to a specific case. Updates can be flagged as private, assigned a priority, and visibility can be controlled for clients and agents.
URL: /api/v130/orders/{order_id}/updates
Method: POST
Request Body Parameters:
| PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
| type | Numeric code representing the type of update | Yes | 3 |
| message | Text message or note content to add to the case | Yes | Client needs an update |
| shift_id | Identifier of the shift during which the update is logged | No | 1 |
| is_private | Boolean flag indicating if the update is private (true = private, false = public) | No | false |
| priority | Numeric priority level of the update (e.g., 1 = Low, 2 = Medium, 3 = High) | No | 2 |
| client_visible | Boolean flag indicating if the update should be visible to the client | No | true |
| agent_visible | List of agent IDs who can view the update | No | 123 |
Success Code: 200 OK – Request Successful
Example:
URL: https://test-api.mbsisystems.com/api/v130/orders/16644858/updates |
Request Body:
{ "type": 3, "message": "Client needs update.", "shift_id": 1, "is_private": false, "priority": 2, "client_visible": true, "agent_visible": [ 123 ] } |
Response:
{ "data": { "id": 72279803, "private": true, "priority": 0, "details": "[RCM] tes", "address": null, "date_at": "2025-08-01T19:31:32.273454Z", "created_at": "2025-08-01 19:31:32", "company_orderno": "136196-1", "order_id": 16636875, "added_by": "rcm test", "type": "Misc", "update_type_id": 9, "author": { "id": 354427, "company_id": 10001, "name": "rcm test", "firstname": "rcm", "lastname": "test", "contact": { "email": "sunil.vootkuri@esginc.us", "mobile_phone": "10651651" }, "roles": [ "Accountant", "Administrator", "Field Agent", "Field Agent Supervisor ", "Lot Person", "Lot Supervisor", "Case Worker", "Compliance Officer", "Investigator" ], "self": "http://test-api.mbsisystems.com/api/employees/354427", "expand": "employee" }, "self": "http://test-api.mbsisystems.com/api/updates/72279803", "expand": "update" }, "status": "success" } |