Opt-out Offer

The Offer opt-out workflow describes the API call that must be made when an Offer 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.

Opt-Out Workflow

Purpose

Utilizing the opt-out workflow serves two critical functions:

1. Regulatory Compliance - Enables Cover Genius to demonstrate conversion rates to regulators, ensuring the product and pricing is fit for purpose
2. Platform Optimization - Powers XCover's machine learning platform BrightWrite to deliver optimal products at optimal prices through data-driven insights

When to Use Opt-out

Call this endpoint when:

• An Offer has been presented to the customer (via Create Offer endpoint)
• The customer has chosen NOT to purchase the Offer
• You need to record the customer's decision to decline coverage

Making an Opt-out Request

Path Parameters

• partner_code - Your partner identifier
• offer_id - The Offer ID from the Create Offer response that was declined

Request Body

The request body is optional and can include:

• partner_metadata - Additional metadata about the opt-out decision
• Custom fields as defined by your integration

Response

• HTTP 204 No Content - Opt-out successfully recorded
• HTTP 403 Forbidden - Authentication or authorization error
• HTTP 404 Not Found - Offer not found

A successful opt-out returns 204 with no body, so there is nothing to parse on the success path.

Error Responses

Opt-out Offer supports the opt-in X-API-Error-Version: v2 header, which returns every error response from this endpoint in one consistent shape. We recommend all new integrations send it.

Opt-out failures are request-level rather than per-product, so the errors array carries a single entry with product_config_id and quote_id set to null:

{
  "type": "api_error",
  "message": "Quote not found.",
  "code": "offer_request_failed",
  "error_id": "5d8a2f61-9c04-4e73-b1a8-3f6e7c0d9b42",
  "errors": [
    {
      "product_config_id": null,
      "quote_id": null,
      "code": "offer_request_failed",
      "details": ["Quote not found."]
    }
  ],
  "metadata": {}
}

See Error Versioning for the full field reference and error code list.

Important Notes

Regulatory Requirement: Recording opt-outs is essential for demonstrating that insurance offerings are presented fairly and that pricing is appropriate for the market.

Data Analytics: Opt-out data feeds into BrightWrite's machine learning algorithms to continuously improve product offerings and pricing strategies.

No Impact on Customer: Calling this endpoint does not affect the customer in any way - it simply records their decision for analytics and compliance purposes.

Best Practices

• Call this endpoint as soon as the customer declines the Offer
• Include relevant metadata to help understand opt-out patterns
• Ensure opt-out is called for every Offer that is presented but not purchased