Data Types

This section details the different data types that this application leverages for certain API resources. These data types will described that expected and allowed values for the data type.

Integers

Integers are positive numeric values without decimal places, 0 is considered to be a valid integer value.

Strings

Strings as short text value that are a minimum of 3 characters and a maximum of 255 characters.

Emails

Emails are string values that are formed using the following valid email format : name @ domain_name . domain

Formats

Formats are strings that represent character configurations, where letters are used to denote where which values will be placed within a string. Formats should not represent real values.

Date Format

Date strings represent the different types of date formats. Below is a list of accepted formats.

DD/MM/YYYY, YYYY/MM/DD, MM/DD/YYYY, DD-MM-YYYY, YYYY-MM-DD, MM-DD-YYYY, DD.MM.YYYY, YYYY.MM.DD, or MM.DD.YYYY.

• DD represents the date as 2 digits.
• MM represents the month as 2 digits.
• YYYY represents the full year as 4 digits.

Time Format

Time strings represent the different types of time formats. Below is a short list of all accepted formats.

HH:MM AM or HH:MM.

• HH represents the hour as 2 digits.
• MM represents the minute as 2 digits.
• AM represents the meridiem status, either am or pm.

Weeks

Week strings are a single worded string which indicates which day of the week it is, there are 7 allowed values, listed below:

Monday, Tuesday, Wednesday, Thrusday, Friday, Saturday, or Sunday.

Addresses

Addresses are JSON objects that consist of 7 attributes:

Parameter	Type	Description
street	string	The first street line for the address. Usually contains the street number.
street_2	string	The second street line for the address.
suburb	string	The suburb of the address, if applicable. Can be treated as a third address line.
city	string	The city of the address.
state	string	The state of the address, if applicable.
postal	string	The postal code for the address.
country	country	The country code for the address.

Currencies

Currencies are represented by the capitalised 3 character ISO codes for all of the currencies in the world. Below is a table that lists all of the allowed values.

