Individual

POST

employer

individual

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

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

async function main() {
  // Automatically fetches more pages as needed.
  for await (const individualResponse of client.hris.individuals.retrieveMany()) {
    console.log(individualResponse.individual_id);
  }
}

main();

{
  "responses": [
    {
      "individual_id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
      "code": 200,
      "body": {
        "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
        "first_name": "Jane",
        "middle_name": null,
        "last_name": "Doe",
        "preferred_name": "Janey",
        "emails": [
          {
            "data": "jane@acme.com",
            "type": "work"
          },
          {
            "data": "janed@personal.com",
            "type": "personal"
          }
        ],
        "phone_numbers": [
          {
            "data": "5051234567",
            "type": "personal"
          }
        ],
        "gender": "female",
        "ethnicity": "black_or_african_american",
        "dob": "1970-01-01",
        "residence": {
          "line1": "123 Main St",
          "line2": "Apt C",
          "city": "Schenectady",
          "state": "NY",
          "postal_code": "12345",
          "country": "US"
        }
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Please use your Access Token

Headers

Finch-API-Version

string

default:2020-09-17

required

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

Content-Type

string

default:application/json

required

Used to indicate the original media type of the resource

Body

application/json

requests

object[]

options

object | null

Response

200 - application/json

Individual data

responses

object[]

required

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

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

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

async function main() {
  // Automatically fetches more pages as needed.
  for await (const individualResponse of client.hris.individuals.retrieveMany()) {
    console.log(individualResponse.individual_id);
  }
}

main();

{
  "responses": [
    {
      "individual_id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
      "code": 200,
      "body": {
        "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
        "first_name": "Jane",
        "middle_name": null,
        "last_name": "Doe",
        "preferred_name": "Janey",
        "emails": [
          {
            "data": "jane@acme.com",
            "type": "work"
          },
          {
            "data": "janed@personal.com",
            "type": "personal"
          }
        ],
        "phone_numbers": [
          {
            "data": "5051234567",
            "type": "personal"
          }
        ],
        "gender": "female",
        "ethnicity": "black_or_african_american",
        "dob": "1970-01-01",
        "residence": {
          "line1": "123 Main St",
          "line2": "Apt C",
          "city": "Schenectady",
          "state": "NY",
          "postal_code": "12345",
          "country": "US"
        }
      }
    }
  ]
}

Organization

Payroll

Deductions

Documents

Connect

Management

Sandbox

Development Guides

Authorizations

Headers

Body

Response