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 (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 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

Name	Type	Description
partner_id	string	Unique Partner Code

Headers

Name	Type	Description
Content-Type	string	application/json
Date	string	Current Datetime
Authorization	string	HMAC Signature
X-Api-Key	string	API Key

201

{
  "id": "TLCC8-B6YWP-INS",
  "status": "RECEIVED",
  "currency": "AUD",
  "total_price": 360.71,
  "total_price_formatted": "A$ 360.71",
  "partner_transaction_id": "ABCD-EFGG-0000-0000",
  "created_at": "2020-02-06T00:12:31.013656Z",
  "updated_at": "2020-02-06T00:12:31.013670Z",
  "pds_url": "https://staging.xcover.com/en/pds/TLCC8-B6YWP-INS",
  "quotes": {
    "0": {
      "id": "ca5c9839-17b3-4810-b0b1-d5b693ecef86",
      "policy_start_date": "2020-02-06T13:00:00+00:00",
      "policy_end_date": "2021-02-06T13:00:00+00:00",
      "status": "RECEIVED",
      "price": 124.85,
      "price_formatted": "A$ 124.85",
      "policy": {
        "policy_type": "product_insurance",
        "policy_name": "Full Product Protection",
        "policy_code": "PFPO05CG",
        "policy_version": "7720b62b-3e84-446a-89d3-48c83cb39384",
        "category": "electronics-insurance",
        "content": {
          "title": "Full Product Cover For Life",
          "header": "Full Product Cover For Life",
          "description": "Theft, damage and expanded warranty that covers the product for life. Cancel anytime.",
          "optout_msg": "<p>.</p>",
          "inclusions": [
            {
              "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
              "description": "Full replacement if the item can’t be repaired."
            },
            {
              "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
              "description": "Cancel anytime."
            },
            {
              "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
              "description": "Covers theft."
            },
            {
              "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
              "description": "Covers repairs when your item is damaged."
            },
            {
              "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
              "description": "Covers what the manufacturer's warranty doesn’t."
            },
            {
              "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
              "description": "Extends warranty protection for the life of the policy."
            }
          ],
          "disclaimer": "<p>I am over 18 and agree to the terms of this policy. This cover is powered by XCover.com and underwritten by Pacific International Insurance Pty Ltd.</p>"
        },
        "underwriter": {
          "disclaimer": "This cover is powered by XCover and underwritten by Pacific International Insurance Pty. Ltd.",
          "name": "Pacific International Insurance Pty. Ltd."
        }
      },
      "insured": null,
      "tax": {
        "total_tax": 21.67,
        "total_amount_without_tax": 103.18,
        "total_tax_formatted": "A$ 21.67",
        "total_amount_without_tax_formatted": "A$ 103.18",
        "taxes": [
          {
            "tax_amount": 11.35,
            "tax_code": "SD",
            "tax_amount_formatted": "A$ 11.35"
          },
          {
            "tax_amount": 10.32,
            "tax_code": "GST",
            "tax_amount_formatted": "A$ 10.32"
          },
          {
            "tax_amount": 0.0,
            "tax_code": "ESL",
            "tax_amount_formatted": "A$ 0.00"
          }
        ]
      },
      "duration": "366 00:00:00",
      "benefits": [
        {
          "description": "Damage or Theft",
          "limit": 1349.76,
          "limit_policy_currency": 1349.76,
          "limit_formatted": "A$ 1349.76",
          "limit_policy_currency_formatted": "A$ 1349.76",
          "excess": 150.0,
          "excess_policy_currency": 150.0,
          "excess_formatted": "A$ 150.00",
          "excess_policy_currency_formatted": "A$ 150.00"
        },
        {
          "description": "Extended Warranty",
          "limit": 1349.76,
          "limit_policy_currency": 1349.76,
          "limit_formatted": "A$ 1349.76",
          "limit_policy_currency_formatted": "A$ 1349.76",
          "excess": 150.0,
          "excess_policy_currency": 150.0,
          "excess_formatted": "A$ 150.00",
          "excess_policy_currency_formatted": "A$ 150.00"
        }
      ],
      "commission": {
        "total_commission": 0.0,
        "total_commission_formatted": "A$ 0.00"
      },
      "created_at": "2020-02-06T00:12:30.974396Z",
      "confirmed_at": null,
      "updated_at": "2020-02-06T00:12:30.974411Z",
      "cancelled_at": null,
      "is_renewable": true,
      "cover_amount": 1349.0,
      "cover_amount_formatted": "A$ 1349.00",
      "pending_renewal": null,
      "pds_url": "https://staging.xcover.com/en/pds/TLCC8-B6YWP-INS?policy_type=product_insurance_v1",
      "discount_price": 124.85,
      "discount_price_formatted": "A$ 124.85",
      "discount_amount": 0.0,
      "discount_amount_formatted": "A$ 0.00"
    }
  },
  "bundle_code": null,
  "bundle_price": 360.71,
  "bundle_content": {},
  "bundle_price_formatted": "A$ 360.71",
  "bundle_discount_percent": 0.0,
  "bundle_discount_amount": 0.0,
  "bundle_discount_amount_formatted": "A$ 0.00"
}

Request Payload

{
    "currency": "AUD",
    "customer_country": "AU",
    "customer_language": "en",
    "partner_transaction_id": "1ef4472a-a50e-4c52-87e1-73b9ca988031",
    "request": [
        {
            "policy_type": "product_insurance",
            "policy_type_version": "2",
            "policy_start_date": "2021-01-14T18:30:00+00:00",
            "retail_value": 3799,
            "category": "Laptop",
            "title": "Apple MacBook Pro",
            "brand": "Apple",
            "model": "MacBook Pro",
            "description": "Apple Macbook Pro 16\" 2019 2.6 GHz w/ Touch Bar 512GB - Space Grey - Au Stock",
            "sku": "190199368477",
            "condition": "new"
        }
    ]
}

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

Name	Type	Description
partner_id	string	Unique Partner Code

Headers

Name	Type	Description
Content-Type	string	application/json
Date	string	Current Datetime
Authorization	string	HMAC Signature
X-Api-Key	string	API Key

200

{
    "id": "TLCC8-B6YWP-INS",
    "status": "RECEIVED",
    "currency": "AUD",
    "total_price": 360.71,
    "total_price_formatted": "A$ 360.71",
    "partner_transaction_id": "ABCD-EFGG-0000-0000",
    "created_at": "2020-02-06T00:12:31.013656Z",
    "updated_at": "2020-02-06T00:12:31.013670Z",
    "pds_url": "https://staging.xcover.com/en/pds/TLCC8-B6YWP-INS",
    "quotes": {
        "0": {
            "id": "ca5c9839-17b3-4810-b0b1-d5b693ecef86",
            "policy_start_date": "2020-02-06T13:00:00+00:00",
            "policy_end_date": "2021-02-06T13:00:00+00:00",
            "status": "RECEIVED",
            "price": 124.85,
            "price_formatted": "A$ 124.85",
            "policy": {
                "policy_type": "product_insurance",
                "policy_name": "Full Product Protection",
                "policy_code": "PFPO05CG",
                "policy_version": "7720b62b-3e84-446a-89d3-48c83cb39384",
                "category": "electronics-insurance",
                "content": {
                    "title": "Full Product Cover For Life",
                    "header": "Full Product Cover For Life",
                    "description": "Theft, damage and expanded warranty that covers the product for life. Cancel anytime.",
                    "optout_msg": "<p>.</p>",
                    "inclusions": [
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
                            "description": "Full replacement if the item can’t be repaired."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
                            "description": "Cancel anytime."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
                            "description": "Covers theft."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
                            "description": "Covers repairs when your item is damaged."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
                            "description": "Covers what the manufacturer's warranty doesn’t."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 124.85/year. Cancel anytime.",
                            "description": "Extends warranty protection for the life of the policy."
                        }
                    ],
                    "disclaimer": "<p>I am over 18 and agree to the terms of this policy. This cover is powered by XCover.com and underwritten by Pacific International Insurance Pty Ltd.</p>"
                },
                "underwriter": {
                    "disclaimer": "This cover is powered by XCover and underwritten by Pacific International Insurance Pty. Ltd.",
                    "name": "Pacific International Insurance Pty. Ltd."
                }
            },
            "insured": null,
            "tax": {
                "total_tax": 21.67,
                "total_amount_without_tax": 103.18,
                "total_tax_formatted": "A$ 21.67",
                "total_amount_without_tax_formatted": "A$ 103.18",
                "taxes": [
                    {
                        "tax_amount": 11.35,
                        "tax_code": "SD",
                        "tax_amount_formatted": "A$ 11.35"
                    },
                    {
                        "tax_amount": 10.32,
                        "tax_code": "GST",
                        "tax_amount_formatted": "A$ 10.32"
                    },
                    {
                        "tax_amount": 0.0,
                        "tax_code": "ESL",
                        "tax_amount_formatted": "A$ 0.00"
                    }
                ]
            },
            "duration": "366 00:00:00",
            "benefits": [
                {
                    "description": "Damage or Theft",
                    "limit": 1349.76,
                    "limit_policy_currency": 1349.76,
                    "limit_formatted": "A$ 1349.76",
                    "limit_policy_currency_formatted": "A$ 1349.76",
                    "excess": 150.0,
                    "excess_policy_currency": 150.0,
                    "excess_formatted": "A$ 150.00",
                    "excess_policy_currency_formatted": "A$ 150.00"
                },
                {
                    "description": "Extended Warranty",
                    "limit": 1349.76,
                    "limit_policy_currency": 1349.76,
                    "limit_formatted": "A$ 1349.76",
                    "limit_policy_currency_formatted": "A$ 1349.76",
                    "excess": 150.0,
                    "excess_policy_currency": 150.0,
                    "excess_formatted": "A$ 150.00",
                    "excess_policy_currency_formatted": "A$ 150.00"
                }
            ],
            "commission": {
                "total_commission": 0.0,
                "total_commission_formatted": "A$ 0.00"
            },
            "created_at": "2020-02-06T00:12:30.974396Z",
            "confirmed_at": null,
            "updated_at": "2020-02-06T00:12:30.974411Z",
            "cancelled_at": null,
            "is_renewable": true,
            "cover_amount": 1349.0,
            "cover_amount_formatted": "A$ 1349.00",
            "pending_renewal": null,
            "pds_url": "https://staging.xcover.com/en/pds/TLCC8-B6YWP-INS?policy_type=product_insurance_v1",
            "discount_price": 124.85,
            "discount_price_formatted": "A$ 124.85",
            "discount_amount": 0.0,
            "discount_amount_formatted": "A$ 0.00"
        },
        "1": {
            "id": "063f9987-efae-4f29-8f85-9e6efa4299c1",
            "policy_start_date": "2020-02-06T13:00:00+00:00",
            "policy_end_date": "2021-02-06T13:00:00+00:00",
            "status": "RECEIVED",
            "price": 235.86,
            "price_formatted": "A$ 235.86",
            "policy": {
                "policy_type": "product_insurance",
                "policy_name": "Full Product Protection",
                "policy_code": "PFPO05CG",
                "policy_version": "7720b62b-3e84-446a-89d3-48c83cb39384",
                "category": "electronics-insurance",
                "content": {
                    "title": "Full Product Cover For Life",
                    "header": "Full Product Cover For Life",
                    "description": "Theft, damage and expanded warranty that covers the product for life. Cancel anytime.",
                    "optout_msg": "<p>.</p>",
                    "inclusions": [
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 235.86/year. Cancel anytime.",
                            "description": "Full replacement if the item can’t be repaired."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 235.86/year. Cancel anytime.",
                            "description": "Cancel anytime."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 235.86/year. Cancel anytime.",
                            "description": "Covers theft."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 235.86/year. Cancel anytime.",
                            "description": "Covers repairs when your item is damaged."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 235.86/year. Cancel anytime.",
                            "description": "Covers what the manufacturer's warranty doesn’t."
                        },
                        {
                            "title": "Get peace of mind with theft, damage and expanded warranty that covers the life of your product for only A$ 235.86/year. Cancel anytime.",
                            "description": "Extends warranty protection for the life of the policy."
                        }
                    ],
                    "disclaimer": "<p>I am over 18 and agree to the terms of this policy. This cover is powered by XCover.com and underwritten by Pacific International Insurance Pty Ltd.</p>"
                },
                "underwriter": {
                    "disclaimer": "This cover is powered by XCover and underwritten by Pacific International Insurance Pty. Ltd.",
                    "name": "Pacific International Insurance Pty. Ltd."
                }
            },
            "insured": null,
            "tax": {
                "total_tax": 40.93,
                "total_amount_without_tax": 194.93,
                "total_tax_formatted": "A$ 40.93",
                "total_amount_without_tax_formatted": "A$ 194.93",
                "taxes": [
                    {
                        "tax_amount": 21.44,
                        "tax_code": "SD",
                        "tax_amount_formatted": "A$ 21.44"
                    },
                    {
                        "tax_amount": 19.49,
                        "tax_code": "GST",
                        "tax_amount_formatted": "A$ 19.49"
                    },
                    {
                        "tax_amount": 0.0,
                        "tax_code": "ESL",
                        "tax_amount_formatted": "A$ 0.00"
                    }
                ]
            },
            "duration": "366 00:00:00",
            "benefits": [
                {
                    "description": "Damage or Theft",
                    "limit": 2549.87,
                    "limit_policy_currency": 2549.87,
                    "limit_formatted": "A$ 2549.87",
                    "limit_policy_currency_formatted": "A$ 2549.87",
                    "excess": 150.0,
                    "excess_policy_currency": 150.0,
                    "excess_formatted": "A$ 150.00",
                    "excess_policy_currency_formatted": "A$ 150.00"
                },
                {
                    "description": "Extended Warranty",
                    "limit": 2549.87,
                    "limit_policy_currency": 2549.87,
                    "limit_formatted": "A$ 2549.87",
                    "limit_policy_currency_formatted": "A$ 2549.87",
                    "excess": 150.0,
                    "excess_policy_currency": 150.0,
                    "excess_formatted": "A$ 150.00",
                    "excess_policy_currency_formatted": "A$ 150.00"
                }
            ],
            "commission": {
                "total_commission": 0.0,
                "total_commission_formatted": "A$ 0.00"
            },
            "created_at": "2020-02-06T00:12:31.008203Z",
            "confirmed_at": null,
            "updated_at": "2020-02-06T00:12:31.008217Z",
            "cancelled_at": null,
            "is_renewable": true,
            "cover_amount": 2549.0,
            "cover_amount_formatted": "A$ 2549.00",
            "pending_renewal": null,
            "pds_url": "https://staging.xcover.com/en/pds/TLCC8-B6YWP-INS?policy_type=product_insurance_v1",
            "discount_price": 235.86,
            "discount_price_formatted": "A$ 235.86",
            "discount_amount": 0.0,
            "discount_amount_formatted": "A$ 0.00"
        }
    },
    "bundle_code": null,
    "bundle_price": 360.71,
    "bundle_content": {},
    "bundle_price_formatted": "A$ 360.71",
    "bundle_discount_percent": 0.0,
    "bundle_discount_amount": 0.0,
    "bundle_discount_amount_formatted": "A$ 0.00"
}

