Admin Portal
addUser
- Documentation
- API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- POSTaddCompanyBankAccount
- PUTdeactivateCompanyBankAccount
- POSTaddUser
- PUTupdateUser
- POSTaddUsers
- POSTaddStateRegistration
- PUTupdateStateRegistration
- POSTaddUserWage
- PUTupdateUserWage
- PUTupdateBusinessUserAsEmployee
- PUTupdateEmployeeAsBusinessUser
- PUTupdateBusinessUser
- PUTupdateCompanyLocation
- POSTactivateUser
- POSTdeactivateUser
- PUTterminateUser
- POST
- User Portal
- Payroll
- Reports
API Reference
Admin Portal
addUser
This endpoint can be used to Create an Employee/Contractor by providing the required fields
POST
/
adminPortal#addUser
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
addUser · string
*
method
Required
string
Add Example Value
user
object
*
user
Required
object
companyId
string
*
companyId
Required
string
userReferenceId
string
userReferenceId
string
firstName
string
*
firstName
Required
string
middleName
string
middleName
string
lastName
string
*
lastName
Required
string
email
string
*
email
Required
string
phoneNumber
Must be 10 digits · string
*
phoneNumber
Required
string
Add Example Value
dateOfJoin
string
*
dateOfJoin
Required
string
workerType
Enum · enum<string>
*
workerType
Required
enum<string>
jobTitle
string
*
jobTitle
Required
string
companyLocationCategory
enum<string>
*
companyLocationCategory
Required
enum<string>
Add Example Value
code
Enum · enum<string>
code
enum<string>
companyLocationId
Need to be added when CompanyLocationCategory is Office · string
companyLocationId
string
Body
application/json
method
string
default: addUserrequireduser
object
requireduser.companyId
string
requireduser.userReferenceId
string
user.firstName
string
requireduser.middleName
string
user.lastName
string
requireduser.email
string
requireduser.phoneNumber
string
requireduser.dateOfJoin
string
requireduser.workerType
enum<string>
requiredAvailable options:
W2
, 1099-NEC
user.jobTitle
string
requireduser.companyLocationCategory
enum<string>
requiredAvailable options:
Office
, Remote
user.code
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
user.companyLocationId
string
Response
200 - application/json
user
object
requireduser.userId
string
requireduser.status
string
requireduser.message
string