XCover API (2.152.1)

Download OpenAPI specification:

Documentation Home

Quotes

Quotes API

Opt out of booking

Opt out of a specific booking.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
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

object

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

Production server

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

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/opt_out

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/opt_out

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/opt_out

Request samples

Payload

Content type

application/json

{"partner_metadata": { }
}

Response samples

Content type

application/json

{"property1": null,
"property2": null
}

Create quote

Create a quote with provided parameters

Authorizations:

HMACAuthentication

path Parameters

partner_id

required

string^[A-Z0-9]+$

query Parameters

active_only	boolean Select only active policies if testing API key is used.
extra_fields	string Extra fields to include in response
fast_quote	boolean Fast quote calculation.Quote will be calculated, but results won't be stored.
include_extra_fields	boolean Include extra_fields in Fast quote response. Shall be used in conjunction with "fast_quote"

Request Body schema: application/json
required

currency required	string (CurrencyEnum) 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" `AED` - AED `AFN` - AFN `ARS` - ARS `AUD` - AUD `AZN` - AZN `BAM` - BAM `BDT` - BDT `BGN` - BGN `BHD` - BHD `BRL` - BRL `BSD` - BSD `BYN` - BYN `CAD` - CAD `CHF` - CHF `CLP` - CLP `CNY` - CNY `COP` - COP `CRC` - CRC `CZK` - CZK `DJF` - DJF `DKK` - DKK `EGP` - EGP `ERN` - ERN `ETB` - ETB `EUR` - EUR `FJD` - FJD `GBP` - GBP `GEL` - GEL `GTQ` - GTQ `HKD` - HKD `HNL` - HNL `HRK` - HRK `HUF` - HUF `IDR` - IDR `ILS` - ILS `INR` - INR `IQD` - IQD `ISK` - ISK `JOD` - JOD `JPY` - JPY `KES` - KES `KHR` - KHR `KRW` - KRW `KWD` - KWD `KZT` - KZT `LAK` - LAK `LBP` - LBP `LKR` - LKR `MAD` - MAD `MKD` - MKD `MUR` - MUR `MVR` - MVR `MXN` - MXN `MYR` - MYR `NGN` - NGN `NOK` - NOK `NPR` - NPR `NZD` - NZD `OMR` - OMR `PEN` - PEN `PHP` - PHP `PKR` - PKR `PLN` - PLN `QAR` - QAR `RON` - RON `RSD` - RSD `RUB` - RUB `SAR` - SAR `SDG` - SDG `SEK` - SEK `SGD` - SGD `SYP` - SYP `THB` - THB `TJS` - TJS `TRY` - TRY `TWD` - TWD `UAH` - UAH `UGX` - UGX `USD` - USD `UYU` - UYU `UZS` - UZS `VND` - VND `XPF` - XPF `YER` - YER `ZAR` - ZAR
required	Array of objects
customer_country required	string (CustomerCountryEnum) 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" `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GO` - Global `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe
customer_region	string or null <= 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 <= 8 characters Customer's language
customer_email	string or null <email> <= 254 characters Email address of the customer (bq_policy_pii)
customer_ip	string or null
customer_postcode	string or null <= 32 characters
partner_subsidiary	string or null <= 128 characters Subsidiary of the Partner if applicable
partner_transaction_id	string or null <= 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 <= 1024 characters Partner's customer ID for this transaction
	object 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.
	object Experiment related data. This can be used, for example, to control the experiment (by setting the 'treatment' key)
	object or null Policyholder information (bq_policy_pii)
opt_out	boolean Default: false Should the created quote be automatically opted out (no booking can be made)

Responses

Request samples

Payload

Content type

application/json

{"currency": "AED",
"request": [{"property1": null,
"property2": null
}
],
"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

{"fast_quote_id": "string",
"currency": "str",
"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
}
},
"pds_url": "string",
"files": [{"property1": null,
"property2": null
}
],
"extra_fields": {"property1": null,
"property2": null
},
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"experiment": { }
}
],
"errors": {"property1": null,
"property2": null
}
}

Get quote

Get a specific quote information

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string QuotePackage `id` (INS-number generated by XCover API) or `fast_quote_id`.

Responses

Production server

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

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"discount_price": -1e+28,
"discount_price_formatted": "string",
"discount_amount": -1e+28,
"discount_amount_formatted": "string",
"instalment_plans": [{"name": "string",
"label": "string",
"amount": -1e+28,
"first_instalment_amount": -1e+28
}
]
}
],
"bundle_code": "string",
"bundle_price": 0.1,
"bundle_content": {"property1": null,
"property2": null
},
"bundle_price_formatted": "string",
"bundle_discount_percent": 0.1,
"bundle_discount_amount": 0.1,
"bundle_discount_amount_formatted": "string",
"errors": {"property1": null,
"property2": null
}
}

Update quote

Update an existing Quote in a Quote Package.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

currency	string (CurrencyEnum) 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" `AED` - AED `AFN` - AFN `ARS` - ARS `AUD` - AUD `AZN` - AZN `BAM` - BAM `BDT` - BDT `BGN` - BGN `BHD` - BHD `BRL` - BRL `BSD` - BSD `BYN` - BYN `CAD` - CAD `CHF` - CHF `CLP` - CLP `CNY` - CNY `COP` - COP `CRC` - CRC `CZK` - CZK `DJF` - DJF `DKK` - DKK `EGP` - EGP `ERN` - ERN `ETB` - ETB `EUR` - EUR `FJD` - FJD `GBP` - GBP `GEL` - GEL `GTQ` - GTQ `HKD` - HKD `HNL` - HNL `HRK` - HRK `HUF` - HUF `IDR` - IDR `ILS` - ILS `INR` - INR `IQD` - IQD `ISK` - ISK `JOD` - JOD `JPY` - JPY `KES` - KES `KHR` - KHR `KRW` - KRW `KWD` - KWD `KZT` - KZT `LAK` - LAK `LBP` - LBP `LKR` - LKR `MAD` - MAD `MKD` - MKD `MUR` - MUR `MVR` - MVR `MXN` - MXN `MYR` - MYR `NGN` - NGN `NOK` - NOK `NPR` - NPR `NZD` - NZD `OMR` - OMR `PEN` - PEN `PHP` - PHP `PKR` - PKR `PLN` - PLN `QAR` - QAR `RON` - RON `RSD` - RSD `RUB` - RUB `SAR` - SAR `SDG` - SDG `SEK` - SEK `SGD` - SGD `SYP` - SYP `THB` - THB `TJS` - TJS `TRY` - TRY `TWD` - TWD `UAH` - UAH `UGX` - UGX `USD` - USD `UYU` - UYU `UZS` - UZS `VND` - VND `XPF` - XPF `YER` - YER `ZAR` - ZAR
	Array of objects or null
