Retrieve an employee policy

GET

/employees/:employee_id/health_insurance/policies/:employee_policy_id

GET

/employees/:employee_id/health_insurance/policies/:employee_policy_id

curl https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies/eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a \
     -H "Authorization: Bearer <apiKey>"

{
  "id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "start_date": "2024-12-01",
  "end_date": "2024-12-01",
  "status": "scheduled",
  "enrolment_type": "opt_out",
  "renewal": {
    "status": "upcoming",
    "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",
    "plan_name": "string",
    "plan_currency": "eur",
    "provider_name": "string",
    "provider_logo_url": "string",
    "documents": [
      {
        "title": "string",
        "link": "string"
      }
    ],
    "provider_employer_platform_url": null,
    "provider_support_phone": null
  },
  "enrolled_dependants_count": 123,
  "estimated_gross_premium": {
    "currency": "eur",
    "monthly": {
      "employee_contribution": 123.45,
      "employer_contribution": 123.45,
      "total": 123.45
    },
    "term": {
      "employee_contribution": 123.45,
      "employer_contribution": 123.45,
      "total": 123.45
    }
  },
  "object": "string",
  "external_customer_id": null,
  "cancellation_date": "2024-12-01",
  "policy_number": null
}

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

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

employee_idstringRequiredformat: "ee_.+"

employee_policy_idstringRequiredformat: "eehp_.+"

Response

idstringformat: "eehp_.+"

Unique identifier for policy

employer_idstringformat: "er_.+"

The Id of the employer for which the policy is created

employee_idstringformat: "ee_.+"

The Id of the employee for which the policy is created

start_datedate

Policy starts on this date

end_datedate

Policy ends on this date

statusenum

Current status of policy

Allowed values:

enrolment_typeenum

Enrolment type of the policy

Allowed values:

renewalobject

Renewal information for the policy

opt_out_deadline_datedate

Last day to opt out from the policy

coverage_levelobject

Represents the current coverage level for the policy

enrolled_dependants_countinteger

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

estimated_gross_premiumobject

Estimated gross premium amounts for this health insurance policy based on current enrollment and policy configuration. Important: These estimates are for planning purposes only and may differ from actual billed amounts due to life events, policy changes, insurer billing practices, or timing adjustments. For accurate payroll amounts, use the Contribution Reporting API.

objectstringOptionalRead-only

The object type

external_customer_idstring or nullOptional

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.

cancellation_datedate or nullOptional

Policy was cancelled on this date, if cancellation occured

policy_numberstring or nullOptional

Health insurance policy number, if available

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors