API docs by Redocly

XCover API (v2 – 2.138.1)

Download OpenAPI specification:

Documentation Home

Quotes

Opt-out

Report conversion of the main product without ancillary insurance products

path Parameters
partner_id
required
string
quote_package_id
required
string

Booking id (INS-number generated by XCover API) or fast_quote_id.

header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
partner_metadata
object (Partner metadata)

This field takes partner-specific fields. The keys represent field names and can be any arbitrary string.The values must be one of the simple JSON types: string, boolean, number or null. It’s impossible to use complex types i.e. objects and arrays.

Responses

Request samples

Content type
application/json
{
  • "partner_metadata": { }
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "message": "string",
  • "code": "string",
  • "href": "string",
  • "errors": {
    }
}

Create quote

Create a quote with provided parameters

path Parameters
partner_id
required
string
query Parameters
fast_quote
boolean

Fast quote calculation.Quote will be calculated, but results won't be stored.

active_only
boolean

Select only active policies if testing API key is used.

include_extra_fields
boolean

Include extra_fields in Fast quote response. Shall be used in conjunction with "fast_quote"

extra_fields
string

Extra fields to include in response

Request Body schema: application/json
required
currency
required
string (Currency)
Enum: "AED" "AFN" "ARS" "AUD" "AZN" "BAM" "BDT" "BGN" "BHD" "BRL" "BSD" "BYN" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DJF" "DKK" "EGP" "ERN" "ETB" "EUR" "FJD" "GBP" "GEL" "GTQ" "HKD" "HNL" "HRK" "HUF" "IDR" "ILS" "INR" "IQD" "ISK" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KZT" "LAK" "LBP" "LKR" "MAD" "MKD" "MUR" "MVR" "MXN" "MYR" "NGN" "NOK" "NPR" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SDG" "SEK" "SGD" "SYP" "THB" "TJS" "TRY" "TWD" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "XPF" "YER" "ZAR"
required
Array of objects (PolicyRequest)
customer_country
required
string (Customer country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GO" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
customer_region
string or null (Customer region) <= 64 characters

Country subdivision where the customer resides (as defined by ISO-3166-2, e.g. "AU-NSW", "FR-20R", "IS-1", "JP-13", "SE-T", "SI-099", "US-NY")

customer_language
string (Customer language) [ 1 .. 8 ] characters

Customer's language

customer_email
string or null <email> (Customer email) <= 254 characters

Email address of the customer (bq_policy_pii)

customer_ip
string or null (Customer ip) non-empty
customer_postcode
string or null (Customer postcode) <= 32 characters
partner_subsidiary
string or null (Partner subsidiary) <= 128 characters

Subsidiary of the Partner if applicable

partner_transaction_id
string or null (Partner transaction id) <= 1024 characters

A unique id of the transaction record (booking, order, etc) on the partner side. It can be used in get booking endpoint, but only if characters are limited to alphanumeric symbols, hyphens and underscores.

partner_customer_id
string or null (Partner customer id) <= 1024 characters

Partner's customer ID for this transaction

partner_metadata
object (Partner metadata)

This field can be used to pass custom information along with the quote request. The value of this field should be a JSON object representing key-value pairs with a string, boolean or number as a value. Complex data types like objects or array are not allowed.

experiment
object (Experiment)
Default: {}

Experiment related data. This can be used, for example, to control the experiment (by setting the 'treatment' key)

policyholder
object or null (Policyholder)

Policyholder information (bq_policy_pii)

opt_out
boolean (Opt out)
Default: false

Should the created quote be automatically opted out (no booking can be made)

Responses

Request samples

Content type
application/json
{
  • "currency": "AED",
  • "request": [
    ],
  • "customer_country": "AF",
  • "customer_region": "string",
  • "customer_language": "string",
  • "customer_email": "[email protected]",
  • "customer_ip": "string",
  • "customer_postcode": "string",
  • "partner_subsidiary": "string",
  • "partner_transaction_id": "string",
  • "partner_customer_id": "string",
  • "partner_metadata": { },
  • "experiment": { },
  • "policyholder": { },
  • "opt_out": false
}

Response samples

Content type
application/json
{
  • "currency": "str",
  • "quotes": {
    },
  • "errors": {
    },
  • "fast_quote_id": "string"
}

Get quote

Get a specific quote information

path Parameters
partner_id
required
string
quote_package_id
required
string

QuotePackage id (INS-number generated by XCover API) or fast_quote_id.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": {
    },
  • "bundle_code": "string",
  • "bundle_price": 0,
  • "bundle_content": {
    },
  • "bundle_price_formatted": "string",
  • "bundle_discount_percent": 0,
  • "bundle_discount_amount": 0,
  • "bundle_discount_amount_formatted": "string",
  • "errors": {
    }
}

