Applies to integrated customers using the RecoveryConnect API
Borrower Phone Operations
The Borrower Phone Operations section contains endpoints used to retrieve, create, update, and delete phone numbers associated with a borrower. These endpoints allow managing borrower contact information linked to a specific order.
All requests must include a valid Bearer token in the request header.
Retrieve Borrower Phones
Description: This endpoint retrieves the list of phone numbers associated with a specific borrower within an order.
Borrowers may have multiple phone numbers linked to their profile, such as mobile, home, or work numbers. This endpoint returns all phone records associated with the specified borrower, including details such as phone type, carrier information, and contact status.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/phones
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57062885/borrowers/124927241/phones |
Request Body: NA
Response:
{ "data": [ { "id": 39317578, "type": 5, "mobile_carrier_id": null, "number": "678-932-1578", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2026-03-07 14:03:51", "updated_at": "2026-03-07 14:03:51" }, { "id": 39317579, "type": 6, "mobile_carrier_id": null, "number": "887-213-6744", "extension": null, "memo": null, "valid": 1, "no_contact": 0, "created_at": "2026-03-07 14:03:51", "updated_at": "2026-03-07 14:03:51" } ] } |
Create Borrower Phone
Description: This endpoint creates a new phone record for a specific borrower within an order.
Borrowers can have multiple phone numbers associated with their profile, such as mobile, home, work, or emergency contact numbers. This endpoint allows users to add a new phone number and define attributes such as phone type, carrier, extension, and contact preferences.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/phones
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
type | Phone type identifier. Refer to Phone Type IDs reference table | Yes | 6 |
mobile_carrier_id | Identifier of the mobile carrier associated with the phone number. Refer to the Mobile Carrier ID Mapping table | No | 1
|
number | Phone number of the borrower | Yes | 6789321578 |
extension | Phone extension number if applicable | No | 22 |
memo | Additional description or note related to the phone number | No | home |
valid | Indicates whether the phone number is valid (1 = Valid, 0 = Invalid) | No | 1 |
no_contact | Indicates whether the borrower should not be contacted on this number (1 = Do Not Contact, 0 = Contact Allowed) | No | 0 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57062885/borrowers/124927241/phones |
Request Body:
{ "type": 6, "mobile_carrier_id": 1, "number": "6789321578", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0 } |
Response:
{ "data": { "id": 39317581, "type": 6, "mobile_carrier_id": 1, "number": "678-932-1578", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0, "created_at": "2026-03-07 14:18:07", "updated_at": "2026-03-07 14:18:07", "deleted_at": null, "migration": null, "address_with_number": "No address" }, "status": "success" } |
Retrieve Borrower Phone Details
Description: This endpoint retrieves the details of a specific phone record associated with a borrower within an order.
Borrowers may have multiple phone numbers linked to their profile. By providing the order ID, borrower ID, and phone ID, this endpoint returns the details of the specified phone record, including phone type, carrier information, contact preferences, and additional metadata.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/phones/{phone_id}
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57062885/borrowers/124927241/phones/39317581 |
Request Body: NA
Response:
{ "data": { "id": 39317581, "type": 6, "mobile_carrier_id": 1, "number": "678-932-1578", "extension": "22", "memo": "home", "valid": 1, "no_contact": 0, "created_at": "2026-03-07 14:18:07", "updated_at": "2026-03-07 14:18:07", "deleted_at": null, "migration": null, "address_with_number": "No address" }, "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/ShowSingleOrderBorrowerPhoneInfo.php", "line": 35, "function": "__construct", "class": "App\\Http\\Resources\\GenericResource", "type": "->" } } } } |
Update Borrower Phone
Description: This endpoint updates the details of an existing phone record associated with a borrower within an order.
Only the fields included in the request body will be updated. Fields not included will remain unchanged.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/phones/{phone_id}
Method: PUT
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
type | Phone type identifier. Refer to Phone Type IDs reference table | No | 6 |
mobile_carrier_id | Identifier of the mobile carrier associated with the phone number. Refer to the Mobile Carrier ID Mapping table | No | 1
|
number | Phone number of the borrower | No | 6789321578 |
extension | Phone extension number if applicable | No | 22 |
memo | Additional description or note related to the phone number | No | home |
valid | Indicates whether the phone number is valid (1 = Valid, 0 = Invalid) | No | 1 |
no_contact | Indicates whether the borrower should not be contacted on this number (1 = Do Not Contact, 0 = Contact Allowed) | No | 0 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57062885/borrowers/124927241/phones/39317581 |
Request Body:
{ "type": 6, "mobile_carrier_id": 2, "number": "678-932-1578", "extension": "44", "memo": "Personal", "valid": 1, "no_contact": 0 } |
Response:
{ "data": { "id": 39317581, "type": 6, "mobile_carrier_id": 2, "number": "678-932-1578", "extension": "44", "memo": "Personal", "valid": 1, "no_contact": 0, "created_at": "2026-03-07 14:18:07", "updated_at": "2026-03-07 17:09:58", "deleted_at": null, "migration": null, "address_with_number": "No address" }, "status": "success" } |
Delete Borrower Phone
Description: This endpoint deletes a specific phone record associated with a borrower within an order.
Borrowers may have multiple phone numbers linked to their profile. Using this endpoint, users can remove a phone record that is no longer valid, duplicated, or no longer required.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/phones/{phone_id}
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57062885/borrowers/124927241/phones/39317579 |
Request Body: NA
Response:
{ "data": { "success": true }, "meta": { "fixme": { "message": "GenericResource: create specific resource object", "source": { "file": "/var/www/mobile_dev/releases/20210210171746/versions/v130/app/Http/Controllers/Api/Mixins/Actions/Delete/DeleteOrderBorrowerInfo.php", "line": 51, "function": "__construct", "class": "App\\Http\\Resources\\GenericResource", "type": "->" } } } } |