Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Transfer Domain

Used to transfer a domain name to your account

For more information about DNS zone operations and the interactions with domains see our Knowledge Base.

  • POSTMethod
  • /v2/domains/domainName/transferURL
  • application/jsonContent-Type
URL fields
Name Type Description Restrictions
Domain Name String The domain name
  • Regular expression: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])$
  • Minimum length: 3
  • Maximum length: 255
  • Registry specific restrictions may apply
Request parameters
Name Type Required / Optional Description Restrictions
Quote Boolean Optional If true, validate the request and request a quote for the action
Request content fields
Name Type Required / Optional Description Restrictions
Customer String Required The customer handle
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
Registrant String Required The handle of the contact to use as registrant
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
Privacy protect Boolean Optional If set to True, privacy protect will be enabled, defaults to the 'Privacy Protect' setting in your account
Period Integer Optional The period to add to the domain during the transfer in months, defaults to the minimum period allowed by the registry
Auth code String Optional The current auth code for the domain name
  • Maximum length: 64
Auto renew Boolean Optional If set to False, the domain will not be auto renewed upon expiration, defaults to True
Name serves List <String> Optional List of name servers
  • When specified with values, the name servers will be changed during the transfer to the specified list
  • When specified as empty list, the name servers will be removed during the transfer
  • When not specified, the name servers will not be changed during the transfer
  • Regular expression: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])$
  • Maximum number of items: 10
  • Minimum length: 4
  • Maximum length: 255
Preferred FOA contacts List <Enum> Optional Specify the preferred contacts to send the FOA to. Please note that this setting may be overruled because of TLD policy requirements.

Possible values:

  • REGISTRANT
  • ADMIN
Designated agent Enum Optional Indicates for whom you are acting as a designated agent. If a registry does not allow you to be designated agent or interaction with the registrant is still required this parameter is silently ignored. You cannot act as designated agent for the old registrant until the domainis in your account. To use this field with any other value then "NONE" the requesting user must have the "DESIGNATED_AGENT" permission.

Possible values:

  • NONE
  • OLD
  • NEW
  • BOTH
zone zone Optional DNS template to use for the domain name, transform an existing zone of the specified service into a managed zone or creates a new managed zone if not found. Vanity name servers can be specified on the "ns" field.
  • In case a existing zone is used the values the values must match the existing zone or be left empty
contacts List < contacts > Optional Domain contacts and their role
keyData List < keyData > Optional DNSSEC key data
  • When specified with values, the DNSSEC records will be changed during the transfer to the specified list
  • When specified as empty list, the DNSSEC records will be removed during the transfer
  • When not specified, the DNSSEC records will not be changed during the transfer
billables List < billables > Optional Acknowledgment of billables for this request
zone
Name Type Required / Optional Description Restrictions
Service Enum Optional DNS service to provision, defaults to BASIC

Possible values:

  • BASIC: Basic, free DNS
  • PREMIUM: Premium DNS
Template String Optional In case of a new zone, the template to use
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
Link Boolean Optional Unless false, the zone is linked to the template
Master String Optional In case of a new zone, the IP address of the (hidden) master
DNSSEC Boolean Optional In case of a new zone, provision zone with DNSSEC
contacts
Name Type Required / Optional Description Restrictions
Role Enum Required The role for the contact

Possible values:

  • ADMIN
  • BILLING
  • TECH
Contact String Required The contact handle
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
keyData
Name Type Required / Optional Description Restrictions
protocol Integer Required The DNSSEC protocol

Possible values:

  • 3
flags Integer Required The DNSSEC flags

Possible values:

  • 256: 256 (ZSK)
  • 257: 257 (KSK)
algorithm Integer Required The DNSSEC algorithm

Possible values:

  • 3: 3 (DSA/SHA1)
  • 5: 5 (RSA/SHA-1)
  • 6: 6 (DSA-NSEC3-SHA1)
  • 7: 7 (RSASHA1-NSEC3-SHA1)
  • 8: 8 (RSA/SHA-256)
  • 10: 10 (RSA/SHA-512)
  • 12: 12 (GOST R 34.10-2001)
  • 13: 13 (ECDSA Curve P-256 with SHA-256)
  • 14: 14 (ECDSA Curve P-384 with SHA-384)
  • 15: 15 (Ed25519)
  • 16: 16 (Ed448)
  • 17: 17 (SM2 signing algorithm with SM3 hashing algorithm)
  • 23: 23 (GOST R 34.10.2012)
