--- title: "Retrieve details for the specified Domain" method: GET path: "/v2/customers/{customerId}/domains/{domain}" tags: ["Domains"] --- # Retrieve details for the specified Domain `GET /v2/customers/{customerId}/domains/{domain}` ## Path parameters - `customerId` string, required - `domain` string, required ## Query parameters - `includes` string[] ## Headers - `X-Request-Id` string ## Response `200` Request was successful - DomainDetailV2 - `domainId` string, required — Unique identifier for this Domain - `domain` string, domain, required — Name of the domain - `subaccountId` string — Reseller subaccount shopperid who can manage the domain - `status` 'ACTIVE' | 'CANCELLED' | 'DELETED_REDEEMABLE' | 'EXPIRED' | 'FAILED' | 'LOCKED_REGISTRAR' | 'PARKED' | 'HELD_REGISTRAR' | 'OWNERSHIP_CHANGED' | 'PENDING_TRANSFER' | 'PENDING_REGISTRATION' | 'REPOSSESSED' | 'SUSPENDED' | 'TRANSFERRED', required — The current status of the domain

ACTIVE - Domain has been registered and is active.
CANCELLED - Domain has been cancelled by the user or system, and is not be reclaimable.
DELETED_REDEEMABLE - Domain is deleted but is redeemable.
EXPIRED - Domain has expired.
FAILED - Domain registration or transfer error.
LOCKED_REGISTRAR - Domain is locked at the registrar - this is usually the result of a spam, abuse, etc.
PARKED - Domain has been parked.
HELD_REGISTRAR - Domain is held at the registrar and cannot be transferred or modified - this is usually the result of a dispute.
OWNERSHIP_CHANGED - Domain has been moved to another account.
PENDING_TRANSFER - Domain transfer has been requested and is pending the transfer process.
PENDING_REGISTRATION - Domain is pending setup at the registry.
REPOSSESSED - Domain has been confiscated - this is usually the result of a chargeback, fraud, abuse, etc.).
SUSPENDED - Domain is in violation and has been suspended.
TRANSFERRED - Domain has been transferred to another registrar.

- `expiresAt` string, iso-datetime — Date and time when this domain will expire - `expirationProtected` boolean, required — Whether or not the domain is protected from expiration - `holdRegistrar` boolean, required — Whether or not the domain is on-hold by the registrar - `locked` boolean, required — Whether or not the domain is locked to prevent transfers - `privacy` boolean, required — Whether or not the domain has privacy protection - `registrarCreatedAt` string, iso-datetime — Date and time when this domain was created by the registrar - `renewAuto` boolean, required — Whether or not the domain is configured to automatically renew - `renewDeadline` string, iso-datetime, required — Date the domain must renew on - `transferProtected` boolean, required — Whether or not the domain is protected from transfer - `createdAt` string, iso-datetime, required — Date and time when this domain was created - `deletedAt` string, iso-datetime — Date and time when this domain was deleted - `modifiedAt` string, iso-datetime — Date and time when this domain was last modified - `transferAwayEligibleAt` string, iso-datetime — Date and time when this domain is eligible to transfer - `authCode` string, required — Authorization code for transferring the Domain - `nameServers` string[], required — Fully-qualified domain names for DNS servers - `hostnames` string[] — Hostnames owned by the domain - `renewal` RenewalDetails - `renewable` boolean — Whether or not the domain is eligble for renewal based on status - `price` integer, required — Price for the domain renewal excluding taxes or fees - `currency` string, iso-currency-code, required — Currency in which the `price` is listed - `verifications` VerificationsDomainV2 - `icann` 'COMPLETED' | 'PENDING' | 'UNABLE_TO_RETRIEVE_STATUS' — Status of the Icann verification of domain registrant contact by completing email and/or phone verification

COMPLETED - Icann verification has been completed.
PENDING - Icann verification has not been completed.
UNABLE_TO_RETRIEVE_STATUS - Icann verification not supported for specified TLD.