Update quote

Update an existing Quote in a Quote Package.

For addition or modification of specific field types(lists or objects) in the "request" field, send the new data appended to the existing data for that particular field type.

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
currency
required
string (Currency)
Enum: "AED" "AFN" "ARS" "AUD" "AZN" "BAM" "BDT" "BGN" "BHD" "BRL" "BSD" "BYN" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DJF" "DKK" "EGP" "ERN" "ETB" "EUR" "FJD" "GBP" "GEL" "GTQ" "HKD" "HNL" "HRK" "HUF" "IDR" "ILS" "INR" "IQD" "ISK" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KZT" "LAK" "LBP" "LKR" "MAD" "MKD" "MUR" "MVR" "MXN" "MYR" "NGN" "NOK" "NPR" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SDG" "SEK" "SGD" "SYP" "THB" "TJS" "TRY" "TWD" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "XPF" "YER" "ZAR"
Array of objects or null
customer_country
required
string (Customer country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GO" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"
customer_region
string or null (Customer region) <= 64 characters

Country subdivision where the customer resides (as defined by ISO-3166-2, e.g. "AU-NSW", "FR-20R", "IS-1", "JP-13", "SE-T", "SI-099", "US-NY")

customer_language
string (Customer language) [ 1 .. 8 ] characters

Customer's language

customer_email
string or null <email> (Customer email) <= 254 characters

Email address of the customer (bq_policy_pii)

customer_ip
string or null (Customer ip) non-empty
customer_postcode
string or null (Customer postcode) <= 32 characters
partner_subsidiary
string or null (Partner subsidiary) <= 128 characters

Subsidiary of the Partner if applicable

partner_transaction_id
string or null (Partner transaction id) <= 1024 characters

A unique id of the transaction record (booking, order, etc) on the partner side. It can be used in get booking endpoint, but only if characters are limited to alphanumeric symbols, hyphens and underscores.

partner_customer_id
string or null (Partner customer id) <= 1024 characters

Partner's customer ID for this transaction

partner_metadata
object (Partner metadata)

This field can be used to pass custom information along with the quote request. The value of this field should be a JSON object representing key-value pairs with a string, boolean or number as a value. Complex data types like objects or array are not allowed.

experiment
object (Experiment)
Default: {}

Experiment related data. This can be used, for example, to control the experiment (by setting the 'treatment' key)

policyholder
object or null (Policyholder)

Policyholder information (bq_policy_pii)

preview
boolean (Preview)
Default: false

When preview is True, the update will only be displayed but not saved.

Responses

Request samples

Content type
application/json
{
  • "currency": "AED",
  • "request": [
    ],
  • "customer_country": "AF",
  • "customer_region": "string",
  • "customer_language": "string",
  • "customer_email": "[email protected]",
  • "customer_ip": "string",
  • "customer_postcode": "string",
  • "partner_subsidiary": "string",
  • "partner_transaction_id": "string",
  • "partner_customer_id": "string",
  • "partner_metadata": { },
  • "experiment": { },
  • "policyholder": { },
  • "preview": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": {
    },
  • "bundle_code": "string",
  • "bundle_price": 0,
  • "bundle_content": {
    },
  • "bundle_price_formatted": "string",
  • "bundle_discount_percent": 0,
  • "bundle_discount_amount": 0,
  • "bundle_discount_amount_formatted": "string",
  • "errors": {
    }
}

Add a quote

