GET
/
employer
/
benefits
/
{benefit_id}
curl --request GET \
  --url https://api.tryfinch.com/employer/benefits/{benefit_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Finch-API-Version: <finch-api-version>'
{
  "benefit_id": "6547e3aa-d887-4a77-bd41-17221e17cce3",
  "type": "401k",
  "description": "Example 401k",
  "frequency": "every_paycheck"
}

Availability: Automated providers only

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

Authorizations

Authorization
string
headerrequired

Please use your Access Token

Headers

Finch-API-Version
string
default: 2020-09-17required

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
benefit_id
string
type
enum<string> | null

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
frequency
enum<string> | null
Available options:
one_time,
every_paycheck,
monthly,
company_contribution
object | null
employee_deduction
object | null

Was this page helpful?

Create DeductionUpdate Deduction