Skip to main content
GET
Read the policy

Authorizations

Authorization
string
header
required

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

Path Parameters

policyId
integer
required

Response

The policy

id
integer
status
integer

0 pending payment, 1 active, 2 cancelled.

price
number

The premium for everyone on the policy, for a year.

pending_declarations
string[]

Employees who still have to declare their medical history. Empty once everyone has.

Where the company pays. A fresh signed link on every read, valid 15 minutes. Null while anyone is in pending_declarations, and once the policy is issued.

provider_policy_id
string | null

The insurer's policy number, once issued.

policy_url
string | null

The policy schedule listing every member, once the company has paid. Null before that.

invoice_url
string | null

The invoice for the premium the company paid, one line per package tier, once the company has paid. Null before that. On sandbox the document is watermarked SANDBOX and is not a tax invoice.

redirect_url
string | null
meta_data
object