Organization
Individual
Deductions
Documents
Management
Sandbox
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Development Guides
Organization
Individual
Read individual data, excluding income and employment data
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": "+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
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Used to indicate the original media type of the resource
Body
application/json
Response
200
application/json
Individual data
The response is of type object
.
Was this page helpful?
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": "+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"
}
}
}
]
}