XCover API (v2 – 2.41.92)

Download OpenAPI specification:Download

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
Request Body schema: application/json
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

204

Request Succeeded

404

Unknown partner or booking, or booking does not belong to the partner

422
post/partners/{partner_id}/bookings/{quote_package_id}/opt_out
https://api.xcover.com/x/partners/{partner_id}/bookings/{quote_package_id}/opt_out

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "partner_metadata": { }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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"

Request Body schema: application/json
currency
required
string (Currency)
Enum: "AED" "ARS" "AUD" "BDT" "BGN" "BHD" "BRL" "BSD" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "EGP" "EUR" "GBP" "GTQ" "HKD" "HNL" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JOD" "JPY" "KRW" "KWD" "KZT" "MAD" "MUR" "MXN" "MYR" "NOK" "NZD" "OMR" "PEN" "PHP" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SEK" "SGD" "THB" "TRY" "TWD" "UAH" "USD" "UYU" "UZS" "VND" "ZAR"
request
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 (Customer region) <= 64 characters Nullable

Country subdivision where the customer resides (as defined by ISO-3166-2, e.g. state or territory for Australia "NSW", "VIC", "ACT", "NT", etc

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

Customer's language

customer_email
string <email> (Customer email) <= 254 characters Nullable

Email address of the customer (bq_policy_pii)

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

Subsidiary of the Partner if applicable

partner_transaction_id
string (Partner transaction id) <= 1024 characters Nullable

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 (Partner customer id) <= 1024 characters Nullable

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.

policyholder
object (Policyholder) Nullable

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

200

Fast Quote

201

Quote

404

Unknown partner

422

Quote params are incorrect or quote cannot be processed.

post/partners/{partner_id}/quotes/
https://api.xcover.com/x/partners/{partner_id}/quotes/

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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": { },
  • "policyholder": { },
  • "opt_out": false
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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

Responses

200
get/partners/{partner_id}/quotes/{quote_package_id}/
https://api.xcover.com/x/partners/{partner_id}/quotes/{quote_package_id}/

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "status": "string",
  • "currency": "str",
  • "total_price": 0,
  • "total_price_formatted": "string",
  • "partner_transaction_id": "string",
  • "created_at": "2022-10-02T16:13:29Z",
  • "updated_at": "2022-10-02T16:13:29Z",
  • "pds_url": "http://example.com",
  • "security_token": "string",
  • "quotes":
    {