POST
/
employer
/
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 employmentDataResponse of client.hris.employments.retrieveMany({
    requests: [{ individual_id: 'individual_id' }],
  })) {
    console.log(employmentDataResponse.individual_id);
  }
}

main();
{
  "responses": [
    {
      "individual_id": "8b3f8edc-735d-4382-84d6-104eac2013b5",
      "code": 404,
      "body": {
        "code": 404,
        "finch_code": "individual_not_found",
        "message": "No individual with id 8b3f8edc-735d-4382-84d6-104eac2013b5 found",
        "name": "not_found_error"
      }
    }
  ]
}

Note: Income information is returned as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.

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

Individual Ids Request Body

Response

200
application/json
Employment data

The response is of type object.