Guides

Updates the AutoEnrolment state for an Employee.
You would use this API call to process notices such as Opt Out, Opt In, etc.
A new assessment is returned showing the result of the state change.

Store values

Parameters

employerId string

The Id of the Employer to which the Employee belongs

employeeId string

The Id of the Employee you want to set the status for

state string

The AutoEnrolment State to set for the Employee (optional)

status string

(optional)

stateDate string

Optional. Will default to the current date (optional)

pensionSchemeId string

Optional. Used to override the default AE Pension. Only valid with states of Enrol, VoluntaryJoiner or OptIn (optional)

workerGroupId string

Optional. Used to override the default AE Pension Workergroup. Only valid with states of Enrol, Join or OptIn. Must be provided if a pensionId is being provided. (optional)

startActionAlreadyReported

boolean

Optional. Set to true if the employee has already been reported to the pension provider as a joiner. (optional)

endActionAlreadyReported

boolean

Optional. Set to true if the employee has already been reported to the pension provider as a leaver. (optional)

pensionId string

Optional. The specific Pension UniqueId. (optional)

Try it Accept:

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

201	Assessment created successfully	`AeAssessment`	text/plain
400	Bad Request - Invalid parameters or state transition
404	Employee or Employer not found