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_id
Headers
X-Platform-Id
The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.
Request
This endpoint expects an object.
employee_id
The employee to check eligibility for.
Response
OK
eligibility_status
Eligibility status: eligible or ineligible.
reasons
List of reasons why the employee is ineligible. Empty if eligible.
provider
The insurance provider associated with the group.
plan
The insurance plan associated with the group.
object
The object type.
Errors
400
Bad Request Error
404
Not Found Error