LogoLogo
API Specification
  • Introduction
  • Integration Checklist
  • Common Use Cases
    • Events / Tickets
    • Travel / Accomodation
    • Property / Renters
    • Parcel / Shipping
    • Product / Retail
  • API Authentication
  • Idempotency Keys
  • Rate Limits
  • Purchase Workflow Overview
    • Quote Request for Policies
      • Fast Quote (Optional)
      • Displaying the Quote
      • JS based offer display
    • Payment Process
      • Single Payment
      • Dual Payment
    • Booking
      • Instant Booking
    • Insurance Opt-Out
  • Cancellation Workflow
  • Modification Workflow
  • Renewal Workflow
  • Instalments Workflow
  • Claim
  • Policy Management
  • XCover Quote Package State
  • API Responses
    • Quote/Policy Status
    • Error Management
    • Error Types
  • Data Formats
  • Webhooks
  • Apple Private Relay
  • FAQs
    • Events / Tickets FAQs
Powered by GitBook
On this page
  • Dates
  • Country Codes
  • Currency
  • Languages
  • Telephone (Mobile Phone) numbers

Was this helpful?

Export as PDF

Data Formats

PreviousError TypesNextWebhooks

Last updated 3 years ago

Was this helpful?

The API adheres to the REST principles and provides developers-friendly, predictive and logically organised resource-oriented structure.

Dates

XCover API accepts date and date-time parameters in the format as defined by , for example 2018-01-01, 2018-01-01T17:00:01Z, 2018-01-01T17:00:00+01:00, 2018-01-01T17:00:01.04399-04:00. We encourage partners to keep the original timezone in contrast to sending all dates in UTC. Having original timezone can helps XCover to deal with potential issues with DST changes.

Country Codes

All country codes provided in API requests must be compliant with standard.

Currency

Currency must be compliant with 3-letter codes as defined by .

Languages

Language input must be compliant with 2-letter codes as defined but standard. Variations of base languages use a variant indicator, for example: "en-us" to specify english, united states variant (where applicable).

Telephone (Mobile Phone) numbers

Phone numbers provided (at booking stage) should predominantly be of personal mobile/cell type, with the format of +[country_code] plus a phone number, e.g., In some use cases, XCover will validate the phone number format (to allow sending SMS policy and claim communications to the customer), and return an error if an invalid format is provided.

RFC 3339, section 5.6
ISO 3166-1 Alpha-2
ISO 4217
ISO 639-1
+61412345678