Applies to integrated customers using the RecoveryConnect API



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/v130/companies/{company_id}/DNU_agents
Method: GET

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

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

        }

    ]

}

 

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

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

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

            }

        }

    }

}