Skip to content
Identity and Access Management

Reference Data

Reference data endpoints expose static, read-only information that consumers can use to populate dropdowns, validate input, or drive locale-aware features within their applications. These endpoints require no request body and accept no filter or pagination parameters — they always return the full supported dataset.

Countries

Section titled “Countries”

GET /referenceData/countries

Returns an object whose items array contains all globally supported countries and their administrative sub-regions (states, provinces, territories). Use this endpoint to resolve display names, validate country codes, or populate country selectors in your application.

Country Object

Section titled “Country Object”
Field Type Description
name string Full English name of the country.
native string Native name of the country in its local language.
alpha2_code string ISO 3166-1 alpha-2 two-letter country code (e.g., US, DE).
alpha3_code string ISO 3166-1 alpha-3 three-letter country code (e.g., USA, DEU). May be null.
calling_code string International dialling prefix for the country (e.g., +1, +49).
regions array List of administrative sub-regions within the country. Each region has a name and an optional code.

Usage Notes

Section titled “Usage Notes”
  • Country codes used elsewhere in the IAM API (e.g., the country field on an Account) follow the ISO 3166-1 alpha-2 standard. Iterate over response.items and use the alpha2_code value from each country object as the accepted input.
  • alpha3_code may be null for territories or regions that do not have an assigned ISO alpha-3 code.
  • Region code may be null for sub-regions that lack a standardised code.

Languages

Section titled “Languages”

GET /referenceData/languages

Returns an object whose items array contains all globally supported languages. Use this endpoint to populate language selectors or map locale codes to human-readable display names.

Language Object

Section titled “Language Object”
Field Type Description
code string BCP 47 language locale code (e.g., en-US, ar-SA, fr-FR).
name string English name of the language (e.g., English, Arabic, French).
native string Native name of the language written in its own script (e.g., عربى, Français).

Usage Notes

Section titled “Usage Notes”
  • The code field follows the BCP 47 standard and is the value accepted by IAM APIs wherever a language or locale is required. Iterate over response.items to access each language object.
  • Use name for English-language UIs and native when displaying the language in its own script.

Timezones

Section titled “Timezones”

GET /referenceData/timezones

Returns an object whose items array contains all globally supported timezones. Use this endpoint to populate timezone selectors or resolve a unique timezone code to its IANA identifier(s) and display label.

Timezone Object

Section titled “Timezone Object”
Field Type Description
name string One or more IANA timezone identifiers (and legacy aliases) associated with this zone, space-separated (e.g., Asia/Calcutta Asia/Kolkata).
code string Unique short identifier for this timezone entry (e.g., inccu).
description string Human-readable location label for the timezone (e.g., Kolkata, India).
zoneTime string Display string combining the current UTC offset and name (e.g., (GMT+05:30) Asia/Calcutta Asia/Kolkata).

Usage Notes

Section titled “Usage Notes”
  • Each timezone entry has a unique code. Iterate over response.items and use code as the stored timezone value when setting timezone fields on IAM resources.
  • Use zoneTime to populate timezone selectors. Use description when a short human-readable location label is needed.
  • name lists the IANA identifier(s) (and any legacy aliases) for the zone. It is not a stable stored identifier — use code instead.

General Contract

Section titled “General Contract”
  • All three endpoints are read-only endpoints. No Application subscription is required to call them.
  • Each response wraps its dataset in a top-level items array. This is a plain envelope, not a paginated list — there is no links property.
  • The datasets are static — they do not change frequently. Consumers are encouraged to cache responses locally and refresh on a periodic basis rather than fetching on every request.
  • No pagination, filtering, or sorting is supported. Each call returns the complete dataset in items.