customer_country	string (CustomerCountryEnum) 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" `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GO` - Global `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe
customer_region	string or null <= 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 <= 8 characters Customer's language
customer_email	string or null <email> <= 254 characters Email address of the customer (bq_policy_pii)
customer_ip	string or null
customer_postcode	string or null <= 32 characters
partner_subsidiary	string or null <= 128 characters Subsidiary of the Partner if applicable
partner_transaction_id	string or null <= 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 <= 1024 characters Partner's customer ID for this transaction
	object 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.
	object Experiment related data. This can be used, for example, to control the experiment (by setting the 'treatment' key)
	object or null Policyholder information (bq_policy_pii)
preview	boolean Default: false When preview is True, the update will only be displayed but not saved.

Responses

Production server

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

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/

Request samples

Payload

Content type

application/json

{"currency": "AED",
"request": [{"property1": null,
"property2": null
}
],
"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": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"discount_price": -1e+28,
"discount_price_formatted": "string",
"discount_amount": -1e+28,
"discount_amount_formatted": "string",
"instalment_plans": [{"name": "string",
"label": "string",
"amount": -1e+28,
"first_instalment_amount": -1e+28
}
]
}
],
"bundle_code": "string",
"bundle_price": 0.1,
"bundle_content": {"property1": null,
"property2": null
},
"bundle_price_formatted": "string",
"bundle_discount_percent": 0.1,
"bundle_discount_amount": 0.1,
"bundle_discount_amount_formatted": "string",
"errors": {"property1": null,
"property2": null
}
}

Add a quote

Add quotes to existing package

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json
required

required

Array of objects

Responses

Production server

https://api.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/add/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/add/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/add/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/add/

Request samples

Payload

Content type

application/json

{"request": [{"property1": null,
"property2": null
}
]
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"discount_price": -1e+28,
"discount_price_formatted": "string",
"discount_amount": -1e+28,
"discount_amount_formatted": "string",
"instalment_plans": [{"name": "string",
"label": "string",
"amount": -1e+28,
"first_instalment_amount": -1e+28
}
]
}
],
"bundle_code": "string",
"bundle_price": 0.1,
"bundle_content": {"property1": null,
"property2": null
},
"bundle_price_formatted": "string",
"bundle_discount_percent": 0.1,
"bundle_discount_amount": 0.1,
"bundle_discount_amount_formatted": "string",
"errors": {"property1": null,
"property2": null
}
}

Delete quote

Delete quotes from existing package

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json
required

required

Array of objects (QuoteID)

Responses

Production server

https://api.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/delete/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/delete/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/delete/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/quotes/{quote_package_id}/delete/

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"discount_price": -1e+28,
"discount_price_formatted": "string",
"discount_amount": -1e+28,
"discount_amount_formatted": "string",
"instalment_plans": [{"name": "string",
"label": "string",
"amount": -1e+28,
"first_instalment_amount": -1e+28
}
]
}
],
"bundle_code": "string",
"bundle_price": 0.1,
"bundle_content": {"property1": null,
"property2": null
},
"bundle_price_formatted": "string",
"bundle_discount_percent": 0.1,
"bundle_discount_amount": 0.1,
"bundle_discount_amount_formatted": "string",
"errors": {"property1": null,
"property2": null
}
}

Bookings

Get booking

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

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string Booking `id` (INS-number generated by XCover API) or `partner_transaction_id`.

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"can_be_cancelled": "string",
"errors": ["string"
],
"third_party_admins": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"ombudsman_list": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"cancellation_info": {"property1": null,
"property2": null
}
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd",
"partner": {"id": "string",
"slug": "string",
"name": "string",
"title": "string",
"logo": "http://example.com",
"contact_url": "http://example.com",
"partner_url": "http://example.com",
"help_center_url": "http://example.com",
"updated_at": "2019-08-24T14:15:22Z",
"xpay_payment_enabled": true,
"xpay_b2c_payment_enabled": true,
"xpay_refund_enabled": true,
"automatic_refund_by_xcore": true,
"allow_policy_modifications_on_xcover": true,
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"from_email": "string",
"bcc_email": "[email protected]",
"email_slug": "string",
"email_version": -2147483648,
"event_name": 0,
"include_partner_in_context": true,
"attach_coi": true,
"send_linked_sms": true,
"auto_send": true,
"enable_expression": "string"
}
],
"attributes": { },
"signup_method_on_xcover": "phone",
"use_standard_region": true,
"allow_payout_customer": true,
"eligible_for_xpay_charge_retry": true,
"subsidiary": {"id": "string",
"slug": "string",
"name": "string",
"title": "string",
"logo": "http://example.com",
"contact_url": "http://example.com",
"partner_url": "http://example.com",
"help_center_url": "http://example.com"
}
},
"partner_metadata": { },
"customer_language": "string"
}

Create booking

Convert a specific quote to booking

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[a-zA-Z0-9-_=]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json
required

required	Array of objects (BookingRequestQuote)
required	object (Policyholder) Policyholder serializer with a minimum set of attributes. The Policyholder serializer class contains the attributes that make up what can be considered a base Policyholder. This class contains only those attributes that are shared by all the variants of Policyholder to minimize repetition of attribute definitions.
require_payment_confirmation	boolean
partner_transaction_id	string
xpay_charge_id	string Deprecated. Please use the payment_details.
xpay_customer_token_id	string Deprecated. Please use the payment_details.
	object (PaymentDetails) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.
	object (BookingAgent) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"insured": [{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"metadata": {"property1": null,
"property2": null
},
"company": "string"
}
],
"instalment_plan": "string",
"first_instalment_paid": true
}
],
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"tax_payer_id": "string"
},
"require_payment_confirmation": true,
"partner_transaction_id": "string",
"xpay_charge_id": "string",
"xpay_customer_token_id": "string",
"payment_details": {"provider": "string",
"xpay_charge_id": "string",
"xpay_customer_id": "string",
"transaction_id": "string",
"customer_token_id": "string"
},
"booking_agent": {"email": "[email protected]"
}
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"can_be_cancelled": "string",
"errors": ["string"
],
"third_party_admins": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"ombudsman_list": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"cancellation_info": {"property1": null,
"property2": null
}
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd"
}

