Skip to main content
POST
/
employer
/
individual
JavaScript
import Finch from '@tryfinch/finch-api';

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

// Automatically fetches more pages as needed.
for await (const individualResponse of client.hris.individuals.retrieveMany()) {
  console.log(individualResponse.individual_id);
}
{
  "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": "[email protected]",
            "type": "work"
          },
          {
            "data": "[email protected]",
            "type": "personal"
          }
        ],
        "phone_numbers": [
          {
            "data": "+14475678901",
            "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

Headers

​
Finch-API-Version
string<date>
default:2020-09-17
required
​
Content-Type
string
default:application/json
required

Query Parameters

​
entity_ids
string<uuid>[]
Required array length: 1 element
Example:

Body

application/json
​
requests
object[]
​
options
object | null

Response

​
responses
object[]
required