For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get access
Getting Started Key Concepts Integration Types Core Components Embed Hosted API API Reference
  • API Reference
      • GETRetrieve employer quote
      • GETList all employer quotes
      • GETRetrieve an employer policy
      • GETList all employer policies
      • GETRetrieve an employee offer
      • GETList all employee offers
      • GETList all employee policies
      • GETRetrieve an employee policy
    • Contribution Reports
    • Events and Webhooks
    • API Errors
Get access
LogoLogo
API ReferenceHealth Insurance

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>"
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": "string",
21    "plan_currency": "eur",
22    "provider_name": "string",
23    "provider_logo_url": "string",
24    "documents": [
25      {
26        "title": "string",
27        "link": "string"
28      }
29    ]
30  },
31  "enrolled_dependants_count": 123,
32  "estimated_gross_premium": {
33    "currency": "eur",
34    "monthly": {
35      "employee_contribution": 123.45,
36      "employer_contribution": 123.45,
37      "total": 123.45
38    },
39    "term": {
40      "employee_contribution": 123.45,
41      "employer_contribution": 123.45,
42      "total": 123.45
43    }
44  },
45  "object": "string",
46  "cancellation_date": "2024-12-01"
47}

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

Previous

List all employee policies

Next

Contribution Reports

Built with

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

employee_idstringRequiredformat: "ee_.+"
employee_policy_idstringRequiredformat: "eehp_.+"

Response

OK
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.

objectstringRead-only
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_datedate or null
Policy was cancelled on this date, if cancellation occured
policy_numberstring or null
Health insurance policy number, if available

Errors

404
Not Found Error