domorder

Domain Products

Modifying the Privacy Protection Status

Description

Changes the Privacy Protection status of the specified Domain Registration Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Domain Registration Order whose privacy protection you want to change.
protect-privacy Boolean Required Enable / Disable Privacy Protection service. Possible values are: true or false.
reason String Required The reason to enable / disable Privacy Protection.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-privacy-protection.json?auth-userid=0&api-key=key&order-id=0&protect-privacy=true&reason=somereason

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 Privacy Protection Modification Action (actiontypedesc)

  • Action ID of the Privacy Protection Modification Action (eaqid)

  • Privacy Protection Modification Action Status (actionstatus)

  • Description of the Privacy Protection Modification 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)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will be returned even if the Selling Price for Privacy Protection is set to zero, since a zero priced Invoice will be raised while enabling Privacy protection.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Check Availability

Description

Checks the availability of the specified domain name(s).

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name Array of Strings Required Domain name(s) that you need to check the availability for
tlds Array of Strings Required TLDs for which the domain name availability needs to be checked See details
suggest-alternative Boolean Optional Pass true if domain name suggestions are required. Default value is false.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net

Response

Returns a hash map containing domain name availability status for the requested TLDs:

  • Domain Availability Status (status)

    • available - domain name available for registration

    • regthroughus - domain name currently registered through the Registrar whose connection is being used to check the availability of the domain name

    • regthroughothers - domain name currently registered through a Registrar other than the one whose connection is being used to check the availability of the domain name. If you wish to manage such a domain name through your Reseller / Registrar Account, you may pass a Domain Transfer API call. See details

    • unknown - returned, if for some reason, the Registry connections are not available. You should ideally re-check the domain name availability after some time.

      Note

      • In case of Donuts TLDs, domain name availability can be checked for a maximum of 5 domain names per Donuts TLD group in one API call. Including more than 5 domain names belonging to the same Donuts TLD group in an API call will return the status as unknown for all the domain names.

        Additional Information

        Donuts TLDs

      • In case of .CA TLD, domain name availability can be checked for a maximum of 15 strings in one API call. Including more than 15 strings in an API call will return the status as unknown for all the strings.

  • Trademark Claims Key (tm-claims-key) - will be returned only if the domain name is available and Trademark for that domain name is listed in the Trademark Clearinghouse database

  • Premium Names (costHash) - A hash map will be returned only if the
    domain is a premium name along with the pricing of the domain ("create",
    "renew", "transfer") and the selling currency symbol

  • Early Access Program (costHash) - A hash map will be returned only
    if the domain is in EAP along with the early access fee
    ("early_access_fee") and the selling currency symbol. The early access fee
    is the non-refundable component which needs to added to the selling price
    of the domain

    • Additional Information

    Trademark Claim Process

  • 3rd Level .UK domain name (ror) - will be returned for an available 2nd Level .UK domain name, if the corresponding 3rd Level .UK domain name already exists. Currently, a 2nd Level .UK domain name can only be registered by the person/entity that owns the 3rd Level .UK domain name, if it already exists.

    Note

    For .UK availability check, the API call need to have only one domain name. Otherwise, the ror parameter will not be returned in the result.

Transfer

Description

Transfers a domain name.

Note

You need to ensure that the domain name is not Locked.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
auth-key String Required Authentication Parameter
domain-name String Required Specify the domain name that you want to transfer.
auth-code String Optional

Authorization Code (a.k.a. Domain Secret) of the domain name that you want to transfer.

The Authorization Code would be required to transfer a domain name of any of the following TLDs (extensions):

  • .AU

  • .BIZ

  • .BZ

  • .CA

  • .CC

  • .CO

  • .COM

  • .COOP

  • .DE

  • .EU

  • .IN (including only these Third Level .IN Domains: .CO.IN, .NET.IN, .ORG.IN, .GEN.IN, .FIRM.IN, .IND.IN)

  • .INFO

  • .MN

  • .MOBI

  • .NAME

  • .NET

  • .NL

  • .NZ

  • .ORG

  • .TV

  • .US

  • .WS

  • .XXX

