Sign in
Health Insurance

Retrieve an employee policy

Retrieve group's health insurance policy for an employee by employee_policy_id.

get/employees/{employee_id}/health_insurance/policies/{employee_policy_id}

Path parameters

employee_idstring required
Example:ee_3b1333d87d9d4fd6ad83ba7f6b0e951a
employee_policy_idstring required
Example:eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

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.

Response

OK

objectstring

The object type

idstring required

Unique identifier for policy

employer_idstring required

The Id of the employer for which the policy is created

employee_idstring required

The Id of the employee for which the policy is created

external_customer_idstring nullable

A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms.

start_datestring date required

Policy starts on this date

end_datestring date required

Policy ends on this date

cancellation_datestring date nullable

Policy was cancelled on this date, if cancellation occured

policy_numberstring nullable

Health insurance policy number, if available

status'scheduled' | 'active' | 'expired' | 'cancelled' required
enrolment_type'opt_out' | 'opt_in' required
opt_out_deadline_datestring date required

Last day to opt out from the policy

enrolled_dependants_countinteger required

Number of dependants (spouse, children, or other eligible family members) currently enrolled in this health insurance policy.

Example response

{
  "id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "start_date": "2024-12-01",
  "end_date": "2024-12-01",
  "cancellation_date": "2024-12-01",
  "renewal": {
    "renewal_date": "2024-12-01",
    "window_start_date": "2024-12-01",
    "window_end_date": "2024-12-01",
    "decision_confirmed": true,
    "renewed_health_insurance_id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "opt_out_deadline_date": "2024-12-01",
  "coverage_level": {
    "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "enrolled_dependants_count": 123,
  "estimated_gross_premium": {
    "monthly": {
      "employee_contribution": 123.45,
      "employer_contribution": 123.45,
      "total": 123.45
    },
    "term": {
      "employee_contribution": 123.45,
      "employer_contribution": 123.45,
      "total": 123.45
    }
  }
}