Retrieve an employee policy

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

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_datestringformat: "date"

Policy starts on this date

end_datestringformat: "date"

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_datestringformat: "date"

Last day to opt out from the policy

coverage_levelobject

Represents the current coverage level for the policy

objectstring or null

The object type

external_customer_idstring or null

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_datestring or nullformat: "date"

Policy was cancelled on this date, if cancellation occured

policy_numberstring or null

Health insurance policy number, if available

1	{
2	"id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
4	"employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5	"start_date": "2024-12-01",
6	"end_date": "2024-12-01",
7	"status": "scheduled",
8	"enrolment_type": "opt_out",
9	"renewal": {
10	"status": "upcoming",
11	"renewal_date": "2024-12-01",
12	"window_start_date": "2024-12-01",
13	"window_end_date": "2024-12-01",
14	"decision_confirmed": true,
15	"renewed_health_insurance_id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
16	},
17	"opt_out_deadline_date": "2024-12-01",
18	"coverage_level": {
19	"plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
20	"plan_name": "foo",
21	"plan_currency": "eur",
22	"provider_name": "foo",
23	"provider_logo_url": "foo",
24	"documents": [
25	{
26	"title": "foo",
27	"link": "foo"
28	}
29	],
30	"provider_employer_platform_url": "foo",
31	"provider_support_phone": "foo"
32	},
33	"object": "foo",
34	"external_customer_id": "foo",
35	"cancellation_date": "2024-12-01",
36	"policy_number": "foo"
37	}

Path parameters

Headers

Response

Errors

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