Skip to main content
GET
/
core
/
v1
/
domaininfo
/
requirements
/
{tld}
Get Specific TLD Requirements
curl --request GET \
  --url https://api.dev.name.com/core/v1/domaininfo/requirements/{tld} \
  --header 'Authorization: Basic <encoded-value>'
{ "tldInfo": { "tld": "fr", "ccTld": true, "supportsTransferLock": true, "supportsDnssec": true, "supportsPremium": true, "supportsPrivacy": true, "requiresPreDelegation": true, "expirationGracePeriod": 3, "idnLanguages": {}, "allowedRegistrationYears": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "hsts": false, "minDomainLength": 5, "minIdnDomainLength": 5, "registryOperator": "registryfr", "claimsCheckRequired": [] }, "contacts": { "description": "The contacts required to be submitted for registration", "type": "string", "required": true, "label": "contacts", "fields": { "registrant": { "description": "Registrant contact requirements", "type": "string", "required": true, "fields": { "firstName": { "description": "First name of registrant contact", "type": "string", "required": true }, "lastName": { "description": "Last name of registrant contact", "type": "string", "required": true }, "address1": { "description": "First part of mailing address", "type": "string", "required": true }, "address2": { "description": "Second part of mailing address", "type": "string", "required": false }, "companyName": { "description": "Company name of registrant contact", "type": "string", "required": false }, "phone": { "description": "Phone number of registrant contact", "type": "string", "required": true }, "fax": { "description": "Fax number of registrant contact", "type": "string", "required": false }, "email": { "description": "Email address of registrant contact", "type": "string", "required": true, "validation": "valid_email" }, "city": { "description": "City of registrant contact", "type": "string", "required": true }, "state": { "description": "State/Province of registrant. Only values from this list are allowed", "type": "string", "required": true }, "zip": { "description": "Postal code of registrant contact", "type": "string", "required": true }, "country": { "description": "Country of registrant, only options in this list are allowed", "type": "enum", "required": true, "options": [ { "value": "AT", "label": "Austria" }, { "value": "AX", "label": "Åland Islands" }, { "value": "BE", "label": "Belgium" }, { "value": "BG", "label": "Bulgaria" }, { "value": "CH", "label": "Switzerland" }, { "value": "CY", "label": "Cyprus" }, { "value": "CZ", "label": "Czech Republic" }, { "value": "DE", "label": "Germany" }, { "value": "DK", "label": "Denmark" }, { "value": "EE", "label": "Estonia" }, { "value": "ES", "label": "Spain" }, { "value": "FI", "label": "Finland" }, { "value": "FR", "label": "France" }, { "value": "GF", "label": "Guiana" }, { "value": "GP", "label": "Guadeloupe" }, { "value": "GR", "label": "Greece" }, { "value": "HU", "label": "Hungary" }, { "value": "IE", "label": "Ireland" }, { "value": "IS", "label": "Iceland" }, { "value": "IT", "label": "Italy" }, { "value": "LI", "label": "Liechtenstein" }, { "value": "LT", "label": "Lithuania" }, { "value": "LU", "label": "Luxembourg" }, { "value": "LV", "label": "Latvia" }, { "value": "MQ", "label": "Martinique" }, { "value": "MT", "label": "Malta" }, { "value": "NC", "label": "New Caledonia" }, { "value": "NL", "label": "Netherlands" }, { "value": "NO", "label": "Norway" }, { "value": "PF", "label": "Polynesia (French)" }, { "value": "PL", "label": "Poland" }, { "value": "PM", "label": "St. Pierre & Miquelon" }, { "value": "PT", "label": "Portugal" }, { "value": "RE", "label": "Reunion" }, { "value": "RO", "label": "Romania" }, { "value": "SE", "label": "Sweden" }, { "value": "SI", "label": "Slovenia" }, { "value": "SK", "label": "Slovakia" }, { "value": "TF", "label": "French Southern and Antarctic Lands" }, { "value": "WF", "label": "Wallis & Futuna Is." }, { "value": "YT", "label": "Mayotte" } ] } } }, "tech": { "description": "Technical contact requirements", "type": "string", "required": true, "fields": { "firstName": { "description": "First name of tech contact", "type": "string", "required": true }, "lastName": { "description": "Last name of tech contact", "type": "string", "required": true }, "address1": { "description": "First part of mailing address", "type": "string", "required": true }, "address2": { "description": "Second part of mailing address", "type": "string", "required": false }, "companyName": { "description": "Required company name of tech contact", "type": "string", "required": true }, "phone": { "description": "Phone number of tech contact", "type": "string", "required": true }, "fax": { "description": "Fax number of tech contact", "type": "string", "required": false }, "email": { "description": "Email address of tech contact", "type": "string", "required": true, "validation": "valid_email" }, "city": { "description": "City of tech contact", "type": "string", "required": true }, "state": { "description": "State/Province of tech contact. Only values from this list are allowed", "type": "string", "required": true }, "zip": { "description": "Postal code of tech contact", "type": "string", "required": true }, "country": { "description": "Country of tech contact", "type": "enum", "required": true } } } } }, "requirements": { "description": "Registration requirements for .fr domains", "fields": { "firstName": { "description": "First name of registrant", "type": "string", "required": true }, "lastName": { "description": "Last name of registrant", "type": "string", "required": true }, "address1": { "description": "First part of mailing address", "type": "string", "required": true }, "address2": { "description": "Second part of mailing address", "type": "string", "required": false }, "companyName": { "description": "Company name of registrant", "type": "string", "required": false }, "phone": { "description": "Phone number of registrant", "type": "string", "required": true }, "fax": { "description": "Fax number of registrant", "type": "string", "required": false }, "email": { "description": "Email address of registrant", "type": "string", "required": true, "validation": "valid_email" }, "city": { "description": "City of registrant", "type": "string", "required": true }, "state": { "description": "State/Province of registrant", "type": "string", "required": true }, "zip": { "description": "Postal code of registrant", "type": "string", "required": true }, "country": { "description": "Country of registrant, only options in this list are allowed", "type": "enum", "required": true, "options": [ { "value": "AT", "label": "Austria" }, { "value": "AX", "label": "Åland Islands" }, { "value": "BE", "label": "Belgium" }, { "value": "BG", "label": "Bulgaria" }, { "value": "CH", "label": "Switzerland" }, { "value": "CY", "label": "Cyprus" }, { "value": "CZ", "label": "Czech Republic" }, { "value": "DE", "label": "Germany" }, { "value": "DK", "label": "Denmark" }, { "value": "EE", "label": "Estonia" }, { "value": "ES", "label": "Spain" }, { "value": "FI", "label": "Finland" }, { "value": "FR", "label": "France" }, { "value": "GF", "label": "Guiana" }, { "value": "GP", "label": "Guadeloupe" }, { "value": "GR", "label": "Greece" }, { "value": "HU", "label": "Hungary" }, { "value": "IE", "label": "Ireland" }, { "value": "IS", "label": "Iceland" }, { "value": "IT", "label": "Italy" }, { "value": "LI", "label": "Liechtenstein" }, { "value": "LT", "label": "Lithuania" }, { "value": "LU", "label": "Luxembourg" }, { "value": "LV", "label": "Latvia" }, { "value": "MQ", "label": "Martinique" }, { "value": "MT", "label": "Malta" }, { "value": "NC", "label": "New Caledonia" }, { "value": "NL", "label": "Netherlands" }, { "value": "NO", "label": "Norway" }, { "value": "PF", "label": "Polynesia (French)" }, { "value": "PL", "label": "Poland" }, { "value": "PM", "label": "St. Pierre & Miquelon" }, { "value": "PT", "label": "Portugal" }, { "value": "RE", "label": "Reunion" }, { "value": "RO", "label": "Romania" }, { "value": "SE", "label": "Sweden" }, { "value": "SI", "label": "Slovenia" }, { "value": "SK", "label": "Slovakia" }, { "value": "TF", "label": "French Southern and Antarctic Lands" }, { "value": "WF", "label": "Wallis & Futuna Is." }, { "value": "YT", "label": "Mayotte" } ] }, "business": { "description": "", "type": "enum", "required": true, "label": "business", "options": [ { "value": "no", "label": "I am an individual", "fields": { "X-FR-BIRTHDATE": { "description": "", "type": "string", "required": false, "label": "Date of Birth (YYYY-MM-DD)" }, "X-FR-BIRTHPLACE": { "description": "", "type": "string", "required": true, "label": "Birth Country (2 Letter Code)", "fields": { "X-FR-BIRTHCITY": { "description": "", "type": "string", "required": false, "label": "Birth City", "required_when": "FR" }, "X-FR-BIRTHPC": { "description": "", "type": "string", "required": false, "label": "Birth Postal Code", "required_when": "FR" } } } } }, { "value": "yes", "label": "I am an organization", "fields": { "X-FR-LOCAL": { "description": "Local company registration #, or tax ID", "type": "string", "required": false, "label": "Local company registration #, or tax ID" } } } ] } } } }