Add quotes to existing package

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "request": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": {
    },
  • "bundle_code": "string",
  • "bundle_price": 0,
  • "bundle_content": {
    },
  • "bundle_price_formatted": "string",
  • "bundle_discount_percent": 0,
  • "bundle_discount_amount": 0,
  • "bundle_discount_amount_formatted": "string",
  • "errors": {
    }
}

Delete quote

Delete quotes from existing package

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
required
Array of objects (QuoteID)

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": {
    },
  • "bundle_code": "string",
  • "bundle_price": 0,
  • "bundle_content": {
    },
  • "bundle_price_formatted": "string",
  • "bundle_discount_percent": 0,
  • "bundle_discount_amount": 0,
  • "bundle_discount_amount_formatted": "string",
  • "errors": {
    }
}

Bookings

List booking

Lists all partner bookings filtered by the query parameters. Datetime fields need to use url-encoded ISO 8601 date format.

path Parameters
partner_id
required
string
query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

id
string

id

customer__email
string

customer__email

customer__email__startswith
string

customer__email__startswith

customer__phone
string

customer__phone

customer__phone__startswith
string

customer__phone__startswith

status
string

status (E.g. 1, 2, 3, CONFIRMED, CANCELLED etc.)

updated_before
string

updated_before

updated_after
string

updated_after

created_before
string

created_before

created_after
string

created_after

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Get booking

Get booking details for the provided quote package id or partner_transaction_id.

path Parameters
partner_id
required
string
quote_package_id
required
string

Booking id (INS-number generated by XCover API) or partner_transaction_id.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {},
  • "partner": {
    },
  • "partner_metadata": { },
  • "customer_language": "string"
}

Create booking

Convert a specific quote to booking

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
required
Array of objects (BookingRequestQuote)
required
object (Policyholder)
require_payment_confirmation
boolean (Require payment confirmation)
partner_transaction_id
string (Partner transaction id) non-empty
xpay_charge_id
string (Xpay charge id) non-empty

Deprecated. Please use the payment_details.

xpay_customer_token_id
string (Xpay customer token id) non-empty

Deprecated. Please use the payment_details.

object (PaymentDetails)
object (BookingAgent)

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ],
  • "policyholder": {
    },
  • "require_payment_confirmation": true,
  • "partner_transaction_id": "string",
  • "xpay_charge_id": "string",
  • "xpay_customer_token_id": "string",
  • "payment_details": {
    },
  • "booking_agent": {}
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {}
}

Change owner

Change the owner of a booking to another user.

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
first_name
required
string (First name) [ 1 .. 255 ] characters

First name

last_name
required
string or null (Last name) <= 255 characters

Last name

email
string or null (Email)

Email address

phone
string or null (Phone)

Phone number

address1
string or null (Address1) <= 256 characters

Address line 1

address2
string or null (Address2) <= 256 characters

Address line 2

postcode
string or null (Postcode) <= 32 characters

Postcode

company
string or null (Company) <= 256 characters

Company name

company_reg_id
string or null (Company reg id) <= 64 characters

Company registration ID

middle_name
string or null (Middle name) <= 256 characters
country
required
string (Country)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GO" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"

Country of residence

age
integer or null (Age)

Age

city
string or null (City) <= 128 characters

City of residence

region
string or null (Region) <= 64 characters

Region

secondary_email
string or null (Secondary email) non-empty

Secondary email address

birth_date
string or null <date> (Birth date)

Date of birth

tax_payer_id
string or null (Tax payer id) <= 32 characters

Tax payer ID

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone": "string",
  • "address1": "string",
  • "address2": "string",
  • "postcode": "string",
  • "company": "string",
  • "company_reg_id": "string",
  • "middle_name": "string",
  • "country": "AF",
  • "age": 0,
  • "city": "string",
  • "region": "string",
  • "secondary_email": "string",
  • "birth_date": "2019-08-24",
  • "tax_payer_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {},
  • "partner": {
    },
  • "partner_metadata": { },
  • "customer_language": "string"
}

Confirm booking

Confirms booking in two-step booking scenario. In this case require_payment_confirmation flag in the Create booking request needs to be set.

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
object (PaymentDetails)
xpay_charge_id
string (Xpay charge id) non-empty

