Sending a Quote Request
The Quote request details the required information of this attached main product so that an appropriate policy quotation can be generated. The response from the Quote endpoint can be used to display information about the policy which includes:
Policy Reference ID - Unique 13 letter code for each policy (id
eg. TXLDR-LH8UN-INS
)
Policy Price and Applicable Taxes
Product Disclosure Statement
Legal Disclaimer
Inclusions/Exclusions
Certificate of Insurance (COI)
Benefits, Limits and Excess
Cover Amount
Making a POST
request to the quotes
endpoint returns one or several insurance products based on the request. The request to the quotes
endpoint is a list (as shown below). At the top level of the request, include the common fields for the quotes like currency
, customer_country
, customer_language
.
Every Quote request should have the minimum required information to get a quote for the specific Product. For instance, in the case of Product Insurance - we need the category, price, name, description.
The response has the insurance price and details about the policy in the requested currency for the supplied parameters. This information can be presented to the customer to move them to the Booking stage.
The response has a top-level ID that is identified by a unique 13 letter alpha-numeric string ending with -INS
suffix. There's also an individual ID assigned to each individual quote in the request. Both of these can be stored on the clients side to to cancel, modify and renew the policies during its lifecycle.
The initial status after the Quote Request is RECEIVED
For some integrations quote step can be skipped or quote responses can be cached, but we encourage all partners to implement price request via quote endpoint in order to enable dynamic product optimisations provided by BrightWrite platform.
An example of quote request can be found below.
POST
https://api.xcover.com/x/partners/:partner_id/quotes/
This API call will retrieve the most relevant policies available for distribution
In the request body, you can send multiple quote requests. This means that in the case of a 201, you will get back a quote for each request. You only need to make one API call to get many quotes. The next example demonstrates this.
POST
https://api.xcover.com/x/partners/:partner_id/quotes/
An example of requesting a QuotePackage with two policies for two separate products. The first element of the Request array is a Policy for a Laptop followed by a Mobile phone policy
The response under quotes
key in the body is zero-indexed based on the position in the request. The first element has an index of 0
in the response, the second element has an index of 1
and so on.
When you request a quote, we send you back a quote package ID (INS number) in the response body, which can be used to retrieve information about all the quotes in the quote package. This is useful incase you don't want to store the Quote response on your side.
GET
https://api.xcover.com/x/partners/:partner_id/quotes/:quote_package_id
The Quote Package ID is obtained during the Quote Request
PATCH
https://api.xcover.com/x/partners/{partner_id}/quotes/{quote_package_id}/
Use this endpoint to mutate an existing Quote in a Quote Package.
POST
https://api.xcover.com/x/partners/{partner_id}/quotes/{quote_package_id}/
The add
endpoint can be used with an already generated INS
(quote-package-id) to add new Quotes to an existing policy. For example: If the customer adds another Phone protection to their existing Product insurance policies, you could use this endpoint to add a new Quote to an existing Quote Package.
The add
method can only be used for Quotes in the RECEIEVED
status.
POST
https://api.xcover.com/x/partners/{partner_id}/quotes/{quote_package_id}/
The add
endpoint can be used with an already generated INS
(quote-package-id) to delete a specific policy, we need the ID of the Quote from the original request. Simply putting that id
in the request will delete the right policy. For example: If the customer remove a product with protection from their cart.
The remove
method can only be used for Quotes in the RECEIEVED
status.
Sending a Fast Quote Request
The Fast Quote endpoint is available to partners who meet specific criteria outlined by Cover Genius. Please contact your assigned Client Solutions Engineer (CSE) to discuss use of the Fast Quote endpoint.
Fast Quote request is commonly issued at product pages to display selective information about the policy which could include:
Policy Price
Product Disclosure Statement
Legal Disclaimer
Inclusions/Exclusions
Making a POST
request to the fast quotes
endpoint returns one or several insurance products based on the request. The request to the fast quotes
endpoint is a list (as shown below). At the top level of the request, include the common fields for the quotes like currency
, customer_country
, customer_language
along with boolean field fast quote
set as true.
Every Fast Quote request should have the minimum required information to get a quote for the specific Product. For instance, in the case of Product Insurance - we need the item category, price, name, description.
The response could have the policy details, static PDS and the price in the requested currency for the supplied parameters. This information can be presented to the customer to move them to the Booking stage.
Fast Quote is followed by Instant Booking as the next stage in the user journey where insurance is selected.
An example of fast quote request can be found below.
POST
https://api.xcover.com/x/partners/:partner_id/quotes/?fast_quote=1
This API call will retrieve the most relevant policies available for distribution
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|
Name | Type | Description |
---|
Name | Type | Description |
---|
In the request body, you can send multiple quote . This means that in the case of a 200ok, you will get back a quote for each request. You only need to make one API call to get many quotes.
partner_id
string
Unique Partner Code
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api-Key
string
API Key
partner_id
string
Unique Partner Code
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api-Key
string
API Key
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api-Key
string
API Key
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api_Key
string
API Key
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api_Key
string
API Key
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api_Key
string
API Key
partner_id | string | Unique Partner Code |
fast_quote | boolean | true |
Content-Type | string | application/json |
Date | string | Current Datetime |
Authorization | string | HMAC Signature |
X-Api-Key | string | API Key |
Presenting the Insurance/Protection offer in the purchase path
Partners will often present an insurance offer after customers have selected a core product (such as a laptop, travel booking, event tickets, etc.). There are key components to presenting an insurance/protection offer, where 1-3 are dynamic from API response, and the items under 4 are static (provided or approved by Cover Genius CSE):
Price
Disclaimer
Policy wording link
Product name, inclusions, panel content, Trustpilot banner, and graphical elements.
Cover Genius offers a standard or customised design structure optimised for the partner specific use case (ie. Travel, Parcel, Ticket, Retail, etc.). A Travel example is presented below:
Legend: Red = Static content , Blue = API response
A Trustpilot.com rating for XCover, demonstrates reliability
B Inclusions content, taken from XCover supplied content
API Response content:
1. Price, per ticket (division of "total_price"
by number of travellers/units) or full price if in "add" button ("total_price"
)
2. Disclaimer, taken from "content":{ "disclaimer"}
field
3. Policy Wording, taken from the "pds_url"
quote response field, for example: "view wording" as a hyperlink of: "https://www.xcover.com/en/pds/ABCD-1234-INS"
Generally, the quote display should address:
Customer relevance - Does the quote/product presentation make sense for this purchase flow?
Compliance and regulatory requirements - Does the offer meet requirements for disclaimers, price, statements of fact, and availability of policy wording?
Marketing copy and trust - Is the offer likely to be understood and selected by the customer? Is the offer trusted/compelling?
Using XCover elements, the work of coding to display quote response is removed.
A simple script is used as a wrapper for the quote request
Using Content Delivery Network (CDN), offers are displayed within the purchase flow on partner site.
Response Signals are used to determine user interaction/purchase choices.
Important: Most display variations are handled by quote request attributes for example the currency display could be set as Indonesian Rp (IDR):
In some cases, partners may have custom display requirements based on experience settings or customisations. An examples of custom display settings is shown below:
In the above example, circled (blue) formatting for currency symbol is selected using custom set signals (symbol). Eg:
In the below example, the currencyDisplay config element is set to narrowSymbol
If custom display settings are required, they may be applied using signals or taken from quote request variables (see ).
This approach reduces the up front development effort and any ongoing growth project maintenance, allowing for streamlined launch and optimizations