API Format Additional Data
From Openprovider API documentation
(Difference between revisions)
												
			
		 (→Format specification > additionalData)  | 
		|||
| Line 302: | Line 302: | ||
|Mandatory for IDN domains  | |Mandatory for IDN domains  | ||
possible values: 'hin-deva'  | possible values: 'hin-deva'  | ||
| + | |colspan="2" style="background-color:#EEEEEE;"|'''.ngo'''  | ||
| + | |-  | ||
| + | |'''sendVerificationEmail'''  | ||
| + | |This indicates if you let Openprovider send the verification e-mail to the registrant, inviting him to start the verification process. This e-mail originates from "Registrar.eu" and will not contain the name of Openprovider. If you want to send this invitation yourself, set option to 0 and inform the registrant within 24 hours.  | ||
| + | Possible values:  | ||
| + | * '1'  | ||
| + | * '0'  | ||
| + | |'''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'  | ||
| + | |-  | ||
|}  | |}  | ||
Revision as of 08:39, 14 March 2019
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: 
  | ||||
| eligibilityType | Specify what makes the registrant eligible to register the .com.au, .net.au, .org.au or .id.au domain name.
 Possible values: 
  | ||||
| idType | This indicates the type of document/registration of the provided ID number.
 Possible values: 
  | ||||
| .ca | |||||
| legalType | possible values:
  | ||||
| .com, .net | |||||
| idnScript | Optional: Only necessary for IDN domains
 possible values: 
  | ||||
| .org | |||||
| idnScript | Optional: Only necessary for IDN domains
 possible values: 
  | ||||
| .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 | ||||
| .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: 
  | ||||
| .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: 
  | ||||
| .संगठन (xn--i1b6b1a6a2e) | |||||
| idnScript | Mandatory for IDN domains
 possible values: 'hin-deva'  | .ngo | |||
| sendVerificationEmail | This indicates if you let Openprovider send the verification e-mail to the registrant, inviting him to start the verification process. This e-mail originates from "Registrar.eu" and will not contain the name of Openprovider. If you want to send this invitation yourself, set option to 0 and inform the registrant within 24 hours.
 Possible values: 
  | ngoOngEligibilityAcceptance |  Confirmation that the registrant is eligible to register this domain. Mandatory for registration.
 Possible values: 
  | ngoOngPolicyAcceptance |  Confirmation that the registrant is aware of and acts according to the domain registration policies. Mandatory for registration.
 Possible values: 
  |