You may fetch the auth-code from your customer and provide it while placing the Transfer Order. Alternatively, you may initially place the Transfer Order without the auth-code. The Administrative Contact can provide it at the time of approving the Transfer Authorization email received from .

It is recommended that you adopt the second option since it leaves out the requirement for an auth-code at the time of placing the Transfer Order and the customer would be more willing to submit it at a later stage.

Domain Name Extensions for which the Authorization Code needs to be compulsorily provided at this stage:

  • .AU

  • .CA

  • .DE

  • .EU

  • .NZ
customer-id Integer Required The Customer for whom the Order should be added.
reg-contact-id Integer Required

The Registrant Contact of the domain name.

The Identity of the Registrant Contact of a .UK domain name must not be changed during the Transfer process. You may modify the Identity once the domain name has been transferred to , by referring to the process listed at http://www.nominet.org.uk/registrants/maintain/transfer/chargeable/.
admin-contact-id Integer Required

The Administrative Contact of the domain name.

.EU, .NZ, .RU and .UK domain names do not have an Administrative Contact associated with them. You need to pass the value of admin-contact-id as -1 for these domain names.
tech-contact-id Integer Required

The Technical Contact of the domain name.

The Technical Contact associated with a .EU domain name cannot be modified while .NZ, .RU and .UK domain names do not have a Technical Contact associated with them. You need to pass the value of tech-contact-id as -1 for these domain names.
billing-contact-id Integer Required

The Billing Contact of the domain name.

The Billing Contact associated with a .EU domain name cannot be modified while .AT, .BERLIN, .CA, .NL, .NZ, .RU and .UK domain names do not have a Billing Contact associated with them. You need to pass the value of billing-contact-id as -1 for these domain names.
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 domain name will be transfered.

    • 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 transfer 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):

  • .ASIA

  • .AT

  • .AU

  • .CA

  • .CN

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .DE

  • .ES

  • .EU

  • .HN

  • .IN

  • .NL

  • .NZ

  • .PRO

  • .RU

  • .SX

  • .TEL

  • .UK

  • .US
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.

Note

Auto-Renewal
ns Array of Strings Optional List of Name Servers to be associated with the domain name. A maximum of 13 Name Servers can be specified.
attr-name Map[name] Optional Mapping key of the extra details needed to transfer a domain name. Refer the description of attr-value.
attr-value Map[value] Optional

Mapping value of the extra details required to transfer a domain name. This together with attr-name shall contain the extra details.

    To transfer a .ASIA domain name:

    cedcontactid: For a .ASIA domain name, 'Charter Eligibility Declaration Contact ID' is mandatory. This parameter represents the CED
    Contact ID. You may select any one of the Admin, Technical, Billing or Registrant Contacts as a value for this parameter.

    attr-name1=cedcontactid&attr-value1=0

    To transfer a Premium domain name:

    type: For transferring a Premium domain name, you need to pass an additional paramater type. The value for this parameter will be premiumft.

    attr-name1=type&attr-value1=premiumft

HTTP Method

POST

Example Test URL Request

Example Test URL Request for Transferring a Domain Name with Privacy Protection

https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true

Example Test URL Request for Transferring a .ASIA Domain Name

https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.asia&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=cedcontactid&attr-value1=0

Example Test URL Request for Transferring a Registry Premium Domain Name


https://test.httpapi.com/api/domains/transfer.json?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true&attr-name1=premium&attr-value1=true

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Name Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Transfer Action (actiontypedesc)

  • Action ID of the Domain Transfer Action (eaqid)

  • Domain Transfer Action Status (actionstatus)

  • Description of the Domain Transfer Action Status (actionstatusdesc)

  • Invoice ID of the Domain Transfer Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer ID associated with the Domain Name Order (customerid)

  • 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 and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Register

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:

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:

  • .EU

  • .NZ

  • .RU

  • .UK
