Add new individuals to a sandbox company

POST /sandbox/directory

JavaScript

JavaScript

import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

const directories = await client.sandbox.directory.create();

console.log(directories);

200

[
  {}
]

Note that requests using the SDK will require a JSON object with a key of body and a value of an array of individuals.

// JavaScript example
await client.sandbox.directory.create({
  body: [
    // list of individual objects
  ]
})

Authorizations

Authorization · string · header · required

Please use your Access Token

Body

application/json

first_name · string | null

The legal first name of the individual.

middle_name · string | null

The legal middle name of the individual.

last_name · string | null

The legal last name of the individual.

preferred_name · string | null

The preferred name of the individual.

emails · object[] | null

Show child attributes

phone_numbers · (object | null)[] | null

Show child attributes

gender · enum<string> | null

The gender of the individual.

Available options: female, male, other, decline_to_specify, null

ethnicity · enum<string> | null

The EEOC-defined ethnicity of the individual.

Available options: 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

marital_status · enum<string> | null

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

Available options: single, married, divorced, widowed, domestic_partner, unknown, null

dob · string | null

ssn · string | null

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_ssn · string | null

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.

residence · Location · object | null

Show child attributes

title · string | null

The current title of the individual.

manager · object | null

The manager object representing the manager of the individual within the org.

Show child attributes

department · object | null

The department object.

Show child attributes

employment · object | null

The employment object.

Show child attributes

start_date · string | null

end_date · string | null

latest_rehire_date · string | null

is_active · boolean | null

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

employment_status · enum<string> | null

The detailed employment status of the individual.

Available options: active, deceased, leave, onboarding, prehire, retired, terminated, null

flsa_status · enum<string> | null

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

Available options: exempt, non_exempt, unknown, null

class_code · string | null

Worker's compensation classification code for this employee

location · Location · object | null

Show child attributes

income · Income · object | null

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.

Show child attributes

income_history · (Income · object | null)[] | null

The array of income history.

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.

Show child attributes

custom_fields · object[] | null

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.

Show child attributes

union_code · string | null

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

union_local · string | null

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

benefit_eligibility_class · string | null

The employer defined benefit eligibility class that groups an employee into a set of eligible benefit plans, as stored by the provider. Null when not configured.

highly_compensated_employee · boolean | null

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

key_employee · boolean | null

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

source_id · string | null

The source system's unique employment identifier for this individual

Response

200 - application/json

OK