Schemas
UpdateTheftProtectionRequest
enabledWhen true, enables theft protection; when false, disables it.
otpOne-time password when required for the operation.
twoFactorTypeTwo-factor authentication type when required.
UpdateNameserversRequest
nsNew Name Servers. A maximum of 13 Name Servers can be specified(repeatable).
otpOTP to authenticate the request when two-factor authentication is enabled.
twoFactorTypeType of 2FA authentication.
UpdateGdprRequest
enabledWhen true, enables GDPR protection; when false, disables it.
RegistrationAttribute
nameAttribute name for the TLD-specific extension.
Supported attribute keys
- idnLanguageCode — IDN language code for the character set; codes vary by TLD (e.g. ko, de, latin).
- phase — Registration phase for sunrise, prega, or landrush.
- smd — Content of the SMD file (sunrise phase).
- tm-claim — Trademark claim acceptance — use value accepted.
- cedcontactid — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).
- id-type — .AU eligibility ID type.
- id — .AU eligibility ID matching the selected id-type (number or string).
- policyReason — .AU eligibility reason when registering an .AU domain.
- isAUWarranty — .AU registrant warranty acceptance — must be true when sent.
- eligibilityType — .AU eligibility type — required for Trademark/Other id-type (e.g. Trademark Owner or Pending TM Owner, Other).
- eligibilityName — .AU eligibility name (company name) — required for Trademark id-type.
- registrantName — .AU registrant name — required for certain BN/Trademark/Other id-types; must be an individual proprietor.
- organisationId — .BR tax/organisation ID (CPF for individual, CNPJ for company).
- cnhosting — .CN hosting in China — true when domain will be hosted in China.
- cnhostingclause — .CN hosting terms acceptance — yes when registrant agrees.
- tnc — Terms and conditions acceptance — Y/y for European registrant data-sharing or gTLD TNC.
- intended-use — .QUEBEC / .SCOT intended use description (e.g. commercial use).
- whois-type — .TEL whois type for registrant.
- publish — .TEL publish contact details in WHOIS (required when whois-type is Natural).
- service-contact — .UK service contact ID for non-UK registrant on 2nd level .UK domains.
- regulatorybody — Regulatory body for professional TLDs (.LAWYER, .DENTIST, etc.) when offering professional services.
- registrant-org-consent — Registrant organization consent for gTLDs with registrant organization value.
- premium — Registry premium domain registration — true.
- eap — Early Access Program registration — true.
valueAttribute value. Meaning depends on name — see the attribute catalog and value tables on DomainRegistrationRequest.attributes.
UpdateDomainContactsRequest
regContactIdContact to use as the new Registrant Contact.
adminContactIdContact to use as the new Admin Contact.
techContactIdContact to use as the new Technical Contact.
billingContactIdContact to use as the new Billing Contact.
sixtyDayLockOptoutOpt out of the 60-day lock placed after Registrant Contact change (gTLDs, IRTP opt-in registrars).
designatedAgentPass true to opt for Designated Agent (default false).
Optional extra details as name/value pairs (e.g. skipIRTP, tnc for .FR/.SCOT/.NZ).
UpdateAuthCodeRequest
authCodeDomain authorization code. For gTLDs, must contain at least one letter, one number, and one special character; this requirement may not apply to ccTLDs.
otpOTP to authenticate the request when two-factor authentication is enabled.
twoFactorTypeType of 2FA authentication.
SearchTransferOutDomainsRequest
noOfRecordspageNoproductkeydomainnamesortTransferOutDomainDto
actionAddedTimestamp when the transfer-away action was added.
descriptionFree-text description of the action or domain row.
domainNameFully qualified domain name (FQDN).
orderIdDomain registration order identifier.
statusOverall operation status (for example, Success or Failed).
DomainRegistrationRequest
domainNameDomain name that you need to Register. For an Internationalized Domain Name, refer to the supported character sets per TLD (.ASIA, .BIZ, .CA, .CO, .COM/.NET, .DE, .ES, .EU, .IN.NET, .INFO, .NAME, .ORG, .PW, .TEL, CentralNic IDN TLDs, etc.). The domain name may be provided in Unicode (native language) or Punycode format.
yearsNumber of years for which you wish to Register this domain name. Note: .AI domains can only be registered for 2 years.
nsThe Name Servers of the domain name. Submitted as repeatable form field ns.
customerIdThe Customer for whom you wish to Register this domain name.
regContactIdThe Registrant Contact of the domain name.
adminContactIdThe Administrative Contact of the domain name. Note: Pass -1 for .EU, .RU, .UK.
techContactIdThe Technical Contact of the domain name. Note: Pass -1 for .EU, .FR, .RU, .UK.
billingContactIdThe Billing Contact of the domain name. Note: Pass -1 for .AT, .BERLIN, .CA, .EU, .FR, .NL, .NZ, .RU, .UK, .LONDON.
invoiceOptionControls how the Customer Invoice will be handled for this registration order.
Allowed values
| Value | Description |
|---|---|
| NoInvoice | No invoice; order executed immediately |
| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |
| KeepInvoice | Invoice for later payment; order executed |
| OnlyAdd | Invoice for later payment; registration pending until paid |
autoRenewEnables or disables the Auto Renewal setting for the domain name.
protectPrivacyEnables or disables the Privacy Protection setting for the domain name.
purchasePrivacyAdds the Privacy Protection service for the domain name. Not supported for .ASIA, .AT, .AU, .CA, .CL, .CN, .ORG.CO/.MIL.CO/.GOV.CO/.EDU.CO, .DE, .ES, .EU, .FR, .HN, .IN, .NL, .NZ, .PRO, .RU, .SX, .TEL, .UK, .US.
purchasePremiumDnsPurchase Premium DNS service.
Optional TLD-specific and phase-specific extra details. Each entry is a name/value pair for extensions such as IDN language codes, sunrise phase, or registry premium flags.
Supported attribute keys
- idnLanguageCode — IDN language code for the character set; codes vary by TLD (e.g. ko, de, latin).
- phase — Registration phase for sunrise, prega, or landrush.
Allowed values
| Value | Description |
|---|---|
| sunrise | Sunrise phase registration — requires smd attribute |
| prega | Regular pre-registration phase |
| landrush | Priority pre-registration (landrush) phase |
- smd — Content of the SMD file (sunrise phase).
- tm-claim — Trademark claim acceptance — use value accepted.
- cedcontactid — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).
- id-type — .AU eligibility ID type.
Allowed values
| Value | Description |
|---|---|
| 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 |
| ARBN | Australian Registered Body Number |
| Other | Other eligibility ID type — requires eligibilityType |
- id — .AU eligibility ID matching the selected id-type (number or string).
- policyReason — .AU eligibility reason when registering an .AU domain.
Allowed values
| Value | Description |
|---|---|
| 1 | Exact match, abbreviation, or acronym of domain name |
| 2 | Close and substantial connection to the domain name |
- isAUWarranty — .AU registrant warranty acceptance — must be true when sent.
Allowed values
| Value | Description |
|---|---|
| true | True |
| false | False |
- eligibilityType — .AU eligibility type — required for Trademark/Other id-type (e.g. Trademark Owner or Pending TM Owner, Other).
- eligibilityName — .AU eligibility name (company name) — required for Trademark id-type.
- registrantName — .AU registrant name — required for certain BN/Trademark/Other id-types; must be an individual proprietor.
- organisationId — .BR tax/organisation ID (CPF for individual, CNPJ for company).
- cnhosting — .CN hosting in China — true when domain will be hosted in China.
- cnhostingclause — .CN hosting terms acceptance — yes when registrant agrees.
- tnc — Terms and conditions acceptance — Y/y for European registrant data-sharing or gTLD TNC.
- intended-use — .QUEBEC / .SCOT intended use description (e.g. commercial use).
- whois-type — .TEL whois type for registrant.
Allowed values
| Value | Description |
|---|---|
| Natural | Individual registrant |
| Legal | Organization registrant |
- publish — .TEL publish contact details in WHOIS (required when whois-type is Natural).
Allowed values
| Value | Description |
|---|---|
| Y | Publish contact details in WHOIS |
| N | Do not publish contact details in WHOIS (required when whois-type is Natural) |
- service-contact — .UK service contact ID for non-UK registrant on 2nd level .UK domains.
- regulatorybody — Regulatory body for professional TLDs (.LAWYER, .DENTIST, etc.) when offering professional services.
- registrant-org-consent — Registrant organization consent for gTLDs with registrant organization value.
- premium — Registry premium domain registration — true.
Allowed values
| Value | Description |
|---|---|
| true | True |
| false | False |
- eap — Early Access Program registration — true.
Allowed values
| Value | Description |
|---|---|
| true | True |
| false | False |
DomainPrivacyDetailsDto
orderIdOrder identifier for the privacy protection action.
actionTypeDescHuman-readable description of the privacy action type.
entityIdEntity identifier for the privacy protection order.
actionStatusStatus of the privacy protection action.
statusOverall operation status.
netCustomerCostNet customer cost for privacy protection.
eaqIdEAQ identifier for the privacy action.
customerIdCustomer identifier associated with the privacy action.
noOfDaysNumber of days covered by the privacy protection purchase.
descriptionDomain or action description in the response.
domainNameDomain name associated with the privacy protection action.
actionTypeAction type key for privacy protection.
invoiceIdInvoice identifier for the privacy protection charge.
customerCostCustomer cost for privacy protection.
actionStatusDescHuman-readable action status description.
priorityPriority value for the privacy action when provided.
actionStartedEpoch timestamp when the privacy action started.
sellingCurrencySymbolCurrency symbol for privacy selling amounts.
unutilisedSellingAmountUnutilised selling amount for privacy protection.
sellingAmountSelling amount for privacy protection.
statusUpdateTimeEpoch timestamp of the last status update.
actionAddedEpoch timestamp when the privacy action was added.
entityTypeIdEntity type identifier for the privacy action.
SubmitTransferAuthCodeRequest
authCodeDomain Secret or Authorization Code for the domain name being transferred.
RestoreDomainRequest
invoiceOptionControls how the Customer Invoice will be handled.
AddResellerLockRequest
reasonReason for applying the Reseller Lock.
RenewDomainRequest
yearsNumber of years for which you want to Renew this Order. Note: .AI domains can only be renewed for 2 years.
expDateCurrent Expiry Date of the Order in UNIX epoch time format.
invoiceOptionControls how the Customer Invoice will be handled.
autoRenewEnables or disables the Auto Renewal setting for the domain name.
purchasePrivacyRenews the Privacy Protection service for the domain name. Not supported for .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.
purchasePremiumDnsPurchase Premium DNS Service.
premiumRegistry premium domain renewal. Set to true when renewing a registry premium domain.
PurchasePremiumDnsRequest
invoiceOptionPurchasePremiumDnsResultEntryDto
domainNameFully qualified domain name for the purchase row.
entityIdInternal entity identifier for the domain order.
descriptionDomain description returned by the registrar.
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
statusRow-level operation status (for example, Success or error).
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type identifier (for example, PurchasePremiumDNS).
errorError message when the row status is error.
ApproveLosingIrtpVerificationRequest
reasonReason for approving the losing IRTP authorization.
CancelIrtpVerificationRequest
reasonReason for cancellation.
PurchasePrivacyProtectionRequest
invoiceOptionControls how the Customer Invoice will be handled.
discountAmountOptional discount amount applied to this privacy protection purchase.
AddDnssecRecordRequest
keytagTag value of the DNSKEY Resource Record that validates this signature. Integer in the range 0 to 65536.
algorithmCryptographic algorithm used to generate the signature. Integer in the range 0 to 255.
digestTypeAlgorithm type used to construct the Digest. Values 1, 2, and 3 for .COM / .NET; 1 and 2 for other supported extensions.
Allowed values
| Value | Description |
|---|---|
| 1 | SHA-1 digest (40-character hex digest) |
| 2 | SHA-256 digest (64-character hex digest) |
| 3 | GOST R 34.11-94 digest (.COM / .NET only; 64-character hex digest) |
digestAlpha-numeric string from applying the Digest Type algorithm. 40 characters for Digest Type 1; 64 characters for Digest Types 2 and 3.
AddChildNameServerRequest
cnsChild Name Server name to add.
ipIP address to associate with the Child Name Server (v1 field ip).
InitiateDomainTransferRequest
customerIdThe Customer for whom the Order should be added.
regContactIdThe Registrant Contact of the domain name. For .UK, the Registrant identity must not change during transfer.
adminContactIdThe Administrative Contact. Pass -1 for .EU, .RU, .UK (no admin contact).
techContactIdThe Technical Contact. Pass -1 for .EU, .RU, .UK.
billingContactIdThe Billing Contact. Pass -1 for .AT, .BERLIN, .CA, .EU, .NL, .NZ, .RU, .UK. field billing-contact-id.
invoiceOptionControls how the Customer Invoice will be handled.
autoRenewEnables or disables the Auto Renewal setting for the domain name.
authCodeAuthorization Code (Domain Secret) of the domain name to transfer. Optional for most TLDs; required at order placement for .AU, .CA, .DE, .EU, .NZ. May be submitted later via submit-auth-code when omitted.
purchasePrivacyAdds the Privacy Protection service. Not supported for .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.
protectPrivacyEnables or disables the Privacy Protection setting for the domain name.
nsName Servers to associate with the domain name (maximum 13). Submitted as repeatable form field ns.
purchasePremiumDnsPurchase Premium DNS Service.
discountAmountOptional discount amount applied to this transfer.
Optional TLD-specific extra details as name/value pairs for transfer-specific extensions.
Supported attribute keys
- cedcontactid — .ASIA Charter Eligibility Declaration Contact ID (Admin, Technical, Billing, or Registrant contact ID).
- type — Premium domain type — premium (registry premium) or premiumft (aftermarket premium).
- premiumprice — Aftermarket premium price when type is premiumft (used as attr-value2 with type).
- tnc — Terms and conditions acceptance — Y or y for .FR, .SCOT, .NZ (EEA contact), etc.
- registrant-org-consent — Registrant organization consent for gTLDs with registrant organization value.
- premium — Registry premium domain transfer — set to true for premium domains.
BulkRegisterDomainsRequest
domainNamesDomain names to register. Submitted as repeated domain-name form fields.
yearsRegistration period in years.
nsName servers for the domain. Submitted as repeatable form field ns.
registrantContactIdRegistrant contact id (reg-contact-id).
adminContactIdAdministrative contact id.
techContactIdTechnical contact id.
billingContactIdBilling contact id.
customerIdCustomer id for the registration order.
invoiceOptionHow the customer invoice is handled for this order.
Allowed values
| Value | Description |
|---|---|
| NoInvoice | No invoice; order executed immediately |
| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |
| KeepInvoice | Invoice for later payment; order executed |
| OnlyAdd | Invoice for later payment; registration pending until paid |
idnLanguageIDN language code when registering an internationalized domain name.
BulkTransferDomainEntry
domainNameauthCodeBulkTransferDomainsRequest
Domain and auth-code pairs (domain-name1/auth-code1, domain-name2/auth-code2, etc.).
registrantContactIdRegistrant contact id shared across all domains (reg-contact-id).
adminContactIdAdministrative contact id.
techContactIdTechnical contact id.
billingContactIdBilling contact id.
customerIdCustomer id for the transfer order.
protectPrivacyWhether privacy protection is enabled.
invoiceOptionHow the customer invoice is handled.
Allowed values
| Value | Description |
|---|---|
| NoInvoice | No invoice; order executed immediately |
| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |
| KeepInvoice | Invoice for later payment; order executed |
| OnlyAdd | Invoice for later payment; registration pending until paid |
BulkRenewDomainsRequest
domainNamesDomain names to renew. Submitted as repeated domain-name form fields.
customerIdCustomer id for the renewal order.
tenureRenewal period.
invoiceOptionHow the customer invoice is handled for this renewal.
Allowed values
| Value | Description |
|---|---|
| NoInvoice | No invoice; order executed immediately |
| PayInvoice | Raise invoice; pay from debit balance if sufficient, otherwise pending |
| KeepInvoice | Invoice for later payment; order executed |
| OnlyAdd | Invoice for later payment; registration pending until paid |
UpdatePrivacyProtectionRequest
protectPrivacyEnable or disable the Privacy Protection service. Possible values are true or false.
reasonReason for enabling or disabling Privacy Protection.
otpOTP to authenticate the request when two-factor authentication is enabled.
twoFactorTypeType of 2FA authentication.
UpdateChildNameServerNameRequest
newCnsNew Child Name Server host name (new-cns).
UpdateChildNameServerIpRequest
oldIpCurrently associated IP address (old-ip).
newIpNew IP address to associate (new-ip).
BulkUpdateNameserversRequest
customerIdCustomer id shared across all domains in the request.
domainNamesDomain names to update. Submitted as repeated domain-name form fields.
nsName servers to apply. Submitted as repeatable form field ns.
BulkUpdateContactsRequest
customerIdCustomer id shared across all domains in the request.
domainNamesDomain names to update. Submitted as repeated domain-name form fields.
registrantContactIdRegistrant contact id (reg-contact-id).
adminContactIdAdministrative contact id.
techContactIdTechnical contact id.
billingContactIdBilling contact id.
TldInfoEntryDto
tldTop-level domain or extension (for example, com, in.net).
privacyAvailableWhether privacy protection is available for this TLD.
registryRegistry operator name.
typeTLD category (for example, generic or country-code).
lockingAvailableWhether registrar lock is available for this TLD.
Launch-phase scheduling metadata for the TLD.
TldInfoPhaseDto
phaseLaunch phase name (for example, ga).
startPhase start timestamp when provided by the registry.
DomainSearchResultEntityDto
orderIdDomain registration order identifier.
customerIdCustomer account identifier that owns the domain order.
entityIdInternal entity identifier for the domain order.
autoRenewWhether auto-renew is enabled on the search result row.
endTimeEnd time for a TLD phase or promotion.
resellerLockWhether the reseller lock is enabled on the order.
timestampLast-updated or event timestamp for the order row.
customerLockWhether the customer lock is enabled on the order.
entityTypeIdEntity type identifier for the order record.
currentStatusCurrent lifecycle status of the domain registration order.
entityTypeKeyEntity type key for the search result row.
transferLockWhether the registrar transfer lock is enabled.
creationTimeUNIX timestamp when the domain order was created.
privacyProtectionPrivacy protection status on the search result row.
entityTypeNameEntity type display name for the search result row.
creationDtCreation date on the search result row.
descriptionFree-text description of the action or domain row.
DomainChildNameServerDto
hostnameFully qualified child nameserver hostname.
ipAddressesIP addresses associated with the child nameserver.
DomainContactDetailDto
contactIdContact identifier.
customerIdCustomer identifier.
companyCompany name.
parentKeyParent key reference.
stateState or province.
phoneCountryCodeTelephone country code.
emailEmail address.
addressLine1Address line 1.
addressLine2Address line 2.
addressLine3Address line 3.
contactStatusContact status.
typeContact type.
cityCity.
countryCountry code.
zipcodePostal or ZIP code.
phoneTelephone number.
contactTypeRegistry-specific contact type tags.
DomainDetailDto
actionCompletedCount or flag indicating how many domain actions have completed.
addNameServerAdd Name Server for this domain operation.
Add-on products associated with the domain order.
Administrative contact details for the domain order.
adminContactIdContact identifier for the administrative contact.
adminEmailAddressEmail address of the administrative contact.
allowDeletionWhether the domain order can be deleted by the caller.
autoRenewAttemptDurationNumber of days over which auto-renewal attempts are made.
autoRenewTermTypeAuto-renewal term type (for example, LONG_TERM).
Billing contact details for the domain order.
billingContactIdContact identifier for the billing contact.
bulkWhoisOptoutBulk WHOIS opt-out flag.
classKeyProduct class key used for pricing and availability.
classNameJava class name for the domain order type.
Child nameservers configured for the domain (hostname and IP addresses).
completionTimeTimestamp when the operation completed.
createdTimeTimestamp when the order record was created.
creationTimeUNIX timestamp when the domain order was created.
currentOrderTenureCurrent order tenure in months.
currentStatusCurrent lifecycle status of the domain registration order.
customerCostCustomer cost for the domain order.
customerIdCustomer account identifier that owns the domain order.
customerLockWhether the customer lock is enabled on the order.
deleteNameServerDelete Name Server for this domain operation.
deletedDateDate when the domain order was deleted.
deletionDateDate when the domain order was or will be deleted.
descriptionFree-text description of the action or domain row.
designatedAgentDesignated agent information for transfer approval.
displayPrivacyEndTimeFormatted privacy protection end time for display.
DNSSEC Delegation Signer (DS) records for the domain.
domainEndTimeDomain expiry timestamp as stored on the order.
domainHashInternal hash grouping related domain order fields.
domainNameFully qualified domain name (FQDN).
domainProtectPlusEndTimeDomain Protect Plus End Time for this domain operation.
domainSecretDomain authorization secret (EPP/auth code).
domainStatusSystem lock/hold flags on the domain (for example, sixtydaylock, renewhold).
dpsSubscriptionLevelDomain Protect Suite subscription level.
effectiveServiceProviderIdEffective service provider used for registry operations.
eaqIdEntity action queue identifier when applicable.
enablePrivacyProtectWhether privacy protection should be enabled.
endTimeEnd time for a TLD phase or promotion.
entityIdInternal entity identifier for the domain order.
entityTypeIdEntity type identifier for the order record.
expiryExpiry timestamp or date for the domain.
expiryDateHuman-readable or formatted domain expiry date after renewal.
fromAutoRenewWhether the renewal was triggered by the auto-renew scheduler.
GDPR privacy protection details for the domain (enabled and eligible flags).
gdprIndicatorIndicator showing GDPR applicability or consent state.
invoiceIdInvoice identifier created when the bulk operation generated billable orders.
isAutoRenewWhether automatic renewal is enabled for the domain order.
isBrokeredWhether the premium domain is brokered.
isDomainProtectPlusAllowedIndicates is domain protect plus allowed.
isDomainProtectPlusTwoFaDisabledIndicates is domain protect plus two fa disabled.
isImmediateResellerWhether the order belongs to a customer directly under the reseller.
isOrderSuspendedUponExpiryWhether the order is suspended due to expiry.
isPremiumWhether the domain is classified as premium.
isPremiumDnsAllowedIndicates is premium dns allowed.
isPremiumDnsEnabledIndicates is premium dns enabled.
isPrivacyAllowedWhether privacy protection is allowed for this TLD or order.
isPrivacyProtectedWhether WHOIS privacy protection is currently enabled.
isRegistrarPrivilegedWhether the reseller has registrar-privileged access.
Jump conditions associated with the domain order.
lockingAvailableWhether domain locking is available for this TLD or order.
modifiedChildNsIpModified Child Ns Ip for this domain operation.
modifiedChildNsNameModified Child Ns Name for this domain operation.
moneyBackPeriodMoney-back guarantee period in days.
multilingualFlagMultilingual support flag for the domain.
newRegistrarName of the gaining registrar for an outgoing transfer.
nsNs for this domain operation.
ns1Nameserver hostname for slot 1.
ns10Nameserver hostname for slot 10.
ns11Nameserver hostname for slot 11.
ns12Nameserver hostname for slot 12.
ns13Nameserver hostname for slot 13.
ns2Nameserver hostname for slot 2.
ns3Nameserver hostname for slot 3.
ns4Nameserver hostname for slot 4.
ns5Nameserver hostname for slot 5.
ns6Nameserver hostname for slot 6.
ns7Nameserver hostname for slot 7.
ns8Nameserver hostname for slot 8.
ns9Nameserver hostname for slot 9.
nsHashNs Hash for this domain operation.
numberOfNameServersNumber Of Name Servers for this domain operation.
numberOfYearsRegistration or renewal period in years.
oldRegistrarName of the losing registrar for an incoming transfer.
orderIdDomain registration order identifier.
orderStatusRegistry lock/hold flags (for example, transferlock, resellerlock).
orderSuspendedByParentWhether the order is suspended by a parent account.
parentIdParent order identifier when this order is a child order.
parentKeyProduct parent key for bundled or dependent orders.
pausedWhether the domain order is paused.
premiumDnsEndTimePremium Dns End Time for this domain operation.
premiumDnsNameServersPremium Dns Name Servers for this domain operation.
premiumDnsSsoLoginSupportedPremium Dns Sso Login Supported for this domain operation.
privacyEndTimePrivacy protection end time on the order.
privacyProtectEndTimeTimestamp when privacy protection expires.
privacyProtectionStatusPrivacy protection status label for the order.
productCategoryProduct category for the domain order.
productKeyProduct key identifying the TLD or product type.
raaVerificationStartTimeTimestamp when RAA verification was started.
raaVerificationStatusRegistrant email address (RAA) verification status.
recurringWhether the order is on a recurring billing cycle.
Registrant contact details for the domain order.
registrantContactIdContact identifier for the domain registrant.
registrantEmailEmail address of the domain registrant.
registrantNameName of the domain registrant.
Registrant organization consent details for applicable gTLD domains.
registrarCompanyNameRegistrar company name displayed to end users.
registrarNameICANN registrar name for the domain.
requestTimeTimestamp when the request was received.
resellerCostReseller cost for the domain order.
resellerIdReseller account identifier associated with the domain order.
resellerLockWhether the reseller lock is enabled on the order.
serviceProviderIdService provider identifier for registry routing.
sixtyDayLockOptOutWhether the registrant opted out of the 60-day transfer lock.
sixtyDayLockStatusCurrent 60-day transfer lock status after IRTP verification.
Technical contact details for the domain order.
techContactIdContact identifier for the technical contact.
timestampLast-updated or event timestamp for the order row.
tncRequiredWhether terms and conditions acceptance is required.
tldTop-level domain suffix (for example, com or net).
transferDateDate when the domain transfer was initiated or completed.
transferLockWhether the registrar transfer lock is enabled.
transferOnRenewalWhether the domain transfers to the renewing registrar on renewal.
transferTypeType of domain transfer (for example, incoming or outgoing).
Execution metadata for renewal and other domain actions.
DomainDnssecDsRecordDto
keytagDNSSEC key tag for the DS record.
algorithmDNSSEC algorithm identifier.
digestTypeDigest type used for the DS record.
digestDS record digest value.
DomainExecutionInfoParamsDto
rpInfoRpDomainIdRegistry provider domain identifier for the in-flight action.
invoiceIdInvoice identifier associated with the domain action.
isBulkWhether the action was submitted as a bulk operation.
currentExpDateCurrent domain expiry timestamp at action time.
addActionUserDetailsUser and role details recorded when the action was created.
actionInvoiceMapInvoice mapping for the action.
roleRole of the user who initiated the action.
paymentTypePayment type used for the action.
rpInfoRpActionStatusRegistry provider action status.
autoRenewalWhether auto-renewal was enabled for the action.
rpInfoRpActionIdRegistry provider action identifier.
serviceProviderIdService provider identifier for the action.
addActionIpAddressIP address recorded when the action was created.
discountDiscount amount applied to the action.
customerCostCustomer cost for the action from execution metadata.
userIdUser identifier that initiated the action.
noOfYearsNumber of years requested for renewal or registration.
DomainGdprDetailsDto
enabledWhether GDPR privacy protection is enabled for the domain.
eligibleWhether the domain is eligible for GDPR privacy protection.
DomainRegistrantOrgConsentDetailsDto
isRegistrantOrgConsentApplicableWhether registrant organization consent changes apply to this TLD.
isRegistrantOrgPlaceholderWhether the registrant organization field is a placeholder.
registrantOrgConsentConsent state: true if provided, false if revoked, or null if never provided.
IrtpContactInfoDto
organizationOrganization name for the contact.
nameContact name.
idContact identifier.
emailContact email address.
IrtpStatusDto
Contact information for the losing registrar.
losingFoaStatusForm of Authorization status at the losing registrar.
Contact information for the gaining registrar.
gainingFoaStatusForm of Authorization status at the gaining registrar.
expiryIRTP verification expiry timestamp.
taskStatusWorkflow task status for IRTP verification.
messageAdditional IRTP status message.
sixtyDayLockStatusCurrent 60-day transfer lock status after IRTP verification.
IrtpVerificationDetailsDto
domainNameFully qualified domain name (FQDN).
orderIdDomain registration order identifier.
Nested IRTP workflow status details.
DomainAvailabilityDto
domainNameclasskeystatustmClaimsKeyrorsampleerrorPendingTransferDto
actionIdIdentifier of the pending transfer action.
actionStatusStatus code of the queued domain action.
addedOnTimestamp when the transfer action was created.
customerIdCustomer account identifier that owns the domain order.
domainNameFully qualified domain name (FQDN).
lastUpdatedOnTimestamp when the transfer action was last updated.
orderIdDomain registration order identifier.
resellerIdReseller account identifier associated with the domain order.
DeleteDnssecRecordRequest
keytagKey Tag value associated with the DS Record.
algorithmAlgorithm associated with the DS Record.
digestTypeDigest Type associated with the DS Record. Values 1, 2, and 3 for .COM / .NET; 1 and 2 for other supported extensions.
Allowed values
| Value | Description |
|---|---|
| 1 | SHA-1 digest (40-character hex digest) |
| 2 | SHA-256 digest (64-character hex digest) |
| 3 | GOST R 34.11-94 digest (.COM / .NET only; 64-character hex digest) |
digestDigest associated with the DS Record (40 characters for type 1, 64 for types 2 and 3).
AddChildNameServerResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
AddDnssecRecordResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
AddResellerLockResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
ApproveLosingIrtpVerificationResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
BulkAddDomainsResponse
domainsInProcessingDomain names accepted for processing.
invalidDomainsDomain names rejected by validation.
BulkRenewDomainsBulkResponse
invoiceIdInvoice identifier when billing applies.
validOrdersDomain names successfully renewed.
statusOverall operation status.
BulkTransferDomainsBulkResponse
invalidTransferDomainDomain names that failed transfer validation.
statusOverall operation status.
BulkUpdateContactsBulkResponse
invalidDomainDomain names that failed validation.
statusOverall operation status.
BulkUpdateNameserversBulkResponse
invalidDomainDomain names that failed validation.
statusOverall operation status.
CancelGdprDisableResponse
actionStatusStatus code of the queued domain action.
entityIdInternal entity identifier for the domain order.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
descriptionFree-text description of the action or domain row.
domainNameFully qualified domain name (FQDN).
CancelIrtpVerificationResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
CheckIdnAvailabilityResponse
statusOverall operation status (for example, Success or Failed).
classkeyProduct class key used for pricing and availability.
CheckPremiumDomainResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
costHashCost Hash for this domain operation.
premiumPremium for this domain operation.
DeleteChildNameServerIpResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
DeleteDnssecRecordResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
DeleteDomainResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
DomainLockDetail
addedByUser or system that added the domain lock.
brandNameBrand name associated with the lock entry.
creationDtUNIX timestamp when the lock was created.
isParentWhether the lock was applied at the parent reseller level.
lockerIdIdentifier of the user or role that applied the lock.
lockerKeyLock type key (for example, resellerlock, customerlock, or transferlock).
reasonReason the domain lock was applied.
DomainSearchResponse
Collection of domain entries returned for this operation.
totalItemsTotal number of matching records in the database.
itemsOnPageNumber of records returned on this page.
GenerateEmailOtpResponse
successSuccess status.
GetCustomerDefaultNameserversResponse
nameServersList of default name servers of the customer.
GetDomainByNameResponse
Nested domain registration order details.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
GetDomainByOrderIdResponse
Nested domain registration order details.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
GetIrtpVerificationStatusResponse
IRTP (Inter-Registrar Transfer Policy) verification details.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
GetTldInfoResponse
One entry per TLD returned by the catalog lookup.
GetTrademarkNoticeResponse
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
InitiateDomainTransferResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
Privacy protection purchase details returned with domain mutation action envelopes.
ListDomainLocksResponse
resellerLockWhether the reseller lock is enabled on the order.
transferLockWhether the registrar transfer lock is enabled.
customerLockWhether the customer lock is enabled on the order.
Detail rows for locks currently applied to the requested domain order.
ListGdprDisabledTldsResponse
disabledTldsTLDs where GDPR privacy protection is currently disabled.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
countTotal number of GDPR-disabled TLDs in the list response.
listList array of TLD suffix strings (same entries as disabledTlds).
ListPendingTransfersResponse
Pending inbound domain transfers matching the query.
totalItemsTotal number of matching records in the database.
itemsOnPageNumber of records returned on this page.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
PurchasePrivacyProtectionResponse
actionStatusStatus code of the queued domain action.
entityIdInternal entity identifier for the domain order.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
descriptionRegisterDomainResponse
actionStatusWorkflow status of the registration action.
actionStatusDescHuman-readable registration action status.
actionTypeDescHuman-readable description of the registration action type.
entityIdEntity identifier for the domain order.
eaqIdEAQ identifier for the registration action.
actionTypeRegistration action type key.
currentActionCurrent action identifier when present in the response.
descriptionRegistered domain name.
statusOverall workflow status (for example Success or PendingDomainVerification).
customerIdCustomer identifier for the registration.
orderIdDomain registration order identifier.
invoiceIdInvoice identifier when billing applies.
sellingAmountSelling amount for the registration.
unutilisedSellingAmountUnutilised selling amount for the registration.
sellingCurrencySymbolCurrency symbol for selling amounts.
errorAdvisory workflow message when the order is accepted but processing is delayed; not an HTTP error indicator.
Nested privacy protection purchase details when applicable.
RemoveResellerLockResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
RenewDomainResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
expiryDateHuman-readable or formatted domain expiry date after renewal.
fromAutoRenewWhether the renewal was triggered by the auto-renew scheduler.
isAutoRenewWhether automatic renewal is enabled for the domain order.
noOfYearsRegistration or renewal period in years.
sendInvoiceMailWhether an invoice email should be sent after renewal.
customerIddomainNamecustomerCostorderIdinvoiceIdnetCustomerCostendTimeResendClaimsApprovalResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
ResendGdprAuthorizationResponse
actionStatusStatus code of the queued domain action.
entityIdInternal entity identifier for the domain order.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
ResendIrtpVerificationResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
ResendRaaVerificationResponse
successWhether the boolean-style operation succeeded.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
ResendTransferApprovalResponse
successWhether the boolean-style operation succeeded.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
RestoreDomainResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
SearchTransferOutDomainsResponse
Collection of domain entries returned for this operation.
totalItemsTotal number of matching records in the database.
itemsOnPageNumber of records returned on this page.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
SubmitTransferAuthCodeResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
errorError message when the operation failed.
successWhether the boolean-style operation succeeded.
UpdateAuthCodeResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
UpdateChildNameServerIpResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
UpdateChildNameServerNameResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
UpdateDomainContactsResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the queued operation.
currentActiondescriptionFree-text description of the action or domain row.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
designatedAgentDesignated agent information for transfer approval.
sixtyDayLockOptoutSixty Day Lock Optout for this domain operation.
UpdateDomainNameServerResponse
actionTypeDescHuman-readable description of the action type.
entityIdInternal entity identifier for the domain order.
actionStatusStatus code of the queued domain action.
statusOverall operation status (for example, Success or Failed).
eaqIdEntity action queue identifier for tracking the operation.
currentActionCurrent queued action type for nameserver updates.
descriptionFree-text description of the action or domain row.
actionTypeAction type code for the queued operation.
actionStatusDescHuman-readable description of the action status.
UpdateGdprResponse
actionStatusAction status for the operation.
entityIdEntity identifier for the action.
statusStatus text.
messageResult message.
domainNameDomain name when returned on disable flows.
UpdatePrivacyProtectionResponse
actionStatusStatus code of the queued domain action.
entityIdInternal entity identifier for the domain order.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
descriptionUpdateTheftProtectionResponse
actionStatusStatus code of the queued domain action.
actionStatusDescHuman-readable description of the action status.
actionTypeDescHuman-readable description of the action type (for example, Enable Theft Protection).
entityIdInternal entity identifier for the domain order.
eaqIdEntity action queue identifier for tracking the operation.
actionTypeAction type code for the operation (for example, Lock or Unlock).
descriptionDomain name or free-text description of the action.
statusOverall operation status (for example, Success or Failed).
errorError code from the operation (for example, NoError).
ValidateDomainNameserversResponse
successWhether the boolean-style operation succeeded.
statusOverall operation status (for example, Success or Failed).
messageAdditional status or error message from the operation.
ValidateIdnDomainResponse
domainNameDomain name validated (from the response body when present, otherwise from the request).
resultValidation outcome. Returns "Success" when the response body is empty, or the per-domain validation message or top-level error detail.