PUT
/
sandbox
/
individual
/
{individual_id}
import Finch from '@tryfinch/finch-api';

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

async function main() {
  const individual = await client.sandbox.individual.update('individual_id');

  console.log(individual.id);
}

main();
{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "preferred_name": "<string>",
  "emails": [
    {
      "data": "<string>",
      "type": "work"
    }
  ],
  "phone_numbers": [
    {
      "data": "<string>",
      "type": "work"
    }
  ],
  "gender": "female",
  "ethnicity": "asian",
  "dob": "<string>",
  "ssn": "<string>",
  "encrypted_ssn": "<string>",
  "residence": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>",
    "name": "<string>",
    "source_id": "<string>"
  },
  "id": "<string>"
}

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.

​
preferred_name
string | null

The preferred name of the individual.

​
emails
object[] | null
​
phone_numbers
array | 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
object | null

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.

​
preferred_name
string | null

The preferred name of the individual.

​
emails
object[] | null
​
phone_numbers
array | 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
object | null
​
id
string

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

Was this page helpful?

Add a new sandbox paymentUpdate sandbox employment