APPROVED - All is well
PENDING - Real name verification is working its way through the workflow
REJECTED_DOCUMENT_OUTDATED - Local government verification shows there is a newer version of your document. Upload the latest version of the document and retry real name verification
REJECTED_EXPIRED_BUSINESS_LICENSE - Business license is expired
REJECTED_EXPIRED_ORGANIZATION_CODE - Organization code certificate number has expired
REJECTED_ILLEGIBLE_DOCUMENT_NAME - There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification
REJECTED_ILLEGIBLE_IDENTIFICATION - Registrant identification is not clear. Upload a better image to retry
REJECTED_INCOMPLETE_IDENTIFICATION - Registrant identification is incomplete
REJECTED_INCOMPLETE_REGISTRATION_LETTER - Registration letter is incomplete
REJECTED_INCONSISTENT_IDENTITY_CARD - Provided identity card is inconsistent with the identity card on record
REJECTED_INCONSISTENT_ORGANIZATION_CODE - Provided organization information is inconsistent with the results obtained using the submitted organization code
REJECTED_INCONSISTENT_REGISTRANT_NAME - Name on the registrant identification does not match the name in the system
REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE - Your document contains an invalid business license or organization code certificate number
REJECTED_INVALID_DOCUMENT - Document is invalid. Please upload another document to retry real name verification
REJECTED_MISMATCH_BUSINESS_ID - Business id does not match the business id in the document
REJECTED_MISMATCH_BUSINESS_NAME - Business name does not match the business name in the document
REJECTED_MISMATCH_DOCUMENT_ID - Document id does not match the id in the document
REJECTED_MISMATCH_DOCUMENT_NAME - Document name does not match the name in the document
REJECTED_MISMATCH_DOCUMENT_TYPE - Document type does not match the document
REJECTED_MISMATCH_REGISTRANT_INFO - The information provided for the registrant does not match the document
REJECTED_MISMATCH_REGISTRANT_LOCALITY - Registrant region is overseas, but a local identity document was provided
REJECTED_MISMATCH_REGISTRANT_NAME - Registrant name has been changed, so the request must be resubmitted
REJECTED_UNABLE_TO_OPEN - Registrant identification could not be opened. Please upload the document again to retry real name verification
REJECTED_UNABLE_TO_VERIFY - Unable to initiate verification. Please upload the document again to retry real name verification
REJECTED_UNKNOWN_ERROR - Document was rejected due to an unknown error. For more information, contact customer support
UNABLE_TO_RETRIEVE_STATUS - Unable to retrieve status for the real name verification process. Retry, if this status persists, contact customer support

- `domainName` 'APPROVED' | 'PENDING' | 'REJECTED' | 'UNABLE_TO_RETRIEVE_STATUS' — Status of the verification of the domain name against a prohibited list maintained by the government - `contacts` DomainContactsV2, required - `registrant` ContactDomain - `contactId` string — Unique identifier for this Contact - `encoding` 'ASCII' | 'UTF-8' — The encoding of the contact data

ASCII - Data contains only ASCII characters that are not region or language specific
UTF-8 - Data contains characters that are specific to a region or language

- `nameFirst` string, person-name, required - `nameMiddle` string - `nameLast` string, person-name, required - `organization` string, organization-name - `jobTitle` string - `email` string, email, required - `phone` string, phone, required - `fax` string, phone - `addressMailing` Address, required - `address1` string, street-address, required - `address2` string, street-address2 - `city` string, city-name, required - `country` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KV' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TP' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', iso-country-code, required — Two-letter ISO country code to be used as a hint for target region

NOTE: These are sample values, there are many more - `postalCode` string, postal-code, required — Postal or zip code - `state` string, state-province-territory, required — State or province or territory - `exposeRegistrantOrganization` boolean, required — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` boolean, required — Whether or not the contact details should be shown in the WHOIS - `metadata` object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds` string[] — The tlds that this contact can be assigned to - `_createdAt` string, iso-datetime — Timestamp indicating when the contact was created - `_modifiedAt` string, iso-datetime — Timestamp indicating when the contact was last modified - `_deleted` boolean — Flag indicating if the contact has been logically deleted in the system - `_revision` integer — The current revision number of the contact. - `admin` ContactDomain - `contactId` string — Unique identifier for this Contact - `encoding` 'ASCII' | 'UTF-8' — The encoding of the contact data

ASCII - Data contains only ASCII characters that are not region or language specific
UTF-8 - Data contains characters that are specific to a region or language

