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
Individual
Read individual data, excluding income and employment data
Please use your Access Token
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
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
Response
A stable Finch id (UUID v4) for an individual in the company.
The legal first name of the individual.
The legal middle name of the individual.
The legal last name of the individual.
The preferred name of the individual.
The gender of the individual.
female, male, other, decline_to_specify The EEOC-defined ethnicity of the individual.
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 Street address or PO box.
Apartment, suite, unit, or building.
City, district, suburb, town, or village.
The state code.
The postal code or zip code.
The 2-letter ISO 3166 country code.
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.
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?