Opt-out

POST /api/partners/{partner_id}/quotes/{quote_id}/opt-out

The Opt-Out API endpoint allows partners to report the conversion of the main product without ancillary insurance products. This endpoint requires a valid access token obtained from the Authentication

Path parameters

Parameter	Type	Description
partner_id	string	The partner identifier provided during onboarding
quote_id	string	Unique identifier of the quote returned in the widget

Headers

Name	Value
Accept	application/json
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
customer.first_name	string	First name
customer.last_name	string	Last name
customer.email	string | email address	Email address
customer.phone	string	Phone number
customer.country	2 characters country code	2 characters country code
customer.date_of_birth	date in format of yyyy-mm-dd	Date of birth
customer.address1	string	Address line 1
customer.address2	string	Address line 2
customer.city	string	City
customer.region	string	Region
customer.postcode	string	Postcode / zip code

{
  "customer": {
    "first_name": "Kaitlin",
    "last_name":  "Brown",
    "email": "[email protected]",
    "phone":  "[phone]",
    "country": "US",
    "date_of_birth":  "2000-01-01",
    "address1": "123 My Street",
    "address2":  "Unit 12",
    "city": "New York",
    "region":  "Kingston",
    "postcode": "12401"
  }
}

Response

🟢 200

{
    "data": {
        "provider_reference": "NVFD3-DKJR6-INS",
        "currency": "AUD",
        "language": "en",
        "expires_at": "2024-09-20T04:16:41.000000Z",
        "created_at": "2024-07-22T04:16:41.000000Z",
        "updated_at": "2024-07-22T04:17:00.000000Z",
        "security_token": "wVIZd-8qfI0-JRti2-EMQyj",
        "is_fast_quote": false,
        "opted_out_at": "2024-07-22T04:17:00.000000Z",
        "source": null,
        "booking": null,
        "id": "483d2530-5d7a-4fce-b6ca-8f888c237340",
        "total_price": 81.8,
        "total_price_formatted": "A$81.80",
        "pds_url": "https://www.xcover.com/en/pds/NVFD3-DKJR6-INS"
    }
}

🔴 401

{
    "message": "Unauthenticated."
}

🔴 422

{
  "message": "The customer.email field must be a valid email address. (and 2 more errors)"
  "errors": {
    "customer.email": [
      "The customer.email field must be a valid email address."
    ],
    "customer.country": [
      "The customer.country field must be 2 characters."
    ],
    "customer.date_of_birth": [
      "The customer.date of birth field must be a valid date."
    ]
  }
}