Skip to main content
GET
Get auto-enrolment assessments

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization_id
required
employee_id
required

Response

Successful Response

assessment_date
string<date>
required

Date of the assessment; equals the pay_date from the pay calendar

worker_category
enum<string>
required

AE worker category determined by the system on this date based on age and earnings: ELIGIBLE_JOBHOLDER, NON_ELIGIBLE_JOBHOLDER, ENTITLED_WORKER, or EXCLUDED

Available options:
ELIGIBLE_JOBHOLDER,
NON_ELIGIBLE_JOBHOLDER,
ENTITLED_WORKER,
EXCLUDED
eligibility_trigger
enum<string>
required

What initiated this assessment: NEW_HIRE (first payrun for this employee), EARNINGS_THRESHOLD (earnings crossed the trigger for the first time), AGE_THRESHOLD (employee turned 22), RE_ENROLMENT (3-year cyclical re-enrolment), PAY_PERIOD_ASSESSMENT (routine check on every payrun)

Available options:
NEW_HIRE,
EARNINGS_THRESHOLD,
AGE_THRESHOLD,
RE_ENROLMENT,
PAY_PERIOD_ASSESSMENT
enrolment_required
boolean
required

True if the employee was eligible and not yet enrolled — auto_enrol() was called and the employee was enrolled into the default scheme. False if already ACTIVE, not eligible, or on postponement

re_enrolment_indicator
boolean
required

True if this was a cyclical re-enrolment (employee had previously opted out and is being re-enrolled under the 3-year duty); false for initial enrolment

qualifying_earnings
string | null
required

Earnings within the AE qualifying band (£6,240–£50,270/year, pro-rated for the period) used as the contribution base; null if the employee was not eligible or contributions were not calculated

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
age_at_assessment
integer | null
required

Employee's age in whole years on the assessment date; null if date of birth was unavailable

payrun_id
string | null
required

ID of the payrun in which this assessment was performed; null for assessments triggered outside a payrun (e.g. manual enrolment)

created_at
string<date-time>
required

Timestamp when this assessment record was created