Public key String Required The base64 encoded public key
billables
Name Type Required / Optional Description Restrictions
Product String Required The product
Action Enum Required The action

Possible values:

  • CREATE
  • REQUEST
  • TRANSFER
  • RENEW
  • RESTORE
  • TRANSFER_RESTORE
  • UPDATE
  • REGISTRANT_CHANGE
  • LOCAL_CONTACT
  • NEGATIVE_MARKUP
  • PRIVACY_PROTECT
  • EXTRA_WILDCARD
  • EXTRA_DOMAIN
  • REGISTRY_LOCK
Quantity Integer Optional The maximum quantity, default 1

Successful request

Domain has been transferred successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
Domain Name String Required The domain name
The status Enum Required The status of the transfer

Possible values:

  • pendingwhois: Transfer is pending for whois information
  • pendingfoa: Transfer is pending approval from authorized contact
  • pendingvalidation: Transfer is pending registrant validation
  • pending: Transfer has is pending at the registry
  • approved: Transfer has been approved by authorized contact
  • cancelled: Transfer has been cancelled by customer
  • rejected: Transfer has been rejected by registry or registrant
  • failed: Transfer has failed
  • completed: Transfer is completed
Requested date Timestamp Required The date the transfer was initiated
Expire date Timestamp Optional Expiration date of the transfer after completion, only present when status is "completed"
Transfer type Enum Required The type of transfer

Possible values:

  • IN: Transfer to your account
  • OUT: Transfer away from your account
The process ID of the transfer Integer Required The unique process identifier for this transfer
Domain transfer has been requested successfully, you will be notified with the final result
  • 202 AcceptedHTTP Status
  • application/jsonContent-Type
Response fields
Name Type Required / Optional Description
Domain Name String Required The domain name
The status Enum Required The status of the transfer

Possible values:

  • pendingwhois: Transfer is pending for whois information
  • pendingfoa: Transfer is pending approval from authorized contact
  • pendingvalidation: Transfer is pending registrant validation
  • pending: Transfer has is pending at the registry
  • approved: Transfer has been approved by authorized contact
  • cancelled: Transfer has been cancelled by customer
  • rejected: Transfer has been rejected by registry or registrant
  • failed: Transfer has failed
  • completed: Transfer is completed
Requested date Timestamp Required The date the transfer was initiated
Action date Timestamp Optional The date the current status will expire
Transfer type Enum Required The type of transfer

Possible values:

  • IN: Transfer to your account
  • OUT: Transfer away from your account
The process ID of the transfer Integer Required The unique process identifier for this transfer

Failed requests

Besides the generic errors these specific error responses can be expected.

Error responses
Type Status Description
BillableAcknowledgmentNeededException 400 Bad Request
URL fields
The domain name
Request parameters
If true, validate the request and request a quote for the action
Request parameters
The customer handle
The handle of the contact to use as registrant
If set to True, privacy protect will be enabled, defaults to the 'Privacy Protect' setting in your account
The period to add to the domain during the transfer in months, defaults to the minimum period allowed by the registry
The current auth code for the domain name
If set to False, the domain will not be auto renewed upon expiration, defaults to True
List of name servers
  • When specified with values, the name servers will be changed during the transfer to the specified list
  • When specified as empty list, the name servers will be removed during the transfer
  • When not specified, the name servers will not be changed during the transfer
Specify the preferred contacts to send the FOA to. Please note that this setting may be overruled because of TLD policy requirements.
Indicates for whom you are acting as a designated agent. If a registry does not allow you to be designated agent or interaction with the registrant is still required this parameter is silently ignored. You cannot act as designated agent for the old registrant until the domainis in your account. To use this field with any other value then "NONE" the requesting user must have the "DESIGNATED_AGENT" permission.
zone
DNS service to provision, defaults to BASIC
In case of a new zone, the template to use
Unless false, the zone is linked to the template
In case of a new zone, the IP address of the (hidden) master
In case of a new zone, provision zone with DNSSEC
contacts
The role for the contact
The contact handle
The role for the contact
The contact handle
The role for the contact
The contact handle
keyData
The DNSSEC protocol
The DNSSEC flags
The DNSSEC algorithm
The base64 encoded public key
billables
The product
The action
The maximum quantity, default 1
Request

POST /v2/domains/domainName/transfer
Content-Type: application/json 

{}
Response