Modify Booking
Retrieve detailed information about an existing booking including policy details, quotes, policyholder information, and current status. This is typically the first step in the modification workflow to retrieve current booking state before making changes. Use this endpoint to obtain the INS number (booking ID), quote IDs, price paid, or current policy details for subsequent operations like modifications or cancellations.
Composite Authentication Scheme (Client Key, Date, and Signature)
This scheme requires the client to provide three mandatory headers in every request:
1. X-Api-Key (Client Key)
- Purpose: Public identifier for the API consumer.
- Example:
X-Api-Key: YOUR_API_KEY_HERE
2. Date (Timestamp)
- Purpose: Timestamp used for generating the signature and preventing replay attacks.
- Format: RFC 7231 format (e.g., in GMT).
- Example:
Date: Sun, 09 Nov 2025 04:04:00 GMT
3. Authorization (Computed Signature)
- Purpose: The cryptographic signature that verifies the request's authenticity and integrity.
- Format:
SIGNATURE [authHeader]
Signature Generation Logic:
The authHeader value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the Date header), signed with the private Client Secret.
Partner code identifier. Client Solutions Engineer (CSE) should provide this value.
The booking ID (INS number) returned from the Confirm Offer endpoint.
OK
Forbidden
Not Found
GET /x/partners/{partner_code}/bookings/{booking_id}/ HTTP/1.1
Host: api.xcover.com
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "text",
"status": "text",
"currency": "text",
"total_price": 1,
"total_price_formatted": "text",
"partner_transaction_id": null,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"pds_url": "https://example.com",
"security_token": "text",
"quotes": [
{
"id": "text",
"policy_start_date": "2026-01-01T00:00:00.000Z",
"policy_end_date": "2026-01-01T00:00:00.000Z",
"status": "text",
"price": 1,
"price_formatted": "text",
"policy": {
"policy_type": "text",
"policy_type_version": "text",
"policy_type_slug": "text",
"policy_type_group_name": "text",
"policy_name": "text",
"policy_code": "text",
"policy_version": "text",
"category": "text",
"content": {
"title": "text",
"header": null,
"description": "text",
"optout_msg": "text",
"inclusions": [
{
"title": "text",
"description": "text"
}
],
"exclusions": [],
"disclaimer": "text",
"disclaimer_html": "text",
"payment_disclaimer": "text",
"in_path_disclaimer": "text",
"extra_content": {}
},
"underwriter": {
"disclaimer": "text",
"name": "text"
},
"claim_selector_id": null,
"policy_currency": "text"
},
"insured": [
{
"id": "text",
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"region": null
}
],
"tax": {
"total_tax": 1,
"total_amount_without_tax": 1,
"taxes": [
{
"tax_amount": 1,
"tax_code": "text",
"tax_amount_formatted": "text"
}
],
"total_tax_formatted": "text",
"total_amount_without_tax_formatted": "text"
},
"duration": "text",
"benefits": [
{
"benefit_content_id": "text",
"description": "text",
"extra_content": {},
"limit": 1,
"limit_policy_currency": 1,
"limit_formatted": "text",
"limit_policy_currency_formatted": "text",
"excess": 1,
"excess_policy_currency": 1,
"excess_formatted": "text",
"excess_policy_currency_formatted": "text"
}
],
"commission": {
"partner_commission": 1,
"surcharge_commission": 1,
"total_commission": 1,
"partner_commission_formatted": "text",
"surcharge_commission_formatted": "text",
"total_commission_formatted": "text"
},
"created_at": "2026-01-01T00:00:00.000Z",
"confirmed_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"cancelled_at": null,
"cancelled_from": null,
"is_renewable": true,
"is_pricebeat_enabled": null,
"cover_amount": 1,
"cover_amount_formatted": "text",
"pds_url": "https://example.com",
"attachments": [],
"files": [],
"custom_documents": null,
"extra_fields": {},
"surcharge": {
"total_amount": null,
"surcharges": null,
"total_amount_formatted": "text"
},
"parent_quote_status": null,
"experiment": null,
"next_renewal": null,
"can_be_cancelled": true,
"third_party_admins": [],
"ombudsman_list": [],
"cancellation_info": {
"reason_for_cancellation": "text"
}
}
],
"coi": {
"url": "https://example.com",
"pdf": "https://example.com"
},
"account_url": "https://example.com",
"sign_up_url": "https://example.com",
"policyholder": {
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone": null,
"address1": null,
"address2": null,
"postcode": "text",
"company": null,
"company_reg_id": null,
"middle_name": null,
"country": "text",
"age": 1,
"city": null,
"region": "text",
"secondary_email": null,
"birth_date": null,
"allow_updates": true,
"fields_allowed_to_update": []
},
"total_tax": 1,
"total_tax_formatted": "text",
"total_premium": 1,
"total_premium_formatted": "text",
"fnol_link": "https://example.com",
"booking_agent": null
}The modification workflow is used when a customer wants to make changes to their existing policy. This endpoint allows you to update policy details which may result in price adjustments, refunds, or additional fees.
Composite Authentication Scheme (Client Key, Date, and Signature)
This scheme requires the client to provide three mandatory headers in every request:
1. X-Api-Key (Client Key)
- Purpose: Public identifier for the API consumer.
- Example:
X-Api-Key: YOUR_API_KEY_HERE
2. Date (Timestamp)
- Purpose: Timestamp used for generating the signature and preventing replay attacks.
- Format: RFC 7231 format (e.g., in GMT).
- Example:
Date: Sun, 09 Nov 2025 04:04:00 GMT
3. Authorization (Computed Signature)
- Purpose: The cryptographic signature that verifies the request's authenticity and integrity.
- Format:
SIGNATURE [authHeader]
Signature Generation Logic:
The authHeader value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the Date header), signed with the private Client Secret.
Partner code identifier. Client Solutions Engineer (CSE) should provide this value.
The booking ID (INS number) returned from the Confirm Offer endpoint.
OK
Forbidden
Unprocessable Entity
PATCH /x/partners/{partner_code}/bookings/{booking_id}/ HTTP/1.1
Host: api.xcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139
{
"quotes": [
{
"id": "text",
"policy_start_date": "text",
"update_fields": {
"insured": [
{
"first_name": "text",
"last_name": "text",
"email": "text"
}
]
}
}
]
}{
"id": "text",
"status": "text",
"currency": "text",
"total_price": 1,
"total_price_formatted": "text",
"partner_transaction_id": null,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"pds_url": "https://example.com",
"security_token": "text",
"quotes": [
{
"id": "text",
"policy_start_date": "2026-01-01T00:00:00.000Z",
"policy_end_date": "2026-01-01T00:00:00.000Z",
"status": "text",
"price": 1,
"price_formatted": "text",
"policy": {
"policy_type": "text",
"policy_type_version": "text",
"policy_type_slug": "text",
"policy_type_group_name": "text",
"policy_name": "text",
"policy_code": "text",
"policy_version": "text",
"category": "text",
"content": {
"title": "text",
"header": null,
"description": "text",
"optout_msg": "text",
"inclusions": [
{
"title": "text",
"description": "text"
}
],
"exclusions": [],
"disclaimer": "text",
"disclaimer_html": "text",
"payment_disclaimer": "text",
"in_path_disclaimer": "text",
"extra_content": {}
},
"underwriter": {
"disclaimer": "text",
"name": "text"
},
"claim_selector_id": null,
"policy_currency": "text"
},
"insured": [
{
"id": "text",
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"region": null
}
],
"tax": {
"total_tax": 1,
"total_amount_without_tax": 1,
"taxes": [
{
"tax_amount": 1,
"tax_code": "text",
"tax_amount_formatted": "text"
}
],
"total_tax_formatted": "text",
"total_amount_without_tax_formatted": "text"
},
"duration": "text",
"benefits": [
{
"benefit_content_id": "text",
"description": "text",
"extra_content": {
"benefit-text-test": "text",
"benefit_rich_text_test": "text"
},
"limit": 1,
"limit_policy_currency": 1,
"limit_formatted": "text",
"limit_policy_currency_formatted": "text",
"excess": 1,
"excess_policy_currency": 1,
"excess_formatted": "text",
"excess_policy_currency_formatted": "text"
}
],
"commission": {
"partner_commission": 1,
"surcharge_commission": 1,
"total_commission": 1,
"partner_commission_formatted": "text",
"surcharge_commission_formatted": "text",
"total_commission_formatted": "text"
},
"created_at": "2026-01-01T00:00:00.000Z",
"confirmed_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"cancelled_at": null,
"cancelled_from": null,
"is_renewable": true,
"is_pricebeat_enabled": null,
"cover_amount": 1,
"cover_amount_formatted": "text",
"pds_url": "https://example.com",
"attachments": [],
"files": [],
"custom_documents": null,
"extra_fields": {
"destination_region": "text",
"seller_entity": "text",
"age_brackets": "text",
"desitnation_sanctions": [],
"sanctioned_distination_countries": [
"text"
],
"test_underwrting_rule": true
},
"surcharge": {
"total_amount": null,
"surcharges": null,
"total_amount_formatted": "text"
},
"parent_quote_status": null,
"experiment": null,
"next_renewal": null,
"can_be_cancelled": true,
"third_party_admins": [],
"ombudsman_list": [],
"cancellation_info": {
"reason_for_cancellation": "text"
}
}
],
"coi": {
"url": "https://example.com",
"pdf": "https://example.com"
},
"account_url": "https://example.com",
"sign_up_url": "https://example.com",
"policyholder": {
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone": null,
"address1": null,
"address2": null,
"postcode": "text",
"company": null,
"company_reg_id": null,
"middle_name": null,
"country": "text",
"age": 1,
"city": null,
"region": "text",
"secondary_email": null,
"birth_date": null,
"allow_updates": true,
"fields_allowed_to_update": []
},
"total_tax": 1,
"total_tax_formatted": "text",
"total_premium": 1,
"total_premium_formatted": "text",
"fnol_link": "https://example.com",
"booking_agent": null
}Preview the price impact of proposed changes to a booking before committing them. This endpoint calculates the price difference (refund or additional charge) for the requested modifications without applying them. Use this to show customers the financial impact before they confirm. The response includes an update_id that must be used with the Confirm Update endpoint to apply the changes.
Composite Authentication Scheme (Client Key, Date, and Signature)
This scheme requires the client to provide three mandatory headers in every request:
1. X-Api-Key (Client Key)
- Purpose: Public identifier for the API consumer.
- Example:
X-Api-Key: YOUR_API_KEY_HERE
2. Date (Timestamp)
- Purpose: Timestamp used for generating the signature and preventing replay attacks.
- Format: RFC 7231 format (e.g., in GMT).
- Example:
Date: Sun, 09 Nov 2025 04:04:00 GMT
3. Authorization (Computed Signature)
- Purpose: The cryptographic signature that verifies the request's authenticity and integrity.
- Format:
SIGNATURE [authHeader]
Signature Generation Logic:
The authHeader value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the Date header), signed with the private Client Secret.
Partner code identifier. Client Solutions Engineer (CSE) should provide this value.
The booking ID returned from the Confirm Offer endpoint.
OK
Forbidden
Unprocessable Entity
PATCH /x/partners/{partner_code}/bookings/{booking_id}/quote_for_update HTTP/1.1
Host: api.xcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139
{
"quotes": [
{
"id": "text",
"policy_start_date": "text",
"update_fields": {
"insured": [
{
"first_name": "text",
"last_name": "text",
"email": "text"
}
]
}
}
]
}{
"id": "text",
"status": "text",
"currency": "text",
"total_price": 1,
"total_price_formatted": "text",
"partner_transaction_id": null,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"pds_url": "https://example.com",
"security_token": "text",
"quotes": [
{
"id": "text",
"policy_start_date": "2026-01-01T00:00:00.000Z",
"policy_end_date": "2026-01-01T00:00:00.000Z",
"status": "text",
"price": 1,
"price_formatted": "text",
"policy": {
"policy_type": "text",
"policy_type_version": "text",
"policy_type_slug": "text",
"policy_type_group_name": "text",
"policy_name": "text",
"policy_code": "text",
"policy_version": "text",
"category": "text",
"content": {
"title": "text",
"header": null,
"description": "text",
"optout_msg": "text",
"inclusions": [
{
"title": "text",
"description": "text"
}
],
"exclusions": [],
"disclaimer": "text",
"disclaimer_html": "text",
"payment_disclaimer": "text",
"in_path_disclaimer": "text",
"extra_content": {}
},
"underwriter": {
"disclaimer": "text",
"name": "text"
},
"claim_selector_id": null,
"policy_currency": "text"
},
"insured": [
{
"id": "text",
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"region": null
}
],
"tax": {
"total_tax": 1,
"total_amount_without_tax": 1,
"taxes": [
{
"tax_amount": 1,
"tax_code": "text",
"tax_amount_formatted": "text"
}
],
"total_tax_formatted": "text",
"total_amount_without_tax_formatted": "text"
},
"duration": "text",
"benefits": [
{
"benefit_content_id": "text",
"description": "text",
"extra_content": {
"benefit-text-test": "text",
"benefit_rich_text_test": "text"
},
"limit": 1,
"limit_policy_currency": 1,
"limit_formatted": "text",
"limit_policy_currency_formatted": "text",
"excess": 1,
"excess_policy_currency": 1,
"excess_formatted": "text",
"excess_policy_currency_formatted": "text"
}
],
"commission": {
"partner_commission": 1,
"surcharge_commission": 1,
"total_commission": 1,
"partner_commission_formatted": "text",
"surcharge_commission_formatted": "text",
"total_commission_formatted": "text"
},
"created_at": "2026-01-01T00:00:00.000Z",
"confirmed_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"cancelled_at": null,
"cancelled_from": null,
"is_renewable": true,
"is_pricebeat_enabled": null,
"cover_amount": 1,
"cover_amount_formatted": "text",
"pds_url": "https://example.com",
"attachments": [],
"files": [],
"custom_documents": null,
"extra_fields": {
"destination_region": "text",
"seller_entity": "text",
"age_brackets": "text",
"desitnation_sanctions": [],
"sanctioned_distination_countries": [
"text"
],
"test_underwrting_rule": true
},
"surcharge": {
"total_amount": null,
"surcharges": null,
"total_amount_formatted": "text"
},
"parent_quote_status": null,
"experiment": null,
"next_renewal": null,
"can_be_cancelled": true,
"third_party_admins": [],
"ombudsman_list": [],
"cancellation_info": {
"reason_for_cancellation": "text"
},
"price_diff": 1,
"price_diff_formatted": "text"
}
],
"coi": {
"url": "https://example.com",
"pdf": "https://example.com"
},
"account_url": "https://example.com",
"sign_up_url": "https://example.com",
"policyholder": {
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone": "text",
"address1": null,
"address2": null,
"postcode": "text",
"company": null,
"company_reg_id": null,
"middle_name": null,
"country": "text",
"age": 1,
"city": null,
"region": "text",
"secondary_email": null,
"birth_date": null,
"allow_updates": true,
"fields_allowed_to_update": []
},
"total_tax": 1,
"total_tax_formatted": "text",
"total_premium": 1,
"total_premium_formatted": "text",
"fnol_link": "https://example.com",
"booking_agent": null,
"total_price_diff": 1,
"total_price_diff_formatted": "text",
"update_id": "text"
}Confirm and apply previously previewed booking modifications. This endpoint finalizes the changes calculated by the Preview endpoint. You must provide the update_id returned from the Preview endpoint. If there is an additional charge, include the xpay_charge_id from the payment transaction.
Composite Authentication Scheme (Client Key, Date, and Signature)
This scheme requires the client to provide three mandatory headers in every request:
1. X-Api-Key (Client Key)
- Purpose: Public identifier for the API consumer.
- Example:
X-Api-Key: YOUR_API_KEY_HERE
2. Date (Timestamp)
- Purpose: Timestamp used for generating the signature and preventing replay attacks.
- Format: RFC 7231 format (e.g., in GMT).
- Example:
Date: Sun, 09 Nov 2025 04:04:00 GMT
3. Authorization (Computed Signature)
- Purpose: The cryptographic signature that verifies the request's authenticity and integrity.
- Format:
SIGNATURE [authHeader]
Signature Generation Logic:
The authHeader value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the Date header), signed with the private Client Secret.
Partner code identifier. Client Solutions Engineer (CSE) should provide this value.
The booking ID returned from the Confirm Offer endpoint.
The update ID returned from the Modify Booking endpoint.
Created
Forbidden
Not Found
Unprocessable Entity
POST /x/partners/{partner_code}/bookings/{booking_id}/confirm_update/{update_id}/ HTTP/1.1
Host: api.xcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"xpay_charge_id": "text"
}{
"id": "text",
"status": "text",
"currency": "text",
"total_price": 1,
"total_price_formatted": "text",
"partner_transaction_id": null,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"pds_url": "https://example.com",
"security_token": "text",
"quotes": [
{
"id": "text",
"policy_start_date": "2026-01-01T00:00:00.000Z",
"policy_end_date": "2026-01-01T00:00:00.000Z",
"status": "text",
"price": 1,
"price_formatted": "text",
"policy": {
"policy_type": "text",
"policy_type_version": "text",
"policy_type_slug": "text",
"policy_type_group_name": "text",
"policy_name": "text",
"policy_code": "text",
"policy_version": "text",
"category": "text",
"content": {
"title": "text",
"header": null,
"description": "text",
"optout_msg": "text",
"inclusions": [
{
"title": "text",
"description": "text"
}
],
"exclusions": [],
"disclaimer": "text",
"disclaimer_html": "text",
"payment_disclaimer": "text",
"in_path_disclaimer": "text",
"extra_content": {}
},
"underwriter": {
"disclaimer": "text",
"name": "text"
},
"claim_selector_id": null,
"policy_currency": "text"
},
"insured": [
{
"id": "text",
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"region": null
}
],
"tax": {
"total_tax": 1,
"total_amount_without_tax": 1,
"taxes": [
{
"tax_amount": 1,
"tax_code": "text",
"tax_amount_formatted": "text"
}
],
"total_tax_formatted": "text",
"total_amount_without_tax_formatted": "text"
},
"duration": "text",
"benefits": [
{
"benefit_content_id": "text",
"description": "text",
"extra_content": {
"benefit-text-test": "text",
"benefit_rich_text_test": "text"
},
"limit": 1,
"limit_policy_currency": 1,
"limit_formatted": "text",
"limit_policy_currency_formatted": "text",
"excess": 1,
"excess_policy_currency": 1,
"excess_formatted": "text",
"excess_policy_currency_formatted": "text"
}
],
"commission": {
"partner_commission": 1,
"surcharge_commission": 1,
"total_commission": 1,
"partner_commission_formatted": "text",
"surcharge_commission_formatted": "text",
"total_commission_formatted": "text"
},
"created_at": "2026-01-01T00:00:00.000Z",
"confirmed_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"cancelled_at": null,
"cancelled_from": null,
"is_renewable": true,
"is_pricebeat_enabled": null,
"cover_amount": 1,
"cover_amount_formatted": "text",
"pds_url": "https://example.com",
"attachments": [],
"files": [],
"custom_documents": null,
"extra_fields": {
"destination_region": "text",
"seller_entity": "text",
"age_brackets": "text",
"desitnation_sanctions": [],
"sanctioned_distination_countries": [
"text"
],
"test_underwrting_rule": true
},
"surcharge": {
"total_amount": null,
"surcharges": null,
"total_amount_formatted": "text"
},
"parent_quote_status": null,
"experiment": null,
"next_renewal": null,
"can_be_cancelled": true,
"third_party_admins": [],
"ombudsman_list": [],
"cancellation_info": {
"reason_for_cancellation": "text"
},
"price_diff": 1,
"price_diff_formatted": "text"
}
],
"coi": {
"url": "https://example.com",
"pdf": "https://example.com"
},
"account_url": "https://example.com",
"sign_up_url": "https://example.com",
"policyholder": {
"first_name": "text",
"last_name": "text",
"email": "[email protected]",
"phone": "text",
"address1": null,
"address2": null,
"postcode": "text",
"company": null,
"company_reg_id": null,
"middle_name": null,
"country": "text",
"age": 1,
"city": null,
"region": "text",
"secondary_email": null,
"birth_date": null,
"allow_updates": true,
"fields_allowed_to_update": []
},
"total_tax": 1,
"total_tax_formatted": "text",
"total_premium": 1,
"total_premium_formatted": "text",
"fnol_link": "https://example.com",
"booking_agent": null,
"total_price_diff": 1,
"total_price_diff_formatted": "text"
}Last updated
Was this helpful?

