Opt Out Offer

Opt-out Offer

post

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.

Authorizations

AuthorizationstringRequired

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.

Path parameters

partner_codestringRequired

Partner code identifier. Client Solutions Engineer (CSE) should provide this value.

offer_idstringRequired

The offer ID returned from the Create Offer endpoint.

Header parameters

X-API-Error-Versionstring · enumOptional

Opt-in selector for the shape of non-2xx response bodies. v1 (the default) returns the legacy error body. v2 returns the structured error body described by ErrorV2. Matched case-insensitively. An absent, empty or unrecognised value falls back to v1 and never fails an otherwise-valid request.

Default: v1Possible values:

Body

objectOptional

Responses

204

No Content

403

Forbidden

application/json

404

Not Found

application/json

post/partners/{partner_code}/offers/{offer_id}/opt_out/

POST /x/partners/{partner_code}/offers/{offer_id}/opt_out/ HTTP/1.1
Host: api.xcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

No content