Appearance
Insurance API Overview
The Insurance API allows agencies to intermediate insurance applications on behalf of their clients. You can guide clients through selecting an insurance quote, applying for a policy, paying, and tracking the policy lifecycle — all through hypermedia-driven interactions.
The API supports health cover for students and visitors in Australia and New Zealand.
Resource Map
The diagram below shows every resource in the Insurance API and how links connect them. Start at the Root and follow link relations to reach any resource.
Insurance Types
The API supports the following insurance types:
| Type | Name | Description |
|---|---|---|
| OSHC | Overseas Student Health Cover | Mandatory health cover for international students in Australia |
| OVHC | Overseas Visitor Health Cover | Health cover for working visa holders and visitors to Australia |
| NZ | Student Insurance | Health and travel cover for international students in New Zealand |
Key Concepts
Before diving into the flows, make sure you're comfortable with these building blocks:
| Concept | Why it matters |
|---|---|
| HATEOAS | You navigate by following links — never hardcode URLs |
| Link Relations | Each link's rel tells you what action it represents — see the Insurance Relations catalogue |
| Forms | Some endpoints return a schema describing the data they expect |
| Anchoring | Links with anchor belong to a specific item in a collection |
| Pagination | Collections use next / prev / first / last links |
| Profiles | The profile link tells you the type of the current resource — see the Insurance Profiles catalogue |
Flows
The Insurance API supports three main flows:
1. Purchase OSHC Insurance
Walk through the complete quote-to-payment flow: browse insurance types, request OSHC quotes, compare offers, complete an application, and generate a payment link.
2. Compare Insurance Quotes
Request quotes for any insurance type and compare offers side by side — including provider features, pricing, and terms.
3. Manage Insurance Policies
Browse intermediated applications, check policy status, download certificates, extend coverage, or cancel policies.
Where to start
If you're new to the API, follow the Getting Started guide first, then work through the Purchase OSHC Insurance flow — it covers the entire lifecycle end to end.
Entrypoints
The insurance flows start from two links on the root resource — insurance-types for quoting and purchasing, and intermediated-insurance-applications for managing existing policies. See Entrypoints for full details.
Reference
For the full catalogue of relations, profiles, and JSON Schemas used by the Insurance API, see:
- Insurance Relations — the action vocabulary
- Insurance Profiles — what each response represents
- Insurance Schemas — the data structures (types, quotes, applications, statuses)
- Common Schemas — shared types (
amount,intermediation,dynamic-data, …)