Company Onboarding
updateAdminUser
- Documentation
- API Reference
Company Onboarding
User Onboarding
Admin Portal
User Portal
Payroll
Reports
API Reference
Company Onboarding
updateAdminUser
Run the getBusinessUserDetails endpoint before running this endpoint inorder to update only the required fields.
Business User can have one or more of these roles :
Payroll Admin
Controller
Beneficial Owner (Ownership Percentage Must be specified for Beneficial Owner)
Employee
PUT
/
companyOnboarding#updateAdminUser
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
updateAdminUser · string
*
method
Required
string
Add Example Value
businessUser
object
*
businessUser
Required
object
businessUserId
string
*
businessUserId
Required
string
firstName
string
firstName
string
middleName
string
middleName
string
lastName
string
lastName
string
phoneNumber
Must be 10 Digits · string
phoneNumber
string
Add Example Value
email
string
email
string
dateOfBirth
string
dateOfBirth
string
Add Example Value
address1
string
address1
string
address2
string
address2
string
city
string
city
string
state
Enum · enum<string>
state
enum<string>
zipcode
Must be Five or Nine Digits · string
zipcode
string
country
enum<string>
country
enum<string>
ssn
string
ssn
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 PUT \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#updateAdminUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "updateAdminUser",
"businessUser": {
"businessUserId": "971F0557-23B2-40ED-A950-F92ECD8C2BBA",
"firstName": "",
"middleName": "",
"lastName": "",
"phoneNumber": "",
"email": "",
"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": "3819B535-F3AA-4E5E-A055-16D33CE68315",
"status": "Ready",
"message": "The Business User has been updated successfully."
}
}
}
}Body
application/json
method
string
default: updateAdminUserrequiredbusinessUser
object
requiredbusinessUser.businessUserId
string
requiredbusinessUser.firstName
string
businessUser.middleName
string
businessUser.lastName
string
businessUser.phoneNumber
string
businessUser.email
string
businessUser.dateOfBirth
string
businessUser.address1
string
businessUser.address2
string
businessUser.city
string
businessUser.state
enum<string>
Available 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
businessUser.country
enum<string>
Available options:
US businessUser.ssn
string
businessUser.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 PUT \
--url 'https://sandbox.rollfi.xyz/companyOnboarding#updateAdminUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "updateAdminUser",
"businessUser": {
"businessUserId": "971F0557-23B2-40ED-A950-F92ECD8C2BBA",
"firstName": "",
"middleName": "",
"lastName": "",
"phoneNumber": "",
"email": "",
"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": "3819B535-F3AA-4E5E-A055-16D33CE68315",
"status": "Ready",
"message": "The Business User has been updated successfully."
}
}
}
}