Note
It is recommended, that you read TLD and their Contacts specific information, prior to continuing reading further:
Description
Registers a domain name.
Parameters
Name |
Data Type |
Required / Optional |
Description |
auth-userid |
Integer |
Required |
Authentication Parameter |
api-key |
String |
Required |
Authentication Parameter |
domain-name |
String |
Required |
Domain name that you need to Register.
For an Internationalized Domain Name, refer to the supported character sets mentioned below:
-
.COM / .NET IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here.
Note
the character ? (codepoint=962) is not supported on our platform.
-
.EU IDN: You can refer to supported character sets here.
-
.INFO IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:
-
.ORG IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:
Note
The domain name used in the API call can be in Unicode (the native language) or in Punycode format.
Example: The domain name can be provided as ??111 (Unicode) or xn--111-dkd4l (Punycode).
domain-name=??111 domain-name=xn--111-dkd4l
|
years |
Integer |
Required |
Number of years for which you wish to Register this domain name. |
ns |
Array of Strings |
Required |
The Name Servers of the domain name. |
customer-id |
Integer |
Required |
The Customer for whom you wish to Register this domain name. |
reg-contact-id |
Integer |
Required |
The Registrant Contact of the domain name. |
admin-contact-id |
Integer |
Required |
The Administrative Contact of the domain name.
Note
Pass -1 for the following TLDs:
|
tech-contact-id |
Integer |
Required |
The Technical Contact of the domain name.
Note
Pass -1 for the following TLDs:
|
billing-contact-id |
Integer |
Required |
The Billing Contact of the domain name.
Note
Pass -1 for the following TLDs:
|
invoice-option |
String |
Required |
This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:
-
NoInvoice: This will not raise any Invoice. The Order will be executed.
-
PayInvoice: This will raise an Invoice and:
-
if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the Order will be executed.
-
if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.
-
KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be executed.
-
OnlyAdd: This will raise an Invoice for the Customer to pay later. The registration action request will remain pending.
|
purchase-privacy |
Boolean |
optional |
Adds the Privacy Protection service for the domain name.
Privacy Protection is not supported for the following TLDs (extensions):
|
protect-privacy |
Boolean |
Optional |
Enables / Disables the Privacy Protection setting for the domain name.
|
auto-renew |
Boolean |
Required |
Enables / Disables the Auto Renewal setting for the domain name.
|
attr-name |
Map[name] |
Optional |
Mapping key of the extra details needed to register a domain name. Refer the description of attr-value. |
attr-value |
Map[value] |
Optional |
Mapping value of the extra details required to register a domain name. This together with attr-name shall contain the extra details.
-
To register an Internationalized Domain Name:
idnLanguageCode: While registering an IDN, you need to provide the corresponding language code:
-
.COM / .NET IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.
attr-name1=idnLanguageCode&attr-value1=aze
-
.EU IDN: The language code needs to be mentioned as latin.
attr-name1=idnLanguageCode&attr-value1=latin
-
.INFO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:
-
Danish - da
-
German - de
-
Hungarian - hu
-
Icelandic - is
-
Korean - ko
-
Latvian - lv
-
Lithuanian - lt
-
Polish - pl
-
Spanish - es
-
Swedish - sv
attr-name1=idnLanguageCode&attr-value1=ko
-
.ORG IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:
-
Chinese - zh-cn (for IDN.org domain name and .?? domain name - the Chinese IDN for .org)
-
Cyrillic - ru (for .??? domain name - the Russian IDN for .org)
-
Danish - da
-
German - de
-
Hindi - hin-deva (for .????? domain name - the Hindi IDN for .org)
-
Hungarian - hu
-
Icelandic - is
-
Korean - ko
-
Latvian - lv
-
Lithuanian - lt
-
Polish - pl
-
Spanish - es
-
Swedish - sv
attr-name1=idnLanguageCode&attr-value1=ko
-
To register a Domain Name in the Sunrise Phase:
-
phase: Mention the phase as sunrise.
attr-name1=phase&attr-value1=sunrise
-
smd: Pass the content of the smd file as the value for this attr-name.
attr-name2=smd&attr-value2=<smd_file_content>
-
To register a Domain Name in the Pre-Registration Phase:
phase: Mention the phase as
-
prega for regular pre-registration
attr-name1=phase&attr-value1=prega
-
landrush for priority pre-registration
attr-name1=phase&attr-value1=landrush
-
To register a domain name that has a Trademark Claim:
tm-claim: Mention the value for this additional parameter as accepted.
attr-name1=tm-claim&attr-value1=accepted
-
To register a .AU domain name:
-
id-type: Mention the appropriate EligibilityID Type as the value for this attr-name. This is mandatory. See details
Send either of the following as the attr-value:
-
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).
-
Other
attr-name1=id-type&attr-value1=ACN
-
id: Mention the appropriate ID as the value for this attr-name, depending upon the EligibilityID Type selected. This is mandatory. This may be either a number or string. See details
attr-name2=id&attr-value2=079 009 340
-
policyReason: Mention the appropriate Eligibility Reason as the value for this attr-name. This is mandatory. See details
attr-name3=policyReason&attr-value3=1
Note
Mention the attr-value3 as 1 to indicate Domain Name is an Exact Match OR Abbreviation OR Acronym of your Entity or Trading Name. and send 2 to indicate Close and substantial connection between the domain name and the operations of your Entity.
-
isAUWarranty: You need to display and accept a warranty from the Registrant. When sending this attribute, it's value needs to be true. See details
attr-name4=isAUWarranty&attr-value4=true
-
eligibilityType: This is mandatory for only the id-type values Trademark and Other. Mention the appropriate value as below.
id-type |
eligibilityType |
Trademark |
Trademark Owner
or
Pending TM Owner |
Other |
Other |
attr-name5=eligibilityType&attr-value5=Trademark
-
eligibilityName: This is mandatory for only the id-type value Trademark. Mention the appropriate Eligibility Name (company name) as the value for this attr-name. See details
attr-name6=eligibilityName&attr-value6=.AU DOMAIN ADMINISTRATION LIMITED
-
registrantName: This is mandatory for only the id-type values VIC BN, NSW BN, SA BN, NT BN, WA BN, TAS BN, ACT BN, QLD BN, Trademark and Other. Mention the appropriate Registrant Name as the value for this attr-name. This value needs to be the proprietor's name and the proprietor should be an individual. See details
attr-name7=registrantName&attr-value7=RICHARD MARK
-
-
To register a .FR domain name:
If the Registrant or Admin contact being associated with a .FR domain name belongs to one of the European nations and the contact is of type Organization, a message on the following lines will need to be displayed to the user: "Important information regarding your contact data. We are contractually obligated to share your personal information with the registry for this TLD. This means that your personal information will be transferred to the registry and may be published in the public WHOIS. For details on why we share your personal information, please review our Privacy Policy and the Domain Registration Agreement." This will be validated using a tnc parameter in the API call.
attr-name1=tnc&attr-value1=Y
-
To register a .SCOT domain name:
intended-use: This parameter indicates the intended use of the .SCOT domain name. For example, commercial use, statistic website, cultural, blog etc.
attr-name1=intended-use&attr-value1=commercial use
- If the Registrant contact being associated with a domain name belongs to one of the European nations, a message on the following lines will need to be displayed to the user:
"Important information regarding your contact data. We are contractually obligated to share your personal information with the registry for this TLD. This means that your personal information will be transferred to the registry and may be published in the public WHOIS.
For details on why we share your personal information, please review our Privacy Policy and the Domain Registration Agreement." This will be validated using a tnc parameter in the API call.attr-name2=tnc&attr-value2=Y
-
To register a 2nd Level .UK domain name with a non UK Registrant Contact, specify an additional Service Contact: See details:
service-contact: Mention the Contact ID of the Service Contact.
attr-name1=service-contact&attr-value1=0
-
To register a .LAWYER, .ATTORNEY domain name:
REGULATORY BODY: The Regulatory Body information is collected during the registration process. This information is only required if the registrant is offering professional services related to the TLD
attr-name1=regulatorybody&attr-value1=<regulatory-body-here>
-
To register a .AIRFORCE, .ARMY, .APP, .DEGREE, .DEV, .ENGINEER, .GIVES, .LAW, .MARKET, .MORTGAGE, .NAVY, .PAGE, .REHAB, .SOFTWARE, .VET, .VOTE, .VOTO domain name:
TNC: stands for Terms and Conditions
Any other value for attr-value1 except y or Y will result in an error "Please accept the Terms & Conditions".
attr-name1=tnc&attr-value1=y
-
To register a .DENTIST domain name:
TNC: stands for Terms and Conditions
Any other value for attr-value1 except y or Y will result in an error "Please accept the Terms & Conditions".
REGULATORY BODY: The Regulatory Body information is collected during the registration process. This information is only required if the registrant is offering professional services related to the TLD
attr-name1=tnc&attr-value1=y&attr-name2=regulatorybody&attr-value2=<regulatory-body>
|
discount-amount |
Float |
Optional |
Discount amount for the order value. |
purchase-premium-dns |
Boolean |
Optional |
Purchase Premium DNS service. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&discount-amount=0.0
Example Test URL Request for Registering a Domain Name with Privacy Protection
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true&discount-amount=0.0
Example Test URL Request for Registering a Domain Name in the Sunrise Phase
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domains1.bike&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customerid=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&discount-amount=0.0&attr-name1=phase&attr-value1=sunrise&attr-name2=smd&attr-value2=<smd_file_content>
Example Test URL Request for Registering a .AU Domain Name
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.net.au&years=2&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&discount-amount=0.0&attr-name1=id-type&attr-value1=ACN&attr-name2=id&attr-value2=079 009 340&attr-name3=policyReason&attr-value3=1&attr-name4=isAUWarranty&attr-value4=true
Example Test URL Request for Registering a .COM IDN
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=??112.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&discount-amount=0.0&attr-name1=idnLanguageCode&attr-value1=aze
Example Test URL Request for Registry Premium domain registration
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&discount-amount=0.0&attr-name1=premium&attr-value1=true
Example Test URL Request for domain registration in EAP
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&discount-amount=0.0&attr-name1=eap&attr-value1=true
Example Test URL Request for Registry Premium domain registration in EAP
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&discount-amount=0.0&attr-name1=premium&attr-value1=true&attr-name2=eap&attr-value2=true
Example Test URL Request for Registering a .LAT Domain Name
https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&discount-amount=0.0
Note
For a .lat domain name it is recommended, that you create a contact with the contact type as MXContact. Click here for more information on creating a contact.
Response
Returns a hash map containing the below details:
-
Domain Name (description)
-
Order ID of the Domain Registration Order (entityid)
-
Action Type (actiontype)
-
Description of the Domain Registration Action (actiontypedesc)
-
Action ID of the Domain Registration Action (eaqid)
-
Domain Registration Action Status (actionstatus)
-
Description of the Domain Registration Action Status (actionstatusdesc)
-
Invoice ID of the Domain Registration Invoice (invoiceid)
-
Selling Currency of the Reseller (sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (sellingamount)
-
Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)
-
Customer ID associated with the Domain Registration Order (customerid)
-
Discount Amount (discount-amount)
-
Privacy Protection Details (privacydetails)
-
Domain Name (description)
-
Order ID of the Domain Registration Order (entityid)
-
Action Type (actiontype)
-
Description of the Privacy Protection Purchase Action (actiontypedesc)
-
Action ID of the Privacy Protection Purchase Action (eaqid)
-
Privacy Protection Purchase Action Status (actionstatus)
-
Description of the Privacy Protection Purchase Action Status (actionstatusdesc)
-
Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)
-
Selling Currency of the Reseller (sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (sellingamount)
-
Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)
-
Customer ID associated with the Domain Registration Order (customerid)
Note
-
invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.
-
Details under privacydetails will be returned only if purchase-privacy is set to true in the Domain Registration API call
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.