Change owner

Change the owner of a booking to another user.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

Request Body schema: application/json

first_name	string <= 255 characters First name
last_name	string or null <= 255 characters Last name
email	string or null Email address
phone	string or null Phone number
address1	string or null <= 256 characters Address line 1
address2	string or null <= 256 characters Address line 2
postcode	string or null <= 32 characters Postcode
city	string or null <= 128 characters City of residence
region	string or null <= 64 characters Region
birth_date	string or null <date> Date of birth
company	string or null <= 256 characters Company name
company_reg_id	string or null <= 64 characters Company registration ID
middle_name	string or null <= 256 characters
country	string (CountryEnum) 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 `AF` - Afghanistan `AX` - Åland Islands `AL` - Albania `DZ` - Algeria `AS` - American Samoa `AD` - Andorra `AO` - Angola `AI` - Anguilla `AQ` - Antarctica `AG` - Antigua and Barbuda `AR` - Argentina `AM` - Armenia `AW` - Aruba `AU` - Australia `AT` - Austria `AZ` - Azerbaijan `BS` - Bahamas `BH` - Bahrain `BD` - Bangladesh `BB` - Barbados `BY` - Belarus `BE` - Belgium `BZ` - Belize `BJ` - Benin `BM` - Bermuda `BT` - Bhutan `BO` - Bolivia `BQ` - Bonaire, Sint Eustatius and Saba `BA` - Bosnia and Herzegovina `BW` - Botswana `BV` - Bouvet Island `BR` - Brazil `IO` - British Indian Ocean Territory `BN` - Brunei `BG` - Bulgaria `BF` - Burkina Faso `BI` - Burundi `CV` - Cabo Verde `KH` - Cambodia `CM` - Cameroon `CA` - Canada `KY` - Cayman Islands `CF` - Central African Republic `TD` - Chad `CL` - Chile `CN` - China `CX` - Christmas Island `CC` - Cocos (Keeling) Islands `CO` - Colombia `KM` - Comoros `CG` - Congo `CD` - Congo (the Democratic Republic of the) `CK` - Cook Islands `CR` - Costa Rica `CI` - Côte d'Ivoire `HR` - Croatia `CU` - Cuba `CW` - Curaçao `CY` - Cyprus `CZ` - Czechia `DK` - Denmark `DJ` - Djibouti `DM` - Dominica `DO` - Dominican Republic `EC` - Ecuador `EG` - Egypt `SV` - El Salvador `GQ` - Equatorial Guinea `ER` - Eritrea `EE` - Estonia `SZ` - Eswatini `ET` - Ethiopia `FK` - Falkland Islands (Malvinas) `FO` - Faroe Islands `FJ` - Fiji `FI` - Finland `FR` - France `GF` - French Guiana `PF` - French Polynesia `TF` - French Southern Territories `GA` - Gabon `GM` - Gambia `GE` - Georgia `DE` - Germany `GH` - Ghana `GI` - Gibraltar `GO` - Global `GR` - Greece `GL` - Greenland `GD` - Grenada `GP` - Guadeloupe `GU` - Guam `GT` - Guatemala `GG` - Guernsey `GN` - Guinea `GW` - Guinea-Bissau `GY` - Guyana `HT` - Haiti `HM` - Heard Island and McDonald Islands `VA` - Holy See `HN` - Honduras `HK` - Hong Kong `HU` - Hungary `IS` - Iceland `IN` - India `ID` - Indonesia `IR` - Iran `IQ` - Iraq `IE` - Ireland `IM` - Isle of Man `IL` - Israel `IT` - Italy `JM` - Jamaica `JP` - Japan `JE` - Jersey `JO` - Jordan `KZ` - Kazakhstan `KE` - Kenya `KI` - Kiribati `XK` - Kosovo `KW` - Kuwait `KG` - Kyrgyzstan `LA` - Laos `LV` - Latvia `LB` - Lebanon `LS` - Lesotho `LR` - Liberia `LY` - Libya `LI` - Liechtenstein `LT` - Lithuania `LU` - Luxembourg `MO` - Macao `MG` - Madagascar `MW` - Malawi `MY` - Malaysia `MV` - Maldives `ML` - Mali `MT` - Malta `MH` - Marshall Islands `MQ` - Martinique `MR` - Mauritania `MU` - Mauritius `YT` - Mayotte `MX` - Mexico `FM` - Micronesia `MD` - Moldova `MC` - Monaco `MN` - Mongolia `ME` - Montenegro `MS` - Montserrat `MA` - Morocco `MZ` - Mozambique `MM` - Myanmar `NA` - Namibia `NR` - Nauru `NP` - Nepal `NL` - Netherlands `NC` - New Caledonia `NZ` - New Zealand `NI` - Nicaragua `NE` - Niger `NG` - Nigeria `NU` - Niue `NF` - Norfolk Island `KP` - North Korea `MK` - North Macedonia `MP` - Northern Mariana Islands `NO` - Norway `OM` - Oman `PK` - Pakistan `PW` - Palau `PS` - Palestine, State of `PA` - Panama `PG` - Papua New Guinea `PY` - Paraguay `PE` - Peru `PH` - Philippines `PN` - Pitcairn `PL` - Poland `PT` - Portugal `PR` - Puerto Rico `QA` - Qatar `RE` - Réunion `RO` - Romania `RU` - Russia `RW` - Rwanda `BL` - Saint Barthélemy `SH` - Saint Helena, Ascension and Tristan da Cunha `KN` - Saint Kitts and Nevis `LC` - Saint Lucia `MF` - Saint Martin (French part) `PM` - Saint Pierre and Miquelon `VC` - Saint Vincent and the Grenadines `WS` - Samoa `SM` - San Marino `ST` - Sao Tome and Principe `SA` - Saudi Arabia `SN` - Senegal `RS` - Serbia `SC` - Seychelles `SL` - Sierra Leone `SG` - Singapore `SX` - Sint Maarten (Dutch part) `SK` - Slovakia `SI` - Slovenia `SB` - Solomon Islands `SO` - Somalia `ZA` - South Africa `GS` - South Georgia and the South Sandwich Islands `KR` - South Korea `SS` - South Sudan `ES` - Spain `LK` - Sri Lanka `SD` - Sudan `SR` - Suriname `SJ` - Svalbard and Jan Mayen `SE` - Sweden `CH` - Switzerland `SY` - Syria `TW` - Taiwan `TJ` - Tajikistan `TZ` - Tanzania `TH` - Thailand `TL` - Timor-Leste `TG` - Togo `TK` - Tokelau `TO` - Tonga `TT` - Trinidad and Tobago `TN` - Tunisia `TR` - Türkiye `TM` - Turkmenistan `TC` - Turks and Caicos Islands `TV` - Tuvalu `UG` - Uganda `UA` - Ukraine `AE` - United Arab Emirates `GB` - United Kingdom `UM` - United States Minor Outlying Islands `US` - United States of America `UY` - Uruguay `UZ` - Uzbekistan `VU` - Vanuatu `VE` - Venezuela `VN` - Vietnam `VG` - Virgin Islands (British) `VI` - Virgin Islands (U.S.) `WF` - Wallis and Futuna `EH` - Western Sahara `YE` - Yemen `ZM` - Zambia `ZW` - Zimbabwe
age	integer or null Age
secondary_email	string or null Secondary email address
tax_payer_id	string or null <= 32 characters Tax payer ID

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/change_owner

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/change_owner

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/change_owner

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/change_owner

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"can_be_cancelled": "string",
"errors": ["string"
],
"third_party_admins": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"ombudsman_list": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"cancellation_info": {"property1": null,
"property2": null
}
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd",
"partner": {"id": "string",
"slug": "string",
"name": "string",
"title": "string",
"logo": "http://example.com",
"contact_url": "http://example.com",
"partner_url": "http://example.com",
"help_center_url": "http://example.com",
"updated_at": "2019-08-24T14:15:22Z",
"xpay_payment_enabled": true,
"xpay_b2c_payment_enabled": true,
"xpay_refund_enabled": true,
"automatic_refund_by_xcore": true,
"allow_policy_modifications_on_xcover": true,
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"from_email": "string",
"bcc_email": "[email protected]",
"email_slug": "string",
"email_version": -2147483648,
"event_name": 0,
"include_partner_in_context": true,
"attach_coi": true,
"send_linked_sms": true,
"auto_send": true,
"enable_expression": "string"
}
],
"attributes": { },
"signup_method_on_xcover": "phone",
"use_standard_region": true,
"allow_payout_customer": true,
"eligible_for_xpay_charge_retry": true,
"subsidiary": {"id": "string",
"slug": "string",
"name": "string",
"title": "string",
"logo": "http://example.com",
"contact_url": "http://example.com",
"partner_url": "http://example.com",
"help_center_url": "http://example.com"
}
},
"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.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

	object (PaymentDetails) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.