Deprecated, moved into payment_details.

Responses

Request samples

Content type
application/json
{
  • "payment_details": {
    },
  • "xpay_charge_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {}
}

Confirm refunds

Confirm processing of refunds for quotes in a booking.

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
required
Array of objects (RefundConfirmationQuoteRequest)

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "message": "string",
  • "code": "string",
  • "href": "string",
  • "errors": {
    }
}

Manually trigger email

Manually triggers policy lifecycle email to be sent to the customer

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
email
string or null (Email)

Email address

event
string or null (Event)
Enum: "BOOKING_CREATED" "BOOKING_CANCELLED"

Defines what email to trigger

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "event": "BOOKING_CREATED"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "message": "string",
  • "code": "string",
  • "href": "string",
  • "errors": {
    }
}

Fast booking

Convert a fast quote to booking

path Parameters
partner_id
required
string
fast_quote_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
required
Array of objects (BookingRequestQuote)
required
object (Policyholder)
require_payment_confirmation
boolean (Require payment confirmation)
partner_transaction_id
string (Partner transaction id) non-empty
xpay_charge_id
string (Xpay charge id) non-empty

Deprecated. Please use the payment_details.

xpay_customer_token_id
string (Xpay customer token id) non-empty

Deprecated. Please use the payment_details.

object (PaymentDetails)
object (BookingAgent)

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ],
  • "policyholder": {
    },
  • "require_payment_confirmation": true,
  • "partner_transaction_id": "string",
  • "xpay_charge_id": "string",
  • "xpay_customer_token_id": "string",
  • "payment_details": {
    },
  • "booking_agent": {}
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {}
}

Instant booking

Make quote and booking in a single step

path Parameters
partner_id
required
string
query Parameters
active_only
boolean

Select only active policies if testing API key is used.

header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
partner_metadata
object (Partner metadata)

This field can be used to pass custom information along with the quote request. The value of this field should be a JSON object representing key-value pairs with a string, boolean or number as a value. Complex data types like objects or array are not allowed.

partner_subsidiary
string or null (Partner subsidiary) <= 128 characters

Subsidiary of the Partner if applicable

xpay_charge_id
string (Xpay charge id) non-empty

Deprecated, moved into payment_details.

fast_quote_id
string <uuid> (Fast quote id)
customer_language
string (Customer language) [ 1 .. 8 ] characters

Customer's language

currency
required
string (Currency)
Enum: "AED" "AFN" "ARS" "AUD" "AZN" "BAM" "BDT" "BGN" "BHD" "BRL" "BSD" "BYN" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DJF" "DKK" "EGP" "ERN" "ETB" "EUR" "FJD" "GBP" "GEL" "GTQ" "HKD" "HNL" "HRK" "HUF" "IDR" "ILS" "INR" "IQD" "ISK" "JOD" "JPY" "KES" "KHR" "KRW" "KWD" "KZT" "LAK" "LBP" "LKR" "MAD" "MKD" "MUR" "MVR" "MXN" "MYR" "NGN" "NOK" "NPR" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SDG" "SEK" "SGD" "SYP" "THB" "TJS" "TRY" "TWD" "UAH" "UGX" "USD" "UYU" "UZS" "VND" "XPF" "YER" "ZAR"
object (PaymentDetails)
customer_ip
string or null (Customer ip) non-empty
partner_customer_id
string or null (Partner customer id) <= 1024 characters

Partner's customer ID for this transaction

object (BookingAgent)
required
Array of objects (BookingPolicyRequest)
experiment
object (Experiment)
Default: {}

Experiment related data. This can be used, for example, to control the experiment (by setting the 'treatment' key)

partner_transaction_id
string or null (Partner transaction id) <= 1024 characters

A unique id of the transaction record (booking, order, etc) on the partner side. It can be used in get booking endpoint, but only if characters are limited to alphanumeric symbols, hyphens and underscores.

required
object (Policyholder)

Responses

Request samples

