---
title: "employee.health_insurance.policy.expired"
method: POST
path: "EmployeeHealthInsurancePolicyExpiredWebhook"
tags: ["Types of events"]
---

# employee.health_insurance.policy.expired

`POST EmployeeHealthInsurancePolicyExpiredWebhook` (webhook)

## Payload

- EmployeeHealthInsurancePolicyExpiredWebhook
  - `id` string, required
  - `type` string, required
  - `platform_id` string, required
  - `data` EmployeeHealthInsurancePolicyResponse, required
    - `object` string — The object type
    - `id` string, required — Unique identifier for policy
    - `employer_id` string, required — The Id of the employer for which the policy is created
    - `employee_id` string, required — The Id of the employee for which the policy is created
    - `external_customer_id` string, 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_date` string, date, required — Policy starts on this date
    - `end_date` string, date, required — Policy ends on this date
    - `cancellation_date` string, date, nullable — Policy was cancelled on this date, if cancellation occured
    - `policy_number` string, nullable — Health insurance policy number, if available
    - `status` 'scheduled' | 'active' | 'expired' | 'cancelled', required
    - `enrolment_type` 'opt_out' | 'opt_in', required
    - `renewal` EmployeeHealthPolicyRenewal, required
      - `status` 'upcoming' | 'open' | 'renewed' | 'cancelled', required
      - `renewal_date` string, date, required — Policy renewal date
      - `window_start_date` string, date, required — Renewal window starts on this day
      - `window_end_date` string, date, required — Renewal window ends at the end of this day
      - `decision_confirmed` boolean, required — Whether the decision to renew the policy has been confirmed
      - `renewed_health_insurance_id` string, nullable — The ID of the renewed health insurance policy, if renewed
    - `opt_out_deadline_date` string, date, required — Last day to opt out from the policy
    - `coverage_level` HealthInsuranceCoverageLevelResponse, required
      - `plan_id` string, required — Unique identifier for the health insurance plan
      - `plan_name` string, required — Name of the health insurance plan
      - `plan_currency` 'eur' | 'aed' | 'afn' | 'xcd' | 'all' | 'amd' | 'aoa' | 'ars' | 'usd' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'xof' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'brl' | 'bsd' | 'inr' | 'btn' | 'nok' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'xaf' | 'cdf' | 'chf' | 'che' | 'chw' | 'nzd' | 'clp' | 'clf' | 'cny' | 'cop' | 'cou' | 'crc' | 'cup' | 'cuc' | 'cve' | 'ang' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'mad' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'mdl' | 'gbp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'hrk' | 'htg' | 'huf' | 'idr' | 'xdr' | 'ils' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'zar' | 'lyd' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mru' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mxv' | 'myr' | 'mzn' | 'nad' | 'xpf' | 'ngn' | 'nio' | 'npr' | 'omr' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sll' | 'sos' | 'srd' | 'ssp' | 'stn' | 'svc' | 'xsu' | 'syp' | 'twd' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'ugx' | 'usn' | 'uyu' | 'uyi' | 'uyw' | 'uzs' | 'ves' | 'vnd' | 'vuv' | 'wst' | 'yer' | 'xua' | 'zmw' | 'zwl', required
      - `provider_name` string, required — Name of the health insurance provider
      - `provider_logo_url` string, required — Logo URL of the health insurance provider
      - `provider_employer_platform_url` string, nullable — URL to the health insurance provider's website for Employer Management
      - `provider_support_phone` string, nullable — Support phone number to the health insurance provider's website for Employer Management
      - `documents` HealthInsuranceCoverageLevelDocumentResponse[], required — Documents related to the health insurance plan, these documents may change at renewal, this includes the documents like `Insurance Product Information Document`, `Hospital Lists`, `Table of Cover` etc
        - `title` string, required — Health Insurance Document Title
        - `link` string, required — Health Insurance Document Link (can be a link to a website or a file path)
    - `enrolled_dependants_count` integer, required — Number of dependants (spouse, children, or other eligible family members) currently enrolled in this health insurance policy.
    - `estimated_gross_premium` HealthInsuranceEstimatedGrossPremiumResponse, required
      - `currency` 'eur' | 'aed' | 'afn' | 'xcd' | 'all' | 'amd' | 'aoa' | 'ars' | 'usd' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'xof' | 'bgn' | 'bhd' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'bov' | 'brl' | 'bsd' | 'inr' | 'btn' | 'nok' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'xaf' | 'cdf' | 'chf' | 'che' | 'chw' | 'nzd' | 'clp' | 'clf' | 'cny' | 'cop' | 'cou' | 'crc' | 'cup' | 'cuc' | 'cve' | 'ang' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'mad' | 'ern' | 'etb' | 'fjd' | 'fkp' | 'mdl' | 'gbp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'hrk' | 'htg' | 'huf' | 'idr' | 'xdr' | 'ils' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'kpw' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'zar' | 'lyd' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mru' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mxv' | 'myr' | 'mzn' | 'nad' | 'xpf' | 'ngn' | 'nio' | 'npr' | 'omr' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sdg' | 'sek' | 'sgd' | 'shp' | 'sll' | 'sos' | 'srd' | 'ssp' | 'stn' | 'svc' | 'xsu' | 'syp' | 'twd' | 'szl' | 'thb' | 'tjs' | 'tmt' | 'tnd' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'ugx' | 'usn' | 'uyu' | 'uyi' | 'uyw' | 'uzs' | 'ves' | 'vnd' | 'vuv' | 'wst' | 'yer' | 'xua' | 'zmw' | 'zwl', required
      - `monthly` HealthInsuranceGrossEstimationAmountResponse, required
        - `employee_contribution` number, double, required — Estimated gross premium amount deducted from employee payroll
        - `employer_contribution` number, double, required — Estimated gross premium amount paid by the employer
        - `total` number, double, required — Total gross premium amount (sum of employee and employer contributions).
      - `term` HealthInsuranceGrossEstimationAmountResponse, required
        - `employee_contribution` number, double, required — Estimated gross premium amount deducted from employee payroll
        - `employer_contribution` number, double, required — Estimated gross premium amount paid by the employer
        - `total` number, double, required — Total gross premium amount (sum of employee and employer contributions).
  - `created_at` string, date-time, required
  - `object` string, required
  - `api_version` string, required

## Acknowledgement `2xx`

Your server implementation should return this HTTP status code if the data was received successfully

## Other responses

- `4xx` — If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!
- `5xx` — If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!

---

[API](https://skmtc.net/kota/apis/kota-api.md) · [All operations](https://skmtc.net/kota/apis/kota-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kota/kota-api/revisions/c7d3d8719330/schema)