Add new individuals to a sandbox company
Authorizations
Please use your Access Token
Body
Worker's compensation classification code for this employee
Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.
The department object.
The employment object.
The detailed employment status of the individual.
active
, deceased
, leave
, onboarding
, prehire
, retired
, terminated
Social Security Number of the individual in encrypted format. This field is only available with the ssn
scope enabled and the options: { include: ['ssn'] }
param set in the body.
The EEOC-defined ethnicity of the individual.
asian
, white
, black_or_african_american
, native_hawaiian_or_pacific_islander
, american_indian_or_alaska_native
, hispanic_or_latino
, two_or_more_races
, decline_to_specify
The legal first name of the individual.
The gender of the individual.
female
, male
, other
, decline_to_specify
The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.
The array of income history.
true
if the individual an an active employee or contractor at the company.
The legal last name of the individual.
The manager object representing the manager of the individual within the org.
The legal middle name of the individual.
The preferred name of the individual.
The source system's unique employment identifier for this individual
Social Security Number of the individual. This field is only available with the ssn
scope enabled and the options: { include: ['ssn'] }
param set in the body. Click here to learn more about enabling the SSN field.
The current title of the individual.
Response
The individuals which were created
Was this page helpful?