Data Formats
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 RFC 3339, section 5.6, 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 ISO 3166-1 Alpha-2 standard.
Currency
Currency must be compliant with 3-letter codes as defined by ISO 4217.
Languages
Language input must be compliant with 2-letter codes as defined but ISO 639-1 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., +61412345678
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.
Last updated