Submit new domain name registration order.
Note: This function is not available for sub users.
Name | Data Type | Status | Description |
auth-id | Integer | Required | Authentication parameter |
auth-password | String | Required | Authentication parameter |
domain-name | String | Required |
Name of the domain. For *.br domains it must be up to 26 symbols |
tld | String | Required | The TLD the domain name will be registered with (com, net, org, etc) |
period | Integer | Required | Registration period in years. The available periods can be viewed with the List domain's information method. |
String | Required | Email address | |
name | String | Required | First and last name of the person |
address | String | Required | Address of the company/person(street, number, etc) |
city | String | Required | Example: Dallas |
state | String | Required | Example: Texas |
zip | Integer | Required | ZIP code |
country | String | Required |
2 letters country code according to ISO 3166 For .de domain names it must be DE For .uk domain names it must be one of the following: GB (United Kingdom), IM (Isle of Man), JE (Jersey) or GG (Guernsey). For *.br domains (com.br, net.br, pro.br, arq.br, eco.br, ind.br, art.br, eng.br, adv.br, mus.br, blog.br) it must be BR. For .hr/.sk domain names, it must be a country code from the EU or UK For *.no the only country that can be chosen is (NO)Norway For *.hu the only country that can be chosen is (HU)Hungary For *.jp the only country that can be choosen is (JP)Japan |
telnocc | Integer | Required | Phone number calling code. Between 1 and 3 digits. |
telno | Integer | Required | Phone number |
ns | Array | Required | Array with name servers, which will be used for starting name servers for this domain name. If empty, the domain name will be pointed to Free name servers, available for your account, or to the Premium in case you do not have access to Free name servers. |
intended_use | String | Optional | Required for *.scot/*.cat/*.swiss/*.madrid/*.com.gn/*.gov.gn/*.com.lr domain names. For example, commercial use, statistic website, cultural, blog, etc. |
company | String | Optional |
Name of the company. Required if the registrant type is a company. |
faxnocc | Integer | Optional | Fax number calling code. Between 1 and 3 digits. |
faxno | Integer | Optional | Fax number. |
registrant_type | String | Optional |
Optional field for specific TLDs. Required for .fr/.re/.pm/.tf/.wf/.yt domain names. Possible values:
Required for *.com.au/*.net.au/*.org.au domain names. Possible values:
Required for *.au domain names. Possible values:
Required for .it domain names. Possible values:
Required for .ru domain names. Possible values:
Required for .ca domain names. Possible values:
Required for *.au/*.com.au/*.net.au/*.org.au domain names. Possible values:
Required for .es/*.com.es/*.org.es/*.nom.es domain names. Possible values:
Required for *.br,*.wiki.br/*.org.br domain names. Possible values:
Required for *.cn domain names. Possible values:
Required for *.ro domain names. Possible values:
Required for *.hr/*.co.il/*.lt/*.rs/*.срб domain names. The only possible value is ORG Required for *.ee/*.com.ee/*.mk/*.al/*.hu/*.cy/*.fi/*.sg/*.vn/*.by/*.mc/ *.com.vn/ *.net.vn/ *.org.vn/*.kr/*.no/*.pe/*.com.pe/*.org.pe/*.net.pe/*.ax/*.tw/*.ma domain names. Possible values:
Required field for *.ua TLD. Possible values:
Required field for *.md TLD. Possible values:
|
registrant_type_id | String | Optional |
Optional field for specific TLDs. Required for *.com.au/*.net.au/*.org.au domain names. Should contain the ID of the number choosen registrant type in the registrant_type parameter. Required for *.au. Possible values:
Required field for .es/*.com.es/*.org.es/*.nom.es domain names. Possible values:
Required field for .ro domain names, if country is RO. An identification number for pesons (personal ID, passport number, driving license, etc), fiscal code for companies or other unique identification number or sequence of characters for juridical entities. Mandatory for Romanian entities. Optional for foreigners. Max Length: 40 chars. Min. Length: 5 chars. Required field for *.al TLD. Possible values:
Required field for *.com.tr domain names. Possible values are:
Required field for *.al TLD. Possible values:
Required field for *.kr TLD. Possible values:
Required field for *.md TLD. Is the company a VAT Payer ? Possible values:
Required for .uy domain names. Possible values:
|
registrant_policy | Integer | Optional |
Optional field for specific TLDs. Required for *.com.au/*.net.au/*.org.au domain names. Possible values:
|
birth_date | String | Optional |
Birth date. Optional field for .fr/.re/.pm/.tf/.wf/.yt/*.vn/*.com.vn/*.org.vn/*.net.vn/*.tw domain names when the registrant_type is INDIVIDUAL. Format: YYYY-MM-DD Optional field for .ru domain names when registrant_type is PRS. Format DD.MM.YYYY Optional field for *.cy domain names. Format DD-MM-YYYY |
birth_cc | String | Optional |
Birth country code. Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is INDIVIDUAL. Optional field for .it (for Registrant contact only) Must be one of the ISO 3166-1 codes (e.g.: IT, FR, NL, ..). If the Registrant is not a natural person (registrant_type <> 1) it must be equal to the registrant country code value. If the Registrant is a natural person (registrant_type = 1), the registrant country code and the birth_cc fields may differ but at least one of them must correspond to the ISO 3166-1 code of a country belonging to the European Union. Format: US |
birth_city | String | Optional |
Birth city name. Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is INDIVIDUAL. |
birth_zip | String | Optional |
Postal code of the birth city. Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is INDIVIDUAL. |
publication | String | Optional |
Restricted or Non-Restricted publication of the individual details. Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is INDIVIDUAL. Possible values:
|
vat | String | Optional |
EU VAT number. Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is COMPANY, TRADEMARK or ASSOCIATION. Required field for *.hu domain names when registrant_type is: Organization, fill in your Company Registration Number. Required field for *.al domain names when the country is Albania or from the European Union. Fill in your VAT number. Required field for *.bg domain names. Fill in your VAT number. Required field for *.md domain names when registrant_type is Legal entity registered in other country. Fill in your VAT number. Required field for *.pe/*.com.pe/*.org.pe/*.net.pe domain names - When registrant_type is: Organization, fill in your VAT Number. |
siren | String | Optional |
Siren number of the company (organization). Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is COMPANY, TRADEMARK or ASSOCIATION. |
duns | String | Optional |
DUNS number of the company (organization). Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is COMPANY, TRADEMARK or ASSOCIATION. |
trademark | String | Optional |
Optional field for specific TLDs. Required field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is TRADEMARK. The parameter should contain the name of the trademark. Required field for *.com.au/*.net.au/*.org.au domain names when the registrant_type is TM. The parameter should be "Trademark Owner" or "Pending TM Owner". Required field for *.com.tr domain names when registrant_type_id is 3 - Trademark: fill in your Trademark number. Required field for *.mc domain names when registrant_type is (IND)Individual - Trademark: fill in your Trademark number. Required field for *.ua domain. The trademark and the domain name have to be the same. |
waldec | String | Optional |
Waldec number of the association. Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is ASSOCIATION. |
registrant_type_other | String | Optional |
Type of the organization. Optional field for .fr/.re/.pm/.tf/.wf/.yt domain names when the registrant_type is OTHER. |
privacy_protection | Integer | Optional |
Enabling/disabling Privacy Protection for the domain. 0=disabled and 1=enabled. By default the Privacy Protection is disabled. |
code | Integer | Optional |
Optional field for .it domains. Identification code | Entering wrong information in this field may lead to cancelation of your domain.
Optional field for .ru domain names. This value is the Taxpayer Identification Number (TIN). This is a 10 digit number and is mandatory for Organization Contact Type, when the Country is Russia. Required field for .es/*.com.es/*.org.es/*.nom.es domain names. Depending upon which registrant_type_id you provided, mention that ID's number as a value. Required field for *.br, *.wiki.br/*.org.br domain names. CPF number for Individuals and CNPJ number for Organizations. Required field for *.cn domain names. Organization ID. Required for *.ro domain names. Mandatory for Commercial Romanian entities (where person_type is 'c'). Optional for foreigners or other Romanian entities. Max Length: 40 chars. Required field for *.sk domain names. Civic registration number, company number, id card/passport number, or the equivalent. Required field for *.se domain names. Civic registration number, company number, id card/passport number, or the equivalent. Required field for *.hr domain names:
Required field for *.fi domain names:
Required field for *.sk/*.co.il/*.sg/*.lt/*.rs/*.mc/*.срб domain names, if registrant type is Organization, you need to fill in your Company Registration Number. Required field for *.ee/*.com.ee/*.mk/*.cy/*.vn/*.com.vn/*.org.vn/*.net.vn/*.tw domain names:
Required field for *.hu domain names when registrant_type is: Individual, fill in your ID number. Required field for *.by domain names when registrant_type is Individual - fill in your passport personal number Required field for *.com.tr domain names when. Possible values:
Required field for *.kr domain names. Fill in your Document number. Required field for *.swiss domain names. Fill in your Company registration number. Example format: CHE.000-000-000 Required field for *.au domain names. Fill in your Registrant ID number. Required field for *.ua domain names. Fill in your Trademark number. Required field for *.md domain names when registrant_type is Legal entity registered in Moldova. Fill in your Moldavian Tax Code (IDNO). Required field for *.no/*.ax domain names - When registrant_type is: Organization, fill in your Company Registration Number. Required field for *.pe/*.com.pe/*.org.pe/*.net.pe domain names - When registrant_type is: Individual, fill in your Personal identification number. Required field for *.com.sg/*.ma domain names. Fill in your Company Registration Number. |
publicity | Integer | Optional |
Available for .it domain names. (Consent to the processing of personal data for registration) Possible field values: 1=yes, 0=NO. If NO is used the request will fail. |
kpp | Integer | Optional |
Available for .ru domain names. His value is the Territory-linked Taxpayer number. This is a 9 digit number and is mandatory for the Organization Contact Type, when the Country is Russia. |
passport_number | String | Optional |
Available for .ru domain names. Document Number Required for *.by when registrant_type is Individual. Required field for *.al. Fill in your ID card number or Passport number. Required field for *.sg. Fill in your Singpass ID. Required field for *.md/*.no/*.ax/*.ma when registrant_type is Individual. Fill in your Personal identification number. |
passport_issued_by | String | Optional |
Available for .ru domain names. Document issued by (123 police station of Moscow) Required for *.by when registrant_type is Individual. |
passport_issued_on | String | Optional | Available for .ru domain names. Passport issued date. Format: DD.MM.YYYY
Required for *.by when registrant_type is Individual. |
organization_authority | String | Optional |
Required for *.by when registrant_type is Organization. |
organization_create_date | String | Optional |
Required for *.by when registrant_type is Organization. |
aero_id | String | Optional |
Required for *.aero domain names. A valid .aero ID is required in order to register any .AERO domain name. You can request an .aero ID from here |
aero_key | String | Optional |
Required for *.aero domain names. Fill in your AERO password. |
registrant_title | String | Optional |
Required for *.ga domain names. Possible values:
|
bank_bic | String | Optional |
Required for *.md domain names when registrant_type is Legal entity registered in Moldova. Fill in your Bank Account BIC. |
bank_name | String | Optional |
Required for *.md domain names when registrant_type is Legal entity registered in Moldova. Fill in your Bank Account Name. |
bank_iban | String | Optional |
Required for *.md domain names when registrant_type is Legal entity registered in Moldova. Fill in your Bank Account IBAN. |
When the authentication of API user is not correct, any API request will fail with the following status and statusDescription:
{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}
In case you do not have enough money in your balance, the following status will be returned:
{"status":"Failed","statusDescription":"You don't have enough money in your balance"}
If there is not added a domain name, the following status will be returned:
{"status":"Failed","statusDescription":"Missing domain name parameter"}
If the domain name is alredy registered or it is not available for some reason, the following status will be returned:
{"status":"Failed","statusDescription":"The domain name example-domain.com is not available"}
If there is not added a TLD parameter, the following status will be returned:
{"status":"Failed","statusDescription":"Missing tld paramter"
Note: These are example errors in JSON format, and these are NOT the only errors that can be displayed for this method.
URL JSON: https://api.cloudns.net/domains/order-new-domain.json
POST/GET: auth-id=0&auth-password=password&domain-name=domain&tld=com&period=1&mail=user@gmail.com&name=John Doe&company=Unknown International LTD.&address=125 North Avenue&city=Dallas&state=Texas&zip=5000&country=US&telno=555555&telnocc=555&
ns[]=pns21.cloudns.net&ns[]=pns22.cloudns.net
URL XML: https://api.cloudns.net/domains/order-new-domain.xml
POST/GET: auth-id=0&auth-password=password&domain-name=domain&tld=com&period=1&mail=user@gmail.com&name=John Doe&company=Unknown International LTD.&address=125 North Avenue&city=Dallas&state=Texas&zip=5000&country=US&telno=555555&telnocc=555&
ns[]=pns21.cloudns.net&ns[]=pns22.cloudns.net