tech-contact-id Integer Required

The Technical Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .NZ

  • .RU

  • .UK
billing-contact-id Integer Required

The Billing Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .AT

  • .BERLIN

  • .CA

  • .EU

  • .NL

  • .NZ

  • .RU

  • .UK

  • .LONDON
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):

  • .ASIA

  • .AT

  • .AU

  • .CA

  • .CN

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .DE

  • .ES

  • .EU

  • .HN

  • .IN

  • .NL

  • .NZ

  • .PRO

  • .RU

  • .SX

  • .TEL

  • .UK

  • .US
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.

Note

Auto-Renewal
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:

    • .BHARAT: The language code needs to be mentioned as hin-deva.

      attr-name1=idnLanguageCode&attr-value1=hin-deva

    • .BIZ 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

      • Danish - da

      • Finnish - fi

      • German - de

      • Hungarian - hu

      • Icelandic - is

      • Japanese - jp

      • Korean - ko

      • Lithuanian - lt

      • Latvian - lv

      • Norwegian - no

      • Polish - pl

      • Portuguese - pt

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

    • .CA IDN: The language code needs to be mentioned as fr.

      attr-name1=idnLanguageCode&attr-value1=fr

    • .CC / .TV 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

    • .CO 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

      • Danish - da

      • Finnish - fi

      • Icelandic - is

      • Japanese - jp

      • Korean - ko

      • Norwegian - no

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=da

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

    • .DE IDN: The language code needs to be mentioned as de.

      attr-name1=idnLanguageCode&attr-value1=de

    • .ES IDN: The language code needs to be mentioned as es.

      attr-name1=idnLanguageCode&attr-value1=es

    • .EU IDN: The language code needs to be mentioned as latin.

      attr-name1=idnLanguageCode&attr-value1=latin

    • .IN.NET IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Arabic - ara

      • Chinese - chi

      • Cyrillic - cyr

      • Greek - gre

      • Hebrew - heb

      • Japanese - jpn

      • Korean - kor

      • Lao - lao

      • Latin - lat

      • Thai - tha

      attr-name1=idnLanguageCode&attr-value1=jpn

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

    • .NAME 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

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

    • .PW IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • Arabic - ara

      • Chinese - chi

      • Cyrillic - cyr

      • Greek - gre

      • Hebrew - heb

      • Japanese - jpn

      • Korean - kor

      • Lao - lao

      • Latin - lat

      • Thai - tha

      attr-name1=idnLanguageCode&attr-value1=tha

    • .TEL 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

      • Danish - da

      • French - fr

      • Finnish - fi

      • German - de

      • Hungarian - hu

      • Icelandic - is

      • Japanese - jp

      • Korean - ko

      • Latvian - lv

      • Lithuanian - lt

      • Norwegian - no

      • Polish - pl

      • Portuguese - pt

      • Russian - ru

      • Spanish - es

      • Swedish - sv

      attr-name1=idnLanguageCode&attr-value1=ko

    • CentralNic IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

      • .EU.COM:

        • Arabic - ara

        • Cyrillic - cyr

        • Greek - gre

        • Hebrew - heb

        • Latin - lat

      • .GB.COM, .QC.COM, .DE.COM, .GB.NET, .NO.COM, .HU.COM, .UY.COM, .ZA.COM, .BR.COM, .SE.COM, .SE.NET, .UK.COM and .UK.NET:

        • Latin - lat

      • .AE.ORG and .SA.COM:

        • Arabic - ara

      • .KR.COM:

        • Korean - kor

      • .US.COM:

        • Arabic - ara

        • Chinese - chi

        • Cyrillic - cyr

        • Greek - gre

        • Hebrew - heb

        • Japanese - jpn

        • Latin - lat

      • .GR.COM:

        • Greek - gre

      • .JPN.COM:

        • Japanese - jpn

      • .CN.COM:

        • Chinese - chi

      • .RU.COM:

        • Cyrillic - cyr

      attr-name1=idnLanguageCode&attr-value1=lat

    • .在线 (Chinese IDN for .online): The language code needs to be mentioned as zh.

      attr-name1=idnLanguageCode&attr-value1=zh

    • .中文网 (Chinese IDN for .network): The language code needs to be mentioned as zh.

      attr-name1=idnLanguageCode&attr-value1=zh

  • 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 .ASIA domain name:

    cedcontactid: While registering a .ASIA domain name, 'Charter Eligibility Declaration Contact ID' is mandatory. This parameter represents the CED
    Contact ID. You may select any one of the Admin, Technical, Billing or Registrant Contacts as a value for this parameter.

    attr-name1=cedcontactid&attr-value1=0

  • 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 .BR (third level) domain name:

    organisationId: Only Brazilian nationals or organizations can register .BR domains. Hence, a tax ID (CPF in case of an individual contact) or an organisation ID (CNPJ in case of a company contact) of the person/organisation needs to be supplied. The tax/organization ID must either not be currently registered in our database or it should be a transferred authority to the registrar through the .BR registry web interface.

    In addition, depending on the contact, you will need to specify the “type” as BrOrgContact (for the Registrant contact) or BrContact (for the Admin/Technical/Billing contact).

    A BrgOrgContact will need the following additional attributes:

    attr-name1=organisationId&attr-value1=123456

  • To register a .CN domain name:

    If the Registrant plans on hosting the domain name in China, he/she needs to ensure that he/she has a valid MIIT ICP Number and include the below parameters:

    • cnhosting: This parameter indicates that the domain name will be hosted in China. The value needs to be passed as true.

      attr-name1=cnhosting&attr-value1=true

    • cnhostingclause: Through this parameter, the Registrant agrees to the terms and conditions for hosting the domain name in China. The value needs to be passed as yes.

      attr-name2=cnhostingclause&attr-value2=yes

  • To register a .QUEBEC domain name:

    intended-use: This parameter indicates the intended use of the .QUEBEC domain name. For example, commercial use, statistic website, cultural, etc.

    attr-name1=intended-use&attr-value1=commercial use

  • To register a .TEL domain name:

    • whois-type: This parameter indicates whether the Registrant is an Individual or an Oragnization. The value needs to be passed as either Natural (for Individual) or Legal (for Oragnization).

      attr-name1=whois-type&attr-value1=Legal

    • publish: This parameter indicates whether the Contact Details associated with a .TEL domain name need to be published or excluded from the publicly available Whois database. The value needs to be passed as either Y or N.

      This parameter is required if whois-type parameter is Natural, otherwise is it Optional.

      attr-name2=publish&attr-value2=Y

    Note

    You may exclude the whois-type parameter itself from the API call, since it is optional. In that case,:

    • whois-type will be automatically set to Legal,

      AND

    • you need not pass the publish parameter.

  • 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, .LTDA, .SRL 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 .DEGREE, .ENGINEER, .MORTGAGE, .MARKET, .SOFTWARE, .NAVY, .VET, .ARMY, .GIVES, .AIRFORCE, .BIO, .ARCHI 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>

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&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice

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&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&purchase-privacy=true

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&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&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&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&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 .CN Domain Name


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.cn&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=cnhosting&attr-value1=true&attr-name2=cnhostingclause&attr-value2=yes

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&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=idnLanguageCode&attr-value1=aze

