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

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

const documents = await client.hris.documents.list();

console.log(documents.documents);
{
  "paging": {
    "offset": 123,
    "count": 123
  },
  "documents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "individual_id": "<string>",
      "url": "<string>",
      "year": 123,
      "type": "w4_2020"
    }
  ]
}

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string<date>
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Query Parameters

entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access.

Required array length: 1 element
Example:
["550e8400-e29b-41d4-a716-446655440000"]
limit
integer

Number of documents to return (defaults to all)

offset
integer

Index to start from (defaults to 0)

individual_ids
string[]

Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals

types
enum<string>[]

Comma-delimited list of document types to filter on. If empty, defaults to all types

Available options:
w4_2020,
w4_2005

Response

200 - application/json

OK

paging
Paging · object
required
documents
object[]
required