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

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

const createCompanyBenefitsResponse = await client.hris.benefits.create({
  entity_ids: ['550e8400-e29b-41d4-a716-446655440000'],
});

console.log(createCompanyBenefitsResponse.benefit_id);
{
  "benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782",
  "job_id": "be1b3351-a88e-46c2-96e4-c2cf38e529a7"
}
Availability: Automated and Assisted providers Employer Match capabilities are currently in Beta. Please reach out if you are interested in gaining early access. If the same request is made more than once with the same type, frequency and description, a new item will not be created. Finch will instead return the benefit_id of the existing item. Latencies may vary depending on whether the provider is Automated or Assisted - new items will be created within minutes for Automated providers and within the 2 business day SLA for Assisted providers.

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.

​
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Query Parameters

​
entity_ids
string<uuid>[]
required

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

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

Body

application/json
​
type
enum<string> | null

Type of benefit.

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

Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).

​
frequency
enum<string> | null

The frequency of the benefit deduction/contribution.

Available options:
every_paycheck,
monthly,
one_time
​
company_contribution
object | null

The company match for this benefit.

Response

Successfully Created

​
benefit_id
string<uuid>
required

The id of the benefit.

​
job_id
string<uuid>
required