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

Used to transfer a domain name to your account

  • POSTMethod
  • /v2/domains/domainName/transferURL
  • application/jsonContent-Type
Name Type Description Restrictions
domainName 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
Name Type Required / Optional Description Restrictions
quote Boolean Optional If true, validate the request and request a quote for the action
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
privacyProtect Boolean Optional If set to True, privacy protect will be enabled, defaults to False
period Integer Optional The period to add to the domain during the transfer in months, defaults to the minimum period allowed by the registry
authcode String Optional The current auth code for the domain name
  • Maximum length: 64
autoRenew Boolean Optional If set to False, the domain will not be auto renewed upon expiration, defaults to True
ns 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
  • Cannot be used in combination with the "zone" field
  • 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
transferContacts 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
designatedAgent 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
  • cannot be used in combination with the "ns" and "keyData" fields
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
  • Cannot be used in combination with the "zone" field
billables List <billables> Optional Acknowledgment of billables for this request
Name Type Required / Optional Description Restrictions
template String Required Name of the template
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
link Boolean Optional Unless false, the zone is linked to the template
Name Type Required / Optional Description Restrictions
role Enum Required The role for the contact

Possible values:

  • ADMIN
  • BILLING
  • TECH
handle String Required The contact handle
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
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)
publicKey String Required The base64 encoded public key
Name Type Required / Optional Description Restrictions
product String Required The product
action Enum Required The action

Possible values:

  • CREATE
  • TRANSFER
  • RENEW
  • RESTORE
  • TRANSFER_RESTORE
  • UPDATE
  • UPDATE_ADMINISTRATION
  • REGISTRANT_CHANGE
  • LOCAL_CONTACT
  • NEGATIVE_MARKUP
  • PRIVACY_PROTECT
quantity Integer Optional The maximum quantity, default 1

Successful request

  • 200 OKHTTP Status
  • application/jsonContent-Type
Name Type Required / Optional Description
domainName String Required The domain name
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
requestedDate Timestamp Required The date the transfer was initiated
expiryDate Timestamp Optional Expiration date of the transfer after completion, only present when status is "completed"
type Enum Required The type of transfer

Possible values:

  • IN: Transfer to your account
  • OUT: Transfer away from your account
processId Integer Required The unique process identifier for this transfer
  • 202 AcceptedHTTP Status
  • application/jsonContent-Type
Name Type Required / Optional Description
domainName String Required The domain name
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
requestedDate Timestamp Required The date the transfer was initiated
actionDate Timestamp Optional The date the current status will expire
type Enum Required The type of transfer

Possible values:

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

Failed requests

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

Type Status Description
BillableAcknowledgmentNeededException 400 Bad Request
The domain name
If true, validate the request and request a quote for the action
The customer handle
The handle of the contact to use as registrant
If set to True, privacy protect will be enabled, defaults to False
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.
Name of the template
The role for the contact
The contact handle
The role for the contact
The contact handle
The role for the contact
The contact handle
The DNSSEC protocol
The DNSSEC flags
The DNSSEC algorithm
The base64 encoded public key
The product
The action
The maximum quantity, default 1

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

{}