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 or auth-password 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 set below:

  • .ASIA IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here.

  • .BIZ IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:

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

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

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

  • .ORG IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets below:

  • .PW IDN: The character set depends upon the language chosen for the Internationalized Domain Name. You can refer to supported character sets here.

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

  • .UK

tech-contact-id Integer Required

The Technical Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .UK

billing-contact-id Integer Required

The Billing Contact of the domain name.

Note

Pass -1 for the following TLDs:

  • .EU

  • .UK

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.

protect-privacy Boolean Required

Enables / Disables the Privacy Protection setting for the domain name.

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

  • .ASIA

  • .EU

  • .IN

  • .UK

  • .US

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:

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

      idnLanguageCode=aze
    • .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 - sw

      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

      • Danish - da

      • German - de

      • Hungarian - hu

      • Icelandic - is

      • Korean - ko

      • Latvian - lv

      • Lithuanian - lt

      • Polish - pl

      • Spanish - es

      • Swedish - sw

      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

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

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)

  • Selling Price for Customers (sellingamount)

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