Sign in
Sandbox

Add new individuals to a sandbox company

post/sandbox/directory

Request body

first_namestring nullable

The legal first name of the individual.

middle_namestring nullable

The legal middle name of the individual.

last_namestring nullable

The legal last name of the individual.

preferred_namestring nullable

The preferred name of the individual.

gender'female' | 'male' | 'other' | 'decline_to_specify' | 'null' nullable

The gender of the individual.

ethnicity'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' | 'null' nullable

The EEOC-defined ethnicity of the individual.

dobstring nullable
ssnstring nullable

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.

encrypted_ssnstring nullable

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.

titlestring nullable

The current title of the individual.

start_datestring nullable
end_datestring nullable
latest_rehire_datestring nullable
is_activeboolean nullable

true if the individual an an active employee or contractor at the company.

employment_status'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | 'null' nullable

The detailed employment status of the individual. Available options: active, deceased, leave, onboarding, prehire, retired, terminated.

class_codestring nullable

Worker's compensation classification code for this employee

source_idstring nullable

The source system's unique employment identifier for this individual

Response

OK

object[] required

The individuals which were created

Changes