Insurance Entrypoints

The Insurance API is accessed through the Agents API root. These are the link relations relevant to insurance that appear in the root response.

Root

The API root is the only URL you need to hardcode. All other URLs are discovered by following links.

Environment	URL
Production	https://api-platform.flywire.com/agents/v2/
Demo	https://api-platform.demo.flywire.com/agents/v2/

Available Entrypoints

When you GET the root, the response contains links for every available action. These are the two insurance-specific relations:

insurance-types

Lists the available insurance types (OSHC, OVHC, NZ). This is the starting point for requesting quotes and purchasing insurance.

Environment	URL
Production	https://api-platform.flywire.com/agents/v2/insurance-types
Demo	https://api-platform.demo.flywire.com/agents/v2/insurance-types

Full relation: tag:flywire.com,2016:agents:api:relation:insurance-types

intermediated-insurance-applications

Lists all insurance applications intermediated by your agency. Use this to browse policies, check statuses, and manage existing applications.

Environment	URL
Production	https://api-platform.flywire.com/agents/v2/intermediated-insurance-applications
Demo	https://api-platform.demo.flywire.com/agents/v2/intermediated-insurance-applications

Full relation: tag:flywire.com,2016:agents:api:relation:intermediated-insurance-applications

Discovering Entrypoints

TIP

You should never hardcode these entrypoint URLs (except the root). Always discover them from the root response's links array by matching the rel suffix.

{
  "links": [
    {
      "rel": "tag:flywire.com,2016:agents:api:relation:insurance-types",
      "href": "https://api-platform.demo.flywire.com/agents/v2/insurance-types"
    },
    {
      "rel": "tag:flywire.com,2016:agents:api:relation:intermediated-insurance-applications",
      "href": "https://api-platform.demo.flywire.com/agents/v2/intermediated-insurance-applications"
    }
  ]
}

Reference

• Insurance Relations — formal definition of the entrypoint relations above
• Insurance Profiles — the response shapes you will encounter
• Insurance Schemas — the JSON Schemas of the response bodies