Code	Currency
AED	UAE Dirham
AFN	Afghanistan, Afghani
ALL	Albania, Lek
AMD	Armenian Dram
ANG	Netherlands Antillian Guilder
AOA	Angola, Kwanza
ARS	Argentine Peso
AUD	Australian Dollar
AWG	Aruban Guilder
AZN	Azerbaijanian Manat
BAM	Bosnia and Herzegovina, Convertible Marks
BBD	Barbados Dollar
BDT	Bangladesh, Taka
BGN	Bulgarian Lev
BHD	Bahraini Dinar
BIF	Burundi Franc
BMD	Bermudian Dollar
BND	Brunei Dollar
BOB	Bolivia, Boliviano
BRL	Brazilian Real
BSD	Bahamian Dollar
BTN	Bhutan, Ngultrum
BWP	Botswana, Pula
BYR	Belarussian Ruble
BZD	Belize Dollar
CAD	Canadian Dollar
CDF	Franc Congolais
CHF	Swiss Franc
CLP	Chilean Peso
CNY	China Yuan Renminbi
COP	Colombian Peso
CRC	Costa Rican Colon
CUC	Cuban Convertible Peso
CUP	Cuban Peso
CVE	Cape Verde Escudo
CZK	Czech Koruna
DJF	Djibouti Franc
DKK	Danish Krone
DOP	Dominican Peso
DZD	Algerian Dinar
EGP	Egyptian Pound
ERN	Eritrea, Nakfa
ETB	Ethiopian Birr
EUR	Euro
FJD	Fiji Dollar
FKP	Falkland Islands Pound
GBP	Pound Sterling
GEL	Georgia, Lari
GHS	Ghana Cedi
GIP	Gibraltar Pound
GMD	Gambia, Dalasi
GTQ	Guatemala, Quetzal
GYD	Guyana Dollar
HKD	Hong Kong Dollar
HNL	Honduras, Lempira
HRK	Croatian Kuna
HTG	Haiti, Gourde
HUF	Hungary, Forint
IDR	Indonesia, Rupiah
ILS	New Israeli Shekel
INR	Indian Rupee
IQD	Iraqi Dinar
IRR	Iranian Rial
ISK	Iceland Krona
JMD	Jamaican Dollar
JOD	Jordanian Dinar
JPY	Japan, Yen
KES	Kenyan Shilling
KGS	Kyrgyzstan, Som
KHR	Cambodia, Riel
KMF	Comoro Franc
KPW	North Korean Won
KRW	South Korea, Won
KWD	Kuwaiti Dinar
KYD	Cayman Islands Dollar
KZT	Kazakhstan, Tenge
LAK	Laos, Kip
LBP	Lebanese Pound
LKR	Sri Lanka Rupee
LRD	Liberian Dollar
LSL	Lesotho, Loti
LYD	Libyan Dinar
MAD	Moroccan Dirham
MDL	Moldovan Leu
MGA	Malagasy Ariary
MKD	Macedonia, Denar
MMK	Myanmar, Kyat
MNT	Mongolia, Tugrik
MOP	Macao, Pataca
MRO	Mauritania, Ouguiya
MTL	Maltese Lira
MUR	Mauritius Rupee
MVR	Maldives, Rufiyaa
MWK	Malawi, Kwacha
MXN	Mexican Peso
MYR	Malaysian Ringgit
MZN	Mozambique Metical
NAD	Namibian Dollar
NGN	Nigeria, Naira
NIO	Nicaragua, Cordoba Oro
NOK	Norwegian Krone
NPR	Nepalese Rupee
NZD	New Zealand Dollar
OMR	Rial Omani
PAB	Panama, Balboa
PEN	Peru, Nuevo Sol
PGK	Papua New Guinea, Kina
PHP	Philippine Peso
PKR	Pakistan Rupee
PLN	Poland, Zloty
PYG	Paraguay, Guarani
QAR	Qatari Rial
RON	Romania, New Leu
RSD	Serbian Dinar
RUB	Russian Ruble
RWF	Rwanda Franc
SAR	Saudi Riyal
SBD	Solomon Islands Dollar
SCR	Seychelles Rupee
SDD	Sudanese Dinar
SEK	Swedish Krona
SGD	Singapore Dollar
SHP	Saint Helena Pound
SLL	Sierra Leone, Leone
SOS	Somali Shilling
SRD	Surinam Dollar
STD	Sao Tome and Principe, Dobra
SVC	El Salvador Colon
SYP	Syrian Pound
SZL	Swaziland, Lilangeni
THB	Thailand, Baht
TJS	Tajikistan, Somoni
TMT	Turkmenistani New Manat
TND	Tunisian Dinar
TOP	Tonga, Paanga
TRY	New Turkish Lira
TTD	Trinidad and Tobago Dollar
TWD	New Taiwan Dollar
TZS	Tanzanian Shilling
UAH	Ukraine, Hryvnia
UGX	Uganda Shilling
USD	US Dollar
UYU	Peso Uruguayo
UZS	Uzbekistan Sum
VEF	Venezuela Bolivares Fuertes
VND	Viet Nam, Dong
VUV	Vanuatu, Vatu
WST	Samoa, Tala
XAF	Franc de la Communaute financi
XCD	East Caribbean Dollar
XPF	CFP Franc
YER	Yemeni Rial
ZAR	South Africa, Rand
ZMW	Zambia Kwacha

Countries

Countries are represented by the capitalised 2 character ISO codes for all of the countries in the world. Below is a table that lists all of the allowed values.

