Appearance
Insurance Profiles
Domain profiles defined by the Insurance API. Each profile URI is the full tag tag:flywire.com,2016:agents:api:profile:{name} — the short name in the table is the suffix after the colon. They are usually advertised together with the structural hypermedia profile (and, for collection items, item).
| Profile | Description |
|---|---|
insurance-types | List of insurance types available to the agency. |
insurance-quote | A quote returned in response to a quote request. |
intermediated-insurance-applications | Collection of insurance applications intermediated by the agency. |
intermediated-insurance-application | Full detail of a single insurance application. |
insurance-types
Representations advertising this profile comply with the insurance-types schema.
insurance-quote
Representations advertising this profile comply with the insurance-quote schema.
intermediated-insurance-applications
Representations advertising this profile comply with the intermediated-insurance-applications schema. They are always emitted together with the hypermedia and item profiles to expose pagination links.
intermediated-insurance-application
Representations advertising this profile comply with the intermediated-insurance-application schema and will, when generated along with the hypermedia profile, expose a link with the IANA payment relation type that can be shared with the agency's clients so that they can pay for the insurance policy. This link will be available until the application it provides payment initialization for is considered complete.