POST
/
employer
/
benefits
import Finch from '@tryfinch/finch-api';

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

async function main() {
  const createCompanyBenefitsResponse = await client.hris.benefits.create();

  console.log(createCompanyBenefitsResponse.benefit_id);
}

main();
{
  "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 7 day SLA for Assisted providers.

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.

Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Body

application/json

Response

201
application/json
Successfully Created

The response is of type object.