v50

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

Enroll Individuals in Deductions

Enroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.

post/employer/benefits/{benefit_id}/individuals

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

individual_idstring

Finch id (uuidv4) for the individual to enroll

Response

Successfully enqueued job to enroll individuals in the benefit

job_idstring uuid required