xpay_charge_id	string Deprecated, moved into payment_details.

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm

Request samples

Payload

Content type

application/json

{"payment_details": {"provider": "string",
"xpay_charge_id": "string",
"xpay_customer_id": "string",
"transaction_id": "string",
"customer_token_id": "string"
},
"xpay_charge_id": "string"
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"can_be_cancelled": "string",
"errors": ["string"
],
"third_party_admins": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"ombudsman_list": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"cancellation_info": {"property1": null,
"property2": null
}
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd"
}

Confirm refunds

Confirm processing of refunds for quotes in a booking.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

Request Body schema: application/json
required

required

Array of objects (RefundConfirmationQuoteRequest)

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_refunds

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_refunds

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_refunds

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_refunds

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"transaction_id": "string",
"refund_date": "2019-08-24T14:15:22Z",
"refund_amount": -1e+28
}
]
}

Response samples

Content type

application/json

{"type": "string",
"message": "string",
"code": "string",
"href": "string",
"errors": {"property1": null,
"property2": null
}
}

Manually trigger email

Manually triggers policy lifecycle email to be sent to the customer

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

email	string or null Email address
	EventEnum (string) or BlankEnum (any) or NullEnum (null) Defines what email to trigger `BOOKING_CREATED` - BOOKING_CREATED `BOOKING_CANCELLED` - BOOKING_CANCELLED

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/send_email

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/send_email

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/send_email

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/send_email

Request samples

Payload

Content type

application/json

{"email": "string",
"event": "BOOKING_CREATED"
}

Response samples

Content type

application/json

{"type": "string",
"message": "string",
"code": "string",
"href": "string",
"errors": {"property1": null,
"property2": null
}
}

Fast booking

Convert a fast quote to booking

Authorizations:

HMACAuthentication

path Parameters

fast_quote_id required	string <uuid>
partner_id required	string^[A-Z0-9]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json
required

required	Array of objects (BookingRequestQuote)
required	object (Policyholder) Policyholder serializer with a minimum set of attributes. The Policyholder serializer class contains the attributes that make up what can be considered a base Policyholder. This class contains only those attributes that are shared by all the variants of Policyholder to minimize repetition of attribute definitions.
require_payment_confirmation	boolean
partner_transaction_id	string
xpay_charge_id	string Deprecated. Please use the payment_details.
xpay_customer_token_id	string Deprecated. Please use the payment_details.
	object (PaymentDetails) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.
	object (BookingAgent) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.

Responses

Production server

https://api.xcover.com/partners/{partner_id}/fast_booking/{fast_quote_id}/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/fast_booking/{fast_quote_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/fast_booking/{fast_quote_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/fast_booking/{fast_quote_id}/

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"insured": [{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"metadata": {"property1": null,
"property2": null
},
"company": "string"
}
],
"instalment_plan": "string",
"first_instalment_paid": true
}
],
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"tax_payer_id": "string"
},
"require_payment_confirmation": true,
"partner_transaction_id": "string",
"xpay_charge_id": "string",
"xpay_customer_token_id": "string",
"payment_details": {"provider": "string",
"xpay_charge_id": "string",
"xpay_customer_id": "string",
"transaction_id": "string",
"customer_token_id": "string"
},
"booking_agent": {"email": "[email protected]"
}
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"can_be_cancelled": "string",
"errors": ["string"
],
"third_party_admins": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"ombudsman_list": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"cancellation_info": {"property1": null,
"property2": null
}
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd"
}

Instant booking

Make quote and booking in a single step

Authorizations:

HMACAuthentication

path Parameters

partner_id

required

string^[A-Z0-9]+$

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

	object (BookingAgent) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.
