Retrieve an employee offer
Retrieve group’s health insurance offer
for an employee
by employee_offer_id
.
Path parameters
employee_id
employee_offer_id
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
OK
id
Unique identifier for offer
employer_id
The Id of the employer for which the offer is available
employee_id
The Id of the employee for which the offer is available
status
Current status of offer
Allowed values:
coverage_level
Details about the coverage level for the offer. Only a single level of cover is available for a specific employee!
object
The object type
external_customer_id
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
Required action to progress the offer, if any. Set only when status
is action_required
.