GET
/
employer
/
benefits
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 companyBenefit of client.hris.benefits.list()) {
    console.log(companyBenefit.benefit_id);
  }
}

main();
[
  {
    "benefit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_contribution": {
      "type": "match",
      "tiers": [
        {
          "threshold": 5000,
          "match": 5000
        }
      ]
    },
    "type": "401k",
    "description": "<string>",
    "frequency": "one_time"
  }
]

Availability: Automated providers only

Employer Match capabilities are currently in Beta. Please reach out if you are interested in gaining early access.

This is a live request to the provider. Latencies may vary from seconds to minutes depending on the provider and number of items.

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.

Response

200 - application/json
OK
​
benefit_id
string
required

The id of the benefit.

​
company_contribution
object | null
required

The company match for this benefit.

​
type
enum<string> | null
required

Type of benefit.

Available options:
401k,
401k_roth,
401k_loan,
403b,
403b_roth,
457,
457_roth,
s125_medical,
s125_dental,
s125_vision,
hsa_pre,
hsa_post,
fsa_medical,
fsa_dependent_care,
simple_ira,
simple,
commuter,
custom_post_tax,
custom_pre_tax
​
description
string | null
required
​
frequency
enum<string> | null
required

The frequency of the benefit deduction/contribution.

Available options:
one_time,
every_paycheck,
monthly