Request Payload

{
    "currency": "AUD",
    "customer_country": "AU",
    "customer_language": "en",
    "partner_transaction_id": "1ef4472a-a50e-4c52-87e1-73b9ca988031",
    "request": [
        {
            "policy_type": "product_insurance",
            "policy_type_version": "2",
            "policy_start_date": "2021-01-14T18:30:00+00:00",
            "retail_value": 3799,
            "category": "Laptop",
            "title": "Apple MacBook Pro",
            "brand": "Apple",
            "model": "MacBook Pro",
            "description": "Apple Macbook Pro 16\" 2019 2.6 GHz w/ Touch Bar 512GB - Space Grey - Au Stock",
            "sku": "190199368477",
            "condition": "new"
        },
        {
            "policy_type": "product_insurance",
            "policy_type_version": "2",
            "policy_start_date": "2021-01-14T18:30:00+00:00",
            "retail_value": 3799,
            "category": "Mobile",
            "title": "Apple iPhone 12 Pro Max",
            "brand": "Apple",
            "model": "iPhone 12 Pro Max",
            "sku": "190199368478",
            "condition": "new"
        }
    ]
} 

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

Name	Type	Description
partner_id	string	Unique Partner Code
quote_package_id	string	Quote Package ID

Headers

Name	Type	Description
Content-Type	string	application/json
Date	string	Current Datetime
Authorization	string	HMAC Signature
X-Api-Key	string	API Key

