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": []
},
"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"
}
}
}
]
}
}
}
}Returns the registration requirements some general information for a specific TLD. The response contains a detailed description of eligibility criteria and a fields object with all required and optional fields, including validation rules, conditional logic, and nested field structures. Provide the TLD as a path parameter to retrieve its complete registration requirements. Useful when you only need details for one TLD (e.g., when a user selects .fr from a dropdown).
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": []
},
"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"
}
}
}
]
}
}
}
}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.
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.
"fr"
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.
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
The TLD this information relates to.
".fr"
Whether the TLD is a Country Code TLD.
true
Whether the TLD supports implementing a Transfer Lock.
true
Whether the TLD supports DNSSEC.
true
Whether there are premium domains for this TLD.
true
Whether the TLD supports WHOIS Privacy.
true
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.
true
The number of days you have to renew your domain after it has expired, but before it is removed from your account.
25
The years that a domain is allowed to be registered for.
[1, 3, 5, 8, 10]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.
true
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.
3
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.
5
The registry that operates the given TLD.
"verisign"
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 [].
registration, landrush_eap, landrush_auction_a, landrush_reserve_a ["registration"]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
A detailed description of the registration requirements for this TLD, including eligibility criteria, restrictions, and important notes.
"Required fields to register an .fr domain"
An object containing all required and optional fields for domain registration, with their validation rules and conditional logic.
Show child attributes
A field definition for TLD registration requirements, including validation rules, conditional logic, and nested field structures.
Show child attributes
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
string, notice, acknowledgement, enum, boolean "string"
Whether this field is mandatory for domain registration. If true, the field must be provided.
true
A detailed description of what this field is for and any specific requirements or constraints.
"First name of registrant"
A user-friendly label for this field that can be used in UI forms.
"First Name"
Validation rule to apply to this field. Common validations include 'valid_email', 'valid_phone', etc.
"valid_email"
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
The actual value of this option. This is what must be submitted when this option is selected.
"no"
A user-friendly label for this option that can be displayed in UI forms.
"I am an individual"
When this option is selected, these nested fields become relevant and may be required. This allows for conditional field logic.
Show child attributes
{
"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"]
}
}For conditional fields, specifies when this field becomes required (e.g., when a parent option has a specific value).
"FR"
For acknowledgement fields, this is the value that must be submitted when the user acknowledges the requirement.
"accepted"
Was this page helpful?