Skip to main content
POST
/
employer
/
benefits
/
register
Register Deduction
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": "457",
  "description": "<string>",
  "frequency": "every_paycheck"
}'
{
  "benefit_id": "e8b90071-0c11-471c-86e8-e303ef2f6782",
  "job_id": "be1b3351-a88e-46c2-96e4-c2cf38e529a7"
}
Availability: Assisted providers only

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string<date>
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

Query Parameters

​
entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access.

Required array length: 1 element
Example:
["550e8400-e29b-41d4-a716-446655440000"]

Body

application/json
​
type
enum<string> | null

Type of benefit.

Available options:
457,
401k,
401k_roth,
401k_loan,
403b,
403b_roth,
457_roth,
commuter,
custom_post_tax,
custom_pre_tax,
fsa_dependent_care,
fsa_medical,
hsa_post,
hsa_pre,
s125_dental,
s125_medical,
s125_vision,
simple,
simple_ira
​
description
string
​
frequency
enum<string> | null

The frequency of the benefit deduction/contribution.

Available options:
every_paycheck,
monthly,
one_time

Response

Successfully Created

​
benefit_id
string<uuid>
required

The id of the benefit.

​
job_id
string<uuid>
required