API Format Additional Data

From Openprovider API documentation

Revision as of 19:10, 3 September 2025 by WikiSysop (Talk | contribs)

(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)

Format specification > additionalData

Overview of additional data fields that might be required for domain registration per TLD. Mandatory fields are in bold.

value	content
.id.au, com.au, .net.au, .org.au
eligibilityTypeRelationship	This indicates the relationship between the Eligibility Type (e.g. business name#) and domain name. Specify the Policy reference number as appropriate from the values below. Possible values: '1' (2LD Domain name is an exact match, an acronym or abbreviation of the company or trading name, organisation or association name, or trademark) '2' (2LD Domain Name is closely and substantially connected to the organisation or activities undertaken by the organisation.)
eligibilityType	Specify what makes the registrant eligible to register the .com.au, .net.au, .org.au or .id.au domain name. Possible values: 'Company' 'RegisteredBusiness' 'SoleTrader' 'Partnership' 'TrademarkOwner' 'PendingTMOwner' 'CitizenResident' 'IncorporatedAssociation' 'Club' 'NonProfitOrganisation' 'Charity' 'TradeUnion' 'IndustryBody' 'CommercialStatutoryBody' 'PoliticalParty' 'Other' 'Non-profit' 'Organisation' 'Charity' 'Citizen/Resident'
idType	This indicates the type of document/registration of the provided ID number. Possible values: 'ABN' (Australian Business Number) 'ACN' (Australian Company Number) 'ARBN' (Australian Registered Body Number) 'OTHER' (Specify ‘OTHER’ for Incorporated Association) 'TM' (Trademark) 'TAS' (Tasmania Business Number) 'VIC' (Victoria Business Number) 'NSW' (New South Wales Business Number) 'ACT' (Australian Capital Territory Business Number) 'QLD' (Queensland Business Number) 'NT' (Northern Territory Business Number) 'WA' (Western Australia Business Number) 'SA' (South Australia Business Number)
.ca
legalType	possible values: 'ABO' (Aboriginal Peoples indigenous to Canada) 'ASS' (Canadian Unincorporated Association) 'CCO' (Corporation (Canada or Canadian province or territory)) 'CCT' (Canadian citizen) 'EDU' (Canadian Educational Institution) 'GOV' (Government or government entity in Canada) 'HOP' (Canadian Hospital) 'INB' (Indian Band recognized by the Indian Act of Canada) 'LAM' (Canadian Library, Archive or Museum) 'LGR' (Legal Rep. of a Canadian Citizen or Permanent Resident) 'MAJ' (Her Majesty the Queen) 'OMK' (Official mark registered in Canada) 'PLT' (Canadian Political Party) 'PRT' (Partnership Registered in Canada) 'RES' (Permanent Resident of Canada) 'TDM' (Trade-mark registered in Canada (by a non-Canadian owner)) 'TRD' (Canadian Trade Union) 'TRS' (Trust established in Canada)
.uk, ltd.uk, co.uk, org.uk
legalType	This indicates legal form of *.uk domain owner Possible values: 'LTD' (UK Limited Company) 'PLC' (UK Public Limited Company) 'PTNR' (UK Partnership) 'STRA' (UK Sole Trader) 'LLP' (UK Limited Liability Partnership) 'IP' (UK Industrial/Provident Registered Company) 'IND' (UK Individual) 'SCH' (UK School) 'RCHAR' (UK Registered Charity) 'GOV' (UK Government Body) 'CRC' (UK Corporation by Royal Charter) 'STAT' (UK Statutory Body) 'OTHER' (Other UKEntity (e.g.clubs, associations, many universities))
.com, .net, .tv, .cc
idnScript	Optional: Only necessary for IDN domains possible values: 'AFR' (Afrikaans) 'ALB' (Albanian) 'ARA' (Arabic) 'ARG' (Aragonese) 'ARM' (Armenian) 'ASM' (Assamese) 'AST' (Asturian) 'AVE' (Avestan) 'AWA' (Awadhi) 'AZE' (Azerbaijani) 'BAN' (Balinese) 'BAL' (Baluchi) 'BAS' (Basa) 'BAK' (Bashkir) 'BAQ' (Basque) 'BEL' (Belarusian) 'BEN' (Bengali) 'BHO' (Bhojpuri) 'BOS' (Bosnian) 'BUL' (Bulgarian) 'BUR' (Burmese) 'CAR' (Carib) 'CAT' (Catalan) 'CHE' (Chechen) 'CHI' (Chinese) 'CHV' (Chuvash) 'COP' (Coptic) 'COS' (Corsican) 'SCR' (Croatian) 'CZE' (Czech) 'DAN' (Danish) 'DIV' (Divehi) 'DOI' (Dogri) 'DUT' (Dutch) 'ENG' (English) 'EST' (Estonian) 'FAO' (Faroese) 'FIJ' (Fijian) 'FIN' (Finnish) 'FRE' (French) 'FRI' (Frisian) 'GLA' (Gaelic) 'GEO' (Georgian) 'GER' (German) 'GON' (Gondi) 'GRE' (Greek) 'GUJ' (Gujarati) 'HEB' (Hebrew) 'HIN' (Hindi) 'HUN' (Hungarian) 'ICE' (Icelandic) 'INC' (Indic) 'IND' (Indonesian) 'INH' (Ingush) 'GLE' (Irish) 'ITA' (Italian) 'JPN' (Japanese) 'JAV' (Javanese) 'KAS' (Kashmiri) 'KAZ' (Kazakh) 'KHM' (Khmer) 'KIR' (Kirghiz) 'KOR' (Korean) 'KUR' (Kurdish) 'LAO' (Lao) 'LAV' (Latvian) 'LIT' (Lithuanian) 'LTZ' (Luxembourgisch) 'MAC' (Macedonian) 'MAL' (Malayalam) 'MAY' (Malay) 'MLT' (Maltese) 'MAO' (Maori) 'MOL' (Moldavian) 'MON' (Mongolian) 'NEP' (Nepali) 'NOR' (Norwegian) 'ORI' (Oriya) 'OSS' (Ossetian) 'PAN' (Panjabi) 'PER' (Persian) 'POL' (Polish) 'POR' (Portuguese) 'PUS' (Pushto) 'RAJ' (Rajasthani) 'RUM' (Romanian) 'RUS' (Russian) 'SMO' (Samoan) 'SAN' (Sanskrit) 'SRD' (Sardinian) 'SCC' (Serbian) 'SND' (Sindhi) 'SIN' (Sinhalese) 'SLO' (Slovak) 'SLV' (Slovenian) 'SOM' (Somali) 'SPA' (Spanish) 'SWA' (Swahili) 'SWE' (Swedish) 'SYR' (Syriac) 'TGK' (Tajik) 'TAM' (Tamil) 'TEL' (Telugu) 'THA' (Thai) 'TIB' (Tibetan) 'TUR' (Turkish) 'UKR' (Ukrainian) 'URD' (Urdu) 'UZB' (Uzbek) 'VIE' (Vietnamese) 'WEL' (Welsh) 'YID' (Yiddish)
.org
idnScript	Optional: Only necessary for IDN domains possible values: 'ZH-TW' (Chinese (Traditional)) 'ZH-CN' (Chinese (Simplified)) 'DA' (Danish) 'DE' (German) 'HU' (Hungarian) 'IS' (Icelandic) 'KO' (Korean (Hangul)) 'LV' (Latvian) 'LT' (Lithuanian) 'PL' (Polish) 'ES' (Spanish) 'SV' (Swedish) 'BS' (Bosnian) 'BG' (Bulgarian) 'BE' (Belarusian) 'MK' (Macedonian) 'RU' (Russian) 'SR' (Serbian) 'UK' (Ukrainian)
.top
idnScript	Optional: Only necessary for IDN domains possible values: 'AR' (Arabic) 'ZH' (Chinese) 'FR' (French) 'DE' (German) 'JA' (Japanese) 'RU' (Russian) 'ES' (Spanish)
.xxx
defensive	This field is optional, should be set to 1 to block domain (defensive registration by non-member of the "Sponsored Community")
.voto
votoAcceptance	This field is required, should be set to 1 to confirm acceptance of .voto registry policies
.dk
dkAcceptance	This field is required, should be set to 1 to confirm acceptance of .dk registry policy for create domain
.vote
voteAcceptance	This field is required, should be set to 1 to confirm acceptance of .vote registry policies
.scot, .eus, .gal. .cat, .barcelona
intendedUse	This field is required, should contain information on how the domain name will be used
idnScript	Optional: Only necessary for IDN domains possible values: 'Latn' (Latin)
domainNameVariants	This field is optional, should be an array of strings, representing appropriate domain variant names
.pl
intendedUse	This field is optional, and may contain information on how the domain name will be used
.شبكة (xn--ngbc5azd), .موقع (xn--4gbrim)
idnScript	Mandatory for IDN domains possible values: 'ar' (Arabic)
.cайт (xn--80aswg), .онлайн (xn--80asehdb)
idnScript	Mandatory for IDN domains possible values: 'Cyrl' (Cyrillic)
.democrat, .dance, .ninja, .social, .futbol, .reviews, .pub, .moda, .consulting, .rocks, .actor, .republican, .attorney, .lawyer, .airforce, .vet, .army, .navy, .mortgage, .market, .engineer, .software, .auction, .dentist, .rehab, .gives, .degree, .forsale, .rip, .band
idnScript	Optional: Only necessary for IDN domains possible values: 'fr','es'
.immobilien, .kaufen, .haus
idnScript	Optional: Only necessary for IDN domains possible values: 'fr' (French) 'es' (Spanish) 'de' (German)
.nrw
idnScript	Optional: Only necessary for IDN domains possible values: 'de' (German)
.travel
travelAcceptance	This field is required and acknowledges that the registrant is engaged in or plan to engage in activities related to travel. Value should be 0 or 1
.орг (xn--c1avg)
idnScript	Mandatory for IDN domains possible values: 'ru' (Russian)
.机构 (xn--nqv7f)
idnScript	Mandatory for IDN domains possible values: 'ZH-TW' (Chinese (Traditional)) 'ZH-CN' (Chinese (Simplified))
.संगठन (xn--i1b6b1a6a2e)
idnScript	Mandatory for IDN domains possible values: 'hin-deva'
.ngo, .ong
ngoOngEligibilityAcceptance	Confirmation that the registrant is eligible to register this domain. Mandatory for registration. Possible values: '1'
ngoOngPolicyAcceptance	Confirmation that the registrant is aware of and acts according to the domain registration policies. Mandatory for registration. Possible values: '1'
.ae
aeAcceptance	This field is required, should be set to 1 to confirm acceptance of .ae registry policies
.se
iisseAcceptance	This field is required, should be set to 1 to confirm acceptance of .se registry policies
.nu
iisseAcceptance	This field is required, should be set to 1 to confirm acceptance of .nu registry policies
.coop
coopAcceptance	This field is required, should be set to 1 to confirm acceptance of .coop registry policies
.gay
gayDonationAcceptance	Confirmation that the registrant acknowledges and agrees with the .gay donation program Possible values: '1'
gayRightsProtectionAcceptance	Confirmation that the registrant acknowledges and agrees with the .gay rights protection policy Possible values:
gTLDs
consentForPublishing	This field is optional. Applicable to: GTLD domains Consent for publishing private domain contacts data to registrar Whois/RDAP. Possible values: '0' (No) '1' (Yes)
iisseAcceptance	REST API field: domain_additional_data → iisse_acceptance Confirmation that the registrant accepts .SE/.NU registry policies. Possible values (string type): '0' (No) '1' (Yes)
dkAcceptance	REST API field: domain_additional_data → dk_acceptance Confirmation that the registrant accepts .DK registry policies. Possible values (string type): '0' (No) '1' (Yes)

API Format Additional Data

From Openprovider API documentation

Format specification > additionalData

Views

Personal tools