Individual

POST

employer

individual

Authorizations

Authorization

string

headerrequired

Please use your Access Token

Headers

Finch-API-Version

string

default: 2020-09-17required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Content-Type

string

default: application/jsonrequired

Used to indicate the original media type of the resource

Body

application/json

requests

object[]

options

object | null

Response

200 - application/json

responses

object[]

responses.individual_id

string

responses.code

integer

responses.body

object

responses.body.id

string

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

responses.body.first_name

string | null

The legal first name of the individual.

responses.body.middle_name

string | null

The legal middle name of the individual.

responses.body.last_name

string | null

The legal last name of the individual.

responses.body.preferred_name

string | null

The preferred name of the individual.

responses.body.emails

object[] | null

responses.body.phone_numbers

array | null

responses.body.gender

enum<string> | null

The gender of the individual.

Available options:

female,

male,

other,

decline_to_specify

responses.body.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

responses.body.dob

string | null

responses.body.residence

object | null

responses.body.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.

responses.body.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.

Was this page helpful?

Directory Employment

Organization

Payroll

Deductions

Management

Sandbox

Development Guides

Authorizations

Headers

Body

Response