Code	Currency
AF	Afghanistan
AX	Aland Islands
AL	Albania
DZ	Algeria
AS	American Samoa
AD	Andorra
AO	Angola
AI	Anguilla
AQ	Antarctica
AG	Antigua And Barbuda
AR	Argentina
AM	Armenia
AW	Aruba
AU	Australia
AT	Austria
AZ	Azerbaijan
BS	Bahamas
BH	Bahrain
BD	Bangladesh
BB	Barbados
BY	Belarus
BE	Belgium
BZ	Belize
BJ	Benin
BM	Bermuda
BT	Bhutan
BO	Bolivia
BA	Bosnia And Herzegovina
BW	Botswana
BV	Bouvet Island
BR	Brazil
IO	British Indian Ocean Territory
BN	Brunei Darussalam
BG	Bulgaria
BF	Burkina Faso
BI	Burundi
KH	Cambodia
CM	Cameroon
CA	Canada
CV	Cape Verde
KY	Cayman Islands
CF	Central African Republic
TD	Chad
CL	Chile
CN	China
CX	Christmas Island
CC	Cocos (Keeling) Islands
CO	Colombia
KM	Comoros
CG	Congo
CD	Congo, Democratic Republic
CK	Cook Islands
CR	Costa Rica
CI	Cote D'Ivoire
HR	Croatia
CU	Cuba
CY	Cyprus
CZ	Czech Republic
DK	Denmark
DJ	Djibouti
DM	Dominica
DO	Dominican Republic
EC	Ecuador
EG	Egypt
SV	El Salvador
GQ	Equatorial Guinea
ER	Eritrea
EE	Estonia
ET	Ethiopia
FK	Falkland Islands (Malvinas)
FO	Faroe Islands
FJ	Fiji
FI	Finland
FR	France
GF	French Guiana
PF	French Polynesia
TF	French Southern Territories
GA	Gabon
GM	Gambia
GE	Georgia
DE	Germany
GH	Ghana
GI	Gibraltar
GR	Greece
GL	Greenland
GD	Grenada
GP	Guadeloupe
GU	Guam
GT	Guatemala
GG	Guernsey
GN	Guinea
GW	Guinea-Bissau
GY	Guyana
HT	Haiti
HM	Heard Island & Mcdonald Islands
VA	Holy See (Vatican City State)
HN	Honduras
HK	Hong Kong
HU	Hungary
IS	Iceland
IN	India
ID	Indonesia
IR	Iran, Islamic Republic Of
IQ	Iraq
IE	Ireland
IM	Isle Of Man
IL	Israel
IT	Italy
JM	Jamaica
JP	Japan
JE	Jersey
JO	Jordan
KZ	Kazakhstan
KE	Kenya
KI	Kiribati
KR	Korea
KW	Kuwait
KG	Kyrgyzstan
LA	Lao People's Democratic Republic
LV	Latvia
LB	Lebanon
LS	Lesotho
LR	Liberia
LY	Libyan Arab Jamahiriya
LI	Liechtenstein
LT	Lithuania
LU	Luxembourg
MO	Macao
MK	Macedonia
MG	Madagascar
MW	Malawi
MY	Malaysia
MV	Maldives
ML	Mali
MT	Malta
MH	Marshall Islands
MQ	Martinique
MR	Mauritania
MU	Mauritius
YT	Mayotte
MX	Mexico
FM	Micronesia, Federated States Of
MD	Moldova
MC	Monaco
MN	Mongolia
ME	Montenegro
MS	Montserrat
MA	Morocco
MZ	Mozambique
MM	Myanmar
NA	Namibia
NR	Nauru
NP	Nepal
NL	Netherlands
AN	Netherlands Antilles
NC	New Caledonia
NZ	New Zealand
NI	Nicaragua
NE	Niger
NG	Nigeria
NU	Niue
NF	Norfolk Island
MP	Northern Mariana Islands
NO	Norway
OM	Oman
PK	Pakistan
PW	Palau
PS	Palestinian Territory, Occupied
PA	Panama
PG	Papua New Guinea
PY	Paraguay
PE	Peru
PH	Philippines
PN	Pitcairn
PL	Poland
PT	Portugal
PR	Puerto Rico
QA	Qatar
RE	Reunion
RO	Romania
RU	Russian Federation
RW	Rwanda
BL	Saint Barthelemy
SH	Saint Helena
KN	Saint Kitts And Nevis
LC	Saint Lucia
MF	Saint Martin
PM	Saint Pierre And Miquelon
VC	Saint Vincent And Grenadines
WS	Samoa
SM	San Marino
ST	Sao Tome And Principe
SA	Saudi Arabia
SN	Senegal
RS	Serbia
SC	Seychelles
SL	Sierra Leone
SG	Singapore
SK	Slovakia
SI	Slovenia
SB	Solomon Islands
SO	Somalia
ZA	South Africa
GS	South Georgia And Sandwich Isl.
ES	Spain
LK	Sri Lanka
SD	Sudan
SR	Suriname
SJ	Svalbard And Jan Mayen
SZ	Swaziland
SE	Sweden
CH	Switzerland
SY	Syrian Arab Republic
TW	Taiwan
TJ	Tajikistan
TZ	Tanzania
TH	Thailand
TL	Timor-Leste
TG	Togo
TK	Tokelau
TO	Tonga
TT	Trinidad And Tobago
TN	Tunisia
TR	Turkey
TM	Turkmenistan
TC	Turks And Caicos Islands
TV	Tuvalu
UG	Uganda
UA	Ukraine
AE	United Arab Emirates
GB	United Kingdom
US	United States
UM	United States Outlying Islands
UY	Uruguay
UZ	Uzbekistan
VU	Vanuatu
VE	Venezuela
VN	Viet Nam
VG	Virgin Islands, British
VI	Virgin Islands, U.S.
WF	Wallis And Futuna
EH	Western Sahara
YE	Yemen
ZM	Zambia
ZW	Zimbabwe