Content type
application/json
{
  • "partner_metadata": { },
  • "partner_subsidiary": "string",
  • "xpay_charge_id": "string",
  • "fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd",
  • "customer_language": "string",
  • "currency": "AED",
  • "payment_details": {
    },
  • "customer_ip": "string",
  • "partner_customer_id": "string",
  • "booking_agent": {},
  • "request": [
    ],
  • "experiment": { },
  • "partner_transaction_id": "string",
  • "policyholder": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {}
}

Modifications

Booking modification

Modifies booking. This endpoint can potentially trigger premium change.

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
Array of objects (UpdateBookingRequestQuote) non-empty
xpay_charge_id
string (Xpay charge id) non-empty
object (PolicyholderUpdate)
skip_xpay_transaction
boolean (Skip xpay transaction)
Default: false

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ],
  • "xpay_charge_id": "string",
  • "policyholder": {
    },
  • "skip_xpay_transaction": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {},
  • "total_price_diff": 0,
  • "total_price_diff_formatted": "string"
}

Confirm booking modification

Confirms booking modification and set parameters as provided in the previous " modification" request

path Parameters
partner_id
required
string
quote_package_id
required
string
update_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
xpay_charge_id
string (Xpay charge id) non-empty

Responses

Request samples

Content type
application/json
{
  • "xpay_charge_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {},
  • "total_price_diff": 0,
  • "total_price_diff_formatted": "string"
}

Quote for booking modification

Generates a quote for booking modification. The modification then needs to be confirmed using the update_id parameter provided in the response.

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
Array of objects (UpdateBookingRequestQuote) non-empty
xpay_charge_id
string (Xpay charge id) non-empty
object (PolicyholderUpdate)
skip_xpay_transaction
boolean (Skip xpay transaction)
Default: false

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ],
  • "xpay_charge_id": "string",
  • "policyholder": {
    },
  • "skip_xpay_transaction": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {},
  • "total_price_diff": 0,
  • "total_price_diff_formatted": "string",
  • "update_id": "string",
  • "payment_methods": [
    ]
}

Cancellations

Cancel booking

Cancel a specific booking.

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
preview
boolean (Preview)
Default: false
refund_required
boolean (Refund required)
Default: true

Deprecated. Refund will be created on a best-effort basis

Array of objects (CancelBookingRequestQuote)

Responses

Request samples

Content type
application/json
{
  • "preview": false,
  • "refund_required": true,
  • "quotes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "quotes": [
    ],
  • "policyholder": {
    },
  • "pds_url": "http://example.com",
  • "coi": {},
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "total_refund": 0,
  • "total_refund_formatted": "string",
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "currency": "str",
  • "cancellation_id": "string",
  • "confirm_before": "2019-08-24T14:15:22Z",
  • "partner": {
    },
  • "refund_amount": 0,
  • "refund_amount_formatted": "string",
  • "cancellation_payout_url": "string"
}

Confirm booking cancellation

Confirm the cancellation that is created by booking cancellation preview

path Parameters
partner_id
required
string
quote_package_id
required
string
cancellation_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
reason_for_cancellation
string or null (Reason for cancellation) <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "reason_for_cancellation": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "quotes": [
    ],
  • "policyholder": {
    },
  • "pds_url": "http://example.com",
  • "coi": {},
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "total_refund": 0,
  • "total_refund_formatted": "string",
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "currency": "str",
  • "cancellation_id": "string",
  • "confirm_before": "2019-08-24T14:15:22Z",
  • "partner": {
    },
  • "refund_amount": 0,
  • "refund_amount_formatted": "string",
  • "cancellation_payout_url": "string"
}

Renewals

Renewal confirmation

Creates a renewal with parameters provided in the previous "Quote for renewal" request

path Parameters
partner_id
required
string
quote_package_id
required
string
pending_renewal_id
required
string
query Parameters
return_booking_detail
boolean

Return booking details in response

header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
required
Array of objects (BookingRequestQuote)

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ]
}

Response samples

Content type
application/json
{
  • "renewal_id": "string",
  • "quotes": [
    ]
}

Renewal opt-out

Calling this endpoint indicates that customer is not intended to renew the policyinsurance products

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
Array of objects (RenewalOptoutRequestQuote)

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "message": "string",
  • "code": "string",
  • "href": "string",
  • "errors": {
    }
}

