Skip to main content
PUT
JavaScript

Authorizations

Authorization
string
header
required

Please use your Access Token

Path Parameters

individual_id
string
required

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.

title
string | null

The current title of the individual.

manager
object | null

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

department
object | null

The department object.

employment
object | null

The employment object.

start_date
string | null
Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
end_date
string | null
Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
latest_rehire_date
string | null
Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
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
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.

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.

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.

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

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.

title
string | null

The current title of the individual.

manager
object | null

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

department
object | null

The department object.

employment
object | null

The employment object.

start_date
string | null
Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
end_date
string | null
Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
latest_rehire_date
string | null
Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
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
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.

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.

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.

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

id
string<uuid>

A stable Finch id (UUID v4) for an individual in the company.

Pattern: [0-9a-fA-F]{8}[-]?(?:[0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}