Register new domain

Description

Submit new domain name registration order.

Note: This function is not available for sub users.


 Parameters

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.
mail 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:

  • INDIVIDUAL - additional fields need to be added for this type
  • COMPANY - company name is a mandatory field when the registrant type is COMPANY
  • TRADEMARK - company name and an additional field for the trademark name need to be added for this type
  • ASSOCIATION - company (associacion) name and additional field for the waldec should be added
  • OTHER - company (organization) name and additional field for the registrant type should be added

Required for *.com.au/*.net.au/*.org.au domain names. Possible values:

  • ACN - Australian Company Number
  • ABN - Australian Business Number
  • VIC_BN - Victoria Business Number
  • NSW_BN - New South Wales Business Number
  • SA_BN - South Australia Business Number
  • NT_BN - Northern Territory Business Number
  • WA_BN - Western Australia Business Number
  • TAS_BN - Tasmania Business Number
  • ACT_BN - Australian Capital Territory Business Number
  • QLD_BN - Queensland Business Number
  • TM - Trademark number
  • ARBN - Registrant's Australian Registered Body Number
  • Other

Required for *.au domain names. Possible values:

  • Resident
  • Company
  • Registered Business
  • Sole Trader
  • Trademark Owner

Required for .it domain names. Possible values:

  • 1 -  Italian and foreign natural persons
  • 2 - Companies/one man companies
  • 3 - Freelance workers/professionals
  • 4 - Non-profit organizations
  • 5 - Public organizations
  • 6 - Other subjects
  • 7 - Foreigners who match 2-6  

Required for .ru domain names. Possible values:

  • ORG
  • PRS

Required for .ca domain names. Possible values:

  • CCO - Corporation (Canada or Canadian province or territory)
  • CCT - Canadian citizen
  • RES - Permanent Resident of Canada
  • GOV - Government or government entity in Canada
  • EDU - Canadian Educational institution
  • ASS - Canadian Unincorporated Association
  • HOP - Canadian Hospital
  • PRT - Partnership Registered in Canada
  • TDM - Trade-mark registered in Canada (by a non-Canadian owner)
  • TRD - Canadian Trade union
  • PLT - Canadian Political party
  • LAM - Canadian Library, Archive or Museum
  • TRS - Trust established in Canada
  • ABO - Aboriginal Peoples (individuals or groups) indigenous to Canada
  • INB - Indian Band recognized by the Indian Act of Canada
  • LGR - Legal Representative of a Canadian Citizen or Permanent Resident
  • OMK - Official mark registered in Canada
  • MAJ - Her Majesty the Queen

Required for *.au/*.com.au/*.net.au/*.org.au domain names. Possible values:

  • ACN - This is the Registrant's Australian Company Number.
  • ABN - This is the Registrant's Australian Business Number.
  • VIC BN - This is the Registrant's Victoria Business Number.
  • NSW BN - This is the Registrant's New South Wales Business Number.
  • SA BN - This is the Registrant's South Australia Business Number.
  • NT BN - This is the Registrant's Northern Territory Business Number.
  • WA BN - This is the Registrant's Western Australia Business Number.
  • TAS BN - This is the Registrant's Tasmania Business Number.
  • ACT BN - This is the Registrant's Australian Capital Territory Business Number.
  • QLD BN - This is the Registrant's Queensland Business Number.
  • TM - This is the Registrant's Trademark number.
  • ARBN - This is the Registrant's Registrant's Australian Registered Body Number (ARBN).

Required for .es/*.com.es/*.org.es/*.nom.es domain names. Possible values:

  • 1 - Natural person or individual
  • 39 - Economic Interest Grouping
  • 47 - Association
  • 59 - Sports Association
  • 68 - Trade Association
  • 124 - Savings Bank
  • 150 - Community Property
  • 152 - Condominium
  • 164 - Religious Order or Institution
  • 181 - Consulate
  • 197 - Public Law Association
  • 203 - Embassy
  • 229 - Municipality
  • 269 - Sports Federation
  • 286- Foundation
  • 365 - Mutual Insurance Company
  • 434 - Provincial Government Body
  • 436 - National Government Body
  • 439 - Political Party
  • 476 - Trade Union
  • 510 - Farm Partnership
  • 524 - Public Limited Company / Corporation
  • 525 - Sports Public Limited Company
  • 554 - Partnership
  • 560 - General Partnership
  • 562 - Limited Partnership
  • 566 - Cooperative
  • 608 - Worker-owned Company
  • 612 - Limited Liability Company
  • 713 - Spanish (company) Branch
  • 717 - Temporary Consortium / Joint Venture
  • 744 - Worker-owned Limited Company
  • 745 - Provincial Government Entity
  • 746 - National Government Entity
  • 747 - Local Government Entity
  • 877 - Others
  • 878 - Designation of Origin Regulatory Council
  • 879 - Natural Area Management Entity

Required for *.br,*.wiki.br/*.org.br domain names. Possible values:

  • ORG for a company
  • PRS for a private person

Required for *.cn domain names. Possible values:

  • cnhosting for site, hosted in Mainland China
  • nocnhosting for site, hosted outside Mainland China

Required for *.ro domain names. Possible values:

  • p - Person
  • ap - Authorized person
  • nc - Non-commercial
  • c - Commercial
  • gi - Government Institution
  • pi - Public Institution
  • o - Other


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:

  • IND for Individual
  • ORG for Organization

Required field for *.ua TLD. Possible values:

  • INPI - National in Ukraine
  • WIPO - International showing Ukraine as country

Required field for *.md TLD. Possible values:

  • IND - Individual
  • LERM - Legal entity registered in Moldova
  • LEREU - Legal entity registered in European Union
  • LEROC - Legal entity registered in other country
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:

  • ACN - Australian Company Number
  • ABN - Australian Business Number
  • Trademark - Trademark number

Required field for .es/*.com.es/*.org.es/*.nom.es domain names. Possible values:

  • 1 - DNI or NIF - Provide either the Spanish National Personal ID or company VAT ID number.
  • 3 - NIE - Provide the Spanish resident alien ID number
  • 0 - Other ID - If you do not have any of the above mentioned IDs, provide either your Passport number, any Foreign ID document number, Company Registration number, Driver's License number, etc.

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:

  • 1 - ID card number
  • 2 - Passport number

Required field for *.com.tr domain names. Possible values are:

  • 1 - Turkish citizen - The domain name should be firstname-lastname.com.tr, otherwise it may be cancelled by the registry.

  • 2 - Turkish company - The domain name should match the company name, otherwise it may be cancelled by the registry.

  • 3 - Trademark - The domain name should match the trademark name and the trademark should be valid in Turkey.

  • 4 - Foreign company - A foreign company with a real link or trade activity in Turkey (the registry will ask for supporting documentation (distribution contract etc). The domain name should match the company name.

Required field for *.al TLD. Possible values:

  • 1 - ID card number
  • 2 - Passport number

Required field for *.kr TLD. Possible values:

  • SOCIAL for Social Security Card
  • DRIVELIC for Driver License
  • PASSPORT for Passport
  • BUSINESS for Business Registration Certificate
  • TAX for Tax Registration Certificate
  • ORG for Organization Registration Certificate
  • BRAND for Brand Name Registration Certificate

Required field for *.md TLD. Is the company a VAT Payer ? Possible values:

  • Yes
  • No

Required for .uy domain names. Possible values:

  • 0 - If you do not have Uruguay local address
  • 1 - If you have Uruguay local address
registrant_policy Integer Optional

Optional field for specific TLDs.

Required for *.com.au/*.net.au/*.org.au domain names. Possible values:

  • 1 - if Domain Name is an Exact Match OR Abbreviation OR Acronym of your Entity or Trading Name.
  • 2 - if Close and substantial connection between the domain name and the operations of your Entity.
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:

  • 0 - Non-Restricted
  • 1 - Restricted
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.

  • If the requester is an Italian natural person it contains his/her tax code (Codice Fiscale).

  • For foreign natural persons it can contain a document number (like passport number or ID card number).

  • For Italian associations without VAT number and numeric tax code must be equal to 'n.a.'.

  • In all the other cases must be equal to VAT number (in the 11 numbers format if Nationality is Italian) or the numeric tax code.

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:

  • When the country is different from (Croatia)HR, fill in your VAT number.
  • When the country is Croatia(HR), fill in OIB number, which has to be 11 symbols long and can contain the numbers from 0 to 9.

Required field for *.fi domain names:

  • When the registrant_type is: IND - Private person and the country is different from Finland, fill in birth date in the following format: YYYY-MM-DD

  • When the registrant_type is ORG - Organization and the country is different from Finland, fill in your Company Registration Number.

  • When the registrant_type is: IND - Private person and the country is Finland, fill in your HETU number.

  • When the registrant_type is ORG - Organization and the country is Finland, fill in your Y-tunnus number

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:

  • When registrant_type is: Individual, fill in your ID number.
  • When registrant_type is: Organization, fill in your Company Registration Number.

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:

  • when registrant_type_id is 1 - Turkish citizen: fill in your Registrant ID number.
  • when registrant_type_id is 2 - Turkish company: fill in your Company Registration Number.
  • when registrant_type_id is 4 - Foreign company: fill in your Company Registration Number.

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:

  • Mr
  • Mrs
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.


 Return: Array with status and status description.


Errors

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.


 Example

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


Last modified: 2024-10-11
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more