- `nameFirst` string, person-name, required - `nameMiddle` string - `nameLast` string, person-name, required - `organization` string, organization-name - `jobTitle` string - `email` string, email, required - `phone` string, phone, required - `fax` string, phone - `addressMailing` Address, required - `address1` string, street-address, required - `address2` string, street-address2 - `city` string, city-name, required - `country` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KV' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TP' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', iso-country-code, required — Two-letter ISO country code to be used as a hint for target region

NOTE: These are sample values, there are many more - `postalCode` string, postal-code, required — Postal or zip code - `state` string, state-province-territory, required — State or province or territory - `exposeRegistrantOrganization` boolean, required — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` boolean, required — Whether or not the contact details should be shown in the WHOIS - `metadata` object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds` string[] — The tlds that this contact can be assigned to - `_createdAt` string, iso-datetime — Timestamp indicating when the contact was created - `_modifiedAt` string, iso-datetime — Timestamp indicating when the contact was last modified - `_deleted` boolean — Flag indicating if the contact has been logically deleted in the system - `_revision` integer — The current revision number of the contact. - `tech` ContactDomain - `contactId` string — Unique identifier for this Contact - `encoding` 'ASCII' | 'UTF-8' — The encoding of the contact data

ASCII - Data contains only ASCII characters that are not region or language specific
UTF-8 - Data contains characters that are specific to a region or language

- `nameFirst` string, person-name, required - `nameMiddle` string - `nameLast` string, person-name, required - `organization` string, organization-name - `jobTitle` string - `email` string, email, required - `phone` string, phone, required - `fax` string, phone - `addressMailing` Address, required - `address1` string, street-address, required - `address2` string, street-address2 - `city` string, city-name, required - `country` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KV' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TP' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', iso-country-code, required — Two-letter ISO country code to be used as a hint for target region

NOTE: These are sample values, there are many more - `postalCode` string, postal-code, required — Postal or zip code - `state` string, state-province-territory, required — State or province or territory - `exposeRegistrantOrganization` boolean, required — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` boolean, required — Whether or not the contact details should be shown in the WHOIS - `metadata` object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds` string[] — The tlds that this contact can be assigned to - `_createdAt` string, iso-datetime — Timestamp indicating when the contact was created - `_modifiedAt` string, iso-datetime — Timestamp indicating when the contact was last modified - `_deleted` boolean — Flag indicating if the contact has been logically deleted in the system - `_revision` integer — The current revision number of the contact. - `billing` ContactDomain - `contactId` string — Unique identifier for this Contact - `encoding` 'ASCII' | 'UTF-8' — The encoding of the contact data

ASCII - Data contains only ASCII characters that are not region or language specific
UTF-8 - Data contains characters that are specific to a region or language

- `nameFirst` string, person-name, required - `nameMiddle` string - `nameLast` string, person-name, required - `organization` string, organization-name - `jobTitle` string - `email` string, email, required - `phone` string, phone, required - `fax` string, phone - `addressMailing` Address, required - `address1` string, street-address, required - `address2` string, street-address2 - `city` string, city-name, required - `country` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KV' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SX' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TP' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', iso-country-code, required — Two-letter ISO country code to be used as a hint for target region

NOTE: These are sample values, there are many more - `postalCode` string, postal-code, required — Postal or zip code - `state` string, state-province-territory, required — State or province or territory - `exposeRegistrantOrganization` boolean, required — Whether or not the domain registrant contact organization field should be shown in the WHOIS - `exposeWhois` boolean, required — Whether or not the contact details should be shown in the WHOIS - `metadata` object — The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} - `tlds` string[] — The tlds that this contact can be assigned to - `_createdAt` string, iso-datetime — Timestamp indicating when the contact was created - `_modifiedAt` string, iso-datetime — Timestamp indicating when the contact was last modified - `_deleted` boolean — Flag indicating if the contact has been logically deleted in the system - `_revision` integer — The current revision number of the contact. - `actions` Action[] — List of current actions in progress for this domain - `type` 'AUTH_CODE_PURCHASE' | 'AUTH_CODE_REGENERATE' | 'AUTO_RENEWAL' | 'BACKORDER_PURCHASE' | 'BACKORDER_DELETE' | 'BACKORDER_UPDATE' | 'CHANGE_OF_REGISTRANT_DELETE' | 'CONTACT_CREATE' | 'CONTACT_DELETE' | 'CONTACT_UPDATE' | 'DNS_VERIFICATION' | 'DNSSEC_CREATE' | 'DNSSEC_DELETE' | 'DOMAIN_DELETE' | 'DOMAIN_UPDATE' | 'DOMAIN_UPDATE_CONTACTS' | 'DOMAIN_UPDATE_NAME_SERVERS' | 'EXPIRY' | 'HOST_CREATE' | 'HOST_DELETE' | 'ICANN_VERIFICATION' | 'MIGRATE' | 'MIGRATE_IN' | 'PREMIUM' | 'PRIVACY_FORWARDING_UPDATE' | 'PRIVACY_PURCHASE' | 'PRIVACY_DELETE' | 'REDEEM' | 'REGISTER' | 'RENEW' | 'RENEW_UNDO' | 'TRADE' | 'TRADE_CANCEL' | 'TRADE_PURCHASE' | 'TRADE_PURCHASE_AUTH_TEXT_MESSAGE' | 'TRADE_RESEND_AUTH_EMAIL' | 'TRANSFER' | 'TRANSFER_IN' | 'TRANSFER_IN_ACCEPT' | 'TRANSFER_IN_CANCEL' | 'TRANSFER_IN_RESTART' | 'TRANSFER_IN_RETRY' | 'TRANSFER_OUT' | 'TRANSFER_OUT_ACCEPT' | 'TRANSFER_OUT_REJECT' | 'TRANSFER_OUT_REQUESTED' | 'TRANSIT', required — The type of action being performed

AUTH_CODE_PURCHASE - Request for an auth code for a .de domain via POST /v2/customers/{customerId}/domains/{domain}/purchaseAuthCode.
AUTH_CODE_REGENERATE - Request to regenerate the authCode for a domain via POST /v2/customers/{customerId}/domains/{domain}/regenerateAuthCode
AUTO_RENEWAL - A Domain Auto Renew is in progress.
BACKORDER_PURCHASE - Request to purchase a domain backorder via POST /v2/customers/{customerId}/domains/backorders/purchase.
BACKORDER_DELETE - Request to cancel the current domain backorder via DELETE /v2/customers/{customerId}/domains/backorders/{domain}.
BACKORDER_UPDATE - Request update the current domain backorder via PATCH /v2/customers/{customerId}/domains/backorders/{domain}.
CHANGE_OF_REGISTRANT_DELETE - Request to delete a change of registrant request via DELETE /v2/customers/{customerId}/domains/{domain}/changeOfRegistrant.
CONTACT_CREATE - Request to create a contact via POST /v2/customers/{customerId}/domains/contacts.
CONTACT_DELETE - Request to delete a contact via DELETE /v2/customers/{customerId}/domains/contacts/{contactId}
CONTACT_UPDATE - Request to update a contact via PATCH /v2/customers/{customerId}/domains/contacts/{contactId}
DNS_VERIFICATION - Domain requires zone file setup.
DNSSEC_CREATE - Request to create DNSSEC record for the domain via PATCH /v2/customers/{customerId}/domains/{domain}/dnssecRecords.
DNSSEC_DELETE - Request to delete DNSSEC record for the domain via DELETE /v2/customers/{customerId}/domains/{domain}/dnssecRecords.
DOMAIN_DELETE - Request to delete the domain via DELETE /v2/customers/{customerId}/domains/{domain}
DOMAIN_UPDATE - Request to update the domain via PATCH /v2/customers/{customerId}/domains/{domain}
DOMAIN_UPDATE_CONTACTS -Request to update the domain contacts via PATCH /v2/customers/{customerId}/domains/{domain}/contacts
DOMAIN_UPDATE_NAME_SERVERS - Request to update the domain name servers via PUT /v2/customers/{customerId}/domains/{domain}/nameServers
EXPIRY - A Domain Expiration is in progress.
HOST_CREATE - Request to create a hostname via PUT /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}
HOST_DELETE - Request to delete a hostname via DELETE /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}
ICANN_VERIFICATION - Domain requires registrant verification for Icann.
PREMIUM - Premium Domain domain sale is in progress.
PRIVACY_FORWARDING_UPDATE - Request to update privacy forwarding information via PATCH /v2/customers/{customerId}/domains/{domain}/privacy/forwarding.
PRIVACY_DELETE - Request to remove privacy from a domain via DELETE /v2/customers/{customerId}/domains/{domain}/privacy
REDEEM - Request to redeem a domain via POST /v2/customers/{customerId}/domains/{domain}/redeem
REGISTER - Request to register a domain via POST /v2/customers/{customerId}/domains/{domain}/register
RENEW - Request to renew a domain via POST /v2/customers/{customerId}/domains/{domain}/renew
RENEW_UNDO - Request to undo a renewal for a uk domain via POST /v2/customers/{customerId}/domains/{domain}/undoRenew
TRADE - A domain trade request is in progress
TRADE_CANCEL - Request to cancel a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeCancel
TRADE_PURCHASE - Request to purchase a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchase
TRADE_PURCHASE_AUTH_TEXT_MESSAGE - Request for a trade purchase text message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchaseAuthorizationTextMessage
TRADE_RESEND_AUTH_EMAIL - Request to resend the trade auth email message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeResendAuthorizationEmail
TRANSFER - Request to transfer a domain via POST /v2/customers/{customerId}/domains/{domain}/transfer
TRANSFER_IN - A domain transfer in request is in progress.
TRANSFER_IN_ACCEPT - Request to accept a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInAccept
TRANSFER_IN_CANCEL - Request to cancel a domain transfer via POST /v2/customers/{customerId}/domains/{domain}/transferInCancel
TRANSFER_IN_RESTART - Request to restart a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInRestart
TRANSFER_IN_RETRY - Request to retry a domain transfer in via POST /v2/customers/{customerId}/domains/{domain}/transferInRetry
TRANSFER_OUT - A domain transfer out request is in progress.
TRANSFER_OUT_ACCEPT - Request to accept a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutAccept
TRANSFER_OUT_REJECT - Request to reject a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutReject
TRANSFER_OUT_REQUESTED - Request to transfer out for a domain (.de) via POST /v2/customers/{customerId}/domains/{domain}/transferOut
TRANSIT - Request to transit a de or at domain at the registry via POST /v2/customers/{customerId}/domains/{domain}/transit

