> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.kota.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.kota.io/_mcp/server.

# employee.health_insurance.offer.action_required

POST 

Reference: https://docs.kota.io/api-reference/events-and-webhooks/types-of-events/employee-health-insurance-offer-action-required-webhook

## Request

### Payload

- `id` (string, required)
- `type` (string, required)
- `platform_id` (string, required)
- `data` (EmployeeHealthInsuranceOfferResponse, required)
- `created` (datetime, required)
- `api_version` (string, required)

## Types

### EmployeeHealthInsuranceOfferResponse

- `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
- `status` (enum, required) — Current status of offer
  - Allowed values: `action_required`, `not_undertaken`, `accepted`
- `coverage_level` (HealthInsuranceCoverageLevelResponse, required) — Details about the coverage level for the offer. Only a single level of cover is available for a specific employee!
- `object` (string, optional) — The object type
- `external_customer_id` (string, optional, 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.
- `required_action` (HealthInsuranceRequiredActionResponse, optional) — Required action to progress the offer, if any. Set only when `status` is `action_required`.

### HealthInsuranceCoverageLevelResponse

- `plan_id` (string, required) — Unique identifier for the health insurance plan
- `plan_name` (string, required) — Name of the health insurance plan
- `plan_currency` (enum, required) — Currency code of the health insurance plan
  - Allowed values: `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`
- `provider_name` (string, required) — Name of the health insurance provider
- `provider_logo_url` (string, required) — Logo URL of the health insurance provider
- `documents` (list of 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
- `provider_employer_platform_url` (string, optional, nullable) — URL to the health insurance provider's website for Employer Management
- `provider_support_phone` (string, optional, nullable) — Support phone number to the health insurance provider's website for Employer Management

### 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` (date, required) — Date and time by which the action is due, if this is not completed then the policy will not be issued.

### HealthInsuranceCoverageLevelDocumentResponse

- `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)