Example Test URL Request for Registering a .TEL Domain Name


https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.tel&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=whois-type&attr-value1=Natural&attr-name2=publish&attr-value2=N

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&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice
&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&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&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&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=KeepInvoice&attr-name1=premium&attr-value1=true&attr-name2=eap&attr-value2=true

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)

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

Domains

Note

It is recommended, that you read TLD and their Contacts specific information, prior to continuing reading further:

Check Availability

Checks the availability of specified domain name(s).

Check Availability - IDN

Checks the availability of the specified Internationalized Domain Name(s) (IDN).

Check Availability - Premium Domains

Checks the availability of Premium Domain Names based on the specified keyword.

Suggest Names

Suggests domain names for the given keyword.

Register

Registers a specified domain name.

Transfer

Transfers a specified domain name to you.

Validating a Transfer Request

Checks if a transfer request is valid for the specified domain name.

Renew

Renews the specified Domain Registration Order for multiple years.

Search

Gets a list of Domain Registration Orders, which suit the Search criteria, along with the details.

Get Customer Default Name Servers

Gets a list of the default Name Servers for the Customer.

Get Order Id

Gets the Order Id of a Registered domain name.

Get Registration Order Details

Gets the details of a Domain Registration Order.

Modify Name Servers

Modifies the Name Servers of the specified Domain Registration Order.