- `origination` 'USER' | 'SYSTEM', required — The origination of the action

USER - These are user requests.
SYSTEM - These are system processing actions.

- `createdAt` string, iso-datetime, required — Timestamp indicating when the action was created - `startedAt` string, iso-datetime — Timestamp indicating when the action was started - `completedAt` string, iso-datetime — Timestamp indicating when the action was completed - `modifiedAt` string, iso-datetime — Timestamp indicating when the action was last modified - `status` 'ACCEPTED' | 'AWAITING' | 'CANCELLED' | 'FAILED' | 'PENDING' | 'SUCCESS', required — The current status of the action

ACCEPTED - The action has been queued, processing has not started.
AWAITING - The action is waiting on a user input.
CANCELLED - The action has been cancelled by the user.
FAILED - An error occurred while the action was processing, no more processing will be performed.
PENDING - The action is being processed.
SUCCESS - The action has completed, no additional processing is required.

- `reason` ActionReason - `code` string, constant, required — Short identifier, suitable for indicating the reason for the current status and how to handle within client code - `message` string — Human-readable, English description of the code - `fields` ErrorField[] — List of the specific fields, and the errors found with their contents - `code` string, constant, required — Short identifier for the error, suitable for indicating the specific error within client code - `message` string — Human-readable, English description of the problem with the contents of the field - `path` string, json-path, required —

JSONPath referring to a field containing an error

JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`

RSAMD5 - [01] DRSA/MD5
DSA - [03] DSA/SHA1
RSASHA1 - [05] RSA/SHA-1
DSA_NSEC3_SHA1 - [06] DSA-NSEC3-SHA1
RSASHA1_NSEC3_SHA1 - [07] RSASHA1-NSEC3-SHA1
RSASHA256 - [08] RSA/SHA-256
RSASHA512 - [10] RSA/SHA-512
ECC_GOST - [12] GOST R 34.10-2001
ECDSAP256SHA256 - [13] ECDSA Curve P-256 with SHA-256
ECDSAP384SHA384 - [14] ECDSA Curve P-384 with SHA-384
ED25519 - [15] Ed25519
ED448 - [16] Ed448

- `keyTag` integer — This is an integer value less than 65536 used to identify the DNSSEC record for the domain name. - `digestType` 'SHA1' | 'SHA256' | 'GOST' | 'SHA384' — This identifies the algorithm used to construct the digest

SHA1 - [01] SHA-1
SHA256 - [02] SHA-256
GOST - [03] GOST R 34.11-94
SHA384 - [04] SHA-384

- `digest` string — The digest is an alpha-numeric value - `flags` 'ZSK' | 'KSK' — This identifies the key type; either a Zone-Signing Key or a Key-Signing Key

ZSK - [256] Zone-Signing Key
KSK - [257] Key-Signing Key

- `publicKey` string — Registries use this value to encrypt DS records. Decryption requires a matching public key - `maxSignatureLife` integer — This specifies the validity period for the signature. The value is expressed in seconds. You can use any integer value larger than zero - `registryStatusCodes` string[] — The current registry status codes of the domain

ADD_PERIOD - This grace period is provided after the initial registration of a domain name.
AUTO_RENEW_PERIOD - This grace period is provided after a domain name registration period expires and is extended (renewed) automatically by the registry.
CLIENT_DELETE_PROHIBITED - This status code tells your domain's registry to reject requests to delete the domain.
CLIENT_HOLD - This status code tells your domain's registry to not activate your domain in the DNS and as a consequence, it will not resolve.
CLIENT_RENEW_PROHIBITED - This status code tells your domain's registry to reject requests to renew your domain.
CLIENT_TRANSFER_PROHIBITED - This status code tells your domain's registry to reject requests to transfer the domain from your current registrar to another.
CLIENT_UPDATE_PROHIBITED - This status code tells your domain's registry to reject requests to update the domain.
INACTIVE - This status code indicates that delegation information (name servers) has not been associated with your domain.
OK - This is the standard status for a domain, meaning it has no pending operations or prohibitions.
PENDING_CREATE - This status code indicates that a request to create your domain has been received and is being processed.
PENDING_DELETE - This status code indicates that the domain is either in a redemption period if combined with either REDEMPTION_PERIOD or PENDING_RESTORE, if not combined with these, then indicates that the redemption period for the domain has ended and domain will be be purged and dropped from the registry database.
PENDING_RENEW - This status code indicates that a request to renew your domain has been received and is being processed.
PENDING_RESTORE - This status code indicates that your registrar has asked the registry to restore your domain that was in REDEMPTION_PERIOD status
PENDING_TRANSFER - This status code indicates that a request to transfer your domain to a new registrar has been received and is being processed.
PENDING_UPDATE - This status code indicates that a request to update your domain has been received and is being processed.
REDEMPTION_PERIOD - This status code indicates that your registrar has asked the registry to delete your domain.
RENEW_PERIOD - This grace period is provided after a domain name registration period is explicitly extended (renewed) by the registrar.
SERVER_DELETE_PROHIBITED - This status code prevents your domain from being deleted.
SERVER_HOLD - This status code is set by your domain's Registry Operator. Your domain is not activated in the DNS.
SERVER_RENEW_PROHIBITED - This status code indicates your domain's Registry Operator will not allow your registrar to renew your domain.
SERVER_TRANSFER_PROHIBITED - This status code prevents your domain from being transferred from your current registrar to another.
SERVER_UPDATE_PROHIBITED - This status code locks your domain preventing it from being updated.
TRANSFER_PERIOD - This grace period is provided after the successful transfer of a domain name from one registrar to another.

## Other responses - `203` — Request was partially successful, but actions, contacts, and/or verifications may not be included. - `401` — Authentication info not sent or invalid - `403` — Authenticated user is not allowed access - `404` — The contact does not exist - `422` — `domain` must be specified - `429` — Too many requests received within interval - `500` — Internal server error --- [API](https://skmtc.net/godaddy/apis/domains-api.md) · [All operations](https://skmtc.net/godaddy/apis/domains-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/godaddy/domains-api/revisions/475bd0561c3c/schema)