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

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

Response

201 - application/json
benefit_id
string
job_id
string

Was this page helpful?

Get All DeductionsCreate Deduction