For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create Offer

Create Offer

post

The Create Offer endpoint generates event ticket protection offerings based on the events and tickets being purchased. Multiple events may be quoted in a single request; the response returns one or more protection products with pricing.

Authorizations
AuthorizationstringRequired

Composite Authentication Scheme (Client Key, Date, and Signature)

Requires three mandatory headers in every request:

1. X-Api-Key (Client Key)

  • Purpose: Public identifier for the API consumer.

2. Date (Timestamp)

  • Purpose: Timestamp used for generating the signature and preventing replay attacks.
  • Format: RFC 7231 format (e.g., in GMT).

3. Authorization (Computed Signature)

  • Purpose: Cryptographic signature that verifies the request's authenticity and integrity.
  • Format: SIGNATURE [authHeader]

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.

Query parameters
active_onlybooleanOptional

When using a test API key, only return active offers

Default: false
include_contentbooleanOptional

Include localized content in the response

Default: true
extra_fieldsstringOptional

Comma-separated list of specific extra fields to include. Available fields: tax, commission, benefits, surcharge

exclude_offer_idsstringOptional

Comma-separated list of Offer Config IDs to exclude from the response

Body
schemastringOptional

Schema identifier for the offer type. Optional. If not provided, the default schema for your partner will be used.

Responses
200

OK

application/json

Event ticket protection offer responses are wrapped in a top-level data object.

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

{
  "partner": {
    "transaction_id": "c992efc4-da4c-4f45-996a-f16365ca3196",
    "subsidiary": "acme-events-us"
  },
  "context": {
    "events": [
      {
        "id": "666643",
        "name": "ACME Single Day Music Event",
        "start_date": "2026-04-29T15:00:00.000Z",
        "end_date": "2026-04-30T15:00:00.000Z",
        "venue": "Downtown Music Hall",
        "city": "Newark",
        "country": "US",
        "multiday_event": true,
        "duration_days": 3,
        "category": "Music",
        "total_amount": 550.44,
        "ticket_count": 3,
        "tickets": [
          {
            "price": 121.46,
            "type": "GA",
            "status": "layaway",
            "id": "459624186",
            "total_paid": 14.46
          },
          {
            "price": 214.49,
            "type": "VIP",
            "status": "purchased",
            "id": "459624281",
            "total_paid": 214.49
          },
          {
            "price": 214.49,
            "type": "VIP",
            "status": "purchased",
            "id": "459624282",
            "total_paid": 214.49
          }
        ]
      },
      {
        "id": "666644",
        "name": "ACME Multi-Day Comedy Festival",
        "start_date": "2026-05-29T03:00:00.000Z",
        "venue": "City Comedy Club",
        "city": "Los Angeles",
        "country": "US",
        "duration_days": 3,
        "category": "Comedy",
        "total_amount": 2339.44,
        "ticket_count": 5,
        "multiday_event": true,
        "tickets": [
          {
            "price": 282.78,
            "type": "General Admission",
            "status": "layaway",
            "id": "459624379",
            "total_paid": 22.88
          },
          {
            "price": 282.78,
            "type": "General Admission",
            "status": "layaway - void",
            "id": "459624380",
            "total_paid": 22.88
          },
          {
            "price": 282.78,
            "type": "General Admission",
            "status": "layaway - void",
            "id": "459624381",
            "total_paid": 22.88
          },
          {
            "price": 426.91,
            "type": "VIP",
            "status": "purchased",
            "id": "459624479",
            "total_paid": 426.91
          },
          {
            "price": 1064.19,
            "type": "Meet & Greet",
            "status": "purchased",
            "id": "459624579",
            "total_paid": 1064.19
          }
        ]
      }
    ]
  },
  "customer": {
    "currency": "USD",
    "country": "US",
    "region": "NY",
    "postcode": "10036",
    "language": "en-us"
  }
}
{
  "data": {
    "id": "462870ac-f408-48ef-8f86-7cf4dbf92652",
    "currency": "USD",
    "products": [
      {
        "id": "78e02aeb-86fa-47e1-b1b7-e0f12b734c5a",
        "product_config_id": "7d28c1c6-6e62-44e6-aa5b-27b06bf17f13",
        "type": "xcover",
        "schema_url": "https://staging.static.xcover.com/media/product-types/schemas/xcover.json",
        "details": {
          "policy_version_id": "d09c2b37-bb8c-41ae-b281-58d99bd13ede",
          "start_date": "2025-12-02T22:58:15.061427+00:00",
          "end_date": "2025-12-07T16:00:00+00:00",
          "finance": {
            "price": {
              "total_amount": 123.68,
              "total_amount_without_tax": null,
              "total_amount_formatted": "US$123.68",
              "total_amount_without_tax_formatted": null
            },
            "tax": {
              "total_amount": null,
              "total_amount_formatted": null
            },
            "surcharge": {
              "total_amount": null,
              "total_amount_formatted": null
            },
            "commission": {
              "total_amount": null,
              "total_amount_formatted": null
            }
          },
          "pds_url": "https://staging.xcover.com/en-us/pds/eff06da8-4e56-475a-865d-3716b1ae4ee2?policy_type=event_ticket_protection_v1",
          "files": [],
          "extra_fields": {
            "seller_entity": "Cover Genius Insurance Services, LLC.",
            "event_datetime": "2025-12-07T16:00:00Z",
            "policy_start_date": "2025-12-02T22:58:15.061427+00:00",
            "customer_id": "N/A",
            "event_id": null,
            "esimid": "",
            "esim_eligible": true,
            "policy_start_calculated": "2025-12-02T22:58:15.086266+00:00",
            "same_day": false
          },
          "experiment": [],
          "benefits": []
        }
      }
    ],
    "content": {
      "schema_version": "content:1.0",
      "locale": "en-us"
    },
    "provider_reference": "eff06da8-4e56-475a-865d-3716b1ae4ee2"
  }
}

Last updated

Was this helpful?