The Doctavian API accepts locale and timezone values across Document Generation and Digital Signatures — controlling number, date, and currency formatting, and how timestamps are displayed to recipients. This page is the complete, authoritative list of accepted values.
The locale field controls number, date, and currency formatting. It also drives translation selection when using Template Labels. Accepted values are listed below.
| Code | Locale |
|---|---|
af | Afrikaans (South Africa) |
am | Amharic (Ethiopia) |
ar-AE | Arabic (United Arab Emirates) |
ar-BH | Arabic (Bahrain) |
ar-DZ | Arabic (Algeria) |
ar-EG | Arabic (Egypt) |
ar-IQ | Arabic (Iraq) |
ar-JO | Arabic (Jordan) |
ar-KW | Arabic (Kuwait) |
ar-LB | Arabic (Lebanon) |
ar-LY | Arabic (Libya) |
ar-MA | Arabic (Morocco) |
ar-OM | Arabic (Oman) |
ar-QA | Arabic (Qatar) |
ar-SA | Arabic (Saudi Arabia) |
ar-SD | Arabic (Sudan) |
ar-SY | Arabic (Syria) |
ar-TN | Arabic (Tunisia) |
ar-YE | Arabic (Yemen) |
az | Azerbaijani (Azerbaijan) |
be | Belarusian (Belarus) |
bg | Bulgarian (Bulgaria) |
bn | Bengali (Bangladesh) |
bn-IN | Bengali (India) |
bs | Bosnian (Bosnia and Herzegovina) |
ca | Catalan (Spain) |
cs | Czech (Czech Republic) |
cy | Welsh (United Kingdom) |
da | Danish (Denmark) |
de-AT | German (Austria) |
de-BE | German (Belgium) |
de-CH | German (Switzerland) |
de | German (Germany) |
de-LU | German (Luxembourg) |
dz | Dzongkha (Butan) |
el | Greek (Greece) |
en-AG | English (Antigua & Barbuda) |
en-AU | English (Australia) |
en-BB | English (Barbados) |
en-BM | English (Bermuda) |
en-BS | English (Bahamas) |
en-BW | English (Botswana) |
en-BZ | English (Belize) |
en-CA | English (Canada) |
en-CM | English (Cameroon) |
en-ER | English (Eritrea) |
en-FJ | English (Fiji) |
en-FK | English (Falkland Islands) |
en-GB | English (United Kingdom) |
en-GH | English (Ghana) |
en-GI | English (Gibraltar) |
en-GM | English (Gambia) |
en-GY | English (Guyana) |
en-HK | English (Hong Kong SAR China) |
en-ID | English (Indonesia) |
en-IE | English (Ireland) |
en-IN | English (India) |
en-JM | English (Jamaica) |
en-KE | English (Kenya) |
en-KY | English (Cayman Islands) |
en-LR | English (Liberia) |
en-MG | English (Madagascar) |
en-MU | English (Mauritius) |
en-MW | English (Malawi) |
en-MY | English (Malaysia) |
en-NA | English (Namibia) |
en-NG | English (Nigeria) |
en-NZ | English (New Zealand) |
en-PG | English (Papua New Guinea) |
en-PH | English (Philippines) |
en-PK | English (Pakistan) |
en-RW | English (Rwanda) |
en-SB | English (Solomon Islands) |
en-SC | English (Seychelles) |
en-SG | English (Singapore) |
en-SH | English (St. Helena) |
en-SL | English (Sierra Leone) |
en-SX | English (Sint Maarten) |
en-SZ | English (Eswatini) |
en-TO | English (Tonga) |
en-TT | English (Trinidad & Tobago) |
en-TZ | English (Tanzania) |
en-UG | English (Uganda) |
en-US-POSIX | English (United States) |
en-VU | English (Vanuatu) |
en-WS | English (Samoa) |
en-ZA | English (South Africa) |
es-AR | Spanish (Argentina) |
es-BO | Spanish (Bolivia) |
es-CL | Spanish (Chile) |
es-CO | Spanish (Colombia) |
es-CR | Spanish (Costa Rica) |
es-CU | Spanish (Cuba) |
es-DO | Spanish (Dominican Republic) |
es-EC | Spanish (Ecuador) |
es | Spanish (Spain) |
es-GT | Spanish (Guatemala) |
es-HN | Spanish (Honduras) |
es-MX | Spanish (Mexico) |
es-NI | Spanish (Nicaragua) |
es-PA | Spanish (Panama) |
es-PE | Spanish (Peru) |
es-PR | Spanish (Puerto Rico) |
es-PY | Spanish (Paraguay) |
es-SV | Spanish (El Salvador) |
es-US | Spanish (United States) |
es-UY | Spanish (Uruguay) |
es-VE | Spanish (Venezuela) |
et | Estonian (Estonia) |
eu | Basque (Spain) |
fa | Persian (Iran) |
fi | Finnish (Finland) |
fr-BE | French (Belgium) |
fr-CA | French (Canada) |
fr-CH | French (Switzerland) |
fr | French (France) |
fr-GN | French (Guinea) |
fr-HT | French (Haiti) |
fr-KM | French (Comoros) |
fr-LU | French (Luxembourg) |
fr-MC | French (Monaco) |
fr-MR | French (Mauritania) |
fr-WF | French (Wallis & Futuna) |
ga | Irish (Ireland) |
gu | Gujarati (India) |
haw | Hawaiian (United States) |
hi | Hindi (India) |
hr | Croatian (Croatia) |
hu | Hungarian (Hungary) |
hy | Armenian (Armenia) |
is | Icelandic (Iceland) |
it-CH | Italian (Switzerland) |
it | Italian (Italy) |
ja | Japanese (Japan) |
ka | Georgian (Georgia) |
kk | Kazakh (Kazakhstan) |
km | Khmer (Cambodia) |
kn | Kannada (India) |
ko-KP | Korean (North Korea) |
ko | Korean (South Korea) |
ky | Kyrgyz (Kyrgyzstan) |
lb | Luxembourgish (Luxembourg) |
lo | Lao (Laos) |
lt | Lithuanian (Lithuania) |
lu | Luba-Katanga (Congo - Kinshasa) |
lv | Latvian (Latvia) |
mi | Maori (New Zealand) |
mk | Macedonian (Macedonia) |
ml | Malayalam (India) |
mr | Marathi (India) |
ms-BN | Malay (Brunei) |
ms | Malay (Malaysia) |
mt | Maltese (Malta) |
my | Burmese (Myanmar [Burma]) |
ne | Nepali (Nepal) |
nl-AW | Dutch (Aruba) |
nl-BE | Dutch (Belgium) |
nl | Dutch (Netherlands) |
nl-SR | Dutch (Suriname) |
no | Norwegian (Norway) |
pl | Polish (Poland) |
ps | Pashto (Afghanistan) |
pt-AO | Portuguese (Angola) |
pt | Portuguese (Brazil) |
pt-CV | Portuguese (Cape Verde) |
pt-MZ | Portuguese (Mozambique) |
pt-PT | Portuguese (Portugal) |
pt-ST | Portuguese (Sao Tome & Principe) |
rm | Romansh (Switzerland) |
rn | Rundi (Burundi) |
ro-MD | Romanian (Moldova) |
ro | Romanian (Romania) |
ru-BY | Russian (Belarus) |
ru-KG | Russian (Kyrgyzstan) |
ru-KZ | Russian (Kazakhstan) |
ru-MD | Russian (Moldova) |
ru | Russian (Russia) |
ru-UA | Russian (Ukraine) |
sk | Slovak (Slovakia) |
sl | Slovenian (Slovenia) |
so-DJ | Somali (Djibouti) |
so | Somali (Somalia) |
sq | Albanian (Albania) |
sr-Cyrl | Serbian (Cyrillic) (Serbia) |
sr | Serbian (Serbia) |
sv | Swedish (Sweden) |
sw-KE | Swahili (Kenya) |
ta | Tamil (India) |
ta-LK | Tamil (Sri Lanka) |
te | Telugu (India) |
tg | Tajik (Tajikistan) |
th | Thai (Thailand) |
ti | Tigrinya (Ethiopia) |
tr | Turkish (Turkey) |
uk | Ukrainian (Ukraine) |
ur | Urdu (Pakistan) |
uz | Uzbek (Latin, Uzbekistan) |
yo-BJ | Yoruba (Benin) |
zh | Chinese (China) |
zh-Hant-HK | Chinese (Hong Kong) |
zh-Hant-MO | Chinese (Macao) |
zh-Hans-MY | Chinese (Malaysia) |
zh-Hans-SG | Chinese (Singapore) |
zh-Hant | Chinese Traditional |
zu | Zulu (South Africa) |
The timezone field controls how date and time values are displayed — for example, the signing timestamp on a completed envelope, or a date field in a generated document. Accepted values are IANA time zone identifiers.
| Identifier | Description |
|---|---|
Etc/GMT+12 | UTC -12:00 (Etc/GMT+12) |
Pacific/Pago_Pago | UTC -11:00 (Pacific/Pago Pago) |
Pacific/Honolulu | UTC -10:00 (Pacific/Honolulu) |
America/Anchorage | UTC -09:00 (America/Anchorage) |
America/Los_Angeles | UTC -08:00 (America/Los Angeles) |
America/Denver | UTC -07:00 (America/Denver) |
America/Chicago | UTC -06:00 (America/Chicago) |
America/New_York | UTC -05:00 (America/New York) |
America/Halifax | UTC -04:00 (America/Halifax) |
America/St_Johns | UTC -03:30 (America/St Johns) |
America/Argentina/Buenos_Aires | UTC -03:00 (America/Argentina/Buenos Aires) |
Atlantic/South_Georgia | UTC -02:00 (Atlantic/South Georgia) |
Atlantic/Azores | UTC -01:00 (Atlantic/Azores) |
Europe/London | UTC +00:00 (Europe/London) |
Europe/Paris | UTC +01:00 (Europe/Paris) |
Europe/Zagreb | UTC +01:00 (Europe/Zagreb) |
Europe/Athens | UTC +02:00 (Europe/Athens) |
Europe/Moscow | UTC +03:00 (Europe/Moscow) |
Asia/Dubai | UTC +04:00 (Asia/Dubai) |
Asia/Kabul | UTC +04:30 (Asia/Kabul) |
Asia/Karachi | UTC +05:00 (Asia/Karachi) |
Asia/Kolkata | UTC +05:30 (Asia/Kolkata) |
Asia/Kathmandu | UTC +05:45 (Asia/Kathmandu) |
Asia/Dhaka | UTC +06:00 (Asia/Dhaka) |
Asia/Yangon | UTC +06:30 (Asia/Yangon) |
Asia/Bangkok | UTC +07:00 (Asia/Bangkok) |
Asia/Singapore | UTC +08:00 (Asia/Singapore) |
Asia/Tokyo | UTC +09:00 (Asia/Tokyo) |
Australia/Darwin | UTC +09:30 (Australia/Darwin) |
Australia/Sydney | UTC +10:00 (Australia/Sydney) |
Australia/Lord_Howe | UTC +10:30 (Australia/Lord Howe) |
Pacific/Noumea | UTC +11:00 (Pacific/Noumea) |
Pacific/Auckland | UTC +12:00 (Pacific/Auckland) |
Pacific/Chatham | UTC +12:45 (Pacific/Chatham) |
Pacific/Apia | UTC +13:00 (Pacific/Apia) |
Pacific/Kiritimati | UTC +14:00 (Pacific/Kiritimati) |