Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
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.

marital_status'single' | 'married' | 'divorced' | 'widowed' | 'domestic_partner' | 'unknown' | 'null' nullable

The employee's marital status, used for beneficiary designation and spousal consent workflows.

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.

flsa_status'exempt' | 'non_exempt' | 'unknown' | 'null' nullable

The FLSA status of the individual. Available options: exempt, non_exempt, unknown.

class_codestring nullable

Worker's compensation classification code for this employee

union_codestring nullable

The code identifying the union the employee is a member of, as configured in the payroll system.

union_localstring nullable

The local chapter or local number within the employee's union.

highly_compensated_employeeboolean nullable

IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.

key_employeeboolean nullable

IRS flag indicating whether the employee is classified as a Key Employee for top-heavy testing purposes. US-only.

source_idstring nullable

The source system's unique employment identifier for this individual

Response

OK

object[] required

The individuals which were created