Skip to main content
POST
JavaScript
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.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
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. Provide exactly one entity ID per request; a maximum of one is accepted.

Required array length: 1 element
Example:

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,
null
description
string
frequency
enum<string> | null

The frequency of the benefit deduction/contribution.

Available options:
every_paycheck,
monthly,
one_time,
null

Response

Successfully Created

benefit_id
string<uuid>
required

The id of the benefit.

job_id
string<uuid>
required