Applies to integrated customers using the RecoveryConnect API
Borrower Address Operations
The Order Operations section contains endpoints used to create, retrieve, update, assign, and manage orders (cases) in the system. These endpoints allow users to manage order details, employees assigned to orders, addresses, tags, attachments, and related order information.
All requests must include a valid Bearer Token in the request header
Retrieve Borrower Addresses
Description: This endpoint retrieves the list of addresses associated with a specific borrower within an order.
Borrowers may have multiple addresses linked to their profile, such as home address, work address, previous address, or other related locations. This endpoint returns all address records associated with the specified borrower, including address details and related metadata.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/addresses
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57073907/borrowers/124943338/addresses |
Request Body: NA
Response:
{ "data": [ { "id": 219114267, "address_id": 120093908, "name": "Home Address", "address_1": "10334 Bridgton Mill, San Antonio", "address_2": "", "unit": "", "zip_code_id": 46261, "type": 1, "latitude": "29.42519100", "longitude": "-98.49459200", "zip_code": "85123", "city_name": "Arizona City", "state_name": "Arizona", "county_name": "Pinal", "hits": 0, "no_contact": 0, "created_at": "2026-03-09 09:38:27", "updated_at": "2026-03-09 09:38:27" }, { "id": 219114268, "address_id": 120093909, "name": "Work Address", "address_1": "11703 Bricewood Heights, San Antonio", "address_2": "", "unit": "", "zip_code_id": 46261, "type": 7, "latitude": "32.75589400", "longitude": "-111.67095800", "zip_code": "85123", "city_name": "Arizona City", "state_name": "Arizona", "county_name": "Pinal", "hits": 0, "no_contact": 0, "created_at": "2026-03-09 09:38:27", "updated_at": "2026-03-09 09:38:27" }, { "id": 219114273, "address_id": 120093908, "name": "Home Address", "address_1": "10334 Bridgton Mill, San Antonio", "address_2": "", "unit": "", "zip_code_id": 46261, "type": 1, "latitude": "29.42519100", "longitude": "-98.49459200", "zip_code": "85123", "city_name": "Arizona City", "state_name": "Arizona", "county_name": "Pinal", "hits": 0, "no_contact": 0, "created_at": "2026-03-09 09:38:27", "updated_at": "2026-03-09 09:38:27" }, { "id": 219114274, "address_id": 120093909, "name": "Work Address", "address_1": "11703 Bricewood Heights, San Antonio", "address_2": "", "unit": "", "zip_code_id": 46261, "type": 7, "latitude": "32.75589400", "longitude": "-111.67095800", "zip_code": "85123", "city_name": "Arizona City", "state_name": "Arizona", "county_name": "Pinal", "hits": 0, "no_contact": 0, "created_at": "2026-03-09 09:38:27", "updated_at": "2026-03-09 09:38:27" } ] } |
Create Borrower Address
Description: This endpoint creates a new address record for a specific borrower within an order.
Borrowers may have multiple addresses associated with their profile, such as home, work, previous, or additional addresses. This endpoint allows users to add a new borrower address and provide relevant details such as address lines, zip code, geographic coordinates, and address category.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/addresses
Method: POST
Request Body Parameters:
PARAMETER | DESCRIPTION | MANDATORY | EXAMPLE |
name | Name or label used to identify the address | Yes | Borrower Address 2- Office |
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) | Yes | 1 |
latitude | Latitude coordinate of the address location | No | 0 |
longitude | Longitude coordinate of the address location |
| 0 |
category_id | Identifier representing the address category (refer to Address Category ID Mapping table) | Yes | 1 |
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57073907/borrowers/124943338/addresses |
Request Body:
{ "name": "Borrower Address 2- Office", "address_1": "3620 W Greenway Rd", "address_2": "3620 W Cliffland Phoenix, AZ Phoenix AZ 85014", "zip": "85123", "unit": 1234, "type_id": 1, "latitude": 0, "longitude": 0, "category_id": 1 } |
Response:
{ "data": { "id": 219114277, "address_id": 120093915, "name": "Borrower Address 2- Office", "address_1": "3620 W Greenway Rd", "address_2": "3620 W Cliffland Phoenix, AZ Phoenix AZ 85014", "unit": "1234", "zip_code_id": 46261, "type": 1, "latitude": "33.44829500", "longitude": "-112.07254900", "zip_code": "85123", "city_name": "Arizona City", "state_name": "Arizona", "county_name": "Pinal", "hits": 0, "no_contact": 0, "created_at": "2026-03-09 09:53:19", "updated_at": "2026-03-09 09:53:19" }, "status": "success" } |
Retrieve Borrower Address Details
Description: This endpoint retrieves the details of a specific address associated with a borrower within an order.
Borrowers may have multiple addresses linked to their profile, such as home, work, or additional addresses. By providing the order ID, borrower ID, and address ID, this endpoint returns the detailed information related to the specified borrower address.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/addresses/{address_id}
Method: GET
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57073907/borrowers/124943338/addresses/120093915 |
Request Body: NA
Response:
{ "data": { "id": 219114277, "address_id": 120093915, "name": "Borrower Address 2- Office", "address_1": "3620 W Greenway Rd", "address_2": "3620 W Cliffland Phoenix, AZ Phoenix AZ 85014", "unit": "1234", "zip_code_id": 46261, "type": 1, "latitude": "33.44829500", "longitude": "-112.07254900", "zip_code": "85123", "city_name": "Arizona City", "state_name": "Arizona", "county_name": "Pinal", "hits": 0, "no_contact": 0, "created_at": "2026-03-09 09:53:19", "updated_at": "2026-03-09 09:53:19" } } |
Delete Borrower Address
Description: This endpoint deletes a specific address record associated with a borrower within an order.
Borrowers may have multiple addresses linked to their profile, such as home, work, previous, or additional addresses. This endpoint allows users to remove an address record that is no longer valid, duplicated, or no longer required.
URL: /api/v140/orders/{order_id}/borrowers/{borrower_id}/addresses/{address_id}
Method: DELETE
Request Body Parameters: NA
Success Code: 200 OK – Request Successful
Example:
URL: https://api.mbsisystems.com/api/v140/orders/57073907/borrowers/124943338/addresses/120093915 |
Request Body: NA
Response:
{ "data": { "success": true }, "meta": { "fixme": { "message": "GenericResource: create specific resource object", "source": { "file": "/var/www/mobile_dev/releases/20210210171746/versions/v140/app/Http/Controllers/Api/Mixins/Actions/Delete/DeleteOrderBorrowerInfo.php", "line": 93, "function": "__construct", "class": "App\\Http\\Resources\\GenericResource", "type": "->" } } } } |