Getting Details of the Domain Registration Order using Domain Name

Description

Gets details of the Domain Registration Order associated with the specified 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 associated with the Domain Registration Order whose details need to be fetched.
options Array of Strings Required Values can be: All, OrderDetails, StatusDetails, ContactIds, RegistrantContactDetails, AdminContactDetails, TechContactDetails, BillingContactDetails, NsDetails, DomainStatus, DNSSECDetails.

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/domains/details-by-name.json?auth-userid=0&api-key=key&domain-name=yourdomain.com&options=OrderDetails

Response

Returns a hash map containing details of the Domain Registration Order as below:

  • Order ID (orderid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived

  • Lock/Hold on the domain name at the Registry (orderstatus) - value(s) will be resellersuspend, resellerlock and/or transferlock

  • Lock/Hold on the domain name in the System (domainstatus) - value(s) will be sixtydaylock and/or renewhold

  • Product Category (productcategory)

  • Product Key (productkey)

  • GDPR Protection (gdpr)

    • Status (key = enabled, value = True/False)

    • Eligibility (key = eligible, value = True/False)

  • Order Creation (at the Registry) Date (creationtime)

  • Registrant Contact Email Address Verification Status (raaVerificationStatus) - value will be Verified, Pending or Suspended

  • Start Time of the Registrant Contact Email Address Verification Process (raaVerificationStartTime) - will not be displayed if the Verification Status is Verified

  • Expiry Date (at the Registry) (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by RID (parentkey)

  • Customer ID Associated with the Order (customerid)

  • Number of Name Servers associated with the Domain Name (noOfNameServers)

  • Name Servers (ns1 and ns2)

  • Child Name Servers (cns)

  • Domain Secret (domsecret)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Privacy Protection allowed for the Product Type (privacyprotectedallowed)

  • Whether Order is Privacy Protected (isprivacyprotected)

  • Privay Protection Details:

    • Privacy Protection Expiry Date (privacyprotectendtime)

    • Privacy Protect Registrant Contact Details (privacy-registrantcontact)

    • Privacy Protect Admin Contact Details (privacy-admincontact)

    • Privacy Protect Technical Contact Details (privacy-techcontact)

    • Privacy Protect Billing Contact Details (privacy-billingcontact)

  • Premium DNS Details

    • Whether Premium DNS is allowed for the Product Type   (premiumdnsallowed)

    • Status of Premium DNS (premiumdnsenabled)

    • Expiry date of the Premium DNS order (premiumdnsendtime)

    • Name Server details for Premium DNS in CSV format (premiumdnsnameservers)

  • Whether Order Deletion is Allowed (allowdeletion)

  • Registrant Contact ID (registrantcontactid)

  • Registrant Contact Details (registrantcontact)

  • Admin Contact ID (admincontactid)

  • Admin Contact Details (admincontact)

  • Technical Contact ID (techcontactid)

  • Technical Contact Details (techcontact)

  • Billing Contact ID (billingcontactid)

  • Billing Contact Details (billingcontact)

  • Auto Renewal (recurring)

  • Delegation Signer (DS) Record Details (dnssec):

    • Key Tag (keytag)

    • Algorithm (algorithm)

    • Digest Type (digesttype)

    • Digest (digest)

Details differ based on the value passed for the options parameter:

Options Details Returned
All All values listed above
OrderDetails domainname, entityid, orderstatus, creationtime, endtime, productcategory, productkey, isImmediateReseller, parentkey, customerid, domsecret, isOrderSuspendedUponExpiry, orderSuspendedByParent, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact, privacy-billingcontact and allowdeletion
ContactIds isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact, privacy-billingcontact, registrantcontactid, admincontactid, techcontactid and billingcontactid
RegistrantContactDetails / AdminContactDetails / TechContactDetails / BillingContactDetails isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact / privacy-admincontact / privacy-techcontact / privacy-billingcontact, registrantcontactid / admincontactid / techcontactid / billingcontactid and registrantOrgConsentDetails 
NsDetails noOfNameServers, ns1, ns2, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact
DomainStatus domainstatus, raaVerificationStatus, raaVerificationStartTime, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact
DNSSECDetails dnssec, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact
Note

  • privacyprotectedallowed will be returned only if Privacy Protection feature is supported for the Product Type (TLD).

  • privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact will be returned only if Privacy Protection is enabled for the domain name.

  • GDPR Protection (gdpr) will return the following values

    • "enabled": "true" will be returned if GDPR Protection has been enabled for a domain name.

    • "enabled": "false" will be returned if GDPR Protection has been disabled for a domain name.

    • "eligible": "true" will be returned if any of the contacts associated with a domain name are from an EEA country. 

    • "eligible": "false" will be returned if any of the contacts associated with a domain name are from an EEA country.

  • registrantOrgConsentDetails will return the following values 
      "isRegistrantOrgConsentApplicable": "true" will be returned if the TLD is applicable for Registrant Org consent changes
      "isRegistrantOrgConsentApplicable": "false" will be returned if the TLD is not applicable for Registrant Org consent changes
      "registrantOrgConsent": "true" will be returned if the consent has been provided
      "registrantOrgConsent": "false" will be returned if the consent has been revoked 
      "registrantOrgConsent": "<null>" will be returned if the consent has not been provided at all for the domain

  • The registrant organization consent is applicable only for gTLD domains