Timezones

This data type describes the timezone used for formatting dates. Below is the table of accepted values, with a short description of the timezone they represent.

Value	Description
Pacific/Midway	(GMT-11:00) Midway Island, Samoa
America/Adak	(GMT-10:00) Hawaii-Aleutian
Pacific/Honolulu	(GMT-10:00) Hawaii
Pacific/Marquesas	(GMT-09:30) Marquesas Islands
Pacific/Gambier	(GMT-09:00) Gambier Islands
America/Anchorage	(GMT-09:00) Alaska
America/Ensenada	(GMT-08:00) Tijuana, Baja California
Pacific/Pitcairn	(GMT-08:00) Pitcairn Islands
America/Los_Angeles	(GMT-08:00) Pacific Time (US & Canada)
America/Denver	(GMT-07:00) Mountain Time (US & Canada)
America/Chihuahua	(GMT-07:00) Chihuahua, La Paz, Mazatlan
America/Dawson_Creek	(GMT-07:00) Arizona
America/Belize	(GMT-06:00) Saskatchewan, Central America
America/Cancun	(GMT-06:00) Guadalajara, Mexico City, Monterrey
Chile/EasterIsland	(GMT-06:00) Easter Island
America/Chicago	(GMT-06:00) Central Time (US & Canada)
America/New_York	(GMT-05:00) Eastern Time (US & Canada)
America/Havana	(GMT-05:00) Cuba
America/Bogota	(GMT-05:00) Bogota, Lima, Quito, Rio Branco
America/Caracas	(GMT-04:30) Caracas
America/Santiago	(GMT-04:00) Santiago
America/La_Paz	(GMT-04:00) La Paz
Atlantic/Stanley	(GMT-04:00) Faukland Islands
America/Campo_Grande	(GMT-04:00) Brazil
America/Goose_Bay	(GMT-04:00) Atlantic Time (Goose Bay)
America/Glace_Bay	(GMT-04:00) Atlantic Time (Canada)
America/St_Johns	(GMT-03:30) Newfoundland
America/Araguaina	(GMT-03:00) UTC-3
America/Montevideo	(GMT-03:00) Montevideo
America/Miquelon	(GMT-03:00) Miquelon, St. Pierre
America/Godthab	(GMT-03:00) Greenland
America/Argentina/Buenos_Aires	(GMT-03:00) Buenos Aires
America/Sao_Paulo	(GMT-03:00) Brasilia
America/Noronha	(GMT-02:00) Mid-Atlantic
Atlantic/Cape_Verde	(GMT-01:00) Cape Verde Is.
Atlantic/Azores	(GMT-01:00) Azores
Europe/Belfast	(GMT) Greenwich Mean Time : Belfast
Europe/Dublin	(GMT) Greenwich Mean Time : Dublin
Europe/Lisbon	(GMT) Greenwich Mean Time : Lisbon
Europe/London	(GMT) Greenwich Mean Time : London
Africa/Abidjan	(GMT) Monrovia, Reykjavik
Europe/Amsterdam	(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna
Europe/Belgrade	(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague
Europe/Brussels	(GMT+01:00) Brussels, Copenhagen, Madrid, Paris
Africa/Algiers	(GMT+01:00) West Central Africa
Africa/Windhoek	(GMT+01:00) Windhoek
Asia/Beirut	(GMT+02:00) Beirut
Africa/Cairo	(GMT+02:00) Cairo
Asia/Gaza	(GMT+02:00) Gaza
Africa/Blantyre	(GMT+02:00) Harare, Pretoria
Asia/Jerusalem	(GMT+02:00) Jerusalem
Europe/Minsk	(GMT+02:00) Minsk
Asia/Damascus	(GMT+02:00) Syria
Europe/Moscow	(GMT+03:00) Moscow, St. Petersburg, Volgograd
Africa/Addis_Ababa	(GMT+03:00) Nairobi
Asia/Tehran	(GMT+03:30) Tehran
Asia/Dubai	(GMT+04:00) Abu Dhabi, Muscat
Asia/Yerevan	(GMT+04:00) Yerevan
Asia/Kabul	(GMT+04:30) Kabul
Asia/Yekaterinburg	(GMT+05:00) Ekaterinburg
Asia/Tashkent	(GMT+05:00) Tashkent
Asia/Kolkata	(GMT+05:30) Chennai, Kolkata, Mumbai, New Delhi
Asia/Katmandu	(GMT+05:45) Kathmandu
Asia/Dhaka	(GMT+06:00) Astana, Dhaka
Asia/Novosibirsk	(GMT+06:00) Novosibirsk
Asia/Rangoon	(GMT+06:30) Yangon (Rangoon)
Asia/Bangkok	(GMT+07:00) Bangkok, Hanoi, Jakarta
Asia/Krasnoyarsk	(GMT+07:00) Krasnoyarsk
Asia/Hong_Kong	(GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi
Asia/Irkutsk	(GMT+08:00) Irkutsk, Ulaan Bataar
Australia/Perth	(GMT+08:00) Perth
Australia/Eucla	(GMT+08:45) Eucla
Asia/Tokyo	(GMT+09:00) Osaka, Sapporo, Tokyo
Asia/Seoul	(GMT+09:00) Seoul
Asia/Yakutsk	(GMT+09:00) Yakutsk
Australia/Adelaide	(GMT+09:30) Adelaide
Australia/Darwin	(GMT+09:30) Darwin
Australia/Brisbane	(GMT+10:00) Brisbane
Australia/Hobart	(GMT+10:00) Hobart
Asia/Vladivostok	(GMT+10:00) Vladivostok
Australia/Lord_Howe	(GMT+10:30) Lord Howe Island
Pacific/Noumea	(GMT+11:00) Solomon Is., New Caledonia
Asia/Magadan	(GMT+11:00) Magadan
Pacific/Norfolk	(GMT+11:30) Norfolk Island
Asia/Anadyr	(GMT+12:00) Anadyr, Kamchatka
Pacific/Auckland	(GMT+12:00) Auckland, Wellington
Pacific/Fiji	(GMT+12:00) Fiji, Kamchatka, Marshall Is.
Pacific/Chatham	(GMT+12:45) Chatham Islands
Pacific/Tongatapu	(GMT+13:00) Nuku'alofa
Pacific/Kiritimati	(GMT+14:00) Kiritimati