Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
Sandbox

Update sandbox individual

put/sandbox/individual/{individual_id}

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.

Response

OK

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.

idstring uuid

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