200

{
    "id": "MPM49-EKX9D-INS",
    "status": "RECEIVED",
    "currency": "GBP",
    "total_price": 244.82,
    "total_price_formatted": "£244.82",
    "partner_transaction_id": "3ab19ca8-1b81-469f-ace5-33d3ccf29c83",
    "created_at": "2021-01-05T08:34:09.323201Z",
    "updated_at": "2021-01-05T08:34:09.323215Z",
    "pds_url": "https://www.xcover.com/en/pds/MPM49-EKX9D-INS",
    "security_token": "HthL6-gpJ5M-nu7sT-x7VkK",
    "quotes": {
        "0": {
            "id": "02ed6b9f-4a9a-4d48-a7e9-128cba071cec",
            "policy_start_date": "2021-01-14T18:30:00+00:00",
            "policy_end_date": "2022-01-13T18:30:00+00:00",
            "status": "RECEIVED",
            "price": 244.82,
            "price_formatted": "£244.82",
            "policy": {
                "policy_type": "product_insurance",
                "policy_name": "Full Product Protection OnBuy",
                "policy_code": "ONB01EL",
                "policy_version": "7a51eb83-dcc6-4639-bf97-ae1cde554416",
                "category": "electronics-insurance",
                "content": {
                    "title": "Full Product Protection",
                    "in_path_disclaimer": "You confirm you are over 18 and have read and agree to the <a href=\"https://www.xcover.com/en/pds/MPM49-EKX9D-INS?policy_type=product_insurance_v3\" target=\"_blank\">Policy Terms</a> & <a href=\"https://static.xcover.com/media/pds/7a51eb83-dcc6-4639-bf97-ae1cde554416/OnBuy_IPID_OkVuyYh.pdf\" target=\"_blank\">IPID</a>. The policy is provided by XCover.com (trading name of Cover Genius Ltd) and underwritten by Fortegra Europe Insurance Company Limited. Onbuy.com (Visor Commerce Ltd) is an Appointed Representative of Cover Genius Ltd who is authorised and regulated by the Financial Conduct Authority (FCA) reference 750711. This can be checked on the financial services register held on the FCA’s website (www.fca.org.uk). Fortegra Europe Insurance Company Limited is authorised and regulated by the MFSA."
                },
                "underwriter": {
                    "disclaimer": "This plan is arranged by XCover and underwritten by Fortegra Europe Insurance Company Limited.",
                    "name": "Fortegra Europe Insurance Company Limited"
                }
            },
            "insured": null,
            "tax": {
                "total_tax": 26.23,
                "total_amount_without_tax": 218.59,
                "total_tax_formatted": "£26.23",
                "total_amount_without_tax_formatted": "£218.59",
                "taxes": [
                    {
                        "tax_amount": 26.23,
                        "tax_code": "IPT",
                        "tax_amount_formatted": "£26.23"
                    }
                ]
            },
            "duration": "364 00:00:00",
            "benefits": [
                {
                    "description": "Accidental Damage",
                    "limit": 1623.51,
                    "limit_policy_currency": 1623.51,
                    "limit_formatted": "£1623.51",
                    "limit_policy_currency_formatted": "£1623.51",
                    "limit_per_unit": 541.17,
                    "limit_per_unit_policy_currency": 541.17,
                    "limit_per_unit_formatted": "£541.17 per item",
                    "limit_per_unit_policy_currency_formatted": "£541.17 per item",
                    "excess": 81.18,
                    "excess_policy_currency": 81.1755,
                    "excess_formatted": "£81.18",
                    "excess_policy_currency_formatted": "£81.18"
                },
                {
                    "description": "Theft",
                    "limit": 1623.51,
                    "limit_policy_currency": 1623.51,
                    "limit_formatted": "£1623.51",
                    "limit_policy_currency_formatted": "£1623.51",
                    "limit_per_unit": 541.17,
                    "limit_per_unit_policy_currency": 541.17,
                    "limit_per_unit_formatted": "£541.17 per item",
                    "limit_per_unit_policy_currency_formatted": "£541.17 per item",
                    "excess": 81.18,
                    "excess_policy_currency": 81.1755,
                    "excess_formatted": "£81.18",
                    "excess_policy_currency_formatted": "£81.18"
                },
                {
                    "description": "Mechanical Breakdown (when the manufacturer's warranty expires)",
                    "limit": 1623.51,
                    "limit_policy_currency": 1623.51,
                    "limit_formatted": "£1623.51",
                    "limit_policy_currency_formatted": "£1623.51",
                    "limit_per_unit": 541.17,
                    "limit_per_unit_policy_currency": 541.17,
                    "limit_per_unit_formatted": "£541.17 per item",
                    "limit_per_unit_policy_currency_formatted": "£541.17 per item",
                    "excess": 81.18,
                    "excess_policy_currency": 81.1755,
                    "excess_formatted": "£81.18",
                    "excess_policy_currency_formatted": "£81.18"
                }
            ],
            "commission": {
                "total_commission": 45.0,
                "total_commission_formatted": "£45.00"
            },
            "created_at": "2021-01-05T08:34:09.316598Z",
            "confirmed_at": null,
            "updated_at": "2021-01-05T08:34:09.316612Z",
            "cancelled_at": null,
            "is_renewable": false,
            "cover_amount": 541.0,
            "cover_amount_formatted": "£541.00 per item",
            "pds_url": "https://www.xcover.com/en/pds/MPM49-EKX9D-INS?policy_type=product_insurance_v3",
            "discount_price": 244.82,
            "discount_price_formatted": "£244.82",
            "discount_amount": 0.0,
            "discount_amount_formatted": "£0.00"
        }
    },
    "bundle_code": null,
    "bundle_price": 244.82,
    "bundle_content": {},
    "bundle_price_formatted": "£244.82",
    "bundle_discount_percent": 0.0,
    "bundle_discount_amount": 0.0,
    "bundle_discount_amount_formatted": "£0.00"
}

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

