getBusinessUserDetails

The getBusinessUserDetails API is used to retrieve comprehensive information about a specific business user within the system.

What it does:

• Returns detailed information for the business user including their role, address, SSN and more
• Allows business users to view their stored data before making changes using other API calls

Note:

• Use getBusinessUserDetails if you do not have access to the business user ID or wish to retrieve data for all business users

GET /reports#getBusinessUserDetails

getBusinessUserDetails

cURL

curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getBusinessUserDetails' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getBusinessUserDetails",
  "businessUserId": "D8934854-20F7-4607-8007-A4B78254007F"
}
'

200

{
  "businessUser": [
    {
      "businessUserId": "D8934854-20F7-4607-8007-A4B78254007F",
      "businessUser": "Regina  Wise",
      "firstName": "Regina",
      "middleName": "",
      "lastName": "Wise",
      "email": "[e-mail]",
      "phoneNumber": "2511630007",
      "payrollAdmin": true,
      "bookKeeper": true,
      "beneficialOwner": false,
      "employee": true,
      "ownershipPercentage": 0,
      "companyLocationID": "889F5A0D-CBC5-4495-A09B-D98B63490C1C",
      "address1": "102 Fallsgrove Blvd",
      "address2": "",
      "city": "Rockville",
      "state": "MD",
      "zipcode": "20850",
      "country": "US",
      "ssn": "587400936",
      "startDate": "2020-09-09",
      "dateOfBirth": "2006-09-09"
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · required

businessUserId · string · required

Response

200 - application/json

businessUser · object[] · required

Show child attributes