Add Child Name Server

Adds Child Name Servers for the specified Domain Registration Order.

Modify Child Name Server Host Name

Modifies the name of the Child Name Server of the specified Domain Registration Order.

Modify Child Name Server IP Address

Modifies the IP addresses associated with the specified Child Name Server of the specified Domain Registration Order.

Deleting Child Name Server IP Address

Deletes the IP address associated with the specified Child Name Server of the particular Domain Registration Order.

Modify Contacts

Modifies the Contacts of the specified Domain Registration Order.

Modify Privacy Protection Status

Changes the Privacy Protection status of the specified Domain Registration Order.

Modify Auth-Code

Modifies the Auth-Code of the specified Domain Registration Order.

Apply Theft Protection Lock

Applies the Theft Protection lock on the specified Order.

Remove Theft Protection Lock

Removes the Theft Protection lock on the specified Order.

Get the List of Locks Applied on a Domain Name

Gets the list of locks applied on a Domain Registration Order.

Get TEL CTH Login Details

Gets the CTH Login Details for the specified .TEL Domain Registration Order.

Modify TEL Whois Preference

Modifies the Whois preference of the .TEL Domain Registration Order.

Resend Transfer Approval Mail

Resends the Transfer Approval mail for the specified Order.

Release a UK Domain Name

Releases (transfer-out) the specified .UK domain name to the specified Registrar tag.

Cancel Transfer

Cancels the Transfer-In Order that is awaiting Admin approval.

Suspend

Applies the Suspension on the specified Domain Registration Order.

Unsuspend

Removes the Suspension on the specified Domain Registration Order.

Delete

Deletes the specified Domain Registration Order.

Restore

Restores the specified Domain Registration Order.

Rechecking NS with .DE Registry

Recheck zone configuration with .de registry of the expired .DE Domain Registration Order.

Associating/Dissociating .XXX Membership Token/ID

Allows associating/dissociating the Membership Token/ID provided by the .XXX Registry, to a Domain Registration Order.

Renew

Description

Renews the specified Domain Registration Order for specified number of years.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Domain Registration Order that you want to Renew.
years Integer Required Number of years for which you want to Renew this Order.
exp-date Integer Required Current Expiry Date of the Order in epoch time format.
purchase-privacy Boolean optional

Renews the Privacy Protection service for the domain name.

Privacy Protection is not supported for the following TLDs (extensions):

  • .ASIA

  • .AT

  • .AU

  • .CA

  • .CN

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .DE

  • .ES

  • .EU

  • .HN

  • .IN

  • .NL

  • .NZ

  • .PRO

  • .RU

  • .SX

  • .TEL

  • .UK

  • .US
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the domain name.

Note

Auto-Renewal
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 renewed.

  • 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 renewed.

    • 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 renewed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The renewal action request will remain pending.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice

Example Test URL Request for Renewing a Domain Name with Privacy Protection


https://test.httpapi.com/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice&purchase-privacy=true

Example Test URL Request for Registry Premium domain renewal


https://test.httpapi.com/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice&attr-name1=premium&attr-value1=true

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Name Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Renewal Action (actiontypedesc)

  • Action ID of the Domain Renewal Action (eaqid)

  • Domain Renewal Action Status (actionstatus)

  • Description of the Domain Renewal Action Status (actionstatusdesc)

  • Invoice ID of the Domain Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer ID associated with the Domain Name Order (customerid)

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

Understanding Domain Name Expiry and Display of a Parking Page

Whenever a particular domain name is not Renewed till the Expiry Date, it would slip into the Renewal Grace Period. All such domain
names would be put on a temporary commercial Parking Page, which would indicate that the domain name has expired. During this period, any website and mails associated with the domain
name would stop working.

Renewal Grace Period of Domains


TLD (Domain Name Extension) Renewal Grace Period (Days)
.ASIA
.AU
.BIZ
.BZ
.CA
.CC
.CN
.CO
.COM
.COM.DE
.COOP
.DE
.ES
.EU 0 OR 27
.HN
.IN
.IN.NET
.INFO
.JOBS
.ME
.MN
.MOBI
.NAME
.NET
.NL
.NZ
.ORG
.PRO
.PW
.RU
.SC
.SHABAKA
.SX
.TEL
.TV
.UK
.US
.VC
.WEB.IN
.WS
.XXX
CentralNic Domains See details
Donuts Domains See details

Caveats and Domain Name Extension Specific Conditions 

Note

  • The above Renewal Grace Periods are applicable if your domain name is expiring today.

  • If your domain name has already expired, these values may have changed since. Contact our Support Team at
    to confirm the Renewal Grace Period for your domain name.

  • If a .AU domain name (Anchor: aurules) is not Renewed until days after Expiry, the domain name would get Deleted and would immediately be available for Registration.

  • A .CO domain name (Anchor: corules) will continue to resolve to the actual website during the initial 5 days of the Renewal Grace Period. It would then be put on a temporary commercial Parking Page for the remainder of the Renewal Grace Period.

  • A .DE domain name will Expire on the 5th last day of the Expiry month, upon Registration, Renewal or Transfer.

    Examples:

    • If yourdomain.de is registered on January 1, 2011, it's Expiry Date becomes January 27, 2012 as the Registration term is 1 year and the 5th last day of January 2012 is January 27.

    • If yourdomain.de is registered on January 31, 2011, it's Expiry Date becomes January 27, 2012 as the Registration term is 1 year and the 5th last day of January 2012 is January 27.

    .DE domain names (Anchor: derules) should be Renewed prior to their Expiry date.
    Upon Expiry of a .DE domain name:

  • Upon Expiry of an .ES domain name (Anchor: esrules):

    • the .ES Registry would email the Admin Contact listed in the Whois of the domain name, that the domain name has not yet been Renewed and if needed, the domain name
      owner may transfer their domain name under the .ES Registry and then Renew this domain name with them.

    • if the .ES domain name is not Renewed until days, the domain name would get Deleted and would immediately be
      available for Registration.

  • A .EU (Anchor: eurules) domain name registered before 15 Septemeber, 2014 will not have
    any Renewal Grace Period. Such a domain name will expire on the second last day of the month it was registered in and will be Deleted on the same day, if not Renewed.

    Example:

    If you register yourdomainname.eu for 1 year on 15 April, 2013, it will expire on 29 April, 2014 and will be Deleted on the same day, if not Renewed.

    If the domain name is Transferred on 20 December, 2013, it will expire on 29 April, 2015 and will be Deleted on the same day, if not Renewed.

    A .EU domain name registered after 15 Septemeber, 2014 will expire at the end of its registration term. Such a domain name will have a Renewal Grace Period of
    27 days and will be Deleted, if not Renewed during this period.

    Example:

    If you register yourdomainname.eu for 1 year on 20 September, 2014, it will expire on 20 Septemeber, 2015 and will be Deleted, if not Renewed till 17 October, 2015.

    If the domain name is Transferred on 20 December, 2014, it will expire on 20 September, 2016 and will be Deleted, if not Renewed till 17 October, 2016.

  • A .HN domain name (Anchor: hnrules) will not have any Renewal Grace Period. It will
    be Deleted upon Expiry, if not Renewed.

    Example:

    If you register yourdomainname.com.hn for one year on 15 April, 2013, it will be Deleted, if not Renewed until 15 April, 2014.

  • The following rules apply to a .NL domain name (Anchor: nlrules):

    • A .NL domain name can be Renewed for only 1 year.

    • You can not Renew your .NL domain name until 60 days prior to it's Expiry.

    • There is no Renewal Grace Period for a .NL domain name. It would be Deleted upon Expiry and placed under Pending Delete Restorable status.

  • The following rules apply to a .RU (Anchor: rurules) domain name:

    • A .RU domain name can be Renewed for only 1 year.

    • You can not Renew your .RU domain name until 60 days prior to it's Expiry.

    • if the .RU domain name is not Renewed until days after Expiry, the domain name would get Deleted and would
      immediately be available for Registration.

  • You may renew your .UK domain name (Anchor: ukrules)anytime from 6 months
    before its Expiry, upto days after its Expiry    . If you do not renew
    your domain name within days after its Expiry, it would be automatically Deleted by the Registry.

    It is important to note that there is no concept of a Redemption Grace Period in case of a .UK domain name.