Name	Type	Description
partner_id	string	Unique Partner Code
quote_package_id	string	Quote Package ID

Headers

Name	Type	Description
Content-Type	string	application/json
Date	string	Current Datetime
Authorization	string	HMAC Signature
X-Api_Key	string	API Key

200

{
  "id": "TLCC8-B6YWP-INS",
  "status": "RECEIVED",
  "currency": "USD",
  "total_price": 360.71,
  "total_price_formatted": "US$ 360.71",
  "partner_transaction_id": "ABCD-EFGG-0000-0000",
  "created_at": "2020-02-06T00:12:31.013656Z",
  "updated_at": "2020-02-06T00:12:31.013670Z",
  "pds_url": "https://staging.xcover.com/en/pds/TLCC8-B6YWP-INS",
  "quotes": {
    "0": {
      "id": "ca5c9839-17b3-4810-b0b1-d5b693ecef86",
      "policy_start_date": "2020-02-06T13:00:00+00:00",
      "policy_end_date": "2021-02-06T13:00:00+00:00",
      "status": "RECEIVED",
      "price": 124.85,
      "price_formatted": "US$ 124.85",
      "policy": {
        "policy_type": "product_insurance",
        "policy_name": "Full Product Protection",
        "policy_code": "PFPO05CG",
        "policy_version": "7720b62b-3e84-446a-89d3-48c83cb39384",
        "category": "electronics-insurance"
      },
      "insured": [
        {
          "first_name": "Bart",
          "last_name": "Simpson",
          "email": "[email protected]"
        }
      ]
    }
  },
  "bundle_code": null,
  "bundle_price": 360.71,
  "bundle_content": {},
  "bundle_price_formatted": "US$ 360.71",
  "bundle_discount_percent": 0.0,
  "bundle_discount_amount": 0.0,
  "bundle_discount_amount_formatted": "US$ 0.00"
}

