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

Confirm Offer

Confirm Offer

post

Finalize the purchase of shipping protection from a previously created Offer. Converts the selected Offer into a confirmed booking after payment has been collected.

Idempotency

This endpoint supports idempotency keys via the x-idempotency-key header to prevent duplicate transactions.

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.

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
offer_idstringRequired

The offer ID returned from the Create Offer endpoint.

Header parameters
x-idempotency-keystring · uuidOptional

A unique identifier to ensure idempotent request processing. Keys are stored for 48 hours.

Body
Responses
200

OK

application/json
idstringOptional
statusstringOptional
currencystringOptional
total_pricenumberOptional
total_price_formattedstringOptional
partner_transaction_idstring · nullableOptional
created_atstring · date-timeOptional
updated_atstring · date-timeOptional
pds_urlstring · uriOptional
security_tokenstringOptional
total_taxnumberOptional
total_tax_formattedstringOptional
total_premiumnumberOptional
total_premium_formattedstringOptional
fnol_linkstring · uriOptional
post/partners/{partner_code}/offers/{offer_id}/confirm/
POST /x/partners/{partner_code}/offers/{offer_id}/confirm/ HTTP/1.1
Host: api.xcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "quotes": [
    {
      "id": "4c783f66-c253-43cf-86d6-3a9096769679"
    }
  ],
  "policyholder": {
    "first_name": "Oscar",
    "last_name": "Linares",
    "email": "[email protected]",
    "address1": "245 East 63rd Street",
    "address2": "Apt 12B",
    "city": "New York",
    "postcode": "10065",
    "region": "NY",
    "country": "US"
  }
}
{
  "id": "L9KQM-2NX4P-INS",
  "status": "CONFIRMED",
  "currency": "USD",
  "total_price": 164.95,
  "total_price_formatted": "US$164.95",
  "partner_transaction_id": null,
  "created_at": "2026-05-08T10:05:00.000000Z",
  "updated_at": "2026-05-08T10:05:00.150000Z",
  "pds_url": "https://www.xcover.com/en/pds/L9KQM-2NX4P-INS",
  "security_token": "7tKwX-PqLra-bcDjK-92ML4",
  "quotes": [
    {
      "id": "4c783f66-c253-43cf-86d6-3a9096769679",
      "policy_start_date": "2026-05-08T10:00:00+00:00",
      "policy_end_date": null,
      "status": "CONFIRMED",
      "price": 164.95,
      "price_formatted": "US$164.95",
      "policy": {
        "policy_type": "parcel_insurance",
        "policy_type_version": "1",
        "policy_type_slug": "parcel_insurance_v1",
        "policy_type_group_name": "logistics",
        "policy_name": "ACME Logistics Parcel Protection",
        "policy_code": "ALPP0001",
        "policy_version": "5c56f9cb-b851-42a8-ad53-eeb0e78a0a88",
        "category": "parcel_insurance",
        "policy_currency": "USD"
      },
      "tax": {
        "total_tax": 0,
        "total_amount_without_tax": 164.95,
        "total_tax_formatted": "US$0.00",
        "total_amount_without_tax_formatted": "US$164.95"
      },
      "benefits": [],
      "commission": {
        "partner_commission": 0,
        "total_commission": 0,
        "partner_commission_formatted": "US$0.00",
        "total_commission_formatted": "US$0.00"
      },
      "created_at": "2026-05-08T10:05:00.000000Z",
      "confirmed_at": "2026-05-08T10:05:00.150000Z",
      "pds_url": "https://www.xcover.com/en/pds/L9KQM-2NX4P-INS?policy_type=parcel_insurance_v1&quote_id=4c783f66-c253-43cf-86d6-3a9096769679",
      "can_be_cancelled": true
    }
  ],
  "coi": {
    "url": "https://www.xcover.com/en/coi/L9KQM-2NX4P-INS?security_token=7tKwX-PqLra-bcDjK-92ML4",
    "pdf": "https://www.xcover.com/en/coi/L9KQM-2NX4P-INS.pdf?security_token=7tKwX-PqLra-bcDjK-92ML4"
  },
  "policyholder": {
    "first_name": "Oscar",
    "last_name": "Linares",
    "email": "[email protected]",
    "country": "US"
  },
  "total_tax": 0,
  "total_tax_formatted": "US$0.00",
  "total_premium": 164.95,
  "total_premium_formatted": "US$164.95",
  "fnol_link": "https://www.xcover.com/en/account/claims/fnol?bookingID=L9KQM-2NX4P-INS&security_token=7tKwX-PqLra-bcDjK-92ML4"
}

Last updated

Was this helpful?