Retrieve an employer policy — Kota Embeded Documentation

Retrieve group’s health insurance policy for an employer by employer_policy_id.

Path parameters

employer_idstringRequired

employer_policy_idstringRequired

Response

idstringformat: "erhp_.+"

Unique identifier for policy

employer_idstringformat: "er_.+"

The Id of the employer for which the policy is created

start_datestringformat: "date"

Policy starts on this date

end_datestringformat: "date"

Policy ends on this date

statusenum

Allowed values: scheduledactiveexpiredcancelled

Current status of policy

enrolment_typeenum

Allowed values: opt_outopt_in

Enrolment type of the policy

renewalobject

Renewal information for the policy

employer_cancellation_period_lengthinteger

How many days the employer has to cancel the policy since the policy starts

coverage_levelslist of objects

Represents the available coverage levels for this olicy

objectstringOptional

The object type

cancellation_datestringOptionalformat: "date"

Policy was cancelled on this date, if cancellation occured

group_policy_numberstringOptional

Group’s health insurance policy number, if available

1 curl https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies/erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a \ 2 -H "Authorization: Bearer <apiKey>"

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

1	curl https://test.api.kota.io/employers/er_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies/erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a \
2	-H "Authorization: Bearer <apiKey>"

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