Quote for renewal

Generates a Quote for renewal as specified in the request which can then be confirmed using the endpoint specified in the Response or through auto_confirm flag in the Request.

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
auto_confirm
boolean (Auto confirm)
Default: false

Should the created renewal be automatically confirmed

use_newest_policy
boolean (Use newest policy)
Default: false

Use newest policy on renewal

due_date_within
integer (Due date within)

Only renew quotes whose due dates are within the specified number of days from when the request is sent. If not provided, all quotes that are eligible for renewal will be renewed. Accepts non-positive values as well.

Responses

Request samples

Content type
application/json
{
  • "auto_confirm": false,
  • "use_newest_policy": false,
  • "due_date_within": 0
}

Response samples

Content type
application/json
{
  • "renewal_id": "string",
  • "quotes": [
    ]
}

Instalments

calculate_instalment_price

Run pricing for an UNPRICED instalment. If dry_run is true in the request body, changes will not be saved.

path Parameters
partner_id
required
string
quote_package_id
required
string
instalment_id
required
string
Request Body schema: application/json
required
dry_run
boolean (Dry run)
Default: false

Responses

Request samples

Content type
application/json
{
  • "dry_run": false
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "message": "string",
  • "code": "string",
  • "href": "string",
  • "errors": {
    }
}

Get instalments

Get instalments details for the provided quote package id.

path Parameters
partner_id
required
string
quote_package_id
required
string

Booking id (INS-number generated by XCover API)

Responses

Response samples

Content type
application/json
{
  • "quotes": [
    ],
  • "currency": "string"
}

Update instalment payment

Update instalment payment status

path Parameters
partner_id
required
string
quote_package_id
required
string
header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
required
Array of objects (QuoteInstalment)

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "message": "string",
  • "code": "string",
  • "href": "string",
  • "errors": {
    }
}

settle_instalments

Calculate final adjustments for cancelled quotes' instalments. For each instalment covered by the cancellation date, recalculate pricing, and save the final_adjustment amount.

path Parameters
partner_id
required
string
quote_package_id
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "message": "string",
  • "code": "string",
  • "href": "string",
  • "errors": {
    }
}

Tables

List tables

List tables.

path Parameters
partner_id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Get table

Get table.

path Parameters
partner_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "slug": "string",
  • "version": 2147483647,
  • "file": {
    },
  • "active_from": "2019-08-24T14:15:22Z",
  • "template": {
    },
  • "data": { }
}

Utils

Health check

Validates health of the internal systems.

Responses

Ping

Tests connection to the service

Responses

misc

Confirm offer

Confirm an offer by converting it to a booking

path Parameters
partner_id
required
string[A-Z0-9]+

Partner ID

offer_id
required
string <uuid>

Offer ID from create_offer response

header Parameters
x-idempotency-key
string

Idempotency key

Request Body schema: application/json
required
required
Array of objects (BookingRequestQuote)
required
object (Policyholder)
require_payment_confirmation
boolean (Require payment confirmation)
partner_transaction_id
string (Partner transaction id) non-empty
xpay_charge_id
string (Xpay charge id) non-empty

Deprecated. Please use the payment_details.

xpay_customer_token_id
string (Xpay customer token id) non-empty

Deprecated. Please use the payment_details.

object (PaymentDetails)
object (BookingAgent)

Responses

Request samples

Content type
application/json
{
  • "quotes": [
    ],
  • "policyholder": {
    },
  • "require_payment_confirmation": true,
  • "partner_transaction_id": "string",
  • "xpay_charge_id": "string",
  • "xpay_customer_token_id": "string",
  • "payment_details": {
    },
  • "booking_agent": {}
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes": [
    ],
  • "coi": {},
  • "account_url": "http://example.com",
  • "sign_up_url": "http://example.com",
  • "policyholder": {
    },
  • "total_tax": 0,
  • "total_tax_formatted": "string",
  • "total_premium": 0,
  • "total_premium_formatted": "string",
  • "fnol_link": "string",
  • "booking_agent": {}
}