Applies to integrated customers using the RecoveryConnect API



Company Operations

The Company Operations section contains endpoints used to retrieve and manage company-related information such as company details, employees, lots, connected entities, tags, and special instructions.

These endpoints allow users to access company configuration data that may be required for order processing, assignments, and other operational workflows.

All requests must include a valid Bearer token in the request header.

 

 

Retrieve Company Lots

DescriptionThis endpoint retrieves the list of company lots available in the system.

Lots represent designated storage locations or facilities associated with the company, where recovered collateral or assets may be stored. This endpoint allows users to retrieve company lot records and optionally filter the results based on mapped iRepo lot IDs or branch IDs.

URL: /api/v140/lots
Method: GET

Query Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

irepo_lot_id

Filters lot records by the mapped iRepo lot identifier

No

?irepo_lot_id=123

irepo_branch_id

Filters lot records by the mapped iRepo branch identifier

No


 

?irepo_branch_id=456

 

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/lots

 

Request Body: NA

Response:

{

    "data": [

        {

            "id": 4,

            "address_id": 4,

            "company_id": 10004,

            "is_primary": 1,

            "is_cars_certified": 1,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-03-01",

            "risc_inspection_id": "999",

            "risc_certification_date": "2023-01-13",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 4,

                "name": "Main",

                "address_1": "2345 Forwarding Comp Strret",

                "address_2": "",

                "state_abbr": "SD",

                "city_name": "Watertown",

                "zip_code": "57201",

                "county_name": "Codington",

                "longitude": "-27.18551000",

                "latitude": "24.11170100",

                "unit": null,

                "phones": [

                    {

                        "id": 2363154,

                        "type": 2,

                        "number": "666-123-4567",

                        "extension": null

                    },

                    {

                        "id": 39318126,

                        "type": 4,

                        "number": "222-555-1234",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 1188136,

            "address_id": 5493358,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-03-28",

            "risc_inspection_id": "bb123",

            "risc_certification_date": "2022-11-10",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 5493358,

                "name": "Regression Testing",

                "address_1": "11787 International Dr",

                "address_2": "",

                "state_abbr": "FL",

                "city_name": "Orlando",

                "zip_code": "32821",

                "county_name": "Orange",

                "longitude": "-81.46568800",

                "latitude": "28.39301400",

                "unit": "",

                "phones": [

                    {

                        "id": 15379764,

                        "type": 2,

                        "number": "666-731-0918",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 1188138,

            "address_id": 5493360,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-01-07",

            "risc_inspection_id": "NA",

            "risc_certification_date": "2023-01-13",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 5493360,

                "name": "Regression Testing",

                "address_1": "2301 West Dunlap",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Ajo",

                "zip_code": "85321",

                "county_name": "Pima",

                "longitude": "-112.90588000",

                "latitude": "32.25969900",

                "unit": "",

                "phones": []

            }

        },

        {

            "id": 1464910,

            "address_id": 20175560,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-09-17",

            "risc_inspection_id": "34422",

            "risc_certification_date": "2023-08-23",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 20175560,

                "name": "shilpatest address 2",

                "address_1": "2301 West Dunlap Ave",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85023",

                "county_name": "Maricopa",

                "longitude": "-112.10921200",

                "latitude": "33.56764800",

                "unit": "",

                "phones": [

                    {

                        "id": 8939008,

                        "type": 4,

                        "number": "539-081-2574",

                        "extension": null

                    },

                    {

                        "id": 8939010,

                        "type": 3,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 25686972,

                        "type": 2,

                        "number": "332-027-3384",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 1632526,

            "address_id": 91668982,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-04-24",

            "risc_inspection_id": "22331",

            "risc_certification_date": "2023-01-13",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 91668982,

                "name": "address 1as main location Phoenix AZ 85019 edited",

                "address_1": "69373 Kailyn Points Suite 411",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Mesa",

                "zip_code": "85212",

                "county_name": "Maricopa",

                "longitude": "-111.64222400",

                "latitude": "33.33123000",

                "unit": "",

                "phones": [

                    {

                        "id": 27652360,

                        "type": 2,

                        "number": "658-943-9162",

                        "extension": null

                    },

                    {

                        "id": 27652362,

                        "type": 4,

                        "number": "751-006-6878",

                        "extension": null

                    },

                    {

                        "id": 27652364,

                        "type": 3,

                        "number": "759-616-3468",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2249715,

            "address_id": 119863964,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-04-26",

            "risc_inspection_id": "testfile",

            "risc_certification_date": "2024-12-25",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 119863964,

                "name": "Test_AZ",

                "address_1": "5138 E 27th St",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Tucson",

                "zip_code": "85711",

                "county_name": "Pima",

                "longitude": "-120.00000000",

                "latitude": "-90.00000000",

                "unit": null,

                "phones": [

                    {

                        "id": 39186898,

                        "type": 2,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39186899,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39186900,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2249716,

            "address_id": 119863965,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-01-22",

            "risc_inspection_id": "SFR123",

            "risc_certification_date": "2024-09-26",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 119863965,

                "name": "Texas_Test",

                "address_1": "4045 Renee Dr",

                "address_2": "",

                "state_abbr": "TX",

                "city_name": "Dallas",

                "zip_code": "75227",

                "county_name": "Dallas",

                "longitude": null,

                "latitude": null,

                "unit": null,

                "phones": [

                    {

                        "id": 39186901,

                        "type": 2,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39186902,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39186903,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2249718,

            "address_id": 119864510,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 0,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-04-26",

            "risc_inspection_id": "112234",

            "risc_certification_date": "2024-12-25",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 119864510,

                "name": "Testing Storage Location Neelima via API",

                "address_1": "3620 W Greenway Rd3, Phoenix, AZ Phoenix AZ 85014",

                "address_2": "3620 W Greenway",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85015",

                "county_name": "Maricopa",

                "longitude": "-112.13673400",

                "latitude": "33.62569100",

                "unit": "1234",

                "phones": [

                    {

                        "id": 39187104,

                        "type": 4,

                        "number": "123-456-7890",

                        "extension": null

                    },

                    {

                        "id": 39187105,

                        "type": 2,

                        "number": "968-637-9017",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2249719,

            "address_id": 119864511,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 0,

            "is_risc_certified": 1,

            "risc_lot_expiration": "2025-11-25",

            "risc_inspection_id": "65433",

            "risc_certification_date": "2024-12-11",

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 119864511,

                "name": "Testing Storage Location Neelima via API",

                "address_1": "36201 W Greenway Rd3, Phoenix, AZ Phoenix AZ 85014",

                "address_2": "3620 W Greenway",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85015",

                "county_name": "Maricopa",

                "longitude": "-112.11048300",

                "latitude": "33.49917800",

                "unit": "12314",

                "phones": [

                    {

                        "id": 39187106,

                        "type": 4,

                        "number": "123-456-7890",

                        "extension": null

                    },

                    {

                        "id": 39187107,

                        "type": 2,

                        "number": "968-637-9017",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2251710,

            "address_id": 120007065,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": null,

            "risc_lot_expiration": null,

            "risc_inspection_id": null,

            "risc_certification_date": null,

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 120007065,

                "name": "storage",

                "address_1": "871 3rd St NW",

                "address_2": "",

                "state_abbr": "CA",

                "city_name": "Los Angeles",

                "zip_code": "90007",

                "county_name": "Los Angeles",

                "longitude": null,

                "latitude": null,

                "unit": null,

                "phones": [

                    {

                        "id": 39250245,

                        "type": 2,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39250246,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39250247,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2251771,

            "address_id": 120011832,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": null,

            "risc_lot_expiration": null,

            "risc_inspection_id": null,

            "risc_certification_date": null,

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 120011832,

                "name": "Automation Address 2025-07-29T10:07:55.190845098",

                "address_1": "Main Dallas, Arizona 2025-07-29T10:07:55.190845098",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85001",

                "county_name": "Maricopa",

                "longitude": "-96.79698790",

                "latitude": "32.77666420",

                "unit": "",

                "phones": [

                    {

                        "id": 39253696,

                        "type": 2,

                        "number": "966-966-2555",

                        "extension": null

                    },

                    {

                        "id": 39253697,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39253698,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2252079,

            "address_id": 120033931,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": null,

            "risc_lot_expiration": null,

            "risc_inspection_id": null,

            "risc_certification_date": null,

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 120033931,

                "name": "Automation Address 2025-09-24T10:01:44.109665123",

                "address_1": "Main Dallas, Arizona 2025-09-24T10:01:44.109665123",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85001",

                "county_name": "Maricopa",

                "longitude": "-112.07767810",

                "latitude": "33.44822660",

                "unit": "",

                "phones": [

                    {

                        "id": 39270665,

                        "type": 2,

                        "number": "966-966-2555",

                        "extension": null

                    },

                    {

                        "id": 39270666,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39270667,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2252121,

            "address_id": 120036405,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": null,

            "risc_lot_expiration": null,

            "risc_inspection_id": null,

            "risc_certification_date": null,

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 120036405,

                "name": "Automation Address 2025-09-30T10:11:59.329940500",

                "address_1": "Main Dallas, Arizona 2025-09-30T10:11:59.329940500",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85001",

                "county_name": "Maricopa",

                "longitude": "-112.07254880",

                "latitude": "33.44829480",

                "unit": "",

                "phones": [

                    {

                        "id": 39272567,

                        "type": 2,

                        "number": "966-966-2555",

                        "extension": null

                    },

                    {

                        "id": 39272568,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39272569,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2252144,

            "address_id": 120037621,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": null,

            "risc_lot_expiration": null,

            "risc_inspection_id": null,

            "risc_certification_date": null,

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 120037621,

                "name": "Automation Address 2025-10-03T09:30:10.064691972",

                "address_1": "Main Dallas, Arizona 2025-10-03T09:30:10.064691972",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85001",

                "county_name": "Maricopa",

                "longitude": "-112.07254880",

                "latitude": "33.44829480",

                "unit": "",

                "phones": [

                    {

                        "id": 39273468,

                        "type": 2,

                        "number": "966-966-2555",

                        "extension": null

                    },

                    {

                        "id": 39273469,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39273470,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2252943,

            "address_id": 120087005,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": null,

            "risc_lot_expiration": null,

            "risc_inspection_id": null,

            "risc_certification_date": null,

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 120087005,

                "name": "Automation Address 2026-02-11T19:26:56.642895100",

                "address_1": "Main Dallas, Arizona 2026-02-11T19:26:56.642895100",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85001",

                "county_name": "Maricopa",

                "longitude": "-112.07254880",

                "latitude": "33.44829480",

                "unit": "",

                "phones": [

                    {

                        "id": 39310836,

                        "type": 2,

                        "number": "966-966-2555",

                        "extension": null

                    },

                    {

                        "id": 39310837,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39310838,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        },

        {

            "id": 2252968,

            "address_id": 120092355,

            "company_id": 10004,

            "is_primary": 0,

            "is_cars_certified": 1,

            "is_risc_certified": null,

            "risc_lot_expiration": null,

            "risc_inspection_id": null,

            "risc_certification_date": null,

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 120092355,

                "name": "Automation Address 2026-03-02T17:17:10.949979500",

                "address_1": "Main Dallas, Arizona 2026-03-02T17:17:10.949979500",

                "address_2": "",

                "state_abbr": "AZ",

                "city_name": "Phoenix",

                "zip_code": "85001",

                "county_name": "Maricopa",

                "longitude": "-112.07254880",

                "latitude": "33.44829480",

                "unit": "",

                "phones": [

                    {

                        "id": 39316392,

                        "type": 2,

                        "number": "966-966-2555",

                        "extension": null

                    },

                    {

                        "id": 39316393,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 39316394,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        }

    ],

    "warnings": []

}

 

Retrieve Lots for Specified Company

DescriptionThis endpoint retrieves the list of lots associated with a specific company.

Lots represent storage facilities or locations used to store recovered collateral or assets. By providing the company ID, this endpoint returns the lots configured for that company.

An optional order_id query parameter can be used to filter the lot list based on the client and lienholder RISC (Repossession Industry Standard Certification) settings. If the client or lienholder requires RISC-enabled lots, only those lots with a valid future RISC expiration date will be returned.

URL: /api/v140/companies/{company_id}/lots
Method: GET

Query Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

order_id


 

Filters the lot list based on the client and lienholder RISC requirements associated with the specified order. If RISC is enabled, only lots with a valid future RISC expiration date will be returned.

No

?order_id=57070537

 

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/companies/127562/lots

 

Request Body: NA

Response:

{

    "data": [

        {

            "id": 127705,

            "address_id": 1595372,

            "company_id": 127562,

            "is_primary": 1,

            "is_cars_certified": 1,

            "is_risc_certified": 0,

            "risc_lot_expiration": null,

            "risc_inspection_id": null,

            "risc_certification_date": null,

            "irepo_lot_id": null,

            "irepo_branch_id": null,

            "address_details": {

                "id": 1595372,

                "name": "MAIN",

                "address_1": "2281 Kurtis Island Apt. 931",

                "address_2": "",

                "state_abbr": "MI",

                "city_name": "Middleville",

                "zip_code": "49333",

                "county_name": "Barry",

                "longitude": null,

                "latitude": null,

                "unit": null,

                "phones": [

                    {

                        "id": 752643,

                        "type": 2,

                        "number": "619-239-5607",

                        "extension": null

                    },

                    {

                        "id": 752644,

                        "type": 4,

                        "number": "",

                        "extension": null

                    },

                    {

                        "id": 752645,

                        "type": 3,

                        "number": "",

                        "extension": null

                    }

                ]

            }

        }

    ],

    "warnings": []

}

 

 

Retrieve DNU Agents for Company

DescriptionThis endpoint retrieves the Do Not Use (DNU) agents configured for a specific company.

DNU agents represent individuals or entities that are restricted from being assigned work or tasks for the company. These listings help ensure that assignments are not allocated to agents who have been flagged or restricted due to operational, compliance, or business reasons.

By providing the company ID, this endpoint returns all DNU agent records associated with that company.

URL: /api/v140/companies/{company_id}/DNU_agents
Method: GET

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/companies/180276/DNU_agents

 

Request Body: NA

Response:

{

    "data": [

        {

            "id": 6945,

            "blacklisted_company_id": 73200,

            "blacklisted_company": {

                "id": 73200,

                "name": "Hobbs Recovery",

                "type": 3,

                "updated_at": "2022-10-27 21:55:37",

                "addresses": [

                    {

                        "id": 63271,

                        "address_id": 349638,

                        "company_id": 73200,

                        "is_primary": 1,

                        "is_cars_certified": 1,

                        "is_risc_certified": 0,

                        "risc_lot_expiration": null,

                        "risc_inspection_id": null,

                        "risc_certification_date": null,

                        "irepo_lot_id": null,

                        "irepo_branch_id": null,

                        "address_details": {

                            "id": 349638,

                            "name": "main",

                            "address_1": "647 Schinner Ports",

                            "address_2": "",

                            "state_abbr": "FL",

                            "city_name": "Pensacola",

                            "zip_code": "32534",

                            "county_name": "Escambia",

                            "longitude": "-87.27164500",

                            "latitude": "30.52975500",

                            "unit": null,

                            "phones": [

                                {

                                    "id": 265120,

                                    "type": 2,

                                    "number": "505-902-4201",

                                    "extension": null

                                },

                                {

                                    "id": 265121,

                                    "type": 4,

                                    "number": "716-653-8419",

                                    "extension": null

                                },

                                {

                                    "id": 265122,

                                    "type": 3,

                                    "number": "",

                                    "extension": null

                                }

                            ]

                        }

                    },

                    {

                        "id": 70918,

                        "address_id": 868272,

                        "company_id": 73200,

                        "is_primary": 0,

                        "is_cars_certified": 1,

                        "is_risc_certified": 0,

                        "risc_lot_expiration": null,

                        "risc_inspection_id": null,

                        "risc_certification_date": null,

                        "irepo_lot_id": null,

                        "irepo_branch_id": null,

                        "address_details": {

                            "id": 868272,

                            "name": "Hobbs Recovery",

                            "address_1": "410 Lura Stream Apt. 602",

                            "address_2": "",

                            "state_abbr": "FL",

                            "city_name": "Pensacola",

                            "zip_code": "32534",

                            "county_name": "Escambia",

                            "longitude": "-87.23991800",

                            "latitude": "30.43925500",

                            "unit": null,

                            "phones": [

                                {

                                    "id": 449012,

                                    "type": 2,

                                    "number": "",

                                    "extension": null

                                },

                                {

                                    "id": 449014,

                                    "type": 4,

                                    "number": "",

                                    "extension": null

                                },

                                {

                                    "id": 449016,

                                    "type": 3,

                                    "number": "",

                                    "extension": null

                                }

                            ]

                        }

                    }

                ]

            },

            "employee_id": 424549,

            "blacklisted_for_company": 180276,

            "reason": "Reason",

            "created_at": "2026-03-12 10:29:39",

            "updated_at": "2026-03-12 10:29:39"

        }

    ]

}

 

Retrieve Company Employees

DescriptionThis endpoint retrieves the list of active employees associated with a specified company.

The requesting user's company and the specified company must have an existing company connection established in order to access the employee records. Only active employees for the specified company will be returned.

Pagination parameters can be used to control the number of records returned per request.

 

URL: /api/v140/companies/{company_id}/employees
Method: GET

Query Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

per_page

Number of records returned per page. Default is 1000, maximum allowed is 5000

No

?per_page=500

page


 

Specifies the page number of the results to retrieve

No

?page=1

 

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/companies/10004/employees?&per_page=4

 

Request Body: NA

Response:

{

    "data": [

        {

            "id": 11765,

            "company_id": 10004,

            "name": "Forwarding Office",

            "firstname": "Forwarding",

            "lastname": "Office",

            "contact": {

                "email": null,

                "mobile_phone": null

            },

            "roles": [

                "Administrator FWD",

                "API Connection",

                "Accountant",

                "Case Worker FWD",

                "Compliance Officer FWD ",

                "Field Agent",

                "Remarketing FWD",

                "Team Lead",

                "Transportation FWD",

                "Accountant",

                "Administrator FWD",

                "Field Agent"

            ],

            "self": "http://stg-api.mbsisystems.com/api/employees/11765",

            "expand": "employee"

        },

        {

            "id": 78830,

            "company_id": 10004,

            "name": "William Sheehan",

            "firstname": "William",

            "lastname": "Sheehan",

            "contact": {

                "email": "wmjsiv@ciber.demo",

                "mobile_phone": null

            },

            "roles": [

                "Administrator FWD"

            ],

            "self": "http://stg-api.mbsisystems.com/api/employees/78830",

            "expand": "employee"

        },

        {

            "id": 80034,

            "company_id": 10004,

            "name": "Erika Clark",

            "firstname": "Erika",

            "lastname": "Clark",

            "contact": {

                "email": "eclark@kciber.demo",

                "mobile_phone": null

            },

            "roles": [

                "Case Worker FWD"

            ],

            "self": "http://stg-api.mbsisystems.com/api/employees/80034",

            "expand": "employee"

        },

        {

            "id": 80077,

            "company_id": 10004,

            "name": "Servicing Solution",

            "firstname": "Servicing",

            "lastname": "Solution",

            "contact": {

                "email": "",

                "mobile_phone": null

            },

            "roles": [

                "Administrator FWD"

            ],

            "self": "http://stg-api.mbsisystems.com/api/employees/80077",

            "expand": "employee"

        }

    ],

    "links": {

        "first": "http://stg-api.mbsisystems.com/api/v140/companies/10004/employees?page=1",

        "last": "http://stg-api.mbsisystems.com/api/v140/companies/10004/employees?page=183",

        "prev": null,

        "next": "http://stg-api.mbsisystems.com/api/v140/companies/10004/employees?page=2"

    },

    "meta": {

        "current_page": 1,

        "from": 1,

        "last_page": 183,

        "path": "http://stg-api.mbsisystems.com/api/v140/companies/10004/employees",

        "per_page": 4,

        "to": 4,

        "total": 732

    }

}

 

 

Retrieve Company Details

DescriptionThis endpoint retrieves the details of a specific company.

By providing the company ID, this endpoint returns company-related information including company identification details and associated metadata. Optional query parameters can be used to filter related address records based on mapped iRepo lot IDs or branch IDs.

 

URL: /api/v140/companies/{company_id}
Method: GET

Query Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

irepo_lot_id

Filters address records by the mapped iRepo lot identifier

No

?irepo_lot_id=123

irepo_branch_id

Filters address records by the mapped iRepo branch identifier

 

 

No

?irepo_branch_id=456

 

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/companies/130875

 

Request Body: NA

Response:

{

    "data": {

        "id": 130875,

        "name": "Swift Recovery Demo",

        "type": 4,

        "updated_at": "2025-09-01 08:31:26",

        "addresses": [

            {

                "id": 131461,

                "address_id": 2121206,

                "company_id": 130875,

                "is_primary": 1,

                "is_cars_certified": 1,

                "is_risc_certified": 1,

                "risc_lot_expiration": "2024-03-15",

                "risc_inspection_id": "test33",

                "risc_certification_date": "2023-01-13",

                "irepo_lot_id": null,

                "irepo_branch_id": null,

                "address_details": {

                    "id": 2121206,

                    "name": "Main",

                    "address_1": "453 Brandyn Vista",

                    "address_2": "",

                    "state_abbr": "AZ",

                    "city_name": "Phoenix",

                    "zip_code": "85029",

                    "county_name": "Maricopa",

                    "longitude": "-112.11493800",

                    "latitude": "33.58439400",

                    "unit": null,

                    "phones": []

                }

            },

            {

                "id": 132026,

                "address_id": 2193531,

                "company_id": 130875,

                "is_primary": 0,

                "is_cars_certified": 1,

                "is_risc_certified": 0,

                "risc_lot_expiration": null,

                "risc_inspection_id": null,

                "risc_certification_date": null,

                "irepo_lot_id": null,

                "irepo_branch_id": null,

                "address_details": {

                    "id": 2193531,

                    "name": "Jacksonville Branch",

                    "address_1": "678 Pink Flat",

                    "address_2": "",

                    "state_abbr": "FL",

                    "city_name": "Saint Johns",

                    "zip_code": "32259",

                    "county_name": "Saint Johns",

                    "longitude": "-81.55824400",

                    "latitude": "30.08803100",

                    "unit": null,

                    "phones": [

                        {

                            "id": 919289,

                            "type": 2,

                            "number": "829-117-6658",

                            "extension": null

                        },

                        {

                            "id": 919290,

                            "type": 4,

                            "number": "209-763-6075",

                            "extension": null

                        },

                        {

                            "id": 919291,

                            "type": 3,

                            "number": "854-570-3836",

                            "extension": null

                        }

                    ]

                }

            },

            {

                "id": 149106,

                "address_id": 2931133,

                "company_id": 130875,

                "is_primary": 0,

                "is_cars_certified": 1,

                "is_risc_certified": 1,

                "risc_lot_expiration": "2023-01-13",

                "risc_inspection_id": "TEST DATA",

                "risc_certification_date": "2022-09-29",

                "irepo_lot_id": null,

                "irepo_branch_id": null,

                "address_details": {

                    "id": 2931133,

                    "name": "tampa location",

                    "address_1": "236 Schneider Centers Suite 043",

                    "address_2": "",

                    "state_abbr": "FL",

                    "city_name": "Tampa",

                    "zip_code": "33602",

                    "county_name": "Hillsborough",

                    "longitude": "-82.45454300",

                    "latitude": "27.95471700",

                    "unit": null,

                    "phones": [

                        {

                            "id": 1154890,

                            "type": 2,

                            "number": "",

                            "extension": null

                        },

                        {

                            "id": 1154891,

                            "type": 4,

                            "number": "",

                            "extension": null

                        },

                        {

                            "id": 1154892,

                            "type": 3,

                            "number": "",

                            "extension": null

                        }

                    ]

                }

            }

        ]

    }

}

 

List Company Connections

DescriptionThis endpoint retrieves the list of entities connected with the authenticated user's company.

Company connections represent external entities associated with the company, such as vendors, lenders, forwarders, or other operational partners. The endpoint supports multiple filters to narrow down the results based on company type, category, location, or iRepo identifiers.

Pagination parameters can be used to control the number of records returned per request.

 

URL: /api/v140/company/connections
Method: GET

Query Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

type

Filters results based on the company type ID

No

?type=2

per_page

Number of records returned per page. Default is 250, maximum allowed is 5000

No

?per_page=500

page

Specifies the page number of the results to retrieve

No

?page=1

category

Filters results by company category such as Vendor, Lender, or Forwarder

No

?category=Vendor

address

Filters results where address_1 contains the specified string

No

?address=Main

zip

Filters results by ZIP or postal code

No

?zip=85001

city

Filters results by city name

No

?city=Phoenix

county

Filters results by county name

No

?county=Maricopa

irepo_lot_id

Filters address records by the mapped iRepo lot identifier

No

?irepo_lot_id=123

irepo_branch_id

Filters address records by the mapped iRepo branch identifier

 

 

No

?irepo_branch_id=456

 

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/company/connections?type=3&zip=92120

 

Request Body: NA

Response:

{

    "data": [

        {

            "id": 10002,

            "name": "Limited User Version Demo",

            "type": 3,

            "updated_at": "2024-03-19 10:20:17",

            "addresses": [

                {

                    "id": 2,

                    "address_id": 2,

                    "company_id": 10002,

                    "is_primary": 1,

                    "is_cars_certified": 1,

                    "is_risc_certified": 1,

                    "risc_lot_expiration": "2025-01-03",

                    "risc_inspection_id": "1234",

                    "risc_certification_date": "2023-01-13",

                    "irepo_lot_id": null,

                    "irepo_branch_id": null,

                    "address_details": {

                        "id": 2,

                        "name": null,

                        "address_1": "1222 N Main Ave",

                        "address_2": "",

                        "state_abbr": "CA",

                        "city_name": "San Diego",

                        "zip_code": "92120",

                        "county_name": "San Diego",

                        "longitude": null,

                        "latitude": null,

                        "unit": null,

                        "phones": [

                            {

                                "id": 2,

                                "type": 2,

                                "number": "111-111-1111",

                                "extension": null

                            },

                            {

                                "id": 10,

                                "type": 3,

                                "number": "333-333-3333",

                                "extension": null

                            },

                            {

                                "id": 18,

                                "type": 4,

                                "number": "222-222-2222",

                                "extension": null

                            }

                        ]

                    }

                }

            ]

        }

    ],

    "links": {

        "first": "http://stg-api.mbsisystems.com/api/v140/company/connections?type=3&zip=92120&page=1",

        "last": "http://stg-api.mbsisystems.com/api/v140/company/connections?type=3&zip=92120&page=1",

        "prev": null,

        "next": null

    },

    "meta": {

        "current_page": 1,

        "from": 1,

        "last_page": 1,

        "path": "http://stg-api.mbsisystems.com/api/v140/company/connections",

        "per_page": 250,

        "to": 1,

        "total": 1

    }

}

 

 

List Company Users (Employees)

DescriptionThis endpoint retrieves the list of users (employees) associated with the authenticated user's company.

The endpoint returns user records linked to the company, including employee details and associated metadata. Pagination parameters can be used to control the number of records returned per request.

URL: /api/v140/employees
Method: GET

Query Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

per_page

Number of records returned per page. Default is 250, maximum allowed is 5000

No

?per_page=500

page

Specifies the page number of the results to retrieve

No

?page=1

 

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/employees?per_page=1

 

Request Body: NA

Response:

{

    "data": [

        {

            "id": 11765,

            "company_id": 10004,

            "name": "Forwarding Office",

            "firstname": "Forwarding",

            "lastname": "Office",

            "contact": {

                "email": null,

                "mobile_phone": null

            },

            "roles": [

                "Administrator FWD",

                "API Connection",

                "Accountant",

                "Case Worker FWD",

                "Compliance Officer FWD ",

                "Field Agent",

                "Remarketing FWD",

                "Team Lead",

                "Transportation FWD",

                "Accountant",

                "Administrator FWD",

                "Field Agent"

            ],

            "self": "http://stg-api.mbsisystems.com/api/employees/11765",

            "expand": "employee"

        }

    ],

    "links": {

        "first": "http://stg-api.mbsisystems.com/api/v140/employees?page=1",

        "last": "http://stg-api.mbsisystems.com/api/v140/employees?page=732",

        "prev": null,

        "next": "http://stg-api.mbsisystems.com/api/v140/employees?page=2"

    },

    "meta": {

        "current_page": 1,

        "from": 1,

        "last_page": 732,

        "path": "http://stg-api.mbsisystems.com/api/v140/employees",

        "per_page": 1,

        "to": 1,

        "total": 732

    }

}

 

 

Get Case Tags for Company

DescriptionThis 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/v140/companies/{company_id}/tags
Method: GET

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/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

DescriptionThis 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/v140/companies/{company_id}/special_instuctions
Method: GET

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/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

DescriptionThis 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/v140/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/v140/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"

}

 

 

Update Special Instruction for Company

DescriptionThis endpoint updates an existing special instruction associated with a specific company.

Special instructions define operational guidelines, requirements, or notes that must be followed when handling cases related to the company. This endpoint allows users to modify the instruction content, associated lienholder conditions, collateral status conditions, and visibility settings for service providers.

Only the fields provided in the request body will be updated. Fields not included will remain unchanged.

All requests must include a valid Bearer Token in the request header.

 

URL: /api/v140/companies/{company_id}/special_instuctions/{special_instuction_id}
Method: PUT

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

No

0

content

Text content of the special instruction

No

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/v140/companies/65690/special_instructions/2473

 

Request Body:

{

  "case_lienholder": 10001,

  "collateral_status": 0,

  "content": "ALternate instruction",

  "display_to_serviceprovider": 0

}

 

 

Response:

{

    "data": {

        "id": 2473,

        "created_by": 408564,

        "created_by_company": 10004,

        "created_for_company": 65690,

        "case_lienholder": 10001,

        "collateral_status": 0,

        "content": "ALternate instruction",

        "display_to_serviceprovider": 0,

        "created_at": "2026-03-12 11:23:54",

        "updated_at": "2026-03-12 11:53:40"

    },

    "status": "success"

}

 

 

Delete Special Instruction for Company

DescriptionThis endpoint deletes an existing special instruction associated with a specific company.

Special instructions define operational guidelines or requirements for handling cases related to the company. This endpoint allows users to remove a special instruction that is no longer required or applicable.

All requests must include a valid Bearer Token in the request header.

 

URL: /api/v140/companies/{company_id}/special_instuctions/{special_instuction_id}
Method: DELETE

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/companies/65690/special_instructions/2473

 

Request Body: NA

Response:

{

    "data": {

        "success": true

    }

}