partner_subsidiary	string or null <= 128 characters Subsidiary of the Partner if applicable
required	object (Policyholder) Policyholder serializer with a minimum set of attributes. The Policyholder serializer class contains the attributes that make up what can be considered a base Policyholder. This class contains only those attributes that are shared by all the variants of Policyholder to minimize repetition of attribute definitions.
	object (PaymentDetails) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.
partner_transaction_id	string or null <= 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.
fast_quote_id	string <uuid>
	object 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.
xpay_charge_id	string Deprecated, moved into payment_details.
customer_language	string <= 8 characters Customer's language
required	Array of objects
currency required	string (CurrencyEnum) 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" `AED` - AED `AFN` - AFN `ARS` - ARS `AUD` - AUD `AZN` - AZN `BAM` - BAM `BDT` - BDT `BGN` - BGN `BHD` - BHD `BRL` - BRL `BSD` - BSD `BYN` - BYN `CAD` - CAD `CHF` - CHF `CLP` - CLP `CNY` - CNY `COP` - COP `CRC` - CRC `CZK` - CZK `DJF` - DJF `DKK` - DKK `EGP` - EGP `ERN` - ERN `ETB` - ETB `EUR` - EUR `FJD` - FJD `GBP` - GBP `GEL` - GEL `GTQ` - GTQ `HKD` - HKD `HNL` - HNL `HRK` - HRK `HUF` - HUF `IDR` - IDR `ILS` - ILS `INR` - INR `IQD` - IQD `ISK` - ISK `JOD` - JOD `JPY` - JPY `KES` - KES `KHR` - KHR `KRW` - KRW `KWD` - KWD `KZT` - KZT `LAK` - LAK `LBP` - LBP `LKR` - LKR `MAD` - MAD `MKD` - MKD `MUR` - MUR `MVR` - MVR `MXN` - MXN `MYR` - MYR `NGN` - NGN `NOK` - NOK `NPR` - NPR `NZD` - NZD `OMR` - OMR `PEN` - PEN `PHP` - PHP `PKR` - PKR `PLN` - PLN `QAR` - QAR `RON` - RON `RSD` - RSD `RUB` - RUB `SAR` - SAR `SDG` - SDG `SEK` - SEK `SGD` - SGD `SYP` - SYP `THB` - THB `TJS` - TJS `TRY` - TRY `TWD` - TWD `UAH` - UAH `UGX` - UGX `USD` - USD `UYU` - UYU `UZS` - UZS `VND` - VND `XPF` - XPF `YER` - YER `ZAR` - ZAR
partner_customer_id	string or null <= 1024 characters Partner's customer ID for this transaction
	object Experiment related data. This can be used, for example, to control the experiment (by setting the 'treatment' key)
customer_ip	string or null

Responses

Request samples

Payload

Content type

application/json

{"booking_agent": {"email": "[email protected]"
},
"partner_subsidiary": "string",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"tax_payer_id": "string"
},
"payment_details": {"provider": "string",
"xpay_charge_id": "string",
"xpay_customer_id": "string",
"transaction_id": "string",
"customer_token_id": "string"
},
"partner_transaction_id": "string",
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd",
"partner_metadata": { },
"xpay_charge_id": "string",
"customer_language": "string",
"request": [{"property1": null,
"property2": null
}
],
"currency": "AED",
"partner_customer_id": "string",
"experiment": { },
"customer_ip": "string"
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"can_be_cancelled": "string",
"errors": ["string"
],
"third_party_admins": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"ombudsman_list": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"cancellation_info": {"property1": null,
"property2": null
}
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd"
}

Modifications

Booking modification

Modifies booking. This endpoint can potentially trigger premium change.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[a-zA-Z0-9-_=]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

	Array of objects (UpdateBookingRequestQuote) non-empty
xpay_charge_id	string
	object (PolicyholderUpdate) Policyholder serializer with a minimum set of attributes. The Policyholder serializer class contains the attributes that make up what can be considered a base Policyholder. This class contains only those attributes that are shared by all the variants of Policyholder to minimize repetition of attribute definitions.
skip_xpay_transaction	boolean Default: false

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"update_fields": { },
"modification_id": "39d4ab5d-94d6-4d4f-9f67-5e13cf1b3f52",
"modification_fields": { }
}
],
"xpay_charge_id": "string",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string"
},
"skip_xpay_transaction": false
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"attributes": {"property1": null,
"property2": null
},
"can_be_cancelled": true,
"coolingoff_end_date": "2019-08-24T14:15:22Z",
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"cancellation_info": {"property1": null,
"property2": null
},
"price_diff": -1e+28,
"price_diff_formatted": "string"
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd",
"total_price_diff": -1e+28,
"total_price_diff_formatted": "string"
}

Confirm booking modification

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

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$
update_id required	string^[a-zA-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

xpay_charge_id

string

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_update/{update_id}/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_update/{update_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_update/{update_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_update/{update_id}/

Request samples

Payload

Content type

application/json

{"xpay_charge_id": "string"
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"attributes": {"property1": null,
"property2": null
},
"can_be_cancelled": true,
"coolingoff_end_date": "2019-08-24T14:15:22Z",
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"cancellation_info": {"property1": null,
"property2": null
},
"price_diff": -1e+28,
"price_diff_formatted": "string"
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd",
"total_price_diff": -1e+28,
"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.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

	Array of objects (UpdateBookingRequestQuote) non-empty
xpay_charge_id	string
	object (PolicyholderUpdate) Policyholder serializer with a minimum set of attributes. The Policyholder serializer class contains the attributes that make up what can be considered a base Policyholder. This class contains only those attributes that are shared by all the variants of Policyholder to minimize repetition of attribute definitions.
skip_xpay_transaction	boolean Default: false

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/quote_for_update

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/quote_for_update

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/quote_for_update

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/quote_for_update

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"update_fields": { },
"modification_id": "39d4ab5d-94d6-4d4f-9f67-5e13cf1b3f52",
"modification_fields": { }
}
],
"xpay_charge_id": "string",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string"
},
"skip_xpay_transaction": false
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"attributes": {"property1": null,
"property2": null
},
"can_be_cancelled": true,
"coolingoff_end_date": "2019-08-24T14:15:22Z",
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"cancellation_info": {"property1": null,
"property2": null
},
"price_diff": -1e+28,
"price_diff_formatted": "string"
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd",
"total_price_diff": -1e+28,
"total_price_diff_formatted": "string",
"update_id": "string",
"payment_methods": [{"number": 0,
"variant": "string",
"expiry_year": 0,
"holder_name": "string",
"expiry_month": 0,
"payment_method": "string"
}
]
}