Authorizations

​
Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Path Parameters

​
tld
string
required

TLD indicates which domain requirements to retrieve (without the dot prefix, e.g., 'fr' for .fr domains). For punycode TLDs, use the ASCII version instead of the UTF-8. So for the онлайн TLD, you would submit xn--80asehdb.

Pattern: ^((?!xn--)[a-z0-9-]{1,63}|xn--[a-z0-9-]{1,63})((?:\.(?!-)[a-z0-9-]{1,63})|(?:\.xn--[a-z0-9-]{1,63}))*$
Example:

"fr"

Response

The complete registration requirements for the specified TLD.

GetRequirementResponse has TLD Info and registration requirements for the specified TLD. The requirements field will always be present but may be an empty object when no specific requirements exist for the TLD.

​
tldInfo
object
required

General information about a specific TLD. These are not registration requirements, but contain useful information for domain reseller and domain registrants in general.

​
contacts
object
required

The registration requirements for the contacts for this TLD, including required fields, validation rules, and conditional logic. This field will always be present but may be an empty object when no specific requirements exist for the TLD. Only a few CC Tlds have specific contact requirements. These contacts must be submitted as part of the domain object when registering a domain, and not part of the tldRequirements parameter. Please check the contact requirements carefully, as different fields may be required for different roles, and there may be additional validation rules that must be followed.

​
requirements
object
required

The registration requirements for this TLD, including required fields, validation rules, and conditional logic. This field will always be present but may be an empty object when no specific requirements exist for the TLD.