Opt Out offer

This opt-out endpoint should be used when a customer has successfully purchased the partner's primary product, but declined the Offer of ancillary products (such as insurance) presented by XCover Elements.

The purpose of utilising the opt-out workflow is so Cover Genius can demonstrate conversion rate to the regulators, ensuring the product and pricing are fit for purpose. It also enables the XCover machine learning platform to deliver the optimal products and prices.

Opt-out offer

post

Required scopes

This endpoint requires the following scopes:

• : Permission to opt-out existing offers.

Authorizations

PartnerPrivateAPI

OAuth2clientCredentialsRequired

XONE API Access Token

To get started with the XONE API, you'll first need to obtain an access token. This token acts as a digital key, granting your application permission to make API calls.

This process uses the OAuth 2.0 Client Credentials Grant flow. You'll use your unique client ID and client secret to request a token, which you then include in subsequent API requests.

🔑 Authentication Steps

• Request Token: Send a "Retrieve Token" request to the XONE authorization server's token endpoint.
• Include Credentials: In the request body, provide your client_id and client_secret as a JSON object.
• Use Token: The server will respond with an access_token that you can now use to authenticate your API calls by including it in the Authorization header as a Bearer token.

Token URL:

Path parameters

partner_idstringRequired

offer_idstringRequired

Body

application/json

Responses

200

200 OK

401

401 Unauthorized

application/json

post

/api/partners/{partner_id}/offers/{offer_id}/opt-out

HTTPcURLJavaScriptPython

POST /api/partners/{partner_id}/offers/{offer_id}/opt-out HTTP/1.1
Host: api.xone.xcover.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "customer": {
    "first_name": "text",
    "last_name": "text",
    "country": "text",
    "email": "text",
    "phone": "text",
    "address1": "text",
    "address2": "text",
    "city": "text",
    "region": "text",
    "postcode": "text"
  }
}

No content