Cancellations

Cancel booking

Cancel a specific booking.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

preview	boolean Default: false
refund_required	boolean Default: true Deprecated. Refund will be created on a best-effort basis
	Array of objects (CancelBookingRequestQuote)
cancellation_date	string <date-time> ISO 8601 datetime for when the cancellation should be effective. If provided, must be within allowed date range and cannot be before booking confirmation or after policy end date.

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/cancel

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/cancel

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/cancel

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/cancel

Request samples

Payload

Content type

application/json

{"preview": false,
"refund_required": true,
"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reason_for_cancellation": "string"
}
],
"cancellation_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"policy_cancellation_date": "2019-08-24T14:15:22Z",
"policy_coolingoff_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"refund_value": -1e+28,
"adjustment_fee": -1e+28,
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"commission": "string"
}
],
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"pds_url": "http://example.com",
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"total_price": -1e+28,
"total_price_formatted": "string",
"total_refund": -1e+28,
"total_refund_formatted": "string",
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"currency": "str",
"cancellation_id": "string",
"confirm_before": "2019-08-24T14:15:22Z",
"partner": {"id": "string",
"slug": "string",
"name": "string",
"title": "string",
"logo": "http://example.com",
"contact_url": "http://example.com",
"partner_url": "http://example.com",
"help_center_url": "http://example.com",
"updated_at": "2019-08-24T14:15:22Z",
"xpay_payment_enabled": true,
"xpay_b2c_payment_enabled": true,
"xpay_refund_enabled": true,
"automatic_refund_by_xcore": true,
"allow_policy_modifications_on_xcover": true,
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"from_email": "string",
"bcc_email": "[email protected]",
"email_slug": "string",
"email_version": -2147483648,
"event_name": 0,
"include_partner_in_context": true,
"attach_coi": true,
"send_linked_sms": true,
"auto_send": true,
"enable_expression": "string"
}
],
"attributes": { },
"signup_method_on_xcover": "phone",
"use_standard_region": true,
"allow_payout_customer": true,
"eligible_for_xpay_charge_retry": true,
"subsidiary": {"id": "string",
"slug": "string",
"name": "string",
"title": "string",
"logo": "http://example.com",
"contact_url": "http://example.com",
"partner_url": "http://example.com",
"help_center_url": "http://example.com"
}
},
"refund_amount": 0.1,
"refund_amount_formatted": "string",
"cancellation_payout_url": "string"
}

Confirm booking cancellation

Confirm the cancellation that is created by booking cancellation preview

Authorizations:

HMACAuthentication

path Parameters

cancellation_id required	string^[a-zA-Z0-9-]+$
partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

Request Body schema: application/json

reason_for_cancellation

string or null <= 1000 characters

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_cancellation/{cancellation_id}/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_cancellation/{cancellation_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_cancellation/{cancellation_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/confirm_cancellation/{cancellation_id}/

Request samples

Payload

Content type

application/json

{"reason_for_cancellation": "string"
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"policy_cancellation_date": "2019-08-24T14:15:22Z",
"policy_coolingoff_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"refund_value": -1e+28,
"adjustment_fee": -1e+28,
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"commission": "string"
}
],
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"pds_url": "http://example.com",
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"total_price": -1e+28,
"total_price_formatted": "string",
"total_refund": -1e+28,
"total_refund_formatted": "string",
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"currency": "str",
"cancellation_id": "string",
"confirm_before": "2019-08-24T14:15:22Z",
"partner": {"id": "string",
"slug": "string",
"name": "string",
"title": "string",
"logo": "http://example.com",
"contact_url": "http://example.com",
"partner_url": "http://example.com",
"help_center_url": "http://example.com",
"updated_at": "2019-08-24T14:15:22Z",
"xpay_payment_enabled": true,
"xpay_b2c_payment_enabled": true,
"xpay_refund_enabled": true,
"automatic_refund_by_xcore": true,
"allow_policy_modifications_on_xcover": true,
"emails": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"from_email": "string",
"bcc_email": "[email protected]",
"email_slug": "string",
"email_version": -2147483648,
"event_name": 0,
"include_partner_in_context": true,
"attach_coi": true,
"send_linked_sms": true,
"auto_send": true,
"enable_expression": "string"
}
],
"attributes": { },
"signup_method_on_xcover": "phone",
"use_standard_region": true,
"allow_payout_customer": true,
"eligible_for_xpay_charge_retry": true,
"subsidiary": {"id": "string",
"slug": "string",
"name": "string",
"title": "string",
"logo": "http://example.com",
"contact_url": "http://example.com",
"partner_url": "http://example.com",
"help_center_url": "http://example.com"
}
},
"refund_amount": 0.1,
"refund_amount_formatted": "string",
"cancellation_payout_url": "string"
}

Renewals

Renewal confirmation

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

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
pending_renewal_id required	string^[a-zA-Z0-9-]+$
quote_package_id required	string^[A-Z0-9-]+$

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

Production server

https://api.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/confirm/{pending_renewal_id}/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/confirm/{pending_renewal_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/confirm/{pending_renewal_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/confirm/{pending_renewal_id}/

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"insured": [{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"metadata": {"property1": null,
"property2": null
},
"company": "string"
}
],
"instalment_plan": "string",
"first_instalment_paid": true
}
]
}

Response samples

Content type

application/json

{"renewal_id": "string",
"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "string",
"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string",
"policy_vertical": "string",
"show_benefits": true,
"metadata": { },
"policy_id": "string",
"activated_at": "2019-08-24T14:15:22Z"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string",
"show_benefit": true,
"claim_types": [null
]
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"discount_price": -1e+28,
"discount_price_formatted": "string",
"discount_amount": -1e+28,
"discount_amount_formatted": "string",
"instalment_plans": [{"name": "string",
"label": "string",
"amount": -1e+28,
"first_instalment_amount": -1e+28
}
],
"attributes": { },
"underwriting_fee": -1e+28
}
]
}

Renewal opt-out

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

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

Array of objects (RenewalOptoutRequestQuote)

Responses

Production server

https://api.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/opt_out/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/opt_out/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/opt_out/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/opt_out/

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}

Response samples