When a domain name expires, the Registry auto-renews (Anchor: autorenew) it for a
period of 1 year and locks our funds for the same. However, the Auto-Renewal action is not immediate, but is queued up for execution. This often takes upto 48
hours to complete.

Auto-Renewal 

Note

With the exception of the following, all domain names are Auto-Renewed by their respective Registry upon Expiry:

  • .AU

  • .BIZ

  • .CO See details

  • .COM.DE

  • .DE

  • .ES

  • .HN

  • .NL

  • .RU

  • .TEL

  • .UK

  • .US

  • .WEB.IN

  • .WS

In case of an Auto-Renewed domain name, the Registry Whois displays the Expiry Date one year ahead of the actual date on which the domain name has already expired.

Now, if you were to add another Renewal action, the domain name would get Renewed for an additional year, even though you do not wish it to get Renewed for any more years than you requested.

Note

  • To avoid this situation, the system's Parking action is on purpose left incomplete. The domain name would bear the following status at this stage:

    Action Requested: Parking of <domain name>

    Status of the action: Awaiting update at Registry

  • Please note that Registry Auto-Renewal is different than any other Auto-Renewal feature your Registration Service provider may provide as an addon service for a domain name.

Once the execution is completed at the Registry, the system will complete the Parking action and renew the domain name.

After you have Renewed the domain name, it would take around 24-48 hours for DNS Propagation to complete Worldwide and the actual website to start resolving properly and mails to be received
on the domain name.

DNS Propagation 

Note

During this DNS Propagation period, your website may intermittently revert to the Parking Page and then change again to your actual website, depending on how ISP caches are refreshed.
However, if you have already Renewed your domain name, do not renew your domain name again. The Parking Page will automatically get removed as soon as the
DNS propagation completes.

Once a domain name has expired, it will go to into Renewal Grace Period, where you can renew this domain name at normal costs. If you do not renew the domain name within the
Renewal Grace Period, then it would be queued for deletion at the end of the Renewal Grace Period and subsequently Deleted. The domain name will then go into Redemption Grace Period
generally (provided there is no backorder for this domain name). In this status you would get another chance to redeem
it. See details

Subscribe to domorder