Company Onboarding
addBusinessUser
- Documentation
- API Reference
Company Onboarding
User Onboarding
Admin Portal
User Portal
Payroll
Reports
API Reference
Company Onboarding
addBusinessUser
Business User Creation Endpoint
To create a Business User. This is a user whose specific role will define their permissions and responsibilities within the system.
-Business User can have one or more of these roles :
-
Payroll Admin
-
Controller
-
Beneficial Owner (Ownership Percentage Must be specified for Beneficial Owner)
-
Employee
POST
/
companyOnboarding#addBusinessUser
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
username
string
username
string
password
string
password
string
object
method
addBusinessUser · string
*
method
Required
string
Add Example Value
businessUser
object
*
businessUser
Required
object
companyId
string
*
companyId
Required
string
firstName
string
*
firstName
Required
string
middleName
string
middleName
string
lastName
string
*
lastName
Required
string
phoneNumber
Must be 10 digits · string
*
phoneNumber
Required
string
Add Example Value
email
string
*
email
Required
string
address1
string
*
address1
Required
string
address2
string
address2
string
city
string
*
city
Required
string
state
Enum · enum<string>
*
state
Required
enum<string>
zipcode
Must be Five or Nine Digits · string
*
zipcode
Required
string
country
Currently only US is supported · enum<string>
*
country
Required
enum<string>
ssn
Must be 9 Digits · string
*
ssn
Required
string
Add Example Value
dateOfBirth
string
*
dateOfBirth
Required
string
Add Example Value
payrollAdmin
boolean
payrollAdmin
boolean
bookkeeper
boolean
bookkeeper
boolean
beneficialOwner
boolean
beneficialOwner
boolean
ownershipPercentage
Must be specified for Beneficial Owner · number
ownershipPercentage
number
curl --request POST \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#addBusinessUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "addBusinessUser",
"businessUser": {
"companyId": "8A9B7683-8E02-494D-8422-963FD05EE785",
"firstName": "Tim",
"middleName": "",
"lastName": "David",
"phoneNumber": "9889890989",
"email": "tim@david.xyz",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"country": "US",
"ssn": "123098989",
"dateOfBirth": "2000-09-09",
"payrollAdmin": true,
"bookkeeper": true,
"beneficialOwner": true,
"ownershipPercentage": 25
}
}'{
"1": {
"summary": "Success",
"value": {
"businessUser": {
"businessUserId": "5370FF7F-9FFF-401A-A949-AFB393B50F09",
"status": "KYC Pending",
"message": "Tim David has been successfully added as BusinessUser."
}
}
}
}Body
application/json
method
string
default: addBusinessUserrequiredbusinessUser
object
requiredbusinessUser.companyId
string
requiredbusinessUser.firstName
string
requiredbusinessUser.middleName
string
businessUser.lastName
string
requiredbusinessUser.phoneNumber
string
requiredbusinessUser.email
string
requiredbusinessUser.address1
string
requiredbusinessUser.address2
string
businessUser.city
string
requiredbusinessUser.state
enum<string>
requiredAvailable options:
TX, AK, ND, IL, MA, KS, AS, AL, UT, SD, MI, DC, GA, SC, TN, OK, CO, CA, ME, MO, WY, MD, VT, NM, CT, AZ, WI, VA, WV, NJ, DE, NC, PR, IN, MT, NH, HI, IA, KY, WA, OH, FL, OR, MP, GU, MN, MS, PA, NE, RI, ID, LA, NY, NV, AR businessUser.zipcode
string
requiredbusinessUser.country
enum<string>
requiredAvailable options:
US businessUser.ssn
string
requiredbusinessUser.dateOfBirth
string
requiredbusinessUser.payrollAdmin
boolean
businessUser.bookkeeper
boolean
businessUser.beneficialOwner
boolean
businessUser.ownershipPercentage
number
Response
200 - application/json
businessUser
object
requiredbusinessUser.businessUserId
string
requiredbusinessUser.status
string
requiredbusinessUser.message
string
curl --request POST \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#addBusinessUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "addBusinessUser",
"businessUser": {
"companyId": "8A9B7683-8E02-494D-8422-963FD05EE785",
"firstName": "Tim",
"middleName": "",
"lastName": "David",
"phoneNumber": "9889890989",
"email": "tim@david.xyz",
"address1": "8745 Colard Ln",
"address2": "",
"city": "Lyons",
"state": "CO",
"zipcode": "80540",
"country": "US",
"ssn": "123098989",
"dateOfBirth": "2000-09-09",
"payrollAdmin": true,
"bookkeeper": true,
"beneficialOwner": true,
"ownershipPercentage": 25
}
}'{
"1": {
"summary": "Success",
"value": {
"businessUser": {
"businessUserId": "5370FF7F-9FFF-401A-A949-AFB393B50F09",
"status": "KYC Pending",
"message": "Tim David has been successfully added as BusinessUser."
}
}
}
}