Content type

application/json

{"type": "string",
"message": "string",
"code": "string",
"href": "string",
"errors": {"property1": null,
"property2": null
}
}

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.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json

auto_confirm	boolean Default: false Should the created renewal be automatically confirmed
use_newest_policy	boolean Default: false Use newest policy on renewal
due_date_within	integer 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

Production server

https://api.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/quote_for_renewal/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/quote_for_renewal/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/quote_for_renewal/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/renewals/{quote_package_id}/quote_for_renewal/

Request samples

Payload

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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"code": "string",
"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string",
"policy_vertical": "string",
"show_benefits": true,
"metadata": { },
"policy_id": "string",
"activated_at": "2019-08-24T14:15:22Z"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string",
"show_benefit": true,
"claim_types": [null
]
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"discount_price": -1e+28,
"discount_price_formatted": "string",
"discount_amount": -1e+28,
"discount_amount_formatted": "string",
"instalment_plans": [{"name": "string",
"label": "string",
"amount": -1e+28,
"first_instalment_amount": -1e+28
}
],
"attributes": { },
"underwriting_fee": -1e+28
}
]
}

Instalments

calculate_instalment_price

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

Authorizations:

HMACAuthentication

path Parameters

instalment_id required	string^[a-zA-Z0-9-]+$
partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

Request Body schema: application/json

number	integer [ -32768 .. 32767 ] Nextup number in the instalments created for a quote
total_amount	number or null <double> ( -1e+28 .. 1e+28 ) Total amount for this instalment of policy e.g. 123.45
	object or null Taxes of the quote (if quote is booked)
	object or null Surcharge of the quote (if quote is booked)
underwriting_fee	number or null <double> ( -1e+28 .. 1e+28 ) Fee payed to the underwriter (in policy currency)
	object or null Commission for this quote (if quote is booked)

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/calculate_instalment_price/{instalment_id}/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/calculate_instalment_price/{instalment_id}/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/calculate_instalment_price/{instalment_id}/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/calculate_instalment_price/{instalment_id}/

Request samples

Payload

Content type

application/json

{"number": -32768,
"total_amount": -1e+28,
"tax": { },
"surcharges": { },
"underwriting_fee": -1e+28,
"commissions": { }
}

Response samples

Content type

application/json

{"type": "string",
"message": "string",
"code": "string",
"href": "string",
"errors": {"property1": null,
"property2": null
}
}

Get instalments

Get instalments details for the provided quote package id.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string Booking `id` (INS-number generated by XCover API)

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/instalments/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/instalments/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/instalments/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/instalments/

Response samples

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"next_payment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"number": -32768,
"quote": "ac2490ad-7b17-416c-8a94-838b251071f6",
"period_start_date": "2019-08-24T14:15:22Z",
"period_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"total_amount": -1e+28,
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"surcharges": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"payment_failures": { },
"extra_fields": "string"
},
"paid_until": "2019-08-24T14:15:22Z",
"is_payment_overdue": true,
"payment_schedule": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"number": -32768,
"quote": "ac2490ad-7b17-416c-8a94-838b251071f6",
"period_start_date": "2019-08-24T14:15:22Z",
"period_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"total_amount": -1e+28,
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"surcharges": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"payment_failures": { },
"extra_fields": "string"
}
],
"total_amount_paid": -1e+28,
"total_amount_due": -1e+28,
"partner_comission_paid": -1e+28,
"partner_comission_due": -1e+28
}
],
"currency": "string"
}

Update instalment payment

Update instalment payment status

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[a-zA-Z0-9-_]+$

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json
required

required

Array of objects (QuoteInstalment)

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/instalments/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/instalments/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/instalments/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/instalments/

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instalment_id": "286b1dc2-e2f0-40ea-bc39-079ef019b7d0",
"instalment_number": 0,
"payment_attempted_date": "2019-08-24T14:15:22Z",
"payment_status": "PAID",
"payment_failures": { }
}
]
}

Response samples

Content type

application/json

{"type": "string",
"message": "string",
"code": "string",
"href": "string",
"errors": {"property1": null,
"property2": null
}
}

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.

Authorizations:

HMACAuthentication

path Parameters

partner_id required	string^[A-Z0-9]+$
quote_package_id required	string^[A-Z0-9-]+$

Responses

Production server

https://api.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/settle_instalments/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/settle_instalments/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/settle_instalments/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/bookings/{quote_package_id}/settle_instalments/

Response samples

Content type

application/json

{"type": "string",
"message": "string",
"code": "string",
"href": "string",
"errors": {"property1": null,
"property2": null
}
}

Tables

List Tables

Authorizations:

HMACAuthentication

path Parameters

partner_id

required

string^[A-Z0-9]+$

query Parameters

limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
"slug": "string",
"version": 2147483647,
"file": "string",
"active_from": "2019-08-24T14:15:22Z",
"template": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"columns": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"data_type": "TEXT",
"is_nullable": true,
"is_unique": true,
"create_index": true
}
]
}
}
]
}

Retrieve Tables

Authorizations:

HMACAuthentication

path Parameters

id required	string <uuid> A UUID string identifying this table.
partner_id required	string^[A-Z0-9]+$

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": "http://example.com",
"active_from": "2019-08-24T14:15:22Z",
"template": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"columns": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"data_type": "TEXT",
"is_nullable": true,
"is_unique": true,
"create_index": true
}
]
},
"data": { }
}

Utils

misc

Confirm offer

Confirm an offer by converting it to a booking

Authorizations:

HMACAuthentication

path Parameters

offer_id required	string <uuid> Offer ID from create_offer response
partner_id required	string[A-Z0-9]+ Partner ID

header Parameters

x-idempotency-key

string

Idempotency key

Request Body schema: application/json
required

required	Array of objects (BookingRequestQuote)
required	object (Policyholder) Policyholder serializer with a minimum set of attributes. The Policyholder serializer class contains the attributes that make up what can be considered a base Policyholder. This class contains only those attributes that are shared by all the variants of Policyholder to minimize repetition of attribute definitions.
require_payment_confirmation	boolean
partner_transaction_id	string
xpay_charge_id	string Deprecated. Please use the payment_details.
xpay_customer_token_id	string Deprecated. Please use the payment_details.
	object (PaymentDetails) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.
	object (BookingAgent) Mixin that automatically generates formatted versions of currency fields. Usage example: class MySerializer(CurrencyFormattedFields, serializers.Serializer): formatted_fields = ["price", "total_amount", "discount"] This will automatically add price_formatted, total_amount_formatted, and discount_formatted to the serialized output.

