curl --request POST \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/pension/enrol \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enrolmentDate": "2023-12-25",
"entryRoute": "AUTO_ENROLLED",
"workerCategory": "ELIGIBLE_JOBHOLDER"
}
'{
"status": "ACTIVE",
"version": 123,
"workerCategory": "ELIGIBLE_JOBHOLDER",
"entryRoute": "AUTO_ENROLLED",
"enrolmentDate": "2023-12-25",
"optOutDate": "2023-12-25",
"enrolmentCommunicationDate": "2023-12-25",
"schemeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}Enrol employee in pension scheme
Records an employee’s enrolment in the workplace pension scheme. Use this to record auto-enrolment triggered by eligibility assessment, voluntary opt-in by a non-eligible jobholder, or a worker choosing to join. If a membership record does not yet exist, one is created automatically. Returns 409 if the employee is already actively enrolled — use the opt-out endpoint first if re-enrolment is needed after a status change.
curl --request POST \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/pension/enrol \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enrolmentDate": "2023-12-25",
"entryRoute": "AUTO_ENROLLED",
"workerCategory": "ELIGIBLE_JOBHOLDER"
}
'{
"status": "ACTIVE",
"version": 123,
"workerCategory": "ELIGIBLE_JOBHOLDER",
"entryRoute": "AUTO_ENROLLED",
"enrolmentDate": "2023-12-25",
"optOutDate": "2023-12-25",
"enrolmentCommunicationDate": "2023-12-25",
"schemeId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}Authorizations
Get token from Auth0 and paste it here
Body
Request to enrol an employee in the pension scheme.
Use to record auto-enrolment, voluntary opt-in, or a worker joining the scheme. If no scheme_id is provided, the organisation's current active scheme is used.
Date on which enrolment takes effect
How the employee entered the scheme (AUTO_ENROLLED, OPTED_IN, JOINED)
AUTO_ENROLLED, OPTED_IN, JOINED Worker category determined at the time of enrolment
ELIGIBLE_JOBHOLDER, NON_ELIGIBLE_JOBHOLDER, ENTITLED_WORKER, EXCLUDED Date the statutory enrolment communication was issued to the employee. Required to validate the statutory one-month opt-out window.
Pension scheme to enrol into. Defaults to the organisation's current scheme.
Response
Successful Response
Current pension membership state for an employee.
Reflects the latest version of the membership history record.
ACTIVE, OPTED_OUT, NOT_ENROLLED ELIGIBLE_JOBHOLDER, NON_ELIGIBLE_JOBHOLDER, ENTITLED_WORKER, EXCLUDED AUTO_ENROLLED, OPTED_IN, JOINED Was this page helpful?