Health Insurance

Retrieve an employee offer

Changed on

Retrieve group's health insurance offer for an employee by employee_offer_id. For intent-based enrolments the offer id is the enrolment intent id.

get/employees/{employee_id}/health_insurance/offers/{employee_offer_id}

Request

  • Base URL
    https://test.api.kota.io
  • URL
    https://test.api.kota.io/employees/{employee_id}/health_insurance/offers/{employee_offer_id}
  • Auth
    HTTP bearer

Path parameters

employee_idstring required
Example:ee_3b1333d87d9d4fd6ad83ba7f6b0e951a
employee_offer_idstring required
Example:eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a

Response

OK

objectstring

The object type

idstring required

Unique identifier for offer

employer_idstring required

The Id of the employer for which the offer is available

employee_idstring required

The Id of the employee for which the offer is available

external_customer_idstring 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

Example response

{
  "id": "eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "required_action": {
    "due_at": "2024-12-01"
  },
  "coverage_level": {
    "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  }
}

Changes