Responses

Production server

https://api.xcover.com/partners/{partner_id}/offers/{offer_id}/confirm/

Regional Production server

https://api.{region}.xcover.com/partners/{partner_id}/offers/{offer_id}/confirm/

Staging server

https://api.staging.xcover.com/partners/{partner_id}/offers/{offer_id}/confirm/

Regional Staging server

http://api.{region}.staging.xcover.com/partners/{partner_id}/offers/{offer_id}/confirm/

Request samples

Payload

Content type

application/json

{"quotes": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"insured": [{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"metadata": {"property1": null,
"property2": null
},
"company": "string"
}
],
"instalment_plan": "string",
"first_instalment_paid": true
}
],
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"tax_payer_id": "string"
},
"require_payment_confirmation": true,
"partner_transaction_id": "string",
"xpay_charge_id": "string",
"xpay_customer_token_id": "string",
"payment_details": {"provider": "string",
"xpay_charge_id": "string",
"xpay_customer_id": "string",
"transaction_id": "string",
"customer_token_id": "string"
},
"booking_agent": {"email": "[email protected]"
}
}

Response samples

Content type

application/json

{"id": "string",
"status": "string",
"currency": "str",
"total_price": -1e+28,
"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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy_start_date": "2019-08-24T14:15:22Z",
"policy_end_date": "2019-08-24T14:15:22Z",
"status": "string",
"price": -1e+28,
"price_formatted": "string",
"policy": {"policy_type": "string",
"policy_type_version": "string",
"policy_type_slug": "string",
"policy_type_group_name": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {"property1": null,
"property2": null
},
"underwriter": {"disclaimer": "string",
"name": "string"
},
"claim_selector_id": "string",
"policy_currency": "string"
},
"insured": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 150,
"birth_date": "2019-08-24",
"company": "string"
}
],
"tax": {"total_tax": -1e+28,
"total_amount_without_tax": -1e+28,
"taxes": [{"tax_amount": -1e+28,
"tax_code": "string"
}
]
},
"duration": "string",
"benefits": [{"benefit_content_id": "8650c96c-29ca-4b1b-b909-6f276c601c22",
"description": "string",
"extra_content": {"property1": null,
"property2": null
},
"parent_benefit_content_id": "71c06cd4-50d9-476e-86b3-b34a7cf4d685",
"parent_description": "string",
"limit_description": "string",
"limit": -1e+28,
"limit_policy_currency": -1e+28,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": -1e+28,
"limit_per_unit_policy_currency": -1e+28,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": -1e+28,
"excess_policy_currency": -1e+28,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": -1e+28,
"minimum_claim_amount_policy_currency": -1e+28,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string",
"waiting_period": 0,
"maximum_claims": 0,
"benefit_code": "string"
}
],
"commission": {"partner_commission": -1e+28,
"surcharge_commission": -1e+28,
"total_commission": -1e+28
},
"created_at": "2019-08-24T14:15:22Z",
"confirmed_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancelled_at": "2019-08-24T14:15:22Z",
"cancelled_from": "2019-08-24T14:15:22Z",
"is_renewable": true,
"is_pricebeat_enabled": true,
"cover_amount": -1e+28,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": ["string"
],
"files": [{"property1": null,
"property2": null
}
],
"custom_documents": { },
"extra_fields": {"property1": null,
"property2": null
},
"surcharge": {"total_amount": -1e+28,
"surcharges": [{"amount": -1e+28,
"code": "string",
"label": "string"
}
]
},
"parent_quote_status": 0,
"experiment": {"property1": null,
"property2": null
},
"next_renewal": {"id": "string",
"package_id": "string",
"quote_id": "3c071a1d-db86-46a7-9dc8-72ba3fbca992",
"status": "string",
"start_date": "2019-08-24T14:15:22Z",
"notification_date": "2019-08-24T14:15:22Z",
"due_date": "2019-08-24T14:15:22Z",
"expiry_date": "2019-08-24T14:15:22Z",
"cancelled_on": "2019-08-24T14:15:22Z",
"paid_on": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"can_be_cancelled": "string",
"errors": ["string"
],
"third_party_admins": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"ombudsman_list": [{"name": "string",
"phone": "string",
"email": "string"
}
],
"cancellation_info": {"property1": null,
"property2": null
}
}
],
"coi": {"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"sign_up_url": "http://example.com",
"policyholder": {"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"address1": "string",
"address2": "string",
"postcode": "string",
"city": "string",
"region": "string",
"birth_date": "2019-08-24",
"company": "string",
"company_reg_id": "string",
"middle_name": "string",
"country": "AF",
"age": 0,
"secondary_email": "string",
"allow_updates": false,
"fields_allowed_to_update": [null
]
},
"total_tax": -1e+28,
"total_tax_formatted": "string",
"total_premium": -1e+28,
"total_premium_formatted": "string",
"fnol_link": "string",
"booking_agent": {"email": "[email protected]"
},
"fast_quote_id": "35c03aeb-0972-4351-af1b-d008324c66dd"
}

List Files

Authorizations:

HMACAuthentication

query Parameters

limit	integer Number of results to return per page.
offset	integer The initial index from which to return the results.
ordering	string Which field to use when ordering the results.

Responses

Response samples

Content type

application/json

{"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
"slug": "string",
"version": 2147483647,
"file": "string",
"active_from": "2019-08-24T14:15:22Z",
"template": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"columns": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"data_type": "TEXT",
"is_nullable": true,
"is_unique": true,
"create_index": true
}
]
}
}
]
}

Retrieve Files

Authorizations:

HMACAuthentication

path Parameters

required

string <uuid>

A UUID string identifying this table.

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": "http://example.com",
"active_from": "2019-08-24T14:15:22Z",
"template": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"columns": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"data_type": "TEXT",
"is_nullable": true,
"is_unique": true,
"create_index": true
}
]
},
"data": { }
}

XCover API (2.152.1)

Quotes

Opt out of booking

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Create quote

Authorizations:

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get quote

Authorizations:

path Parameters

Responses

Response samples

Update quote

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Add a quote

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete quote

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Bookings

Get booking

Authorizations:

path Parameters

Responses

Response samples

Create booking

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Change owner

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm booking

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm refunds

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required