LogoLogo
API Specification
  • Introduction
  • Integration Checklist
  • Common Use Cases
    • Events / Tickets
    • Travel / Accomodation
    • Property / Renters
    • Parcel / Shipping
    • Product / Retail
  • API Authentication
  • Idempotency Keys
  • Rate Limits
  • Purchase Workflow Overview
    • Quote Request for Policies
      • Fast Quote (Optional)
      • Displaying the Quote
      • JS based offer display
    • Payment Process
      • Single Payment
      • Dual Payment
    • Booking
      • Instant Booking
    • Insurance Opt-Out
  • Cancellation Workflow
  • Modification Workflow
  • Renewal Workflow
  • Instalments Workflow
  • Claim
  • Policy Management
  • XCover Quote Package State
  • API Responses
    • Quote/Policy Status
    • Error Management
    • Error Types
  • Data Formats
  • Webhooks
  • Apple Private Relay
  • FAQs
    • Events / Tickets FAQs
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Purchase Workflow Overview

Insurance Opt-Out

PreviousInstant BookingNextCancellation Workflow

Last updated 3 years ago

Was this helpful?

The Insurance opt-out workflow describes the API call that must be made in the case that XCover insurance is offered but not selected by the customer. The purpose of utilising the opt-out workflow is so Cover Genius can demonstrate conversion rate to the regulators ensuring the product and pricing is fit for purpose. It also enables XCover machine learning platform Brightwrite to deliver the optimal products at the optimal prices.

Sending Opt-Out Data

POST https://api.xcover.com/x/partners/:partner_id/bookings/:quote_package_id/opt_out

The opt-out request does not require any data to be contained in the payload.

Path Parameters

Name
Type
Description

partner_id

string

Uniquer Partner Code

quote_package_id

string

Quote Package ID

Headers

Name
Type
Description

Date

string

Current Datetime

Authorization

string

HMAC Signature

X-Api-Key

string

API Key

Opt-Out Workflow