GET
/
employer
/
documents
import Finch from '@tryfinch/finch-api';

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

async function main() {
  const document = await client.hris.documents.list();

  console.log(document.documents);
}

main();
{
  "paging": {
    "count": 1,
    "offset": 0
  },
  "documents": [
    {
      "id": "238b1d2a-3172-4b4a-a825-b04c0b2d0cac",
      "individual_id": "f92b3db4-7bcb-4a54-a570-396bf99e041a",
      "year": 2020,
      "url": "https://api.tryfinch.com/employer/documents/238b1d2a-3172-4b4a-a825-b04c0b2d0cac",
      "type": "w4_2020"
    }
  ]
}

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.

Query Parameters

​
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
object
​
documents
object[]

Was this page helpful?