Retrieve an employee policy

GET
/employees/:employee_id/health_insurance/policies/:employee_policy_id

Retrieve group’s health insurance policy for an employee by employee_policy_id.

Path parameters

employee_idstringRequired
employee_policy_idstringRequired

Response

OK

idstringformat: "eehp_.+"

Unique identifier for policy

employer_idstringformat: "er_.+"

The Id of the employer for which the policy is created

employee_idstringformat: "ee_.+"

The Id of the employee for which the policy is created

start_datestringformat: "date"

Policy starts on this date

end_datestringformat: "date"

Policy ends on this date

statusenum
Allowed values: scheduledactiveexpiredcancelled

Current status of policy

enrolment_typeenum
Allowed values: opt_outopt_in

Enrolment type of the policy

renewalobject

Renewal information for the policy

opt_out_deadline_datestringformat: "date"

Last day to opt out from the policy

coverage_levelobject

Represents the current coverage level for the policy

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.

cancellation_datestringOptionalformat: "date"

Policy was cancelled on this date, if cancellation occured

policy_numberstringOptional

Health insurance policy number, if available

Built with