Request Payload

{
    "currency": "USD",
    "request": [
        {
            "quote_id": "ca5c9839-17b3-4810-b0b1-d5b693ecef86",
            "insured": [
                {
                    "first_name": "Bart",
                    "last_name": "Simpson",
                    "email": "[email protected]"
                }
            ]
        }
    ]
}

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

Name	Type	Description
partner_id	string	Unique Partner Code
quote_package_id	string	Quote Package ID

Headers

Name	Type	Description
Content-Type	string	application/json
Date	string	Current Datetime
Authorization	string	HMAC Signature
X-Api_Key	string	API Key

200

{
  "id": "TLCC8-B6YWP-INS",
  "status": "RECEIVED",
  "currency": "USD",
  "total_price": 360.71,
  "total_price_formatted": "US$ 360.71",
  "partner_transaction_id": "ABCD-EFGG-0000-0000",
  "created_at": "2020-02-06T00:12:31.013656Z",
  "updated_at": "2020-02-06T00:12:31.013670Z",
  "pds_url": "https://staging.xcover.com/en/pds/TLCC8-B6YWP-INS",
  "quotes": {
    "0": {
      "id": "ca5c9839-17b3-4810-b0b1-d5b693ecef86",
      "policy_start_date": "2020-02-06T13:00:00+00:00",
      "policy_end_date": "2021-02-06T13:00:00+00:00",
      "status": "RECEIVED",
      "price": 124.85,
      "price_formatted": "US$ 124.85",
      "policy": {
        "policy_type": "product_insurance",
        "policy_name": "Full Product Protection",
        "policy_code": "PFPO05CG",
        "policy_version": "7720b62b-3e84-446a-89d3-48c83cb39384",
        "category": "electronics-insurance"
      },
      "insured": [
        {
          "first_name": "Bart",
          "last_name": "Simpson",
          "email": "[email protected]"
        }
      ]
    }
  },
  "bundle_code": null,
  "bundle_price": 360.71,
  "bundle_content": {},
  "bundle_price_formatted": "US$ 360.71",
  "bundle_discount_percent": 0.0,
  "bundle_discount_amount": 0.0,
  "bundle_discount_amount_formatted": "US$ 0.00"
}

