Retrieve an employee offer

GET
/employees/:employee_id/health_insurance/offers/:employee_offer_id

Retrieve group’s health insurance offer for an employee by employee_offer_id.

Path parameters

employee_idstringRequired
employee_offer_idstringRequired

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
Allowed values: action_requirednot_undertakenaccepted

Current status of offer

coverage_levelobject

Details about the coverage level for the offer. Only a single level of cover is available for a specific employee!

objectstringOptional

The object type

external_customer_idstringOptional

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.

Built with