Quote Request for Policies
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 (
ideg.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 Quote Request
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.
Request a Quote
POST https://api.xcover.com/x/partners/:partner_id/quotes/
This API call will retrieve the most relevant policies available for distribution
Path Parameters
partner_id
string
Unique Partner Code
Headers
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api-Key
string
API Key
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.
Multiple Quotes in Single Request
Request Multiple Quotes
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.
Path Parameters
partner_id
string
Unique Partner Code
Headers
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api-Key
string
API Key
Retrieving Quote Information
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.
Retrieve a Quote
GET https://api.xcover.com/x/partners/:partner_id/quotes/:quote_package_id
The Quote Package ID is obtained during the Quote Request
Path Parameters
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Headers
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api-Key
string
API Key
Update a Quote
Update Quote in Quote Package
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.
Path Parameters
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Headers
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api_Key
string
API Key
Add Quote
Add Quote to 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.
Path Parameters
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Headers
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api_Key
string
API Key
The add method can only be used for Quotes in the RECEIEVED status.
Remove Quote
Add Quote to 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 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.
Path Parameters
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Headers
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api_Key
string
API Key
The remove method can only be used for Quotes in the RECEIEVED status.
Last updated