API ReferenceHealth Insurance

Retrieve an employer policy

Retrieve group’s health insurance policy for an employer by employer_policy_id.

Path parameters

employer_idstringRequired
employer_policy_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK

idstringformat: "erhp_.+"

Unique identifier for policy

employer_idstringformat: "er_.+"

The Id of the employer for which the policy is created

start_datestringformat: "date"

Policy starts on this date

end_datestringformat: "date"

Policy ends on this date

statusenum

Current status of policy

Allowed values:
enrolment_typeenum

Enrolment type of the policy

Allowed values:
renewalobject

Renewal information for the policy

employer_cancellation_period_lengthinteger

How many days the employer has to cancel the policy since the policy starts

coverage_levelslist of objects

Represents the available coverage levels for this olicy

objectstringOptional

The object type

cancellation_datestringOptionalformat: "date"

Policy was cancelled on this date, if cancellation occured

group_policy_numberstringOptional

Group’s health insurance policy number, if available

Errors