Sign in
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

Changes

Changed in 4 of the 53 revisions of this API.26

  • 0105d239fcaf3See the full diff
    • ○

      added the new optional query request parameter entity_ids

      new-optional-request-parameter

    • ○

      added the new optional request property items/configuration/company_contribution/tiers

      new-optional-request-property

    • ○

      added the new tiered enum value to the request property items/configuration/company_contribution/type

      request-property-enum-value-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 46640c1b46881See the full diff
    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

  • bf858f37d7ab21See the full diff
    • ▲

      the response's body type/format changed from array/ to object/ for status 200

      response-body-type-changed

    • ▲

      removed the success response with the status 207

      response-success-status-removed

    • ○

      added the required property job_id to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 14d375aab89e1See the full diff
    • ○

      added the new optional request property items/configuration/effective_date

      new-optional-request-property