---
title: "employee.health_insurance.offer.action_required"
method: POST
path: "EmployeeHealthInsuranceOfferActionRequiredWebhook"
tags: ["Types of events"]
---

# employee.health_insurance.offer.action_required

`POST EmployeeHealthInsuranceOfferActionRequiredWebhook` (webhook)

## Payload

- EmployeeHealthInsuranceOfferActionRequiredWebhook
  - `id` string, required
  - `type` string, required
  - `platform_id` string, required
  - `data` EmployeeHealthInsuranceOfferResponse, required
    - `object` string — The object type
    - `id` string, required — Unique identifier for offer
    - `employer_id` string, required — The Id of the employer for which the offer is available
    - `employee_id` string, required — The Id of the employee for which the offer is available
    - `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.
    - `status` 'action_required' | 'not_undertaken' | 'accepted', required
    - `required_action` HealthInsuranceRequiredActionResponse
      - `reason` string, required — Concise reason for the required action
      - `reason_description` string, required — Description for the required action
      - `code` string, required — Identified the type of action required, not unique across health insurance providers
      - `due_at` string, date, required — Date and time by which the action is due, if this is not completed then the policy will not be issued.
    - `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)
  - `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)