Check employee eligibility for a group

Checks whether an employee qualifies for a group without adding them to it. This is a dry-run eligibility check — the employee is not enrolled or added. The response includes provider and plan information.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

group_idstringRequiredformat: "gr_.+"

Request

This endpoint expects an object.
employee_idstringRequiredformat: "ee_.+"
The employee to check eligibility for.

Response

OK
eligibility_statusenum

Eligibility status: eligible or ineligible.

Allowed values:
reasonslist of objects
List of reasons why the employee is ineligible. Empty if eligible.
providerobject
The insurance provider associated with the group.
planobject
The insurance plan associated with the group.
objectstring or nullRead-only
The object type.

Errors