Get Specific TLD Requirements

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.

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.

Show child attributes

tldInfo.tld

string

required

The TLD this information relates to.

Example:

".fr"

tldInfo.ccTld

boolean

required

Whether the TLD is a Country Code TLD.

Example:

true

tldInfo.supportsTransferLock

boolean

required

Whether the TLD supports implementing a Transfer Lock.

Example:

true

tldInfo.supportsDnssec

boolean

required

Whether the TLD supports DNSSEC.

Example:

true

tldInfo.supportsPremium

boolean

required

Whether there are premium domains for this TLD.

Example:

true

tldInfo.supportsPrivacy

boolean

required

Whether the TLD supports WHOIS Privacy.

Example:

true

tldInfo.requiresPreDelegation

boolean

required

Whether this TLD requires pre-delegation. If this is true, these domains must be added to the name servers before the domain creation is completed.

Example:

true

tldInfo.expirationGracePeriod

number<int32>

required

The number of days you have to renew your domain after it has expired, but before it is removed from your account.

Example:

25

tldInfo.allowedRegistrationYears

number[]

required

The years that a domain is allowed to be registered for.

Example:

[1, 3, 5, 8, 10]

tldInfo.idnLanguages

object

required

The IND Languages that the TLD supports (if any).

Show child attributes

tldInfo.idnLanguages.{key}

string

Example:

{
  "DE": "German",
  "DK": "Danish",
  "ES": "Spanish",
  "IT": "Italian",
  "JP": "Japanese"
}

tldInfo.hsts

boolean

required

The entire TLD namespace has been added to the HSTS Preload list. As such, all second-level domains under .TLD will only load on modern browsers if a valid SSL certificate has been configured and the webserver is serving HTTPS.

Example:

true

tldInfo.minDomainLength

number<int32>

required

The minimum allowed length for the second level domain (SLD) for a given TLD. The SLD would be the example part of example.com. Attempts to register a domain with a shorter length than allowed will result in a failure of a Create Domain request.

Example:

3

tldInfo.minIdnDomainLength

number<int32> | null

required

The minimum allowed length for the second level domain (SLD) that utilizes an IDN character for a given TLD. The SLD would be the èxample part of èxample.com. Attempts to register a domain with a shorter length than allowed will result in a failure of a Create Domain request. This value will often be different from the minDomainLength for non-IDN registrations. This parameter will return as null for any TLDs that do not support IDN registrations.

Example:

5

tldInfo.registryOperator

string

required

The registry that operates the given TLD.

Example:

"verisign"

tldInfo.claimsCheckRequired

enum<string>[]

required

Array of valid purchase types if claims check is required for this TLD for current date/time. If claims checking is required, returns an array of valid purchase types (e.g., ["registration", "landrush_eap"]). If claims checking is not required, returns an empty array [].

Available options:

registration,

landrush_eap,

landrush_auction_a,

landrush_reserve_a

Example:

["registration"]

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.

Show child attributes

requirements.description

string

A detailed description of the registration requirements for this TLD, including eligibility criteria, restrictions, and important notes.

Example:

"Required fields to register an .fr domain"

requirements.fields

object

An object containing all required and optional fields for domain registration, with their validation rules and conditional logic.

Show child attributes

requirements.fields.{key}

object

A field definition for TLD registration requirements, including validation rules, conditional logic, and nested field structures.

Show child attributes

requirements.fields.{key}.type

enum<string>

required

The requirement type of this field. Each requirement type has different information.

Possible values and their details:

string: These are open string fields that cannot be submitted as empty. They will always have a label. A description is optional as the label may convey all of the required information the user would need to submit. Note: Some string fields may have a required format (i.e. date format of YYYY/MM/DD). The format will be listed in the "validation" parameter if required. Example TLDs: abogado, law, com.br (and more)
notice: These field types will just have a description, and contain information that must be displayed to the user prior to registration. There is no data that will be required to be submitted, so all notice type fields will have a "required" value of false. Example TLDs: at (notice only), ca (1 notice field)
acknowledgement: These field types will have a description, label and value. The description must be displayed to the user, the label is the required label for the acknowledgement, and the value is what must be submitted. Example TLDs: security, ngo, music (and more)
enum: The field types have a list of predefined options that the user must choose from in order to submit. Only the values returned in the "options" array will be allowed, or the request will fail validation. Options MAY include dependent fields, as some registries required additional information depending on what was chosen for the "parent" option. All dependent fields will follow the same field patterns as the parent fields. Options: These are the predefined options for the enum type fields. They will always have a label and a value. The value is what must be submitted. The options MAY include a description, but will mostly only have a label parameter. Note: There may be a single option returned for an enum. This is because that is the ONLY OPTION ALLOWED by the registry. Example TLDs with simple lists: ca, es (and more) Example TLDs with dependent fields: fr, se, com.br
boolean: Boolean fields for simple true/false acknowledgements or selections. Example TLDs: security

Available options:

string,

notice,

acknowledgement,

enum,

boolean

Example:

"string"

requirements.fields.{key}.required

required

Whether this field is mandatory for domain registration. If true, the field must be provided.

Example:

true

requirements.fields.{key}.description

string

A detailed description of what this field is for and any specific requirements or constraints.

Example:

"First name of registrant"

requirements.fields.{key}.label

string

A user-friendly label for this field that can be used in UI forms.

Example:

"First Name"

requirements.fields.{key}.validation

string | null

Validation rule to apply to this field. Common validations include 'valid_email', 'valid_phone', etc.

Example:

"valid_email"

requirements.fields.{key}.options

For fields with predefined choices, this can be either an array of complex option objects, a simple array of string values, or null if no options are available.

Show child attributes

requirements.fields.{key}.options.value

string

required

The actual value of this option. This is what must be submitted when this option is selected.

Example:

"no"

requirements.fields.{key}.options.label

string

A user-friendly label for this option that can be displayed in UI forms.

Example:

"I am an individual"

requirements.fields.{key}.options.fields

object

When this option is selected, these nested fields become relevant and may be required. This allows for conditional field logic.

Show child attributes

Example:

{
  "X-FR-BIRTHDATE": {
    "description": "DOB in format yy/mm/dd",
    "type": "string",
    "required": true
  },
  "X-FR-BIRTHPLACE": {
    "required": true,
    "description": "Nation of Birth",
    "type": "enum",
    "options": ["FR", "GB", "USA"]
  }
}

requirements.fields.{key}.required_when

string | null

For conditional fields, specifies when this field becomes required (e.g., when a parent option has a specific value).

Example:

"FR"

requirements.fields.{key}.fields

object

For complex fields or when options are selected, contains nested field definitions that become relevant.

Show child attributes

requirements.fields.{key}.fields.{key}

object

Show child attributes

requirements.fields.{key}.value

string | null

For acknowledgement fields, this is the value that must be submitted when the user acknowledges the requirement.

Example:

"accepted"

API Home

Guides & Flows

Core API Overview

name.com Core API Reference

Resources

Authorizations

Path Parameters

Response