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.
[ { "individual_id": …, "configuration": … } ]. Do not wrap it in an object: sending { "items": [ … ] } returns 400 Expected array but received object. In the schema below, the items. prefix labels each element of the array, not a top-level items field.Enrollment Bodies
Enrollment bodies have a common format for each benefit type, with a differentconfiguration schema based on the benefit type. The configurations for each type are outlined below. These are general configurations and may vary per provider. Please use the /provider endpoint to view provider specific supported configurations.
Retirement Benefits
Includes 401(k), Roth 401(k), 403(b), Roth 403(b), 457, Roth 457, and Simple IRAHSA
Section 125 Benefits, FSA, Custom Benefits
- Note:
effective_dates that are undefined or in the past will default to the date the request was made. We recommend grouping enrollments byeffective_datefor a request. If multiple distincteffective_dates are included, the job will be in pending status until the latesteffective_dateenrollment is processed. Sandbox integrations do not currently support multiple distincteffective_dates within the same request.
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))Used to indicate the original media type of the resource
Path Parameters
Query Parameters
The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.
1 elementBody
Response
Successfully enqueued job to enroll individuals in the benefit