Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
Deductions

Register Deduction

Register existing benefits from the customer on the provider, on Finch's end. Please use the /provider endpoint to view available types for each provider.

post/employer/benefits/register

Query parameters

entity_idsstring[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

[
  "550e8400-e29b-41d4-a716-446655440000"
]

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Content-Typestring required

Used to indicate the original media type of the resource

Request body

type'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' nullable

Type of benefit.

descriptionstring
frequency'every_paycheck' | 'monthly' | 'one_time' | 'null' nullable

The frequency of the benefit deduction/contribution.

Response

Successfully Created

benefit_idstring uuid required

The id of the benefit.

job_idstring uuid required