Skip to main content
POST
/
sandbox
/
directory
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);
[
  {}
]

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Body

application/json
​
first_name
string | null

The legal first name of the individual. The legal first name of the individual.

​
middle_name
string | null

The legal middle name of the individual. The legal middle name of the individual.

​
last_name
string | null

The legal last name of the individual. The legal last name of the individual.

​
preferred_name
string | null

The preferred name of the individual.

​
emails
object[] | null
​
phone_numbers
(object | null)[] | null
​
gender
enum<string> | null

The gender of the individual.

Available options:
female,
male,
other,
decline_to_specify,
​
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,
​
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
​
title
string | null

The current title of the individual.

​
manager
object

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

​
department
object

The department object.

​
employment
object

The employment object.

​
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.

Available options:
active,
deceased,
leave,
onboarding,
prehire,
retired,
terminated,
​
class_code
string | null

Worker's compensation classification code for this employee

​
location
Location · object
​
income
Income · object

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.

​
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.

​
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.

​
source_id
string | null

The source system's unique employment identifier for this individual

Response

200 - application/json

OK