Request Payload

{
    "currency": "USD",
    "request": [
        {
            "policy_type": "product_insurance",
            "policy_type_version": "2",
            "policy_start_date": "2021-01-14T18:30:00+00:00",
            "retail_value": 450,
            "category": "Mobile",
            "title": "Samsung S8",
            "brand": "Samsung",
            "model": "S8",
            "sku": "1231231",
            "condition": "new"
        }
    ]
}

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

Name	Type	Description
partner_id	string	Unique Partner Code
quote_package_id	string	Quote Package ID

Headers

Name	Type	Description
Content-Type	string	application/json
Date	string	Current Datetime
Authorization	string	HMAC Signature
X-Api_Key	string	API Key

200

{
  "id": "TLCC8-B6YWP-INS",
  "status": "RECEIVED",
  "currency": "USD",
  "total_price": 360.71,
  "total_price_formatted": "US$ 360.71",
  "partner_transaction_id": "ABCD-EFGG-0000-0000",
  "created_at": "2020-02-06T00:12:31.013656Z",
  "updated_at": "2020-02-06T00:12:31.013670Z",
  "pds_url": "https://staging.xcover.com/en/pds/TLCC8-B6YWP-INS",
  "quotes": {
    "0": {
      "id": "ca5c9839-17b3-4810-b0b1-d5b693ecef86",
      "policy_start_date": "2020-02-06T13:00:00+00:00",
      "policy_end_date": "2021-02-06T13:00:00+00:00",
      "status": "RECEIVED",
      "price": 124.85,
      "price_formatted": "US$ 124.85",
      "policy": {
        "policy_type": "product_insurance",
        "policy_name": "Full Product Protection",
        "policy_code": "PFPO05CG",
        "policy_version": "7720b62b-3e84-446a-89d3-48c83cb39384",
        "category": "electronics-insurance"
      },
      "insured": [
        {
          "first_name": "Bart",
          "last_name": "Simpson",
          "email": "[email protected]"
        }
      ]
    }
  },
  "bundle_code": null,
  "bundle_price": 360.71,
  "bundle_content": {},
  "bundle_price_formatted": "US$ 360.71",
  "bundle_discount_percent": 0.0,
  "bundle_discount_amount": 0.0,
  "bundle_discount_amount_formatted": "US$ 0.00"
}

Request Payload

{
    "quotes": [
        {
            "id": "ca5c9839-17b3-4810-b0b1-d5b693ecef86"
        }
    ]
}

The remove method can only be used for Quotes in the RECEIEVED status.