API ReferenceEnrolment Intents

Update policy configuration enrolment intent

Updates the policy configuration for an existing enrolment_intent. This will reset the enrolment intent back to processing status and re-evaluate the enrolment intent based on the new configuration provided.Unavailable for enrolment intents that are already enrolling or enrolled.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path Parameters

enrolment_intent_idstringRequiredformat: "ei_.+"

Request

This endpoint expects an object.
desired_policy_start_datedate or nullOptional

The desired date for the employee’s policy to start. This date is not guaranteed to be honored by the insurance provider and may be adjusted based on provider-specific rules and requirements. If unspecified, the policy start date will be determined by the insurance provider.

enrolment_datedate or nullOptional
The date on which the employee agreed to enrol into the group's policies. This date may be used by some insurance providers to determine the policy start date. If unspecified, the enrolment date will default to the date the enrolment intent is processed.

Response

OK
idstringformat: "ei_.+"

Unique identifier for the enrolment intent. Prefixed with ei_.

employee_idstringformat: "ee_.+"

Identifier for the employee associated with this enrolment intent. Prefixed with ee_.

group_idstringformat: "gr_.+"

Identifier for the group associated with this enrolment intent. Prefixed with gr_.

statusenum
Current status of the enrolment intent.
force_confirmationboolean

If set to true, the system will always force the PendingConfirmation state before enrolling the employee, even if no action is required. This can be useful in scenarios where you want to ensure that the employee explicitly confirms their enrolment, regardless of their eligibility or any other factors. Defaults to false.

policieslist of objects or null
Policies to be created as part of this enrolment intent.
objectstring or null
The object type
ineligibility_reasonobject or null

If the enrolment intent status is ineligible, this field provides details about the reason for employees ineligibility.

policy_configurationobject or null
Policy configuration associated with this enrolment intent.
action_requiredobject or null

If the enrolment intent status is action_required, this field provides details about the action that needs to be taken to proceed with the enrolment.

pending_confirmationobject or null

If the enrolment intent status is pending_confirmation, this field provides details about the pending confirmation state.

Errors