GET
/
employer
/
benefits
/
{benefit_id}
JavaScript
import Finch from '@tryfinch/finch-api';

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

const companyBenefit = await client.hris.benefits.retrieve('benefit_id');

console.log(companyBenefit.benefit_id);
{
  "benefit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_contribution": {
    "type": "match",
    "tiers": [
      {
        "threshold": 5000,
        "match": 5000
      }
    ]
  },
  "type": "457",
  "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.

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.

Path Parameters

​
benefit_id
string
required

Response

200
application/json

OK

The response is of type object.