Skip to navigation
API ReferenceHealth Insurance

Retrieve an employee offer

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.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

employee_idstringRequiredformat: "ee_.+"
employee_offer_idstringRequiredformat: "eeho_.+"

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK
idstringformat: "eeho_.+"
Unique identifier for offer
employer_idstringformat: "er_.+"
The Id of the employer for which the offer is available
employee_idstringformat: "ee_.+"
The Id of the employee for which the offer is available
statusenum
Current status of offer
Allowed values:
coverage_levelobject
Details about the coverage level for the offer. Only a single level of cover is available for a specific employee!
objectstringOptionalRead-only
The object type
external_customer_idstring or nullOptional

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_actionobjectOptional

Required action to progress the offer, if any. Set only when status is action_required.

Errors

404
Not Found Error