POST
/
employer
/
benefits
curl --request POST \
  --url https://api.tryfinch.com/employer/benefits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'Finch-API-Version: <finch-api-version>'
{
  "benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782"
}

Availability: Automated and Assisted providers

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.

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

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.

Content-Type
string
default: application/jsonrequired

Used to indicate the original media type of the resource

Body

application/json
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

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
Available options:
one_time,
every_paycheck,
monthly

Response

201 - application/json
benefit_id
string