Knipp DRS Payload Specification (Version 2.0)

Table of contents

Table of contents

Preface

General information concerning request/response syntax

This payload definition specifies the syntax of requests accepted by the Knipp Domain Registration System (DRS) and the corresponding responses. The protocol allows the provisioning of objects managed for customers within the DRS. These objects are:

Domain objects (associated with contact and host objects). When a domain is hosted on the DRS name servers (as opposed to a customer's own name servers), a domain may additionally be associated with web and e-mail forwarding configurations, a zone configuration (for literal DNS zone data), or a stealth name server (i.e., a hidden primary name server). These objects may be added to a domain via separate commands.
Contact objects (associated with domain objects in certain roles, such as registrant or administrator).
Host objects (associated with domain objects as name servers).
Stealth objects (containing a hidden primary name server if your domain uses DRS name servers).
Zone objects (containing literal DNS data records if your domain uses DRS name servers).
Web- or E-mail forwarding configurations (containing web/e-mail forwarding information if your domain uses DRS name servers).
Mailbox configurations (containing mailbox information if your domain uses DRS name servers).

The payload protocol format consists of key/value pairs where each pair is given on a separate input/output line of the request/response; key and value are separated by a colon. The following general rules apply:

The order in which the lines appear is not important.
Whitespace at the beginning of request lines and before and after the key-value separator ':' is allowed and not considered as a part of the key or value.
To enable the use of whitespace at the beginning of a value and multi-line fields, the DRS will accept the quoting convention of using double quotes (") at the beginning and end of the value.
To enter double quotes within field values specified this way, two double quotes ("") must be used.
Most commands require the specification of the involved registry (registry.id). Domain, contact and host objects are always bound to a specific registry and cannot be used in conjunction with objects belonging to a different registry.

Command Availablity Matrix

Command

afilias

neulevel

gnr

verisign

neustar

dotcoop

cnnic

cnnic.idn

pir

denic

misc

alien

twnic

eurid

dotaero

dotmobi

inregistry

dotasia

domen

telnic

switch

iis

itnic

icmregistry

atnic

nominet

sidn

dottv

create contact

yes

limited*

yes

limited*

yes

create host

— command is registry independent —

create domain

yes

delete contact

yes

—

yes

delete host

yes

—

yes

delete domain

— command is registry independent —

schedule domain deletion

yes

set domain extend decision

yes

restore domain (at the registry and in the DRS database)

—

yes

—

yes

—

limited*

yes

—

limited*

—

limited*

—

limited*

yes

—

yes

transit domain

—

yes

—

yes*

—

push a domain to another registrar

—

yes*

—

inquire contact

yes

inquire host

— command is registry independent —

inquire domain

— command is registry independent —

inquire web forwarding config

yes

inquire e-mail forwarding config

yes

inquire zone config

yes

inquire stealth server

yes

inquire mailbox config

yes

check domains

— command is registry independent —

modify contact

yes

—

yes

modify host

yes

—

yes

modify domain

yes

yes*

—

yes

yes*

yes

set web forwarding config

yes

set email forwarding config

yes

set email forwarding config from pending objects

yes

set zone config

yes

add records to zone config

yes

remove records from zone config

yes

set stealth server

yes

set mailbox config

yes

request domain transfer

yes

—

yes

yes*

—

yes

request domain transfer + trade

—

request domain trade

—

yes

—

cancel domain transfer

yes

—

yes

—

yes

reply domain transfer

yes

—

yes

—

yes

create a forestalled domain transfer decision

yes

delete a forestalled domain transfer decision

yes

modify domain status

— command is registry independent —

poll request

— command is registry independent —

poll acknowledge

— command is registry independent —

poll status

— command is registry independent —

start e-mail verification

— command is registry independent —

inquire an e-mail address's verification status

— command is registry independent —

* see comments on corresponding command

afilias	Afilias real-time registry Afilias registry, responsible for the `.info` TLD.
neulevel	Neulevel real-time registry Neulevel registry, responsible for the `.biz` TLD.
gnr	Global Name Registry real-time registry Global Name Registry, responsible for the `.name` TLD.
verisign	VeriSign real-time registry VeriSign registry, responsible for the `.com`, `.net` and (before January 25th, 2003) `.org` TLD.
neustar	Neustar real-time registry Neustar registry, responsible for the `.US` TLD.
dotcoop	DotCooperation LLC real-time registry DotCooperation LLC (dotCoop), responsible for the `.coop` TLD. Registry is operated by Poptel.
cnnic	CNNIC real-time registry (for pure ASCII domains) CNNIC registry, responsible for the `.cn` TLD. Registry is operated by Neustar.
cnnic.idn	CNNIC real-time registry (for IDN domains) CNNIC registry, responsible for the `.cn` and `.xn--fiqs8s` TLDs. Registry is operated by Neustar.
pir	Public Interest Registry real-time system Public Interest Registry, responsible for the `.org` TLD (after January 25th, 2003).
denic	DENIC e-mail based registry DENIC, responsible for the `.de` CCTLD.
misc	common registry type for miscellaneous domains Special pseudo registry for various CCTLDs and other registries which do not support automated domain registration.
alien	common registry type for 'alien' domains Special pseudo registry for domains which are not registered by Knipp but belong to Knipp customers and are available for value added services.
twnic	TWNIC real-time registry TWNIC registry, responsible for the `.tw` TLD. Registry is operated by Neustar.
eurid	EURid real-time registry EURid registry, responsible for the `.eu` TLD.
dotaero	Dotaero real-time registry Dotaero registry, responsible for the `.aero` TLD. Registry is operated by Afilias.
dotmobi	dotmobi real-time registry dotmobi, responsible for the `.mobi` TLD. Registry is operated by Afilias.
inregistry	.in real-time registry INRegistry, responsible for the `.in` TLD. Registry is operated by Afilias.
dotasia	.asia real-time registry dotasia, responsible for the `.asia` TLD. Registry is operated by Afilias.
domen	.me real-time registry domen, responsible for the `.me` TLD. Registry is operated by doMEn, a joint venture partnering with Afilias.
telnic	.tel real-time registry Telnic registry, responsible for the `.tel` TLD.
switch	SWITCH real-time registry SWITCH registry, responsible for the `.ch` and `.li` TLDs.
iis	IIS (.se) real-time registry IIS, responsible for the `.se` TLD.
itnic	it nic (.it) real-time registry ITNIC, responsible for the `.it` TLD.
icmregistry	.xxx real-time registry ICM Registry, responsible for the `.xxx` TLD.
atnic	.at real-time registry nic.at, responsible for the `.at` TLD.
nominet	.uk real-time registry Nominet, responsible for the `.uk` TLD.
sidn	.nl real-time registry SIDN (Foundation for Internet Domain Registration in the Netherlands), responsible for the `.nl` TLD.
dottv	.tv real-time registry .tv real-time registry

Commands

Table of contents

Command type: create contact

Description:

Create a new contact object.

Registry Specific Notes:

switch:

For .ch/.li contacts, only the localized variant of contact postal data (specified in contact.i15d.* fields) is supported.

atnic:

For .at contacts, only the internationalized variant of contact postal data is supported. The contact.i15d.* fields are therefore not supported.

Request format:

	Key	Occurrence	Value type/content	Description
	request.type	Required	Fixed: 'contact.create'	Identifies the command type for contact creation.
	contact.id	Optional	Character string (ASCII subset)	The ID (handle) of the contact to create. If omitted, an automatic ID will be used and returned. Registry Specific Notes: atnic: The .at registry does not support the specification of contact IDs by the registrar. IDs are always auto-generated by the registry. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
	payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
	transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
	customer.id	Required	Integer value	Id of the requesting customer.
	person.id	Required	Integer value	Id of the requesting person.
	request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
	transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
	agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
	registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
	contact.name	Required	Character string, min. 1, max. 128 characters (ASCII subset)	Name of the individual or the role represented by the contact. Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters denic: This field is fully supported. occurrence: Optional
	contact.title	Optional	Character string, min. 1, max. 128 characters (ASCII subset)	Title of the individual. Registry Specific Notes: verisign: This field is fully supported. afilias, neulevel, gnr, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	contact.organization	Optional	Character string, min. 1, max. 128 characters (ASCII subset)	Name of the organization with which the contact is affiliated. Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters dotcoop: This field is fully supported. occurrence: Required denic: This field is fully supported. occurrence: Optional
	contact.address.street.<1-3>	First index required	Character string, min. 1, max. 255 characters (ASCII subset)	The contact's first, second and third street address. Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters denic: This field is fully supported. occurrence: Optional
	contact.address.city	Required	Character string, min. 1, max. 255 characters (ASCII subset)	The contact's city. Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters denic: This field is fully supported. occurrence: Optional
	contact.address.state	Optional	Character string, min. 1, max. 255 characters (ASCII subset)	The contact's state or province. Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters
	contact.address.postalcode	Required	Character string, min. 1, max. 16 characters (ASCII subset)	The contact's postal code. Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 10 characters denic: This field is fully supported. occurrence: Optional
	contact.address.countrycode	Required	ISO-3166 country code, min. 2, max. 2 characters	The contact's country code (two-character ISO 3166 country code). Registry Specific Notes: denic: This field is fully supported. occurrence: Optional

The following block of internationalized (i15d) fields is entirely optional. If at least one field is specified, all constraints in the 'Occurrence' column apply.
	contact.i15d.name	Required	Character string, min. 1, max. 128 characters (full Unicode charset)	Name of the individual or the role represented by the contact. [internationalized version] Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters denic: This field is fully supported. occurrence: Optional
	contact.i15d.title	Optional	Character string, min. 1, max. 128 characters (full Unicode charset)	Title of the individual. [internationalized version] Registry Specific Notes: verisign: This field is fully supported. afilias, neulevel, gnr, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	contact.i15d.organization	Optional	Character string, min. 1, max. 128 characters (full Unicode charset)	Name of the organization with which the contact is affiliated. [internationalized version] Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters dotcoop: This field is fully supported. occurrence: Required denic: This field is fully supported. occurrence: Optional
	contact.i15d.address.street.<1-3>	First index required	Character string, min. 1, max. 255 characters (full Unicode charset)	The contact's first, second and third street address. [internationalized version] Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters denic: This field is fully supported. occurrence: Optional
	contact.i15d.address.city	Required	Character string, min. 1, max. 255 characters (full Unicode charset)	The contact's city. [internationalized version] Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters denic: This field is fully supported. occurrence: Optional
	contact.i15d.address.state	Optional	Character string, min. 1, max. 255 characters (full Unicode charset)	The contact's state or province. [internationalized version] Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 30 characters
	contact.i15d.address.postalcode	Required	Character string, min. 1, max. 16 characters (full Unicode charset)	The contact's postal code. [internationalized version] Registry Specific Notes: neulevel, dottv: This field is fully supported. Character string, min. 1, max. 10 characters denic: This field is fully supported. occurrence: Optional
	contact.i15d.address.countrycode	Required	ISO-3166 country code, min. 2, max. 2 characters	The contact's country code (two-character ISO 3166 country code). [internationalized version] Registry Specific Notes: denic: This field is fully supported. occurrence: Optional

	contact.voice.number	Optional	Character string that must begin with a plus '+' sign, followed by a country code, followed by a dot, followed by a sequence of digits representing the telephone number, min. 1, max. 17 characters	The contact's voice telephone number.
	contact.voice.extension	Optional	Character string, min. 1, max. 8 characters, pattern (regular expression): '^\d+$' (ASCII subset)	The contact's voice telephone number extension.
	contact.fax	Optional	Character string that must begin with a plus '+' sign, followed by a country code, followed by a dot, followed by a sequence of digits representing the telephone number, min. 1, max. 17 characters	The contact's facsimile telephone number. Registry Specific Notes: denic: Fax numbers are no longer supported by DENIC
	contact.email	Required	Character string representing a valid e-mail address, min. 1, max. 132 characters	The contact's e-mail address. Registry Specific Notes: neulevel, neustar, dottv: This field is fully supported. Character string, min. 1, max. 80 characters denic: This field is fully supported. occurrence: Optional
	contact.language	Optional	Language tag according to RFC 1766	The contact's preferred natural language. Registry Specific Notes: eurid: This field is fully supported. One of: 'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'hu', 'it', 'lt', 'lv', 'mt', 'nl', 'pl', 'pt', 'sk', 'sl', 'sv' occurrence: Required
	contact.authinfo	Optional	Character string, min. 4, max. 89 characters (ASCII subset)	The authorization information specified by the registrant (pass phrase/password). Registry Specific Notes: afilias: This field is fully supported. Character string, min. 6, max. 16 characters occurrence: Required neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, dottv: This field is fully supported. occurrence: Required denic: This field is not supported.
	contact.maintainer	Optional	Character string, min. 1, max. 128 characters (full Unicode charset)	Id or URL of the customer's reseller (if the contact is not directly maintained by the customer).
	contact.datapolicy	Optional	One of: 'restrictive', 'permissive' (default value: restrictive)	Specifies whether the contact's data may be used for marketing purposes. `restrictive` disallows the use, `permissive` allows it.
	contact.disclosures	Optional	Character string (ASCII subset) (default value: )	Specifies which of the contact's data is disclosed or not disclosed, in addition to the registry's policy. The value is a comma-separated list of tags, each preceded by `+` or `-`. `+` stands for disclose, `-` for do not disclose. Possible tags are: nameint, nameloc, orgint, orgloc, addrint, addrloc, voice, fax, email.
	contact.vat.number	Optional	Character string, min. 1, max. 20 characters (ASCII subset)	The european value added tax identification number the entity might have. Registry Specific Notes: eurid, iis: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	contact.natural.person	Optional	Boolean value ('true' or 'false')	Whether the contact represents a natural person. Registry Specific Notes: eurid: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	contact.citizenship.countrycode	Optional	ISO-3166 country code	The two-character ISO 3166 country code of the contact's country of citizenship. Registry Specific Notes: eurid: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	neustar.nexus.purpose	Optional	One of: 'P1', 'P2', 'P3', 'P4', 'P5'	The Nexus application purpose. Registry Specific Notes: neustar: This field is fully supported. occurrence: This field is optional in general, but is required for contacts to be used as registrants in domain registrations. afilias, neulevel, gnr, verisign, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	neustar.nexus.category	Optional	One of: 'C11', 'C12', 'C21', 'C31', 'C32'	The Nexus category. Registry Specific Notes: neustar: This field is fully supported. occurrence: This field is optional in general, but is required for contacts to be used as registrants in domain registrations. afilias, neulevel, gnr, verisign, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	neustar.nexus.validator	Optional	Character string (ASCII subset)	This field contains additional information for the Nexus category. This field must be left blank for the categories `C11`, `C12` and `C21`. For the categories `C31` and `C32` this field must contain an uppercase two letter ISO-3166 code. Registry Specific Notes: neustar: This field is fully supported. occurrence: This field is optional in general, but is required for contacts to be used as registrants in domain registrations. afilias, neulevel, gnr, verisign, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.type	Optional	One of: 'person', 'org', 'request'	Specifies the DENIC type of the contact (person, role, org or request contact). Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.uritemplate	Optional	Character string, min. 1, max. 1024 characters (ASCII subset)	Specifies a URI template for "request" contacts Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.verification.<1-6>.claims			A space/comma separated list of claims, see DENIC documentation for the accepted claims (at the time of writing, it is "name", "address" and "e-mail"). Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.verification.<1-6>.result		One of: 'success', 'failed'	The outcome of the verification process for the claims. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.verification.<1-6>.reference		Character string (ASCII subset)	A free format reference that identifies the verification process. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.verification.<1-6>.timestamp		Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The point in time the verification completed. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.verification.<1-6>.evidence		Character string (ASCII subset)	The evidence that was provided for the verification process. See DENIC documentation for details. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.verification.<1-6>.method		Character string (ASCII subset)	The verification method that was chosen. See DENIC documentation for details. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	denic.verification.<1-6>.trustframework		Character string (ASCII subset)	The trust framework which applies to the verification process. See DENIC documentation for details. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	eurid.type	Optional	One of: 'registrant', 'billing', 'tech', 'onsite'	The EURid type of contact. The value of the type defines the usage within domain requests. Registry Specific Notes: eurid: This field is fully supported. occurrence: Required afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	atnic.type	Optional	One of: 'privateperson', 'organisation', 'role'	The nic.at type of contact. The value of the type defines the usage within domain requests. Note that this type may not be changed as long as the contact is used as a registrant in at least one domain. Registry Specific Notes: atnic: This field is fully supported. occurrence: Required afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
	verification.result	Optional	One of: 'success', 'failure'	The verification result. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
	verification.date	Optional	Character string (ASCII subset)	The date when the verification happened. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
	verification.method	Optional	Character string (ASCII subset)	The methods used for verification. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
	verification.agent	Optional	Character string (ASCII subset)	The agent used for verification. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
	verification.reference	Optional	Character string (ASCII subset)	The verification reference string. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
	sidn.id.form	Optional	One of: 'individual', 'corp', 'unincorp'	The legal form of the contact. Currently allowed values according to the .nl registry are: "individual" (Individual), "corp" (Corporation) and "unincorp" (Unincorporated Business). Registry Specific Notes: sidn: This field is fully supported. occurrence: Required afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, dottv: This field is not supported.
	sidn.id.number	Optional	Character string (ASCII subset)	The registration number of the legal form. This field is obsolete after SIDN's switch to the "Hello" registry in 2026, but still accepted for backwards compatibility. Registry Specific Notes: sidn: This field is fully supported. occurrence: Optional afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, dottv: This field is not supported.
	itnic.registrant.regcode	Optional	Character string, min. 5, max. 127 characters (ASCII subset)	The registration code is required for .it registrants. Organizations must give the registration number of the business, private persons will have to put in there id card number. Registry Specific Notes: itnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	itnic.registrant.nationalitycode	Optional	Character string, min. 2, max. 2 characters (ASCII subset)	Nationality code is required for .it registrants. It will be the two letter ISO code country code where the registrant did register his registration data (id card issuing count or register cord country) Registry Specific Notes: itnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	itnic.registrant.entitytype	Optional	Character string, min. 1, max. 1 characters (ASCII subset)	Entity number required for .it registrants. It represents the type of business registered by the registrant. The business type is represented by a value between 1-6. Registry Specific Notes: itnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	nominet.org.trad.name	Optional	Character string, min. 1, max. 255 characters (ASCII subset)	Trading name for .uk registrants. Specifies the trading name of the organisation if different to the account name. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
	nominet.registrant.type	Optional	Character string, min. 1, max. 16 characters (ASCII subset)	The registrant type for .uk registrants. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
	nominet.registrant.co.no	Optional	Character string, min. 1, max. 255 characters (ASCII subset)	The registered company number or the DfES UK school number of a .uk registrant. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
	nominet.opt.out	Optional	Boolean value ('true' or 'false')	The flag telling whether the contact's address details are published in the Nominet WHOIS system. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
	cnnic.contact.type	Optional	One of: 'I', 'E'	The CNNIC contact type; required if the contact shall be used as a registrant. Possible types are: I (domestic individual contact) E (domestic enterprise contact) Registry Specific Notes: cnnic: This field is fully supported. occurrence: Optional afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	cnnic.identification.type	Optional	One of: 'BDDM', 'BJWSXX', 'GAJMTX', 'GAJZZ', 'GZJGZY', 'HZ', 'JDDWFW', 'JGZ', 'JJHFR', 'JWJG', 'LSZY', 'MBFQY', 'MBXXBX', 'ORG', 'QT', 'SFJD', 'SFZ', 'SHFWJG', 'SHTTFR', 'SYDWFR', 'TWJMTX', 'TWJZZ', 'TYDM', 'WGCZJG', 'WGZHWH', 'WJLSFZ', 'WLCZJG', 'YLJGZY', 'YYZZ', 'ZJCS'	The CNNIC type of registrant identification. Required if the contact shall be used as a registrant. Possible types for individual contacts are: SFZ (ID Card), HZ (Passport), GAJMTX (MainlandTravel Permit for Hong Kong and Macau Residents), TWJMTX (Mainland travel permit for Taiwan residents), WJLSFZ (Foreign Permanent Resident ID Card), GAJZZ (Residence permit for Hong Kong and Macao resident), TWJZZ (Residence permit for Taiwan residents), JGZ (Certificate of officers) and QT (Other). Possible types for enterprise contacts are: ORG (Organization Code Certificate), YYZZ (Business Licence), TYDM (Unified Social Credit Code Certificate), BDDM (Force Number), JDDWFW (License of Paid Service for Military Units), SYDWFR (Legal Person Certificate of Institution), WGCZJG (Foreign Enterprise Resident Representative Office Registration Certificate), SHTTFR (Social Organization Legal Person Registration Certificate), ZJCS (Registration Certificate of Religious Place), MBFQY (Registration Certificate for Private Non-Enterprise Unit), JJHFR (Foundation Legal Person Registration Certificate), LSZY (Practice License of Law Firm), WGZHWH (Registration Certificate of Foreign Cultural Centers in China), WLCZJG (Registration Certificate of Permanent Representative Office of Tourism Department of Foreign Government), SFJD (Forensic Identification License), JWJG (Certificates of Overseas Institution), SHFWJG (Registration Certificate of Social Service Institution), MBXXBX (Permits for Running Private School), YLJGZY (Practice License of Medical Institution), GZJGZY (Practice Certificate of Notary Institution), BJWSXX (Permits for Running School for Children of Foreign Embassy Staff in Beijing) and QT (Other) This field is ignored unless cnnic.identification.value is also specified. Registry Specific Notes: cnnic: This field is fully supported. occurrence: Optional afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	cnnic.identification.value	Optional	Character string, min. 1, max. 50 characters (full Unicode charset)	The value for the CNNIC registrant identification, e.g. the passport number. Required if the contact shall be used as a registrant. This field is ignored unless cnnic.identification.type is also specified. Registry Specific Notes: cnnic: This field is fully supported. occurrence: Optional afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	cnnic.phone.number	Optional	Character string that must begin with a plus '+' sign, followed by a country code, followed by a dot, followed by a sequence of digits representing the telephone number, min. 1, max. 17 characters	The phone number to be used for registrant validation. Required if the contact shall be used as a registrant. Registry Specific Notes: cnnic: This field is fully supported. occurrence: Optional afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	dotcoop.sponsor.<1-∞>.id	Optional	Character string (ASCII subset)	Specifies the sponsors for a registrant contact. The given value must be the ID of a previously created contact. The data of the contact is copied, i.e. modifications applied to the contacts afterwards do not affect the copies stored with the contact created here. A contact must have either no or at least two sponsor contacts. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	iis.org.number	Optional	Character string, min. 5, max. 127 characters (ASCII subset)	Organizational number required for .se registrants. Starts with ISO 3166 Alpha-2 country code in square brackets. If the country code for Sweden is given [SE], a valid Swedish personal or organisational number must be given (6 digits, dash, 4 digits), otherwise 1 to 123 characters can follow, If contact.organization is empty and the country code for Sweden [SE] is given, the organization number must be a personal number, not an organizational number. Note that this field cannot be updated. Registry Specific Notes: iis: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
	addon.*	Optional	Character string (ASCII subset)	Any field that matches the given prefix is used for the value adding services supplied by backend registries. The description of the specific fields available is out of scope of this document.
	gateway.*	Optional	Character string (ASCII subset)	Any field with the "gateway." prefix is passed through as-is to GatewayNG (with the "gateway." prefix stripped from the key). This field is only supported for GatewayNG registries.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'contact.create'	Specifies the response type for contact creation.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
contact.id	Character string (ASCII subset)	The id (handle) assigned to the created contact (in case of successful completion).
contact.roid	Character string (ASCII subset)	The ROID (Repository Object IDentifier) assigned to the created contact (in case of successful completion); may be missing if not available.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: contact.create
contact.id: contact1-ID
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
contact.name: John Doe
contact.title: Dr.
contact.organization: ACME Solutions
contact.address.street.1: 100 Centre St
contact.address.city: Townsville
contact.address.state: County Derry
contact.address.postalcode: Z1Z 1Z1
contact.address.countrycode: CA
contact.voice.number: +1.4165559999
contact.voice.extension: 1232
contact.fax: +1.4165558888
contact.email: jdoe@acmesolutions.info
contact.language: en-US
contact.authinfo: mySecret
contact.maintainer: http://www.myreseller.com
contact.datapolicy: permissive
contact.disclosures: -addrint, -addrloc
contact.vat.number: DE123456
contact.natural.person: true
contact.citizenship.countrycode: DE
neustar.nexus.purpose: P1
neustar.nexus.category: C11
neustar.nexus.validator: FR
denic.type: person
denic.uritemplate: mailto:info@example.com?subject=domain:{Ulabel}
denic.verification.1.claims: name
denic.verification.1.result: success
denic.verification.1.reference: ABC123/45GHT
denic.verification.1.timestamp: 2023-11-11T15:36:21Z
denic.verification.1.evidence: idcard
denic.verification.1.method: auth
denic.verification.1.trustframework: de_denic
eurid.type: registrant
atnic.type: registrant
verification.result: success
verification.date: 2025-01-01T00:00:00.0Z
verification.method: phone
verification.agent: some agent
verification.reference: my-ref-1
sidn.id.form: individual
sidn.id.number: 8764654.0
itnic.registrant.regcode: 123456
itnic.registrant.nationalitycode: DE
itnic.registrant.entitytype: 1
nominet.org.trad.name: ACME Ltd.
nominet.registrant.type: LTD
nominet.registrant.co.no: 42
nominet.opt.out: true
cnnic.contact.type: E
cnnic.identification.type: SFZ
cnnic.identification.value: 1232232123212
cnnic.phone.number: +12.3456712189
dotcoop.sponsor.1.id: COR4543
iis.org.number: [SE]802405-0190
addon.*: foobar
gateway.*: foobar

Response:

response.type: contact.create
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
contact.id: contact1-ID
contact.roid: C1232131-LRMS

Table of contents

Command type: create host

Description:

Create a new host object.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'host.create'	Identifies the command type for host creation.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
host.name	Required	Character string, min. 1, max. 132 characters (full Unicode charset)	The fully qualified host name. Registry Specific Notes: verisign, pir: Character string, min. 1, max. 80 characters Must contain one "." neustar: This field is fully supported. Character string, min. 1, max. 128 characters
host.addr.<1-∞>.value	If the host name exists in a top level domain for which the registry is not authoritative, then the host object MUST NOT have any associated IP addresses. If the host name exists in a top level domain for which the registry is authoritative, then the host object MAY have associated IP addresses. Furthermore, if the host name exists in a top level domain for which the registry is authoritative, then the superordinate domain of the host MUST be known to the registry (i.e., has to be created) before the host object can be created.	Character string (ASCII subset)	An IP address of the host. Registry Specific Notes: afilias, neulevel, gnr, dotcoop, cnnic, cnnic.idn, twnic, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, dottv: Registry supports a maximum of 13 IP addresses per name server. verisign, pir: First required. Supports a maximum of 13 IP addresses neustar: Only one address may be specified at most. Hosts that are in the .US TLD must have an IP address, where others may have one.
host.addr.<1-∞>.type	Optional	One of: 'ipv4', 'ipv6' (default value: ipv4)	The type of the corresponding IP address (IPV4 or IPV6). Note that some registries may not allow the use of IPV6 addresses.
host.authinfo	Optional	Character string, min. 4, max. 89 characters (ASCII subset)	The authorization information (pass phrase/password) to be associated with the host. Registry Specific Notes: afilias: This field is fully supported. Character string, min. 6, max. 16 characters verisign, pir: This field is fully supported. Character string, min. 4, max. 16 characters
host.maintainer	Optional	Character string, min. 1, max. 128 characters (full Unicode charset)	Id or URL of the customer's reseller (if the host is not directly maintained by the customer).
addon.*	Optional	Character string (ASCII subset)	Any field that matches the given prefix is used for the value adding services supplied by backend registries. The description of the specific fields available is out of scope of this document.
gateway.*	Optional	Character string (ASCII subset)	Any field with the "gateway." prefix is passed through as-is to GatewayNG (with the "gateway." prefix stripped from the key). This field is only supported for GatewayNG registries.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'host.create'	Specifies the response type for host creation.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
host.name	Character string (full Unicode charset)	The name of the host specified in the request. Registry Specific Notes: verisign, pir: Character string, min. 1, max. 80 characters Must contain one "."
host.id	Character string (ASCII subset)	The id assigned to the host by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: host.create
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
host.name: ns1.domain.info
host.addr.1.value: 100.103.44.15
host.addr.1.type: ipv4
host.authinfo: mySecret
host.maintainer: http://www.myreseller.com
addon.*: foobar
gateway.*: foobar

Response:

response.type: host.create
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
host.name: ns1.domain.info
host.id: host1-ID

Table of contents

Command type: create domain

Description:

Create a new domain object.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.create'	Identifies the command type for domain creation.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
ens.auth.id	Optional	Character string, min. 1, max. 20 characters (ASCII subset)	ID of ENS_Auth record on which the registration is based. Registry Specific Notes: dotaero: This field is fully supported. occurrence: Required afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
ens.auth.key	Optional	Character string, min. 1, max. 20 characters (ASCII subset)	The authentication key (password). Must match the ENS_Auth record identified by ens.auth.id. Registry Specific Notes: dotaero: This field is fully supported. occurrence: Required afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
gnr.consent.id	Optional	Character string, min. 1, max. 64 characters (ASCII subset)	Consent ID that grants the right to register an object which is protected by a defensive registration. Registry Specific Notes: gnr: This field is fully supported. afilias, neulevel, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
icmregistry.nonresolver	Optional	Boolean value ('true' or 'false') (default value: false)	Flag indicating whether the domain is supposed to resolve or not (i.e., just created for blocking the name). If set to 'false' (or omitted), the domain's registrant may receive an invitation to create a .xxx membership association from the .xxx registry (in order to make the domain resolve after the establishing the membership). If set to 'true', no such invitation will be sent. Registry Specific Notes: icmregistry: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, atnic, nominet, sidn, dottv: This field is not supported.
domain.name	Required	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain (including top level domain). Registry Specific Notes: afilias: Character string, min. 1, max. 68 characters Domain must consist of a second level label plus the registry's TLD label 'info'. neulevel: Character string, min. 1, max. 67 characters Domain must consist of a second level label plus the registry's TLD label 'biz'. gnr: Character string, min. 1, max. 131 characters Domain must consist of the third and second level labels plus the registry's TLD label. verisign, pir: Character string, min. 1, max. 67 characters Domain must consist of a second level label plus the registry's TLD label 'com', 'net' or 'org'. neustar: Character string, min. 1, max. 66 characters Domain must consist of a second level label plus the registry's TLD label 'us'. dotmobi: Character string, min. 1, max. 68 characters Domain must consist of a second level label plus the registry's TLD label 'mobi'. inregistry: Character string, min. 1, max. 66 characters Domain must consist of a second level label plus the registry's TLD label 'in'. dotasia: Character string, min. 1, max. 68 characters Domain must consist of a second level label plus the registry's TLD label 'asia'. domen: Character string, min. 1, max. 66 characters Domain must consist of a second level label plus the registry's TLD label 'me'. telnic: Character string, min. 1, max. 67 characters Domain must consist of a second level label plus the registry's TLD label 'tel'. switch: Character string, min. 1, max. 66 characters Domain must consist of a second level label plus the registry's TLD labels 'ch' or 'li'. iis: Character string, min. 1, max. 66 characters Domain must consist of a second level label plus the registry's TLD label 'se'. itnic: Character string, min. 1, max. 66 characters Domain must consist of a second level label plus the registry's TLD label 'it'. icmregistry: Character string, min. 1, max. 67 characters Domain must consist of a second level label plus the registry's TLD label 'xxx'. dottv: Character string, min. 1, max. 66 characters Domain must consist of a second level label plus the registry's TLD label 'tv'.
domain.name.language	Optional	Language tag according to RFC 1766	This field defines the language context of the domain name. Depending on the registry policy the registry may use it to register, reserve or block language specific variants of the domain name. Registry Specific Notes: afilias, verisign, neustar, cnnic, cnnic.idn, pir, denic, telnic, switch, iis, itnic, atnic: This field is fully supported.
domain.authinfo	Optional	Character string, min. 4, max. 89 characters (full Unicode charset)	The authorization information specified by the registrant (pass phrase/password). Registry Specific Notes: afilias: This field is fully supported. Character string, min. 6, max. 16 characters occurrence: Required neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, dottv: This field is fully supported. occurrence: Required denic: This field is fully supported.
domain.authinfo.expiration.date	Optional	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	This date specifies the expiration date of the authinfo. If omitted, the maximum possible duration is taken. If the date is in the past, the authinfo is ignored/cleared. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
domain.maintainer	Optional	Character string, min. 1, max. 128 characters (full Unicode charset)	Id or URL of the customer's reseller (if the domain is not directly maintained by the customer).
domain.comment	Optional	Character string, min. 1, max. 255 characters (full Unicode charset)	An arbitrary text stored as a comment for the domain.
ns.<1-∞>.name	Optional	Character string, min. 1, max. 132 characters (full Unicode charset)	The fully qualified name of a host (name server) to be associated with the domain. A host with this name must exists in the involved registry. The number of required name servers is registry specific. Registry Specific Notes: afilias: The registry requires zero or 2 to 13 name servers. neulevel, neustar, dottv: Up to 13 name servers may be specified. verisign, pir: The registry requires 0 to 13 name servers
ns.<1-∞>.id	Optional	Character string (ASCII subset)	The id of a host to be associated with the domain (may be specified as an alternative to the host's name). The same registry specific restrictions apply as to the `ns.#.name` field
ns.<1-∞>.role	Optional	One of: 'none', 'primary' (default value: none)	The role of this host concerning the domain; currently, only 'none' (no particular role) or 'primary' (the host is the primary name server for the domain) are supported.
ns.<1-∞>.address.<1-∞>.value	Optional	Character string, min. 3, max. 45 characters (ASCII subset)	The IP address of the host given in the specified format. Note that this field is only evaluated for generic registries using hosts as domain attributes.
ns.<1-∞>.address.<1-∞>.type	Optional	One of: 'ipv4', 'ipv6'	This field specifies the address type of the given name server. Note that this field is only evaluated for generic registries using hosts as domain attributes.
contact.<1-∞>.id	Optional	Character string, min. 1 characters (ASCII subset)	The id of a contact to be associated with the domain. A contact with this name must exists in the involved registry. The number and types of required contacts are registry specific. Registry Specific Notes: eurid: The registry requires 1 to 5 onsite contacts and exactly one registrant contact. switch: The Switch registry requires exactly one tech and exactly one registrant contact. Billing and admin contacts are not supported; the billing contact for .ch/.li domains is always the registrar. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: There must be exactly one registrant, admin, tech and billing contact specified.
contact.<1-∞>.type	Optional	One of: 'admin', 'billing', 'registrant', 'tech', 'zone', 'onsite', 'ced', 'opn', 'member', 'abuse', 'general'	The type of the corresponding contact. The number and types of required contacts are registry specific. Registry Specific Notes: eurid: There must be exactly one registrant contact specified; an optional onsite contact may also be specified. Other contact types are not allowed. dotasia: There must be one ced contact specified and in use as one of the other contacts like registrant, billing, admin, tech. Contact type onsite is not allowed. Contact type opn is optional. switch: One of: 'registrant', 'tech' Only registrant and tech contacts are supported by the Switch registry. atnic: As registrant contacts, only contacts marked as "privateperson" or "organisation" may be specified. "role" contacts are not permitted as registrants. denic: Admin, tech and zone contacts are no longer supported by DENIC. While they are accepted by the system, they are no longer submitted to DENIC. Abuse and general contacts may be added, but are not required. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, dotaero, dotmobi, inregistry, domen, telnic, iis, itnic, icmregistry, nominet, sidn, dottv: There must be exactly one registrant, admin, tech and billing contact specified.
domain.parked	Optional	Boolean value ('true' or 'false') (default value: false)	If set to `true`, the domain is marked as 'parked' in the DRS database and ignored by zone or procmailer generators.
telnic.whois.type	Optional	One of: 'legal', 'natural'	Specifies whether the domain is held by a corporation or individual. Registry Specific Notes: telnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
telnic.whois.publish	Optional	Boolean value ('true' or 'false') (default value: true)	Specifies whether to publish social data to WHOIS for an individually owned domain. Registry Specific Notes: telnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
icmregistry.member.contact.password	Optional	Character string, min. 4, max. 64 characters (ASCII subset)	The password associated with the specified 'member' contact. May only occur when such a contact is specified (and is a mandatory field in this case). Registry Specific Notes: icmregistry: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, atnic, nominet, sidn, dottv: This field is not supported.
nominet.auto.bill	Optional	Integer value, min. 0, max. 182	The field used to indicate how many days before expiry a domain name should be renewed automatically by the registry. This field can be cleared by setting the default value of 0; it cannot be set if `nominet.next.bill` or `nominet.renew.not.required` is set. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
nominet.next.bill	Optional	Integer value, min. 0, max. 182	The field used to indicate how many days before expiry a domain name should be renewed automatically by the registry. The next-bill field will reset to 0 by the registry after a single registration period. This field can be cleared by setting the default value of 0; it cannot be set if `nominet.auto.bill` or `nominet.renew.not.required` is set. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
nominet.auto.period	Optional	Integer value, min. 1, max. 9	This field is used in combination with `nominet.auto.bill` to define the number of years to renew a domain name for. The default renewal period is two years when this is undefined. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
nominet.next.period	Optional	Integer value, min. 1, max. 9	This field is used in combination with `nominet.next.bill` to define the number of years to renew a domain name for. The default renewal period is two years when this is undefined. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
nominet.note.<1-20>	Optional	Character string, min. 0, max. 200 characters (ASCII subset)	These are free-form fields for miscellaneous information relating to the domain name. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
nominet.reseller	Optional	Character string (ASCII subset)	A field which can be used to associate a reseller with a domain. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
period.unit	Optional	One of: 'y', 'm' (default value: y)	The unit of measurement for the object's period (years or months). Registry Specific Notes: afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: Only year may be specified as the period unit.
period.value	Required	Integer value, min. 1, max. 99	The object's actual registration period as a multiple of the unit. Registry Specific Notes: afilias, neulevel, neustar, dottv: This field is fully supported. Integer value, min. 1, max. 10 verisign, pir: This field is fully supported. Integer value, min. 1, max. 10 inregistry: This field is fully supported. Integer value, min. 1, max. 5 switch: Fixed: '1' Switch only allows 1-year registrations initially.
dnssec.sign	Optional	Boolean value ('true' or 'false')	Flag whether DRS shall automatically sign the zone and publish it on its name servers. Note that in this case the DNSSEC key data for the registry is automatically maintained. The DNSSEC key data specified in this request may be overwritten by the system at a later point in time.
dnssec.ds.<1-∞>.ds.keytag	Optional	Integer value, min. 0, max. 65535	The key tag assigned to the DS record. The field is required for a DS entry. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.alg	Optional	Integer value, min. 0, max. 255	The algorithm of the related DNSKEY record. The field is required for a DS entry. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.digesttype	Optional	Integer value, min. 0, max. 255	The digest type used for the hash of the related DNSKEY record. The field is required for a DS entry. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.digest.hex	Optional	Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)	The hexadecimal representation of the hash of the DNSKEY record. Must be specified unless the data is given in the Base64 notation. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.digest.base64	Optional	Base64 encoded binary data according to RFC 4648	The Base64 representation of the hash of the DNSKEY record. Must be given unless the data is given in hexadecimal notation. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.maxsiglife	Optional	Integer value, min. 1	The maximum lifetime of the signature of the DS record. This is only a recommendation, the registry is not obliged to respect the value. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.flags	Optional	Integer value, min. 0, max. 65535	The "flags" value of the related DNSKEY record. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.protocol	Optional	Integer value, min. 0, max. 255	The "protocol" value of the related DNSKEY record. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.alg	Optional	Integer value, min. 0, max. 255	The "algorithm" value of the related DNSKEY record. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.pubkey.hex	Optional	Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)	The hexadecimal representation of the public key data. Must be specified unless the data is given in the Base64 notation. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.pubkey.base64	Optional	Base64 encoded binary data according to RFC 4648	The Base64 representation of the public key data. Must be given unless the data is given in hexadecimal notation. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
price.limit.value	Optional	Floating point value	The maximum amount of currency units to be paid for the operation. If this amount is exceeded by the actual costs, the request is rejected. If this field is specified, `price.limit.currency` must be specified as well. Note that this field is only evaluated for registries connected via GatewayNG, and only if the request's submitter belongs to the support staff.
price.limit.currency	Optional	Character string, min. 3, max. 3 characters, pattern (regular expression): '^[A-Z]{3}$' (ASCII subset)	The currency used to specify the maximum price to be paid for the operation. If the currency does not match the currency in which the actual costs are calculated, the request may be rejected if a currency conversion is unavailable. If this field is specified, `price.limit.value` must be specified as well. Note that this field is only evaluated for registries connected via GatewayNG, and only if the request's submitter belongs to the support staff.
addon.*	Optional	Character string (ASCII subset)	Any field that matches the given prefix is used for the value adding services supplied by backend registries. The description of the specific fields available is out of scope of this document.
gateway.*	Optional	Character string (ASCII subset)	Any field with the "gateway." prefix is passed through as-is to GatewayNG (with the "gateway." prefix stripped from the key). This field is only supported for GatewayNG registries.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.create'	Specifies the response type for domain creation.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
domain.name	Character string (full Unicode charset)	The name of the domain (including top level domain) specified in the request. Registry Specific Notes: dotaero: This field is fully supported.
domain.authinfo	Character string (ASCII subset)	If present, this field contains the authinfo string that was automatically assigned to the domain (which may differ from the one originally specified).
domain.id	Character string (ASCII subset)	The id assigned to the domain by the registry.
expiration.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The expire date of the object according to the registry.
dotcoop.verification.state	One of: 'verified', 'pending', 'rejected', 'investigation', 'refused'	The domain registrant's current verification state. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.create
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
ens.auth.id: 12345678-airline
ens.auth.key: jGaA45
gnr.consent.id: ID:12345
icmregistry.nonresolver: false
domain.name: acme.info
domain.name.language: en-US
domain.authinfo: mySecret
domain.authinfo.expiration.date: 2008-12-24T18:00:00.0Z
domain.maintainer: http://www.myreseller.com
domain.comment: just a comment...
ns.1.name: ns1.domain.info
ns.1.id: host1-ID
ns.1.role: primary
ns.1.address.1.value: 123.145.167.212
ns.1.address.1.type: ipv4
contact.1.id: contact1-ID
contact.1.type: admin
domain.parked: false
telnic.whois.type: natural
telnic.whois.publish: true
icmregistry.member.contact.password: my-secret
nominet.auto.bill: 5
nominet.next.bill: 5
nominet.auto.period: 1
nominet.next.period: 1
nominet.note.1: example note for testing
nominet.reseller: ACME Inc.
period.unit: y
period.value: 2
dnssec.sign: false
dnssec.ds.1.ds.keytag: 38583
dnssec.ds.1.ds.alg: 3
dnssec.ds.1.ds.digesttype: 1
dnssec.ds.1.ds.digest.hex: 666F6F626172
dnssec.ds.1.ds.digest.base64: Zm9vYmFy
dnssec.ds.1.ds.maxsiglife: 1
dnssec.ds.1.key.flags: 256
dnssec.ds.1.key.protocol: 3
dnssec.ds.1.key.alg: 3
dnssec.ds.1.key.pubkey.hex: 666F6F626172
dnssec.ds.1.key.pubkey.base64: Zm9vYmFy
price.limit.value: 100.00
price.limit.currency: USD
addon.*: foobar
gateway.*: foobar

Response:

response.type: domain.create
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
domain.name: acme.info
domain.authinfo: jerjkI23!wer1ee
domain.id: domain1-ID
expiration.date: 2003-05-17T22:00:00.0Z
dotcoop.verification.state: verified

Table of contents

Command type: delete contact

Description:

Delete a contact object.

Registry Specific Notes:

cnnic, cnnic.idn:

This command is not supported.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'contact.delete'	Identifies the command type for contact deletion.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
contact.id	Required	Character string (ASCII subset)	The id (handle) of the contact to delete.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'contact.delete'	Specifies the response type for contact deletion.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: contact.delete
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
contact.id: contact1-ID

Response:

response.type: contact.delete
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: delete host

Description:

Delete a host object.

Registry Specific Notes:

cnnic, cnnic.idn:

This command is not supported.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'host.delete'	Identifies the command type for host deletion.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
host.name	Required (only if alternative field 'host.id' is not specified)	Character string, min. 1, max. 132 characters (full Unicode charset)	The fully qualified name of the host to delete. Registry Specific Notes: dotaero: This field is fully supported.
host.id	Required (only if alternative field 'host.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the host to delete.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'host.delete'	Specifies the response type for host deletion.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: host.delete
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
host.name: ns1.domain.info
host.id: host1-ID

Response:

response.type: host.delete
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: delete domain

Description:

Delete a domain object.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.delete'	Identifies the command type for domain deletion.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain to delete. Registry Specific Notes: dotaero: This field is fully supported. verisign, pir: This field is fully supported. Character string, min. 1, max. 67 characters
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain to delete. Registry Specific Notes: dotaero: This field is fully supported.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.delete'	Specifies the response type for domain deletion.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.delete
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID

Response:

response.type: domain.delete
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: schedule domain deletion

Description:

Set a new user scheduled end date for a domain (or erase it); does not immediately delete the domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.deletion.schedule'	Identifies the command type for domain deletion scheduling.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which deletion is to be scheduled. Registry Specific Notes: dotaero: This field is fully supported. verisign, pir: This field is fully supported. Character string, min. 1, max. 67 characters
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain which deletion is to be scheduled. Registry Specific Notes: dotaero: This field is fully supported.
domain.user.scheduled.end.date	Optional	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The new user scheduled end date to be set for the domain. If omitted, any existing user scheduled end date for the domain is erased (set to null).

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.deletion.schedule'	Specifies the response type for domain deletion scheduling.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.deletion.schedule
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
domain.user.scheduled.end.date: 2003-05-17T22:00:00.0Z

Response:

response.type: domain.deletion.schedule
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: set domain extend decision

Description:

Set a extend decision for a domain

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.extend.decision.set'	Identifies the command type for domain extend decision setting.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which deletion is to be scheduled. Registry Specific Notes: dotaero: This field is fully supported. verisign, pir: This field is fully supported. Character string, min. 1, max. 67 characters
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain which deletion is to be scheduled. Registry Specific Notes: dotaero: This field is fully supported.
domain.extend.decision	Required	One of: 'extend', 'delete'	The new extend decision to be set for the domain.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.extend.decision'	Specifies the response type for domain extend decision setting.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.extend.decision.set
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
domain.extend.decision: extend

Response:

response.type: domain.extend.decision
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: restore domain (at the registry and in the DRS database)

Description:

Restores a previously deleted domain by sending a suitable command to the affected registry and undeletes the domain objects in the DRS database. The command is only available to privileged DRS users (support). The domain name given must point to a currently deleted domain in the DRS database that belongs to the effective customer issuing the command.

Registry Specific Notes:

neulevel, verisign, neustar, denic, iis, sidn, dottv:

This command is fully supported.

pir, dotmobi:

The domain is immediately restored at the registry, but the restore is preliminary. It has to be completed within 5 days (via the admin tool of the registry web site) by providing a restore report. Support personnel is automatically notified of any such restore by the DRS, so no manual action is necessary.

eurid:

Restoring a deleted domain is only possible during the first 40 days after the deletion.

switch:

Restoring a deleted domain is only possible during the first 14 days after the deletion.

afilias, gnr, dotcoop, cnnic, cnnic.idn, misc, alien, twnic, dotaero, inregistry, dotasia, domen, telnic, itnic, icmregistry, atnic, nominet:

This command is not supported.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.restore'	Identifies the command type for domain restoration
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain to restore.
domain.extend.decision	Required	One of: 'extend', 'delete', 'undecided'	The new extend decision to be set for the domain. This field's content is ignored if the destination customer id is different from the domain's previous customer (see above); in this case, the domain is extended unconditionally.
restore.send.report	Optional	Boolean value ('true' or 'false')	Specifies whether a restore report should be sent to the registry automatically (via EPP). Defaults to `false`.
restore.reason	Optional	One of: 'registranterror', 'registrarerror', 'legal', 'other'	Specifies a reason for the domain restoration. Use `registranterror` in case of an error of the registrant, `registrarerror` in case of registrar errors, `legal` to indicate judicial/arbitration/legal reasons and `other` in any other case. Must be specified if `restore.send.report` is `true`.
price.limit.value	Optional	Floating point value	The maximum amount of currency units to be paid for the operation. If this amount is exceeded by the actual costs, the request is rejected. If this field is specified, `price.limit.currency` must be specified as well. Note that this field is only evaluated for registries connected via GatewayNG, and only if the request's submitter belongs to the support staff.
price.limit.currency	Optional	Character string, min. 3, max. 3 characters, pattern (regular expression): '^[A-Z]{3}$' (ASCII subset)	The currency used to specify the maximum price to be paid for the operation. If the currency does not match the currency in which the actual costs are calculated, the request may be rejected if a currency conversion is unavailable. If this field is specified, `price.limit.value` must be specified as well. Note that this field is only evaluated for registries connected via GatewayNG, and only if the request's submitter belongs to the support staff.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.restore'	Specifies the response type for domain restoration.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.restore
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.extend.decision: extend
restore.send.report: true
restore.reason: registrarerror
price.limit.value: 100.00
price.limit.currency: USD

Response:

response.type: domain.restore
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: transit domain

Description:

Puts a domain into transit. For .de and .at, domains can be given back to the registry for maintaining them (typically in case of payment problems with the customer). For .uk, domains may be pushed to another registrar using this command.

Registry Specific Notes:

denic:

This command is fully supported.

atnic:

For nic.at, putting a domain into transit is mapped to the special .at "withdraw" EPP command.

nominet:

For Nominet, domains may be pushed to another registrar using this command. Internally, it is mapped to an EPP "update" command with Nominet's special "release" extension. A gaining client ID for the destination registrar must be specified.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, sidn, dottv:

This command is not supported.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.transit'	Identifies the command type for domain transit.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which shall be put into transit.
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain to be put into transit.
gaining.client.id	Optional	Character string (ASCII subset)	The EPP client ID of the registrar to which the domain should be pushed. Registry Specific Notes: nominet: This field is fully supported. occurrence: Required afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.transit'	Specifies the response type for domain transit.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.transit
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
gaining.client.id: clnt24-ID

Response:

response.type: domain.transit
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: push a domain to another registrar

Description:

Pushes a domain to another registrar. This command merely initiates a state machine, which eventually performs the push via a domain.transit command.

Registry Specific Notes:

nominet:

A gaining client ID for the destination registrar must be specified.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv:

This command is not supported.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.push.request'	Identifies the command type for a domain push request.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which shall be put into transit.
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain to be put into transit.
gaining.client.id	Optional	Character string (ASCII subset)	The EPP client ID of the registrar to which the domain should be pushed. Registry Specific Notes: nominet: This field is fully supported. occurrence: Required afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.push.request'	Specifies the response type for a domain push request.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.push.request
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
gaining.client.id: clnt24-ID

Response:

response.type: domain.push.requests
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: inquire contact

Description:

Inquire information about a contact object.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'contact.inquire'	Identifies the command type for contact inquiry.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
contact.id	Required	Character string (ASCII subset)	The id (handle) of the contact to inquire.
contact.authinfo	Optional	Character string, min. 4, max. 89 characters (ASCII subset)	The authorization information specified by the registrant (pass phrase/password).

Response format:

Key	Value type/content	Description
response.type	Fixed: 'contact.inquire'	Specifies the response type for contact inquiry.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
sponsor.client.id	Character string (ASCII subset)	The client id of the inquired object's sponsor.
sponsor.customer.id	Integer value	Id of the sponsoring customer (if the inquired object is sponsored by a customer).
creator.client.id	Character string (ASCII subset)	The client id of the inquired object's creator.
creator.customer.id	Integer value	Id of the customer that created the inquired object (if the inquired object was created by a customer).
creation.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The date of object creation according to the registry.
updater.client.id	Character string (ASCII subset)	The client id of the inquired object's last updater. Not present if the inquired object has never been modified.
updater.customer.id	Integer value	Id of the customer that last updated the inquired object (if the last object update was done by a customer).
update.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The date of the last object update according to the registry. Not present if the inquired object has never been modified.
transfer.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The date of the last transfer of the inquired object. Not present if the inquired object has never been transferred.
contact.id	Character string (ASCII subset)	The id (handle) of the inquired contact.
contact.roid	Character string (ASCII subset)	The ROID of the inquired contact.
contact.status	Character string (ASCII subset)	A comma-separated list of status values for the contact. Refer to the status value specification below for a list of valid status values.
contact.name	Character string (full Unicode charset)	Name of the individual or the role represented by the inquired contact.
contact.title	Character string (full Unicode charset)	Title of the individual.
contact.organization	Character string (full Unicode charset)	Name of the organization with which the contact is affiliated.
contact.address.street.<1-3>	Character string (full Unicode charset)	The contact's first, second and third street address.
contact.address.city	Character string (full Unicode charset)	The contact's city.
contact.address.state	Character string (full Unicode charset)	The contact's state or province.
contact.address.postalcode	Character string (full Unicode charset)	The contact's postal code.
contact.address.countrycode	ISO-3166 country code	The contact's country code (two-character ISO 3166 country code).
contact.i15d.name	Character string (full Unicode charset)	Name of the individual or the role represented by the inquired contact. [optional internationalized version]
contact.i15d.title	Character string (full Unicode charset)	Title of the individual. [optional internationalized version]
contact.i15d.organization	Character string (full Unicode charset)	Name of the organization with which the contact is affiliated. [optional internationalized version]
contact.i15d.address.street.<1-3>	Character string (full Unicode charset)	The contact's first, second and third street address. [optional internationalized version]
contact.i15d.address.city	Character string (full Unicode charset)	The contact's city. [optional internationalized version]
contact.i15d.address.state	Character string (full Unicode charset)	The contact's state or province. [optional internationalized version]
contact.i15d.address.postalcode	Character string (full Unicode charset)	The contact's postal code. [optional internationalized version]
contact.i15d.address.countrycode	ISO-3166 country code	The contact's country code (two-character ISO 3166 country code). [optional internationalized version]
contact.voice.number	Character string that must begin with a plus '+' sign, followed by a country code, followed by a dot, followed by a sequence of digits representing the telephone number	The contact's voice telephone number.
contact.voice.extension	Character string (ASCII subset)	The contact's voice telephone number extension.
contact.fax	Character string (ASCII subset)	The contact's facsimile telephone number.
contact.fax.extension	Character string (ASCII subset)	The contact's fax number extension.
contact.email	Character string representing a valid e-mail address	The contact's e-mail address.
contact.language	Language tag according to RFC 1766	The contact's preferred natural language.
contact.authinfo	Character string (ASCII subset)	The authorization information associated with the contact (pass phrase/password); this information is only returned if the querying customer is sponsoring the inquired contact. Registry Specific Notes: afilias: This field is fully supported. Character string, min. 6, max. 16 characters neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, twnic, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, dottv: This field is fully supported. denic: This field is not supported.
contact.sponsored.registrar	Boolean value ('true' or 'false')	If set to `true`, the contact is currently sponsored by the registrar for which this instance of the DRS is operating (but possibly not the inquiring customer); this usually implies that the DRS is able to modify and use the contact in sponsored domains. If set to `false`, the contact is sponsored by another registrar. The field may be missing if this information cannot be determined.
contact.maintainer	Character string (full Unicode charset)	Id or URL of the customer's reseller (if the contact is not directly maintained by the customer).
contact.datapolicy	One of: 'restrictive', 'permissive'	Specifies whether the contact's data may be used for marketing purposes. `restrictive` disallows the use, `permissive` allows it.
contact.disclosures	Character string (ASCII subset)	Specifies which of the contact's data is disclosed or not disclosed, in addition to the registry's policy. The value is a comma-separated list of tags, each preceded by `+` or `-`. `+` stands for disclose, `-` for do not disclose.
contact.vat.number	Character string, min. 1, max. 20 characters (ASCII subset)	The european value added tax identification number the entity might have. Registry Specific Notes: eurid, iis: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
contact.natural.person	Boolean value ('true' or 'false')	Whether the contact represents a natural person. Registry Specific Notes: eurid: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
contact.citizenship.countrycode	ISO-3166 country code	The two-character ISO 3166 country code of the contact's country of citizenship. Registry Specific Notes: eurid: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
denic.verification.<1-6>.claims		A space/comma separated list of claims, see DENIC documentation for the accepted claims (at the time of writing, it is "name", "address" and "e-mail"). Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
denic.verification.<1-6>.result	One of: 'success', 'failed'	The outcome of the verification process for the claims. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
denic.verification.<1-6>.reference	Character string (ASCII subset)	A free format reference that identifies the verification process. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
denic.verification.<1-6>.timestamp	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The point in time the verification completed. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
denic.verification.<1-6>.evidence	Character string (ASCII subset)	The evidence that was provided for the verification process. See DENIC documentation for details. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
denic.verification.<1-6>.method	Character string (ASCII subset)	The verification method that was chosen. See DENIC documentation for details. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
denic.verification.<1-6>.trustframework	Character string (ASCII subset)	The trust framework which applies to the verification process. See DENIC documentation for details. Registry Specific Notes: denic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
neustar.nexus.purpose	One of: 'P1', 'P2', 'P3', 'P4', 'P5'	The Nexus application purpose. Registry Specific Notes: neustar: This field is fully supported. afilias, neulevel, gnr, verisign, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
neustar.nexus.category	One of: 'C11', 'C12', 'C21', 'C31', 'C32'	The Nexus category. Registry Specific Notes: neustar: This field is fully supported. afilias, neulevel, gnr, verisign, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
neustar.nexus.validator	Character string (ASCII subset)	This field contains additional information for the Nexus category. Registry Specific Notes: neustar: This field is fully supported. afilias, neulevel, gnr, verisign, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.verification.state	One of: 'verified', 'pending', 'rejected', 'investigation', 'refused'	The contact's current verification state. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.name	Character string (ASCII subset)	The sponsor's name. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.organization	Character string (ASCII subset)	The name of the sponsor's organization. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.address.street.<1-∞>	Character string (ASCII subset)	The street where the sponsor is located. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.address.city	Character string (ASCII subset)	The city where the sponsor is located. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.address.state	Character string (ASCII subset)	The state or province where the sponsor is located. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.address.postalcode	Character string (ASCII subset)	The postalcode of the city where the sponsor is located. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.address.countrycode	ISO-3166 country code	The country code of the country where the sponsor is located. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.voice.number	Character string (ASCII subset)	The sponsor's voice phone number. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.voice.extension	Character string (ASCII subset)	The sponsor's voice telephone number extension. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.fax	Character string (ASCII subset)	The sponsor's fax number. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dotcoop.sponsor.<1-∞>.email	Character string representing a valid e-mail address	The sponsor's e-mail address. Registry Specific Notes: dotcoop: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
eurid.type	One of: 'registrant', 'billing', 'technical', 'onsite'	The EURid type of contact. The value of the type defines the usage within domain requests. Registry Specific Notes: eurid: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
iis.org.number	Character string, min. 5, max. 127 characters (ASCII subset)	Organizational number required for .se registrants. Starts with ISO 3166 Alpha-2 country code in square brackets. If the country code for Sweden is given [SE], a valid Swedish personal or organisational number must be given (6 digits, dash, 4 digits), otherwise 1 to 123 characters can follow If contact.organization is empty and the country code for Sweden [SE] is given, the organization number must be a personal number, not an organizational number. Registry Specific Notes: iis: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
itnic.registrant.regcode	Character string, min. 5, max. 127 characters (ASCII subset)	The registration code is required for .it registrants. Organizations must give the registration number of the business, private persons will have to put in there id card number. Registry Specific Notes: itnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
itnic.registrant.nationalitycode	Character string, min. 5, max. 127 characters (ASCII subset)	Nationality code is required for .it registrants. It will be the two letter ISO code country code where the registrant did register his registration data (id card issuing count or register cord country) Registry Specific Notes: itnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
itnic.registrant.entitytype	Character string, min. 1, max. 1 characters (ASCII subset)	Entity number required for .it registrants. It represents the type of business, registered from the registrant. The business type is represented by a value between 1-6. Registry Specific Notes: itnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
nominet.org.trad.name	Character string, min. 1, max. 255 characters (ASCII subset)	Trading name for .uk registrants. Specifies the trading name of the organisation if different to the account name. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
nominet.registrant.type	Character string, min. 1, max. 16 characters (ASCII subset)	The registrant type for .uk registrants. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
nominet.registrant.co.no	Character string, min. 1, max. 255 characters (ASCII subset)	The registered company number or the DfES UK school number of a .uk registrant. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
nominet.opt.out	Boolean value ('true' or 'false')	The flag telling whether the contact's address details are published in the Nominet WHOIS system. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
cnnic.contact.type	One of: 'I', 'E'	The CNNIC contact type; required if the contact shall be used as a registrant. Possible types are: I (domestic individual contact) E (domestic enterprise contact) Registry Specific Notes: cnnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
cnnic.identification.type	One of: 'BDDM', 'BJWSXX', 'GAJMTX', 'GAJZZ', 'GZJGZY', 'HZ', 'JDDWFW', 'JGZ', 'JJHFR', 'JWJG', 'LSZY', 'MBFQY', 'MBXXBX', 'ORG', 'QT', 'SFJD', 'SFZ', 'SHFWJG', 'SHTTFR', 'SYDWFR', 'TWJMTX', 'TWJZZ', 'TYDM', 'WGCZJG', 'WGZHWH', 'WJLSFZ', 'WLCZJG', 'YLJGZY', 'YYZZ', 'ZJCS'	The CNNIC type of registrant identification. Required if the contact shall be used as a registrant. Possible types for individual contacts are: SFZ (ID Card), HZ (Passport), GAJMTX (MainlandTravel Permit for Hong Kong and Macau Residents), TWJMTX (Mainland travel permit for Taiwan residents), WJLSFZ (Foreign Permanent Resident ID Card), GAJZZ (Residence permit for Hong Kong and Macao resident), TWJZZ (Residence permit for Taiwan residents), JGZ (Certificate of officers) and QT (Other). Possible types for enterprise contacts are: ORG (Organization Code Certificate), YYZZ (Business Licence), TYDM (Unified Social Credit Code Certificate), BDDM (Force Number), JDDWFW (License of Paid Service for Military Units), SYDWFR (Legal Person Certificate of Institution), WGCZJG (Foreign Enterprise Resident Representative Office Registration Certificate), SHTTFR (Social Organization Legal Person Registration Certificate), ZJCS (Registration Certificate of Religious Place), MBFQY (Registration Certificate for Private Non-Enterprise Unit), JJHFR (Foundation Legal Person Registration Certificate), LSZY (Practice License of Law Firm), WGZHWH (Registration Certificate of Foreign Cultural Centers in China), WLCZJG (Registration Certificate of Permanent Representative Office of Tourism Department of Foreign Government), SFJD (Forensic Identification License), JWJG (Certificates of Overseas Institution), SHFWJG (Registration Certificate of Social Service Institution), MBXXBX (Permits for Running Private School), YLJGZY (Practice License of Medical Institution), GZJGZY (Practice Certificate of Notary Institution), BJWSXX (Permits for Running School for Children of Foreign Embassy Staff in Beijing) and QT (Other) Registry Specific Notes: cnnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
cnnic.identification.value	Character string, min. 1, max. 50 characters (full Unicode charset)	The value for the CNNIC registrant identification, e.g. the passport number. Required if the contact shall be used as a registrant. Registry Specific Notes: cnnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
cnnic.phone.number	Character string that must begin with a plus '+' sign, followed by a country code, followed by a dot, followed by a sequence of digits representing the telephone number, min. 1, max. 17 characters	The phone number to be used for registrant validation. Required if the contact shall be used as a registrant. Registry Specific Notes: cnnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
atnic.type	One of: 'privateperson', 'organisation', 'role'	The nic.at type of contact. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.result	One of: 'success', 'failure'	The verification result. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.date	Character string (ASCII subset)	The date when the verification happened. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.method	Character string (ASCII subset)	The methods used for verification. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.agent	Character string (ASCII subset)	The agent used for verification. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.reference	Character string (ASCII subset)	The verification reference string. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.status	Character string (ASCII subset)	The verification status. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.action.date	Date, formatted according to one variant of ISO-8601: 'yyyy-mm-dd'	The date and time when the registry will take action if the reported verification status is not fixed. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.client.id	Character string (ASCII subset)	The ID of the registrar who submitted the verification. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
verification.received.date	Date, formatted according to one variant of ISO-8601: 'yyyy-mm-dd'	The ID of the registrar who submitted the verification. Registry Specific Notes: atnic: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, nominet, sidn, dottv: This field is not supported.
addon.*	Character string (ASCII subset)	Associcated information for value adding services supplied by the backend registries.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: contact.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
contact.id: contact1-ID
contact.authinfo: mySecret

Response:

response.type: contact.inquire
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
sponsor.client.id: clnt23-ID
sponsor.customer.id: 123
creator.client.id: clnt23-ID
creator.customer.id: 32
creation.date: 2001-05-17T22:00:00.0Z
updater.client.id: clnt23-ID
updater.customer.id: 32
update.date: 2001-05-17T22:00:00.0Z
transfer.date: 2001-03-17T21:23:00.0Z
contact.id: contact1-ID
contact.roid: C1232131-LRMS
contact.status: ok
contact.name: John Doe
contact.title: Dr.
contact.organization: ACME Solutions
contact.address.street.1: 100 Centre St
contact.address.city: Townsville
contact.address.state: County Derry
contact.address.postalcode: Z1Z 1Z1
contact.address.countrycode: CA
contact.voice.number: +1.4165559999
contact.voice.extension: 1232
contact.fax: +1.4165558888
contact.fax.extension: 1232
contact.email: jdoe@acmesolutions.info
contact.language: en-US
contact.authinfo: mySecret
contact.sponsored.registrar: true
contact.maintainer: http://www.myreseller.com
contact.datapolicy: restrictive
contact.disclosures: -addrint, -addrloc
contact.vat.number: DE123456
contact.natural.person: true
contact.citizenship.countrycode: DE
denic.verification.1.claims: name
denic.verification.1.result: success
denic.verification.1.reference: ABC123/45GHT
denic.verification.1.timestamp: 2023-11-11T15:36:21Z
denic.verification.1.evidence: idcard
denic.verification.1.method: auth
denic.verification.1.trustframework: de_denic
neustar.nexus.purpose: P1
neustar.nexus.category: C11
neustar.nexus.validator: FR
dotcoop.verification.state: verified
dotcoop.sponsor.1.name: John Doe
dotcoop.sponsor.1.organization: Co-Op Demo
dotcoop.sponsor.1.address.street.1: 1 Acacia Avenue
dotcoop.sponsor.1.address.city: Swindon
dotcoop.sponsor.1.address.state: Ontario
dotcoop.sponsor.1.address.postalcode: 12345
dotcoop.sponsor.1.address.countrycode: CA
dotcoop.sponsor.1.voice.number: +44.20812334567
dotcoop.sponsor.1.voice.extension: 1232
dotcoop.sponsor.1.fax: +44.2081234568
dotcoop.sponsor.1.email: test@dummy.coop
eurid.type: registrant
iis.org.number: [SE]802405-0190
itnic.registrant.regcode: 123456
itnic.registrant.nationalitycode: DE
itnic.registrant.entitytype: 1
nominet.org.trad.name: ACME Ltd.
nominet.registrant.type: LTD
nominet.registrant.co.no: 42
nominet.opt.out: true
cnnic.contact.type: SFZ
cnnic.identification.type: SFZ
cnnic.identification.value: 1232232123212
cnnic.phone.number: +12.3456712189
atnic.type: registrant
verification.result: success
verification.date: 2025-01-01T00:00:00.0Z
verification.method: phone
verification.agent: some agent
verification.reference: my-ref-1
verification.status: verified
verification.action.date: 2025-01-01T00:00:00.0Z
verification.client.id: CL-123
verification.received.date: 2025-01-01T00:00:00.0Z
addon.*: foobar

Table of contents

Command type: inquire host

Description:

Inquire information about a host object.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'host.inquire'	Identifies the command type for host inquiry.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
host.name	Required (only if alternative field 'host.id' is not specified)	Character string, min. 1, max. 132 characters (full Unicode charset)	The name of the host to inquire.
host.id	Required (only if alternative field 'host.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the host to inquire.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'host.inquire'	Specifies the response type for host inquiry.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
sponsor.client.id	Character string (ASCII subset)	The client id of the inquired object's sponsor.
sponsor.customer.id	Integer value	Id of the sponsoring customer (if the inquired object is sponsored by a customer).
creator.client.id	Character string (ASCII subset)	The client id of the inquired object's creator.
creator.customer.id	Integer value	Id of the customer that created the inquired object (if the inquired object was created by a customer).
creation.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The date of object creation according to the registry.
updater.client.id	Character string (ASCII subset)	The client id of the inquired object's last updater. Not present if the inquired object has never been modified.
updater.customer.id	Integer value	Id of the customer that last updated the inquired object (if the last object update was done by a customer).
update.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The date of the last object update according to the registry. Not present if the inquired object has never been modified.
transfer.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The date of the last transfer of the inquired object. Not present if the inquired object has never been transferred.
host.name	Character string (full Unicode charset)	The name of the inquired host.
host.id	Character string (ASCII subset)	The registry-assigned id of the inquired host.
host.status	Character string (ASCII subset)	A comma-separated list of status values for the host. Refer to the status value specification below for a list of valid status values.
host.addr.<1-∞>.value	Character string (ASCII subset)	An IP address of the host.
host.addr.<1-∞>.type	One of: 'ipv4', 'ipv6'	The type of the corresponding IP address (IPV4 or IPV6).
host.authinfo	Character string (ASCII subset)	The authorization information associated with the host (pass phrase/password); this information is only returned if the querying customer is sponsoring the inquired host.
host.maintainer	Character string (full Unicode charset)	Id or URL of the customer's reseller (if the host is not directly maintained by the customer).
addon.*	Character string (ASCII subset)	Associcated information for value adding services supplied by the backend registries.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: host.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
host.name: ns1.domain.info
host.id: host1-ID

Response:

response.type: host.inquire
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
sponsor.client.id: clnt23-ID
sponsor.customer.id: 123
creator.client.id: clnt23-ID
creator.customer.id: 32
creation.date: 2001-05-17T22:00:00.0Z
updater.client.id: clnt23-ID
updater.customer.id: 32
update.date: 2001-05-17T22:00:00.0Z
transfer.date: 2001-03-17T21:23:00.0Z
host.name: ns1.domain.info
host.id: host1-ID
host.status: ok
host.addr.1.value: 100.103.44.15
host.addr.1.type: ipv4
host.authinfo: mySecret
host.maintainer: http://www.myreseller.com
addon.*: foobar

Table of contents

Command type: inquire domain

Description:

Inquire information about a domain object.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.inquire'	Identifies the command type for domain inquiry.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain to inquire. Registry Specific Notes: verisign, pir: This field is fully supported. Character string, min. 1, max. 67 characters
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain to inquire.
domain.authinfo	Optional	Character string, min. 4, max. 89 characters (full Unicode charset)	The authorization information specified by the registrant (pass phrase/password). If this is specified, the registry may return additional information (like contacts) about the inquired domain, which is not included in its response otherwise.
request.authinfo	Optional	Boolean value ('true' or 'false')	Specifies whether an authinfo for the domain should be requested at the registry. Registry Specific Notes: eurid: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.

Response format:

Key Value type/content Description

response.type

Fixed: 'domain.inquire'

Specifies the response type for domain inquiry.

payload.version

Fixed: '2.0'

Version of the payload format used in the response.

result.code

Integer value

The overall numeric result code of the command.

result.msg

Character string (ASCII subset)

The overall result of the command in human-readable form.

transaction.id

Character string (ASCII subset)

The transaction id specified in the request.

registry.transaction.id

Character string (ASCII subset)

The transaction id assigned by the registry.

sponsor.client.id

Character string (ASCII subset)

The client id of the inquired object's sponsor.

sponsor.customer.id

Integer value

Id of the sponsoring customer (if the inquired object is sponsored by a customer).

creator.client.id

Character string (ASCII subset)

The client id of the inquired object's creator.

creator.customer.id

Integer value

Id of the customer that created the inquired object (if the inquired object was created by a customer).

creation.date

Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.

The date of object creation according to the registry.

updater.client.id

Character string (ASCII subset)

The client id of the inquired object's last updater. Not present if the inquired object has never been modified.

updater.customer.id

Integer value

Id of the customer that last updated the inquired object (if the last object update was done by a customer).

update.date

The date of the last object update according to the registry. Not present if the inquired object has never been modified.

transfer.date

The date of the last transfer of the inquired object. Not present if the inquired object has never been transferred.

domain.name

Character string (full Unicode charset)

The name of the inquired domain.

Registry Specific Notes:

verisign, pir:

This field is fully supported.

Character string, min. 1, max. 67 characters

domain.id

Character string (ASCII subset)

The registry-assigned id of the inquired domain.

domain.supplier.id

Integer value

The ID of the domain's supplier.

Registry Specific Notes:

misc:

This field is fully supported.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

domain.name.language

Language tag according to RFC 1766

This field defines the language context of the domain name.

Registry Specific Notes:

verisign:

This field is fully supported.

afilias, neulevel, gnr, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

domain.status

Character string (ASCII subset)

A comma-separated list of status values for the domain. Refer to the status value specification below for a list of valid status values.

domain.sponsored.client

Boolean value ('true' or 'false')

If set to true, the domain is currently sponsored by the registrar for which this instance of the DRS is operating; this usually implies that the DRS is able to manage the domain. If set to false, the domain is sponsored by another registrar. The field may be missing if this information cannot be determined. Note that the content of this field is independent from the DRS customer sending the request, i.e. it may contain true even if the inquired domain does not belong to the DRS customer's account. To determine customer sponsorship, the domain.sponsored.customer response field may be used.

domain.sponsored.customer

Boolean value ('true' or 'false')

If set to true, the domain is currently sponsored by the effective DRS customer who submitted the inquire request; this usually implies that the customer is able to modify the domain. If set to false, the domain is either sponsored by another DRS customer, or not present in the DRS database at all. The field may be missing if this information cannot be determined.

domain.authinfo

Character string (full Unicode charset)

The authorization information associated with the domain (pass phrase/password); this information is only returned if the querying customer is sponsoring the inquired domain.

Registry Specific Notes:

afilias:

This field is fully supported.

Character string, min. 6, max. 16 characters

neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, twnic, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, icmregistry, dottv:

This field is fully supported.

denic:

This field is fully supported.

domain.authinfo.expiration.date

This date specifies the expiration date of the authinfo. Only reported for own domains.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

domain.authinfo.defined

Boolean value ('true' or 'false')

Specifies whether the domain has an associated authinfo. Contrary to the domain.authinfo field, this is returned both for domains managed by DRS and by other registrars.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

domain.maintainer

Character string (full Unicode charset)

Id or URL of the customer's reseller (if the domain is not directly maintained by the customer).

domain.comment

Character string (full Unicode charset)

An arbitrary text stored as a comment for the domain.

expiration.date

The expire date of the object according to the registry.

contact.<1-∞>.id

Character string (ASCII subset)

The id of a contact to be associated with the domain. The number and types of required contacts are registry specific.

contact.<1-∞>.type

One of:

'admin', 'billing', 'registrant', 'tech', 'zone', 'onsite', 'ced', 'opn', 'member', 'abuse', 'general'

The type of the corresponding contact. The number and types of required contacts are registry specific.

ns.<1-∞>.name

Character string (full Unicode charset)

The fully qualified name of a name server associated with the domain. The number of name servers is registry specific.

ns.<1-∞>.id

Character string (ASCII subset)

The registry-assigned id of the corresponding name server.

ns.<1-∞>.role

One of:

'none', 'primary'

The role of this host concerning the domain; currently, only 'none' (no particular role) or 'primary' (the host is the primary name server for the domain) are supported.

host.<1-∞>.name

Character string (full Unicode charset)

The fully qualified name of a host object created under this superordinate domain object.

Note:

According to EPP, host objects listed here are subject to transfer when transferring the domain object.

host.<1-∞>.id

Character string (ASCII subset)

The registry-assigned id of the corresponding host object.

telnic.whois.type

One of:

'legal', 'natural'

Specifies whether the domain is held by a corporation or individual.

Registry Specific Notes:

telnic:

This field is fully supported.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

telnic.whois.publish

Boolean value ('true' or 'false')

Specifies whether to publish social data to WHOIS for an individually owned domain.

Registry Specific Notes:

telnic:

This field is fully supported.

This field is not supported.

dnssec.sign

Boolean value ('true' or 'false')

Flag whether DRS shall automatically sign the zone and publish it on its name servers. Note that in this case the DNSSEC key data for the registry is automatically maintained. The DNSSEC key data specified in this request may be overwritten by the system at a later point in time.

dnssec.ds.<1-∞>.ds.keytag

Integer value, min. 0, max. 65535

The key tag assigned to the DS record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

dnssec.ds.<1-∞>.ds.alg

Integer value, min. 0, max. 255

The algorithm of the related DNSKEY record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digesttype

Integer value, min. 0, max. 255

The digest type used for the hash of the related DNSKEY record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digest.hex

Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)

The hexadecimal representation of the hash of the DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digest.base64

Base64 encoded binary data according to RFC 4648

The Base64 representation of the hash of the DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.maxsiglife

Integer value, min. 1

The maximum lifetime of the signature of the DS record. This is only a recommendation, the registry is not obliged to respect the value.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.flags

Integer value, min. 0, max. 65535

The "flags" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.protocol

Integer value, min. 0, max. 255

The "protocol" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.alg

Integer value, min. 0, max. 255

The "algorithm" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.pubkey.hex

Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)

The hexadecimal representation of the public key data.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.pubkey.base64

Base64 encoded binary data according to RFC 4648

The Base64 representation of the public key data.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

domain.parked

Boolean value ('true' or 'false')

If set to true, the domain is marked as 'parked' in the DRS database and ignored by zone or procmailer generators.

domain.start.date

Date, formatted according to one variant of ISO-8601: 'yyyy-mm-dd'

the start date of the domain. Not present if the inquired domain does not have a start date.

domain.end.date

Date, formatted according to one variant of ISO-8601: 'yyyy-mm-dd'

the end date of the domain. Not present if the inquired domain does not have a end date.

domain.scheduled.end.date

Date, formatted according to one variant of ISO-8601: 'yyyy-mm-dd'

the scheduled end date of the domain. Not present if the inquired domain does not have a scheduled end date.

domain.user.scheduled.end.date

Date, formatted according to one variant of ISO-8601: 'yyyy-mm-dd'

the user scheduled end date of the domain. Not present if the inquired domain does not have a user scheduled end date.

domain.application.date

Date, formatted according to one variant of ISO-8601: 'yyyy-mm-dd'

the application date of the domain. Not present if the inquired domain does not have a application date.

nominet.reg.status

Character string (ASCII subset)

This fields shows the registration status of a domain name.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.auto.bill

Integer value, min. 0, max. 182

The field used to indicate how many days before expiry a domain name should be renewed automatically by the registry. This field can be cleared by setting the default value of 0; it cannot be set if nominet.next.bill or nominet.renew.not.required is set.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.auto.period

Integer value, min. 1, max. 9

This field is used in combination with nominet.auto.bill to define the number of years to renew a domain name for. The default renewal period is two years when this is undefined.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.next.bill

Integer value, min. 0, max. 182

The field used to indicate how many days before expiry a domain name should be renewed automatically by the registry. The next-bill field will reset to 0 by the registry after a single registration period. This field can be cleared by setting the default value of 0; it cannot be set if nominet.auto.bill, or nominet.renew.not.required is set.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.next.period

Integer value, min. 1, max. 9

This field is used in combination with nominet.next.bill to define the number of years to renew a domain name for. The default renewal period is two years when this is undefined.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.renew.not.required

Boolean value ('true' or 'false')

This field is used to mark domain names that the registrant does not intend to renew. Setting this field will prevent Nominet from sending renewal reminders to the registrant. When set, a single e-mail notification will be sent to the registrant to advise that the domain name will not be renewed. This field can be cleared by renewing the domain name or by the registrant using Nominet's Online Service to change registrar. This field cannot be set if either nominet.auto.bill or nominet.next.bill is set.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.note.<1-20>

Character string, min. 0, max. 200 characters (full Unicode charset)

These are free-form fields for miscellaneous information relating to the domain name.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.reseller

Character string (ASCII subset)

A field which can be used to associate a reseller with a domain.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

verification.status

Character string (ASCII subset)

The verification status of the domain's registrant.

Registry Specific Notes:

atnic:

This field is fully supported.

This field is not supported.

verification.action.date

Date, formatted according to one variant of ISO-8601: 'yyyy-mm-dd'

The date and time when the registry will take action if the reported verification status is not fixed.

Registry Specific Notes:

atnic:

This field is fully supported.

This field is not supported.

addon.*

Character string (ASCII subset)

Associcated information for value adding services supplied by the backend registries.

result.<1-∞>.code

Integer value

Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.

result.<1-∞>.msg

Character string (ASCII subset)

The specific result of the command in human-readable form.

result.<1-∞>.error.<1-∞>

Character string (ASCII subset)

The field value from the request which caused the corresponding result.

result.<1-∞>.key.<1-∞>

Character string (ASCII subset)

The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
domain.authinfo: mySecret

Response:

response.type: domain.inquire
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
sponsor.client.id: clnt23-ID
sponsor.customer.id: 123
creator.client.id: clnt23-ID
creator.customer.id: 32
creation.date: 2001-05-17T22:00:00.0Z
updater.client.id: clnt23-ID
updater.customer.id: 32
update.date: 2001-05-17T22:00:00.0Z
transfer.date: 2001-03-17T21:23:00.0Z
domain.name: acme.info
domain.id: domain1-ID
domain.supplier.id: 123
domain.name.language: en-US
domain.status: ok
domain.sponsored.client: true
domain.sponsored.customer: true
domain.authinfo: mySecret
domain.authinfo.expiration.date: 2008-12-24T18:00:00.0Z
domain.authinfo.defined: true
domain.maintainer: http://www.myreseller.com
domain.comment: just a comment...
expiration.date: 2003-05-17T22:00:00.0Z
contact.1.id: contact1-ID
contact.1.type: registrant
ns.1.name: ns1.domain.info
ns.1.id: host1-ID
ns.1.role: primary
host.1.name: ns1.acme.info
host.1.id: host2-ID
telnic.whois.type: natural
telnic.whois.publish: true
dnssec.sign: false
dnssec.ds.1.ds.keytag: 38583
dnssec.ds.1.ds.alg: 3
dnssec.ds.1.ds.digesttype: 1
dnssec.ds.1.ds.digest.hex: 666F6F626172
dnssec.ds.1.ds.digest.base64: Zm9vYmFy
dnssec.ds.1.ds.maxsiglife: 1
dnssec.ds.1.key.flags: 256
dnssec.ds.1.key.protocol: 3
dnssec.ds.1.key.alg: 3
dnssec.ds.1.key.pubkey.hex: 666F6F626172
dnssec.ds.1.key.pubkey.base64: Zm9vYmFy
domain.parked: false
domain.start.date: false
domain.end.date: false
domain.scheduled.end.date: false
domain.user.scheduled.end.date: false
domain.application.date: false
nominet.reg.status: Registered until expiry date.
nominet.auto.bill: 5
nominet.auto.period: 1
nominet.next.bill: 5
nominet.next.period: 1
nominet.renew.not.required: Y
nominet.note.1: example note for testing
nominet.reseller: ACME Inc.
verification.status: verified
verification.action.date: 2025-01-01T00:00:00.0Z
addon.*: foobar

Table of contents

Command type: inquire web forwarding config

Description:

Inquire the web forwarding configuration for a domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'webfwd.cfg.inquire'	Identifies the command type for web forward configuration inquiry.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'webfwd.cfg.inquire'	Specifies the response type for web forward configuration inquiries.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
domain.name	Character string (full Unicode charset)	The name of the domain (including top level domain) which web forward configuration is returned.
domain.id	Character string (ASCII subset)	The id of the domain which web forward configuration is returned.
fwd.<1-∞>.name	Character string, min. 0, max. 255 characters (full Unicode charset)	The name of a forward entry, i.e. the domain prefix. This may be left empty to indicate that this is the default forward for the domain.
fwd.<1-∞>.desturlbase	Character string, min. 1, max. 512 characters (full Unicode charset)	The destination base URL for a forward entry.
fwd.<1-∞>.defaultrootdoc	Character string, min. 1, max. 255 characters (full Unicode charset)	The root document (appended to the base URL) for the forward entry.
fwd.<1-∞>.option.<1-∞>	One of: 'frames', 'asquerystring', 'matchallsubnames', 'scantitle', 'scanmeta', 'redirect-temporarily', 'redirect-permanently', 'redirect-see-other', 'redirect-temporary-redirect', 'tls-cs', 'no-path', 'no-query-string', 'no-magic-www'	An option flag to be associated with this forward entry. Refer to the Knipp web redirector documentation for more information.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: webfwd.cfg.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID

Response:

response.type: webfwd.cfg.inquire
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
domain.name: acme.info
domain.id: domain1-ID
fwd.1.name: www
fwd.1.desturlbase: http://members.dokom.de/~test
fwd.1.defaultrootdoc: index.html
fwd.1.option.1: frames

Table of contents

Command type: inquire e-mail forwarding config

Description:

Inquire the e-mail forwarding configuration for a domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'emailfwd.cfg.inquire'	Identifies the command type for email forward configuration inquiry.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'emailfwd.cfg.inquire'	Specifies the response type for email forward configuration inquiries.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
domain.name	Character string (full Unicode charset)	The name of the domain (including top level domain) which email forward configuration is returned.
domain.id	Character string (ASCII subset)	The id of the domain which email forward configuration is returned.
fwd.<1-∞>.name	Character string, min. 0, max. 128 characters (full Unicode charset)	The name of this forward entry, i.e. the recipient for the forward. It may be empty to indicate that this is the default forward for the domain (which is used if no specific matching entry is found). Note that it is possible to have multiple enties with the same name for a domain, resulting in multiple forwarded mails for each mail that is sent to this name.
fwd.<1-∞>.destaddr	Character string, min. 1, max. 512 characters (full Unicode charset)	The destination e-mail address for this forward entry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: emailfwd.cfg.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID

Response:

response.type: emailfwd.cfg.inquire
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
domain.name: acme.info
domain.id: domain1-ID
fwd.1.name: hans
fwd.1.destaddr: hans@members.dokom.de

Table of contents

Command type: inquire zone config

Description:

Inquire the zone configuration for a domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'zone.cfg.inquire'	Identifies the command type for zone configuration inquiry.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'zone.cfg.inquire'	Specifies the response type for zone configuration inquiries.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
domain.name	Character string (full Unicode charset)	The name of the domain (including top level domain) which zone configuration is returned.
domain.id	Character string (ASCII subset)	The id of the domain which zone configuration is returned.
rr.<1-∞>.type	Character string (ASCII subset)	The type of this resource record (RR).
rr.<1-∞>.subtype	One of: 'stdmail', 'stdmailvw', 'stdmailsf', 'stdmailvwsf', 'redir', 'bakmail', 'monetizing', 'mailbox'	The type of this resource record. Only valid for records of type 'SPECIAL'.
rr.<1-∞>.owner	Character string, min. 1, max. 512 characters (full Unicode charset)	The owner (subdomain) for this resource record.
rr.<1-∞>.class	One of: 'IN', 'CH'	The network class for this resource record. May be omitted, defaults to the most common value.
rr.<1-∞>.ttl	Integer value	The time to live setting for this resource record. Defaults to 0 which means 'no value'.
rr.<1-∞>.priority	Integer value	The priority for this resource record (only significant to records of type 'mx').
rr.<1-∞>.rdata	Character string, min. 1 characters (full Unicode charset)	The rdata string for this resource record (the semantics are record type specific).
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: zone.cfg.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID

Response:

response.type: zone.cfg.inquire
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
domain.name: acme.info
domain.id: domain1-ID
rr.1.type: MX
rr.1.subtype: redir
rr.1.owner: www
rr.1.class: IN
rr.1.ttl: 10000
rr.1.priority: 10
rr.1.rdata: super.duper.edu

Table of contents

Command type: inquire stealth server

Description:

Inquire the stealth server (hidden primary DNS) for a domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'stealth.inquire'	Identifies the command type for stealth server inquiry.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'stealth.inquire'	Specifies the response type for stealth inquiries.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
domain.name	Character string (full Unicode charset)	The name of the domain (including top level domain) which stealth server is returned.
domain.id	Character string (ASCII subset)	The id of the domain which stealth server is returned.
stealth.addr.value	Character string (ASCII subset)	The IP address of the stealth server.
stealth.addr.type	One of: 'ipv4', 'ipv6'	The type of the stealth server's IP address (IPV4 or IPV6).
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: stealth.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID

Response:

response.type: stealth.inquire
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
domain.name: acme.info
domain.id: domain1-ID
stealth.addr.value: 100.103.44.15
stealth.addr.type: ipv4

Table of contents

Command type: inquire mailbox config

Description:

Inquire the mailbox configuration for a domain. Note that passwords are not returned as they are not stored in clear text.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'mailbox.cfg.inquire'	Identifies the command type for mailbox configuration inquiry.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain whose mailbox configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain whose mailbox configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'mailbox.cfg.inquire'	Specifies the response type for mailbox configuration inquiries.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
domain.name	Character string (full Unicode charset)	The name of the domain (including top level domain) whose mailbox configuration is returned.
domain.id	Character string (ASCII subset)	The id of the domain whose email forward configuration is returned.
mailbox.price.tier	Character string (ASCII subset)	The mailbox price tier selected for the domain. Depending on the tier, the number of supported mailboxes may be restricted.
mailbox.<1-∞>.name	Character string, min. 0, max. 255 characters (full Unicode charset)	The name of this entry, i.e. the local name of the mailbox within the domain.
mailbox.<1-∞>.fullname	Character string, min. 1, max. 255 characters (full Unicode charset)	The full name of the mailbox user.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: mailbox.cfg.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID

Response:

response.type: mailbox.cfg.inquire
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
domain.name: acme.info
domain.id: domain1-ID
mailbox.price.tier: tier1
mailbox.1.name: hans
mailbox.1.fullname: Hans Mustermann

Table of contents

Command type: check domains

Description:

Check the availability of domain names

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.check'	Identifies the command type for domain check.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.<1-∞>.name	Required	Character string, min. 1, max. 255 characters (full Unicode charset)	This field specifies the domain name(s) that shall be tested for availability. The field may contain either the presentation form or its Punycode encoded form. Registry Specific Notes: verisign: Verisign allows to check five domain names at maximum.
domain.<1-∞>.name.i15d	Optional	Character string, min. 1, max. 255 characters (full Unicode charset)	This field contains the presentation form the corresponding `domain.#.name` field to ensure the integrity of the name. If the field is specified, the other field may not contain a name in presentation form, but must use the Punycode encoding. If the Punycode form represents a different name than the presentation form, the request is rejected. Registry Specific Notes: verisign: This field is fully supported. Character string, min. 1, max. 67 characters afilias: This field is fully supported. Character string, min. 1, max. 68 characters neulevel, telnic: This field is fully supported. Character string, min. 1, max. 67 characters pir: This field is fully supported. Character string, min. 1, max. 67 characters inregistry: This field is fully supported. Character string, min. 1, max. 67 characters gnr, neustar, dotcoop, cnnic, cnnic.idn, denic, misc, alien, twnic, eurid, dotaero, dotmobi, dotasia, domen, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
domain.<1-∞>.name.language	Optional	Language tag according to RFC 1766	This field defines the language context of the domain name to check. Note that this is only required by some registries if an IDN is checked; otherwise, the field may be specified but is ignored. Registry Specific Notes: afilias, pir: This field must be specified if an IDN is checked.
period.value	Optional	Integer value, min. 1, max. 99	The period value for checking price information. If this field is specified and the registry supports it, the command will return price information for billable operations (create, renew, transfer, restore) performed on the checked object(s), i.e. it will determine how much the effective client of the command would be charged if the client performed the respective command on the object, using the specified period.
period.unit	Optional	One of: 'y', 'm' (default value: y)	The unit of measurement for the specified object's period (years or months).

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.check'	Specifies the response type for domain check.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
domain.<1-∞>.name	Character string, min. 1, max. 255 characters (full Unicode charset)	This field contains the domain name(s) that have been requested to be checked. Each field corresponds to the n-th field of the request. Please note that the contents of the field does not need to be exactly the same. Normalization or other registry specific rules may have adjusted the name. Registry Specific Notes: : This field is fully supported.
domain.<1-∞>.name.i15d	Character string, min. 1, max. 255 characters (full Unicode charset)	This field contains the presentation form the corresponding `domain.#.name` field to ensure the integrity of the name. Registry Specific Notes: verisign: This field is fully supported. Character string, min. 1, max. 67 characters afilias: This field is fully supported. Character string, min. 1, max. 68 characters neulevel, telnic: This field is fully supported. Character string, min. 1, max. 67 characters cnnic.idn, denic, eurid: This field is fully supported. Character string, min. 1, max. 66 characters pir: This field is fully supported. Character string, min. 1, max. 67 characters : This field is fully supported. gnr, neustar, dotcoop, cnnic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
domain.<1-∞>.available	Boolean value ('true' or 'false')	Contains the availability of the domain name.
domain.<1-∞>.reason	Character string (full Unicode charset)	Optional response field that contains an additional reason for the given availability. The possible values are not standardized and should not be interpreted.
domain.<1-∞>.claim.exists	Boolean value ('true' or 'false')	Specifies whether a trade mark claim exists for the domain name in the specified launch phase; if this is the case, the name can only be registered in the launch phase if the create request is submitted with a suitable claims notice. This response field is not present if a launch phase was not specified for the check request, or if trademark claim information could not be retrieved from the registry.
domain.<1-∞>.claim.<1-∞>.key	Character string (ASCII subset)	Specifies the claim key which needs to be used to retrieve the trademark claims notice from the Trademark Validator specified by the corresponding `domain..claim..validator.id` field. Note that a domain may have multiple claim keys, one for each Trademark Validator; ICANN's Trademark Clearinghouse (TMCH) is the default, but other Trademark Validators may exist.
domain.<1-∞>.claim.<1-∞>.validator.id	Character string (ASCII subset)	Specifies the ID of the Trademark Validator for which the claim key specified by the corresponding `domain..claim..key` field must be used. If not present, the key must be used for ICANN's Trademark Clearinghouse (TMCH), which is the default Trademark Validator.
domain.<1-∞>.claim.<1-∞>.notice.id	Character string (ASCII subset)	Specifies the ID of the claims notice retrieved from the Trademark Validator for the domain.
domain.<1-∞>.claim.<1-∞>.notice.not.before.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	Specifies the start date and time of the claims notice's validity period.
domain.<1-∞>.claim.<1-∞>.notice.not.after.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	Specifies the end date and time of the claims notice's validity period.
domain.<1-∞>.claim.<1-∞>.notice.accept.url	Character string (full Unicode charset)	Specifies the URL the registrant of the checked domain needs to visit in order to accept the Trademark Validator's claims notice prior to an attempt to register the domain. The Gateway records the acceptance of the claims notice and utilizes this information when it receives a subsequent `domain.create` for the domain name within the validity period of the notice.
domain.<1-∞>.create.price.<1-∞>.amount	Floating point value	Specifies an amount the member is charged to create the checked domain, in the currency specified by the corresponding `domain.#.create.price.#.currency` field. Similar response fields may be available for the "renew", "transfer" and "restore" operations. Note that multiple charges per operation may apply (e.g. in the case of separate application and creation fees), which is why more than one amount may occur (however, in most cases, only a single charge applies). Also note that this field is only returned if a period was specified in the check request.
domain.<1-∞>.create.price.<1-∞>.currency	Character string, min. 3, max. 3 characters (ASCII subset)	Specifies the currency for the amount specified by the corresponding `domain.#.create.price.#.amount` field. Similar response fields may be available for the "renew", "transfer" and "restore" operations. Note that this field is only returned if a period was specified in the check request.
domain.<1-∞>.create.price.standard	Boolean value ('true' or 'false')	Specifies whether the amount(s) specified by the corresponding `domain.#.create.price.#.amount` field(s) represent a "standard" price for the registry, as opposed to e.g. a premium price or special discount price, which are not regarded as "standard" prices. Similar response fields may be available for the "renew", "transfer" and "restore" operations. Note that this field is only returned if a period was specified in the check request.
domain.<1-∞>.phase.<1-∞>.name	Character string (ASCII subset)	Specifies the name of a launch phase for which phase specific information (such as for pricing) may be available in corresponding fields with the same prefix. Note that this field is only returned if a period was specified in the check request.
domain.<1-∞>.phase.<1-∞>.subname	Character string (ASCII subset)	Specifies the name of the sub-phase of the phase specified by the corresponding `domain.#.phase.#.name` field. Note that this field is only returned if a period was specified in the check request, and if the corresponding phase has a sub-phase.
domain.<1-∞>.phase.<1-∞>.create.price.<1-∞>.amount	Floating point value	Specifies an amount the member is charged to create the checked domain in the phase, in the currency specified by the corresponding `domain.#.phase.#.create.price.#.currency` field. Similar response fields may be available for the "renew", "transfer" and "restore" operations. Note that multiple charges per operation may apply (e.g. in the case of separate application and creation fees), which is why more than one amount may occur (however, in most cases, only a single charge applies). Also note that this field is only returned if a period was specified in the check request.
domain.<1-∞>.phase.<1-∞>.create.price.<1-∞>.currency	Character string (ASCII subset)	Specifies the currency for the amount specified by the corresponding `domain.#.phase.#.create.price.#.amount` field. Similar response fields may be available for the "renew", "transfer" and "restore" operations. Note that this field is only returned if a period was specified in the check request.
domain.<1-∞>.phase.<1-∞>.create.price.standard	Boolean value ('true' or 'false')	Specifies whether the amount(s) specified by the corresponding `domain.#.phase.#.create.price.#.amount` field(s) represent a "standard" price for the registry, as opposed to e.g. a premium price or special discount price, which are not regarded as "standard" prices. Similar response fields may be available for the "renew", "transfer" and "restore" operations. Note that this field is only returned if a period was specified in the check request.
domain.<1-∞>.phase.<1-∞>.trademark.smd.required	Boolean value ('true' or 'false')	Specifies whether the phase requires the specification of Signed Mark Data (SMD) when domains are created.
domain.<1-∞>.phase.<1-∞>.claims.checked	Boolean value ('true' or 'false')	Specifies whether the phase may involve checks for trademark claims when domains are created.
domain.<1-∞>.phase.<1-∞>.start.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	Specifies the start date and time of the phase (only present if known to the system); attempts to create new domains before this date/time will fail.
domain.<1-∞>.phase.<1-∞>.end.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	Specifies the end date and time of the phase (only present if known to the system); attempts to create new domains at or after this date/time will fail.
domain.<1-∞>.phase.<1-∞>.eligibility.<1-∞>.key.suffix	Character string (ASCII subset)	Specifies the Payload key suffix to be used to specify an eligibility information field in a `domain.create` request for the phase. If the suffix is e.g. "intended-use", the full Payload key required to specify the field is "eligibility.intended-use".
domain.<1-∞>.phase.<1-∞>.eligibility.<1-∞>.name	Character string (ASCII subset)	Specifies the human-readable name (in English) of the respective eligibility information field.
domain.<1-∞>.phase.<1-∞>.eligibility.<1-∞>.documentation	Character string (ASCII subset)	An (English) string describing the purpose/meaning/usage of the respective eligibility information field.
domain.<1-∞>.phase.<1-∞>.eligibility.<1-∞>.pattern	Character string (ASCII subset)	A regular expression to match valid values of the respective eligibility information field (if available).
domain.<1-∞>.phase.<1-∞>.eligibility.<1-∞>.example	Character string (ASCII subset)	An example string for the value of the respective eligibility information field (if available).
domain.<1-∞>.phase.<1-∞>.eligibility.<1-∞>.required	Boolean value ('true' or 'false')	Flag denoting whether specifying the respective eligibility information field is required.
nominet.abuse.limit	Integer value	This field shows the abuse limit. Nominet restricts the number of check commands per calendar day to 5000. If this limit is exceeded, the check command is automatically disabled and will remain so until the following midnight. Registry Specific Notes: nominet: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, sidn, dottv: This field is not supported.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.check
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.1.name: example.com
domain.1.name.i15d: example.com
domain.1.name.language: en-US
period.value: 2
period.unit: y

Response:

response.type: domain.check
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
domain.1.name: example.com
domain.1.name.i15d: example.com
domain.1.available: false
domain.1.reason: In use
domain.1.claim.exists: true
domain.1.claim.1.key: 2018012700/2/4/9/F4m6J9z9FVbR2HpkvyqZ-R1u1230000153
domain.1.claim.1.validator.id: some-validator
domain.1.claim.1.notice.id: 370d0b7c9223372036854775807
domain.1.claim.1.notice.not.before.date: 2018-08-14T09:00:00Z
domain.1.claim.1.notice.not.after.date: 2018-08-16T09:00:00Z
domain.1.claim.1.notice.accept.url: https://accept-claim-notice.info/c?i=abcXYZ
domain.1.create.price.1.amount: 50
domain.1.create.price.1.currency: USD
domain.1.create.price.standard: true
domain.1.phase.1.name: open
domain.1.phase.1.subname: premium-3
domain.1.phase.1.create.price.1.amount: 50
domain.1.phase.1.create.price.1.currency: USD
domain.1.phase.1.create.price.standard: true
domain.1.phase.1.trademark.smd.required: false
domain.1.phase.1.claims.checked: false
domain.1.phase.1.start.date: 2019-01-01T00:00:00.000Z
domain.1.phase.1.end.date: 2020-01-01T00:00:00.000Z
domain.1.phase.1.eligibility.1.key.suffix: intended-use
domain.1.phase.1.eligibility.1.name: Intended Use
domain.1.phase.1.eligibility.1.documentation: Free text describing the domain's intended use.
domain.1.phase.1.eligibility.1.pattern: .*fish.*
domain.1.phase.1.eligibility.1.example: Web site about fishing.
domain.1.phase.1.eligibility.1.required: true
nominet.abuse.limit: 4217

Table of contents

Command type: modify contact

Description:

Modify a contact object.

Registry Specific Notes:

cnnic, cnnic.idn:

This command is not supported.

Request format:

Key Occurrence Value type/content Description

request.type

Required

Fixed: 'contact.modify'

Identifies the command type for contact modification.

Note:

The modification causes *all* changeable contact data to be replaced, so previous contact fields that do not need to be changed must be supplied again. This means that it is *not* sufficient to specify only fields that need changes.

payload.version

Required

Fixed: '2.0'

Version of the payload format used in the request.

transaction.atp

Required only for commands sent via e-mail, else optional

Character string (ASCII subset)

The 'any time' password (specified by the customer using the web interface) to be used for the transaction.

customer.id

Required

Integer value

Id of the requesting customer.

person.id

Required

Integer value

Id of the requesting person.

request.feedback

Optional

Boolean value ('true' or 'false') (default value: true)

If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.

transaction.id

Required

Character string (ASCII subset)

The customer's arbitrary internal transaction id.

agent.id

Optional

Character string (ASCII subset)

The id of the agent (client program) that created the order.

registry.id

Optional

Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)

The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de").

Registry Specific Notes:

afilias:

This field is fully supported.

Fixed: 'afilias'

occurrence: Optional

neulevel:

This field is fully supported.

Fixed: 'neulevel'

occurrence: Required

gnr:

This field is fully supported.

Fixed: 'gnr'

occurrence: Required

verisign:

This field is fully supported.

Fixed: 'verisign'

occurrence: Required

neustar:

This field is fully supported.

Fixed: 'neustar'

occurrence: Required

pir:

This field is fully supported.

Fixed: 'pir'

occurrence: Required

dotaero:

This field is fully supported.

Fixed: 'dotaero'

occurrence: Required

dotmobi:

This field is fully supported.

Fixed: 'dotmobi'

occurrence: Required

inregistry:

This field is fully supported.

Fixed: 'inregistry'

occurrence: Required

dotasia:

This field is fully supported.

Fixed: 'dotasia'

occurrence: Required

domen:

This field is fully supported.

Fixed: 'domen'

occurrence: Required

telnic:

This field is fully supported.

Fixed: 'telnic'

occurrence: Required

switch:

This field is fully supported.

Fixed: 'switch'

occurrence: Required

iis:

This field is fully supported.

Fixed: 'iis'

occurrence: Required

itnic:

This field is fully supported.

Fixed: 'itnic'

occurrence: Required

icmregistry:

This field is fully supported.

Fixed: 'icmregistry'

occurrence: Required

dottv:

This field is fully supported.

Fixed: 'dottv'

occurrence: Required

contact.id

Required

Character string (ASCII subset)

The id (handle) of the contact to modify.

contact.name

Required

Character string, min. 1, max. 128 characters (ASCII subset)

Name of the individual or the role represented by the contact.

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

denic:

This field is fully supported.

occurrence: Optional

contact.title

Optional

Character string, min. 1, max. 128 characters (ASCII subset)

Title of the individual.

Registry Specific Notes:

verisign:

This field is fully supported.

This field is not supported.

contact.organization

Optional

Character string, min. 1, max. 128 characters (ASCII subset)

Name of the organization with which the contact is affiliated.

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

dotcoop:

This field is fully supported.

occurrence: Required

denic:

This field is fully supported.

occurrence: Optional

contact.address.street.<1-3>

First index required

Character string, min. 1, max. 255 characters (ASCII subset)

The contact's first, second and third street address.

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

denic:

This field is fully supported.

occurrence: Optional

contact.address.city

Required

Character string, min. 1, max. 255 characters (ASCII subset)

The contact's city.

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

denic:

This field is fully supported.

occurrence: Optional

contact.address.state

Optional

Character string, min. 1, max. 255 characters (ASCII subset)

The contact's state or province.

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

contact.address.postalcode

Required

Character string, min. 1, max. 16 characters (ASCII subset)

The contact's postal code.

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 10 characters

denic:

This field is fully supported.

occurrence: Optional

contact.address.countrycode

Required

ISO-3166 country code, min. 2, max. 2 characters

The contact's country code (two-character ISO 3166 country code).

Registry Specific Notes:

denic:

This field is fully supported.

occurrence: Optional

The following block of internationalized (i15d) fields is entirely optional. If at least one field is specified, all constraints in the 'Occurrence' column apply.

contact.i15d.name

Required

Character string, min. 1, max. 128 characters (full Unicode charset)

Name of the individual or the role represented by the contact.

[internationalized version]

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

denic:

This field is fully supported.

occurrence: Optional

contact.i15d.title

Optional

Character string, min. 1, max. 128 characters (full Unicode charset)

Title of the individual.

[internationalized version]

Registry Specific Notes:

verisign:

This field is fully supported.

This field is not supported.

contact.i15d.organization

Optional

Character string, min. 1, max. 128 characters (full Unicode charset)

Name of the organization with which the contact is affiliated.

[internationalized version]

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

dotcoop:

This field is fully supported.

occurrence: Required

denic:

This field is fully supported.

occurrence: Optional

contact.i15d.address.street.<1-3>

First index required

Character string, min. 1, max. 255 characters (full Unicode charset)

The contact's first, second and third street address.

[internationalized version]

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

denic:

This field is fully supported.

occurrence: Optional

contact.i15d.address.city

Required

Character string, min. 1, max. 255 characters (full Unicode charset)

The contact's city.

[internationalized version]

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

denic:

This field is fully supported.

occurrence: Optional

contact.i15d.address.state

Optional

Character string, min. 1, max. 255 characters (full Unicode charset)

The contact's state or province.

[internationalized version]

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 30 characters

contact.i15d.address.postalcode

Required

Character string, min. 1, max. 16 characters (full Unicode charset)

The contact's postal code.

[internationalized version]

Registry Specific Notes:

neulevel, dottv:

This field is fully supported.

Character string, min. 1, max. 10 characters

denic:

This field is fully supported.

occurrence: Optional

contact.i15d.address.countrycode

Required

ISO-3166 country code, min. 2, max. 2 characters

The contact's country code (two-character ISO 3166 country code).

[internationalized version]

Registry Specific Notes:

denic:

This field is fully supported.

occurrence: Optional

contact.voice.number

Optional

Character string that must begin with a plus '+' sign, followed by a country code, followed by a dot, followed by a sequence of digits representing the telephone number, min. 1, max. 17 characters

The contact's voice telephone number.

contact.voice.extension

Optional

Character string, min. 1, max. 8 characters, pattern (regular expression): '^\d+$' (ASCII subset)

The contact's voice telephone number extension.

contact.fax

Optional

Character string that must begin with a plus '+' sign, followed by a country code, followed by a dot, followed by a sequence of digits representing the telephone number, min. 1, max. 17 characters

The contact's facsimile telephone number.

Registry Specific Notes:

denic:

Fax numbers are no longer supported by DENIC

contact.email

Required

Character string representing a valid e-mail address, min. 1, max. 132 characters

The contact's e-mail address.

Registry Specific Notes:

neulevel, neustar, dottv:

This field is fully supported.

Character string, min. 1, max. 80 characters

denic:

This field is fully supported.

occurrence: Optional

contact.language

Optional

Language tag according to RFC 1766

The contact's preferred natural language.

Registry Specific Notes:

eurid:

This field is fully supported.

One of:

'cs', 'da', 'de', 'el', 'en', 'es', 'et', 'fi', 'fr', 'hu', 'it', 'lt', 'lv', 'mt', 'nl', 'pl', 'pt', 'sk', 'sl', 'sv'

occurrence: Required

contact.authinfo

Optional

Character string, min. 4, max. 89 characters (ASCII subset)

The authorization information specified by the registrant (pass phrase/password).

Registry Specific Notes:

afilias:

This field is fully supported.

Character string, min. 6, max. 16 characters

occurrence: Required

neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, dottv:

This field is fully supported.

occurrence: Required

denic:

This field is not supported.

contact.maintainer

Optional

Character string, min. 1, max. 128 characters (full Unicode charset)

Id or URL of the customer's reseller (if the contact is not directly maintained by the customer).

contact.datapolicy

Optional

One of:

'restrictive', 'permissive'

(default value: restrictive)

Specifies whether the contact's data may be used for marketing purposes. restrictive disallows the use, permissive allows it.

contact.disclosures

Optional

Character string (ASCII subset) (default value: )

Specifies which of the contact's data is disclosed or not disclosed, in addition to the registry's policy. The value is a comma-separated list of tags, each preceded by + or -. + stands for disclose, - for do not disclose. Possible tags are: nameint, nameloc, orgint, orgloc, addrint, addrloc, voice, fax, email.

contact.vat.number

Optional

Character string, min. 1, max. 20 characters (ASCII subset)

The european value added tax identification number the entity might have.

Registry Specific Notes:

eurid, iis:

This field is fully supported.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

contact.natural.person

Optional

Boolean value ('true' or 'false')

Whether the contact represents a natural person.

Registry Specific Notes:

eurid:

This field is fully supported.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

contact.citizenship.countrycode

Optional

ISO-3166 country code

The two-character ISO 3166 country code of the contact's country of citizenship.

Registry Specific Notes:

eurid:

This field is fully supported.

This field is not supported.

neustar.nexus.purpose

Optional

One of:

'P1', 'P2', 'P3', 'P4', 'P5'

The Nexus application purpose.

Registry Specific Notes:

neustar:

This field is fully supported.

occurrence: This field is optional in general, but is required for contacts to be used as registrants in domain registrations.

afilias, neulevel, gnr, verisign, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

neustar.nexus.category

Optional

One of:

'C11', 'C12', 'C21', 'C31', 'C32'

The Nexus category.

Registry Specific Notes:

neustar:

This field is fully supported.

occurrence: This field is optional in general, but is required for contacts to be used as registrants in domain registrations.

This field is not supported.

neustar.nexus.validator

Optional

Character string (ASCII subset)

This field contains additional information for the Nexus category. This field must be left blank for the categories C11, C12 and C21. For the categories C31 and C32 this field must contain an uppercase two letter ISO-3166 code.

Registry Specific Notes:

neustar:

This field is fully supported.

occurrence: This field is optional in general, but is required for contacts to be used as registrants in domain registrations.

This field is not supported.

denic.type

Optional

One of:

'person', 'org', 'request'

Specifies the DENIC type of the contact (person, role, org or request contact).

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

denic.uritemplate

Optional

Character string, min. 1, max. 1024 characters (ASCII subset)

Specifies a URI template for "request" contacts

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

denic.verification.<1-6>.claims

A space/comma separated list of claims, see DENIC documentation for the accepted claims (at the time of writing, it is "name", "address" and "e-mail").

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

denic.verification.<1-6>.result

One of:

'success', 'failed'

The outcome of the verification process for the claims.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

denic.verification.<1-6>.reference

Character string (ASCII subset)

A free format reference that identifies the verification process.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

denic.verification.<1-6>.timestamp

The point in time the verification completed.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

denic.verification.<1-6>.evidence

Character string (ASCII subset)

The evidence that was provided for the verification process. See DENIC documentation for details.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

denic.verification.<1-6>.method

Character string (ASCII subset)

The verification method that was chosen. See DENIC documentation for details.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

denic.verification.<1-6>.trustframework

Character string (ASCII subset)

The trust framework which applies to the verification process. See DENIC documentation for details.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

eurid.type

Optional

One of:

'registrant', 'billing', 'tech', 'onsite'

The EURid type of contact. The value of the type defines the usage within domain requests.

Registry Specific Notes:

eurid:

This field is fully supported.

occurrence: Required

This field is not supported.

atnic.type

Optional

One of:

'privateperson', 'organisation', 'role'

The nic.at type of contact. The value of the type defines the usage within domain requests. Note that this type may not be changed as long as the contact is used as a registrant in at least one domain.

Registry Specific Notes:

atnic:

This field is fully supported.

occurrence: Required

This field is not supported.

verification.result

Optional

One of:

'success', 'failure'

The verification result.

Registry Specific Notes:

atnic:

This field is fully supported.

This field is not supported.

verification.date

Optional

Character string (ASCII subset)

The date when the verification happened.

Registry Specific Notes:

atnic:

This field is fully supported.

This field is not supported.

verification.method

Optional

Character string (ASCII subset)

The methods used for verification.

Registry Specific Notes:

atnic:

This field is fully supported.

This field is not supported.

verification.agent

Optional

Character string (ASCII subset)

The agent used for verification.

Registry Specific Notes:

atnic:

This field is fully supported.

This field is not supported.

verification.reference

Optional

Character string (ASCII subset)

The verification reference string.

Registry Specific Notes:

atnic:

This field is fully supported.

This field is not supported.

sidn.id.form

Optional

One of:

'individual', 'corp', 'unincorp'

The legal form of the contact. Currently allowed values according to the .nl registry are: "individual" (Individual), "corp" (Corporation) and "unincorp" (Unincorporated Business).

Registry Specific Notes:

sidn:

This field is fully supported.

occurrence: Required

This field is not supported.

sidn.id.number

Optional

Character string (ASCII subset)

The registration number of the legal form. This field is obsolete after SIDN's switch to the "Hello" registry in 2026, but still accepted for backwards compatibility.

Registry Specific Notes:

sidn:

This field is fully supported.

occurrence: Optional

This field is not supported.

itnic.registrant.regcode

Optional

Character string, min. 5, max. 127 characters (ASCII subset)

The registration code is required for .it registrants. Organizations must give the registration number of the business, private persons will have to put in there id card number.

Registry Specific Notes:

itnic:

This field is fully supported.

This field is not supported.

itnic.registrant.nationalitycode

Optional

Character string, min. 2, max. 2 characters (ASCII subset)

Nationality code is required for .it registrants. It will be the two letter ISO code country code where the registrant did register his registration data (id card issuing count or register cord country)

Registry Specific Notes:

itnic:

This field is fully supported.

This field is not supported.

itnic.registrant.entitytype

Optional

Character string, min. 1, max. 1 characters (ASCII subset)

Entity number required for .it registrants. It represents the type of business registered by the registrant. The business type is represented by a value between 1-6.

Registry Specific Notes:

itnic:

This field is fully supported.

This field is not supported.

nominet.org.trad.name

Optional

Character string, min. 1, max. 255 characters (ASCII subset)

Trading name for .uk registrants. Specifies the trading name of the organisation if different to the account name.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.registrant.type

Optional

Character string, min. 1, max. 16 characters (ASCII subset)

The registrant type for .uk registrants.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.registrant.co.no

Optional

Character string, min. 1, max. 255 characters (ASCII subset)

The registered company number or the DfES UK school number of a .uk registrant.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.opt.out

Optional

Boolean value ('true' or 'false')

The flag telling whether the contact's address details are published in the Nominet WHOIS system.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

cnnic.contact.type

Optional

One of:

'I', 'E'

The CNNIC contact type; required if the contact shall be used as a registrant. Possible types are:

I (domestic individual contact)
E (domestic enterprise contact)

Registry Specific Notes:

cnnic:

This field is fully supported.

occurrence: Optional

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

cnnic.identification.type

Optional

One of:

'BDDM', 'BJWSXX', 'GAJMTX', 'GAJZZ', 'GZJGZY', 'HZ', 'JDDWFW', 'JGZ', 'JJHFR', 'JWJG', 'LSZY', 'MBFQY', 'MBXXBX', 'ORG', 'QT', 'SFJD', 'SFZ', 'SHFWJG', 'SHTTFR', 'SYDWFR', 'TWJMTX', 'TWJZZ', 'TYDM', 'WGCZJG', 'WGZHWH', 'WJLSFZ', 'WLCZJG', 'YLJGZY', 'YYZZ', 'ZJCS'

The CNNIC type of registrant identification. Required if the contact shall be used as a registrant.

Possible types for individual contacts are: SFZ (ID Card), HZ (Passport), GAJMTX (MainlandTravel Permit for Hong Kong and Macau Residents), TWJMTX (Mainland travel permit for Taiwan residents), WJLSFZ (Foreign Permanent Resident ID Card), GAJZZ (Residence permit for Hong Kong and Macao resident), TWJZZ (Residence permit for Taiwan residents), JGZ (Certificate of officers) and QT (Other). Possible types for enterprise contacts are: ORG (Organization Code Certificate), YYZZ (Business Licence), TYDM (Unified Social Credit Code Certificate), BDDM (Force Number), JDDWFW (License of Paid Service for Military Units), SYDWFR (Legal Person Certificate of Institution), WGCZJG (Foreign Enterprise Resident Representative Office Registration Certificate), SHTTFR (Social Organization Legal Person Registration Certificate), ZJCS (Registration Certificate of Religious Place), MBFQY (Registration Certificate for Private Non-Enterprise Unit), JJHFR (Foundation Legal Person Registration Certificate), LSZY (Practice License of Law Firm), WGZHWH (Registration Certificate of Foreign Cultural Centers in China), WLCZJG (Registration Certificate of Permanent Representative Office of Tourism Department of Foreign Government), SFJD (Forensic Identification License), JWJG (Certificates of Overseas Institution), SHFWJG (Registration Certificate of Social Service Institution), MBXXBX (Permits for Running Private School), YLJGZY (Practice License of Medical Institution), GZJGZY (Practice Certificate of Notary Institution), BJWSXX (Permits for Running School for Children of Foreign Embassy Staff in Beijing) and QT (Other)

This field is ignored unless cnnic.identification.value is also specified.

Registry Specific Notes:

cnnic:

This field is fully supported.

occurrence: Optional

This field is not supported.

cnnic.identification.value

Optional

Character string, min. 1, max. 50 characters (full Unicode charset)

The value for the CNNIC registrant identification, e.g. the passport number. Required if the contact shall be used as a registrant. This field is ignored unless cnnic.identification.type is also specified.

Registry Specific Notes:

cnnic:

This field is fully supported.

occurrence: Optional

This field is not supported.

cnnic.phone.number

Optional

Character string that must begin with a plus '+' sign, followed by a country code, followed by a dot, followed by a sequence of digits representing the telephone number, min. 1, max. 17 characters

The phone number to be used for registrant validation. Required if the contact shall be used as a registrant.

Registry Specific Notes:

cnnic:

This field is fully supported.

occurrence: Optional

This field is not supported.

addon.*

Optional

Character string (ASCII subset)

Any field that matches the given prefix is used for the value adding services supplied by backend registries. The description of the specific fields available is out of scope of this document.

gateway.*

Optional

Character string (ASCII subset)

Any field with the "gateway." prefix is passed through as-is to GatewayNG (with the "gateway." prefix stripped from the key). This field is only supported for GatewayNG registries.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'contact.modify'	Specifies the response type for contact modification.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: contact.modify
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
contact.id: contact1-ID
contact.name: John Doe
contact.title: Dr.
contact.organization: ACME Solutions
contact.address.street.1: 100 Centre St
contact.address.city: Townsville
contact.address.state: County Derry
contact.address.postalcode: Z1Z 1Z1
contact.address.countrycode: CA
contact.voice.number: +1.4165559999
contact.voice.extension: 1232
contact.fax: +1.4165558888
contact.email: jdoe@acmesolutions.info
contact.language: en-US
contact.authinfo: mySecret
contact.maintainer: http://www.myreseller.com
contact.datapolicy: permissive
contact.disclosures: -addrint, -addrloc
contact.vat.number: DE123456
contact.natural.person: true
contact.citizenship.countrycode: DE
neustar.nexus.purpose: P1
neustar.nexus.category: C11
neustar.nexus.validator: FR
denic.type: person
denic.uritemplate: mailto:info@example.com?subject=domain:{Ulabel}
denic.verification.1.claims: name
denic.verification.1.result: success
denic.verification.1.reference: ABC123/45GHT
denic.verification.1.timestamp: 2023-11-11T15:36:21Z
denic.verification.1.evidence: idcard
denic.verification.1.method: auth
denic.verification.1.trustframework: de_denic
eurid.type: registrant
atnic.type: registrant
verification.result: success
verification.date: 2025-01-01T00:00:00.0Z
verification.method: phone
verification.agent: some agent
verification.reference: my-ref-1
sidn.id.form: individual
sidn.id.number: 8764654.0
itnic.registrant.regcode: 123456
itnic.registrant.nationalitycode: DE
itnic.registrant.entitytype: 1
nominet.org.trad.name: ACME Ltd.
nominet.registrant.type: LTD
nominet.registrant.co.no: 42
nominet.opt.out: true
cnnic.contact.type: E
cnnic.identification.type: SFZ
cnnic.identification.value: 1232232123212
cnnic.phone.number: +12.3456712189
addon.*: foobar
gateway.*: foobar

Response:

response.type: contact.modify
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: modify host

Description:

Modify a host object.

Registry Specific Notes:

cnnic, cnnic.idn:

This command is not supported.

Request format:

Key

Occurrence

Value type/content

Description

request.type

Required

Fixed: 'host.modify'

Identifies the command type for host modification.

Note:

The modification causes *all* changeable host data to be replaced, so previous host fields that do not need to be changed must be supplied again. This means that it is *not* sufficient to specify only fields that need changes.

payload.version

Required

Fixed: '2.0'

Version of the payload format used in the request.

transaction.atp

Required only for commands sent via e-mail, else optional

Character string (ASCII subset)

The 'any time' password (specified by the customer using the web interface) to be used for the transaction.

customer.id

Required

Integer value

Id of the requesting customer.

person.id

Required

Integer value

Id of the requesting person.

request.feedback

Optional

Boolean value ('true' or 'false') (default value: true)

transaction.id

Required

Character string (ASCII subset)

The customer's arbitrary internal transaction id.

agent.id

Optional

Character string (ASCII subset)

The id of the agent (client program) that created the order.

registry.id

Optional

Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)

Registry Specific Notes:

afilias:

This field is fully supported.

Fixed: 'afilias'

occurrence: Optional

neulevel:

This field is fully supported.

Fixed: 'neulevel'

occurrence: Required

gnr:

This field is fully supported.

Fixed: 'gnr'

occurrence: Required

verisign:

This field is fully supported.

Fixed: 'verisign'

occurrence: Required

neustar:

This field is fully supported.

Fixed: 'neustar'

occurrence: Required

pir:

This field is fully supported.

Fixed: 'pir'

occurrence: Required

dotaero:

This field is fully supported.

Fixed: 'dotaero'

occurrence: Required

dotmobi:

This field is fully supported.

Fixed: 'dotmobi'

occurrence: Required

inregistry:

This field is fully supported.

Fixed: 'inregistry'

occurrence: Required

dotasia:

This field is fully supported.

Fixed: 'dotasia'

occurrence: Required

domen:

This field is fully supported.

Fixed: 'domen'

occurrence: Required

telnic:

This field is fully supported.

Fixed: 'telnic'

occurrence: Required

switch:

This field is fully supported.

Fixed: 'switch'

occurrence: Required

iis:

This field is fully supported.

Fixed: 'iis'

occurrence: Required

itnic:

This field is fully supported.

Fixed: 'itnic'

occurrence: Required

icmregistry:

This field is fully supported.

Fixed: 'icmregistry'

occurrence: Required

dottv:

This field is fully supported.

Fixed: 'dottv'

occurrence: Required

host.name

Required (only if alternative field 'host.id' is not specified)

Character string, min. 1, max. 132 characters (full Unicode charset)

The fully qualified name of the host to modify.

host.id

Required (only if alternative field 'host.name' is not specified)

Character string (ASCII subset)

The registry-assigned id of the host to modify.

host.newname

Optional

Character string, min. 1, max. 132 characters (ASCII subset)

The new fully qualified name of the host.

host.addr.<1-∞>.value

If the host name exists in a top level domain for which the registry is not authoritative, then the host object MUST NOT have any associated IP addresses. If the host name exists in a top level domain for which the registry is authoritative, then the host object MAY have associated IP addresses. Furthermore, if the host name exists in a top level domain for which the registry is authoritative, then the superordinate domain of the host MUST be known to the registry (i.e., has to be created) before the host object can be created.

Character string (ASCII subset)

An IP address of the host.

Registry Specific Notes:

afilias, neulevel, gnr, dotcoop, cnnic, cnnic.idn, twnic, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, dottv:

Registry supports a maximum of 13 IP addresses per name server.

verisign, pir:

First required. Supports a maximum of 13 IP addresses

neustar:

Only one address may be specified at most. Hosts that are in the .US TLD must have an IP address, where others may have one.

host.addr.<1-∞>.type

Optional

One of:

'ipv4', 'ipv6'

(default value: ipv4)

The type of the corresponding IP address (IPV4 or IPV6). Note that some registries may not allow the use of IPV6 addresses.

host.authinfo

Optional

Character string, min. 4, max. 89 characters (ASCII subset)

The authorization information (pass phrase/password) to be associated with the host.

Registry Specific Notes:

afilias:

This field is fully supported.

Character string, min. 6, max. 16 characters

verisign, pir:

This field is fully supported.

Character string, min. 4, max. 16 characters

host.maintainer

Optional

Character string, min. 1, max. 128 characters (full Unicode charset)

Id or URL of the customer's reseller (if the host is not directly maintained by the customer).

addon.*

Optional

Character string (ASCII subset)

Any field that matches the given prefix is used for the value adding services supplied by backend registries. The description of the specific fields available is out of scope of this document.

gateway.*

Optional

Character string (ASCII subset)

Any field with the "gateway." prefix is passed through as-is to GatewayNG (with the "gateway." prefix stripped from the key). This field is only supported for GatewayNG registries.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'host.modify'	Specifies the response type for host modification.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: host.modify
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
host.name: ns1.domain.info
host.id: host1-ID
host.newname: ns3.domain.info
host.addr.1.value: 100.103.44.15
host.addr.1.type: ipv4
host.authinfo: mySecret
host.maintainer: http://www.myreseller.com
addon.*: foobar
gateway.*: foobar

Response:

response.type: host.modify
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: modify domain

Description:

Modify a domain object.

Registry Specific Notes:

cnnic, cnnic.idn:

This command is not supported.

dotcoop:

The registrant contact may not be changed, i.e. the same contact ID that has been used for the creation must be specified as registrant. Otherwise the command will fail.

nominet:

The registrant contact may only be changed if the new contact has the same value in its "organization" field as the existing registrant. Otherwise, the change may only be done via the Nominet web site.

This command is not supported.

Request format:

Key Occurrence Value type/content Description

request.type

Required

Fixed: 'domain.modify'

Identifies the command type for domain modification.

Note:

The modification causes *all* changeable domain data to be replaced, so previous domain fields that do not need to be changed must be supplied again. This means that it is *not* sufficient to specify only fields that need changes.

payload.version

Required

Fixed: '2.0'

Version of the payload format used in the request.

transaction.atp

Required only for commands sent via e-mail, else optional

Character string (ASCII subset)

The 'any time' password (specified by the customer using the web interface) to be used for the transaction.

customer.id

Required

Integer value

Id of the requesting customer.

person.id

Required

Integer value

Id of the requesting person.

request.feedback

Optional

Boolean value ('true' or 'false') (default value: true)

transaction.id

Required

Character string (ASCII subset)

The customer's arbitrary internal transaction id.

agent.id

Optional

Character string (ASCII subset)

The id of the agent (client program) that created the order.

registry.id

Optional

Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)

Registry Specific Notes:

afilias:

This field is fully supported.

Fixed: 'afilias'

occurrence: Optional

neulevel:

This field is fully supported.

Fixed: 'neulevel'

occurrence: Required

gnr:

This field is fully supported.

Fixed: 'gnr'

occurrence: Required

verisign:

This field is fully supported.

Fixed: 'verisign'

occurrence: Required

neustar:

This field is fully supported.

Fixed: 'neustar'

occurrence: Required

pir:

This field is fully supported.

Fixed: 'pir'

occurrence: Required

dotaero:

This field is fully supported.

Fixed: 'dotaero'

occurrence: Required

dotmobi:

This field is fully supported.

Fixed: 'dotmobi'

occurrence: Required

inregistry:

This field is fully supported.

Fixed: 'inregistry'

occurrence: Required

dotasia:

This field is fully supported.

Fixed: 'dotasia'

occurrence: Required

domen:

This field is fully supported.

Fixed: 'domen'

occurrence: Required

telnic:

This field is fully supported.

Fixed: 'telnic'

occurrence: Required

switch:

This field is fully supported.

Fixed: 'switch'

occurrence: Required

iis:

This field is fully supported.

Fixed: 'iis'

occurrence: Required

itnic:

This field is fully supported.

Fixed: 'itnic'

occurrence: Required

icmregistry:

This field is fully supported.

Fixed: 'icmregistry'

occurrence: Required

dottv:

This field is fully supported.

Fixed: 'dottv'

occurrence: Required

domain.name

Required (only if alternative field 'domain.id' is not specified)

Character string, min. 1, max. 131 characters (full Unicode charset)

The name of the domain to modify.

Registry Specific Notes:

verisign, pir:

This field is fully supported.

Character string, min. 1, max. 67 characters

domain.id

Required (only if alternative field 'domain.name' is not specified)

Character string (ASCII subset)

The registry-assigned id of the domain to modify.

domain.authinfo

Optional

Character string, min. 4, max. 89 characters (full Unicode charset)

The authorization information specified by the registrant (pass phrase/password).

Registry Specific Notes:

afilias:

This field is fully supported.

Character string, min. 6, max. 16 characters

occurrence: Required

neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, dottv:

This field is fully supported.

occurrence: Required

denic:

This field is fully supported.

domain.authinfo.expiration.date

Optional

This date specifies the expiration date of the authinfo. If omitted, the maximum possible duration is taken. If the date is in the past, the authinfo is ignored/cleared.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

domain.maintainer

Optional

Character string, min. 1, max. 128 characters (full Unicode charset)

Id or URL of the customer's reseller (if the domain is not directly maintained by the customer).

domain.comment

Optional

Character string, min. 1, max. 255 characters (full Unicode charset)

An arbitrary text stored as a comment for the domain.

ns.<1-∞>.name

Optional

Character string, min. 1, max. 132 characters (full Unicode charset)

The fully qualified name of a host (name server) to be associated with the domain. A host with this name must exists in the involved registry. The number of required name servers is registry specific.

Registry Specific Notes:

afilias:

The registry requires zero or 2 to 13 name servers.

neulevel, neustar, dottv:

Up to 13 name servers may be specified.

verisign, pir:

The registry requires 0 to 13 name servers

ns.<1-∞>.id

Optional

Character string (ASCII subset)

The id of a host to be associated with the domain (may be specified as an alternative to the host's name). The same registry specific restrictions apply as to the ns.#.name field

ns.<1-∞>.role

Optional

One of:

'none', 'primary'

(default value: none)

The role of this host concerning the domain; currently, only 'none' (no particular role) or 'primary' (the host is the primary name server for the domain) are supported.

ns.<1-∞>.address.<1-∞>.value

Optional

Character string, min. 3, max. 45 characters (ASCII subset)

The IP address of the host given in the specified format. Note that this field is only evaluated for generic registries using hosts as domain attributes.

ns.<1-∞>.address.<1-∞>.type

Optional

One of:

'ipv4', 'ipv6'

This field specifies the address type of the given name server. Note that this field is only evaluated for generic registries using hosts as domain attributes.

contact.<1-∞>.id

Optional

Character string, min. 1 characters (ASCII subset)

The id of a contact to be associated with the domain. A contact with this name must exists in the involved registry. The number and types of required contacts are registry specific.

Registry Specific Notes:

eurid:

The registry requires 1 to 5 onsite contacts and exactly one registrant contact.

switch:

The Switch registry requires exactly one tech and exactly one registrant contact. Billing and admin contacts are not supported; the billing contact for .ch/.li domains is always the registrar.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

There must be exactly one registrant, admin, tech and billing contact specified.

contact.<1-∞>.type

Optional

One of:

'admin', 'billing', 'registrant', 'tech', 'zone', 'onsite', 'ced', 'opn', 'member', 'abuse', 'general'

The type of the corresponding contact. The number and types of required contacts are registry specific.

Registry Specific Notes:

eurid:

There must be exactly one registrant contact specified; an optional onsite contact may also be specified. Other contact types are not allowed.

dotasia:

There must be one ced contact specified and in use as one of the other contacts like registrant, billing, admin, tech. Contact type onsite is not allowed. Contact type opn is optional.

switch:

One of:

'registrant', 'tech'

Only registrant and tech contacts are supported by the Switch registry.

atnic:

As registrant contacts, only contacts marked as "privateperson" or "organisation" may be specified. "role" contacts are not permitted as registrants.

denic:

Admin, tech and zone contacts are no longer supported by DENIC. While they are accepted by the system, they are no longer submitted to DENIC. Abuse and general contacts may be added, but are not required.

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, dotaero, dotmobi, inregistry, domen, telnic, iis, itnic, icmregistry, nominet, sidn, dottv:

There must be exactly one registrant, admin, tech and billing contact specified.

domain.parked

Optional

Boolean value ('true' or 'false') (default value: false)

If set to true, the domain is marked as 'parked' in the DRS database and ignored by zone or procmailer generators.

telnic.whois.type

Optional

One of:

'legal', 'natural'

Specifies whether the domain is held by a corporation or individual.

Registry Specific Notes:

telnic:

This field is fully supported.

This field is not supported.

telnic.whois.publish

Optional

Boolean value ('true' or 'false') (default value: true)

Specifies whether to publish social data to WHOIS for an individually owned domain.

Registry Specific Notes:

telnic:

This field is fully supported.

This field is not supported.

icmregistry.member.contact.password

Optional

Character string, min. 4, max. 64 characters (ASCII subset)

The password associated with the specified 'member' contact. May only occur when such a contact is specified (and is a mandatory field in this case).

Registry Specific Notes:

icmregistry:

This field is fully supported.

This field is not supported.

nominet.auto.bill

Optional

Integer value, min. 0, max. 182

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.next.bill

Optional

Integer value, min. 0, max. 182

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.auto.period

Optional

Integer value, min. 1, max. 9

This field is used in combination with nominet.auto.bill to define the number of years to renew a domain name for. The default renewal period is two years when this is undefined.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.next.period

Optional

Integer value, min. 1, max. 9

This field is used in combination with nominet.next.bill to define the number of years to renew a domain name for. The default renewal period is two years when this is undefined.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.note.<1-20>

Optional

Character string, min. 0, max. 200 characters (ASCII subset)

These are free-form fields for miscellaneous information relating to the domain name.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.reseller

Optional

Character string (ASCII subset)

A field which can be used to associate a reseller with a domain.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

nominet.renew.not.required

Optional

Boolean value ('true' or 'false')

This field is used to mark domain names that the registrant does not intend to renew. Setting this field will prevent Nominet from sending renewal reminders to the registrant. When set, a single e-mail notification will be sent to the registrant to advise that the domain name will not be renewed. This field is set with a value of y and can be cleared with a value of n. This field can also be cleared by renewing the domain name or by the registrant using Nominet's Online Service to change registrar. This field cannot be set if either nominet.auto.bill or nominet.next.bill is set.

Registry Specific Notes:

nominet:

This field is fully supported.

This field is not supported.

ens.auth.id

Optional

Character string, min. 1, max. 20 characters (ASCII subset)

ID of ENS_Auth record on which the registration is based.

Registry Specific Notes:

dotaero:

This field is fully supported.

occurrence: Required

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This field is not supported.

ens.auth.key

Optional

Character string, min. 1, max. 20 characters (ASCII subset)

The authentication key (password). Must match the ENS_Auth record identified by ens.auth.id.

Registry Specific Notes:

dotaero:

This field is fully supported.

occurrence: Required

This field is not supported.

dnssec.urgent

Optional

Boolean value ('true' or 'false') (default value: false)

This flag tells the registry that an urgent update of the name servers is desired. However, the registry is not obliged to comply with the desire.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.sign

Optional

Boolean value ('true' or 'false')

dnssec.ds.<1-∞>.ds.keytag

Optional

Integer value, min. 0, max. 65535

The key tag assigned to the DS record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.alg

Optional

Integer value, min. 0, max. 255

The algorithm of the related DNSKEY record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digesttype

Optional

Integer value, min. 0, max. 255

The digest type used for the hash of the related DNSKEY record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digest.hex

Optional

Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)

The hexadecimal representation of the hash of the DNSKEY record. Must be specified unless the data is given in the Base64 notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digest.base64

Optional

Base64 encoded binary data according to RFC 4648

The Base64 representation of the hash of the DNSKEY record. Must be given unless the data is given in hexadecimal notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.maxsiglife

Optional

Integer value, min. 1

The maximum lifetime of the signature of the DS record. This is only a recommendation, the registry is not obliged to respect the value.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.flags

Optional

Integer value, min. 0, max. 65535

The "flags" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.protocol

Optional

Integer value, min. 0, max. 255

The "protocol" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.alg

Optional

Integer value, min. 0, max. 255

The "algorithm" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.pubkey.hex

Optional

Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)

The hexadecimal representation of the public key data. Must be specified unless the data is given in the Base64 notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.pubkey.base64

Optional

Base64 encoded binary data according to RFC 4648

The Base64 representation of the public key data. Must be given unless the data is given in hexadecimal notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

addon.*

Optional

Character string (ASCII subset)

Any field that matches the given prefix is used for the value adding services supplied by backend registries. The description of the specific fields available is out of scope of this document.

gateway.*

Optional

Character string (ASCII subset)

Any field with the "gateway." prefix is passed through as-is to GatewayNG (with the "gateway." prefix stripped from the key). This field is only supported for GatewayNG registries.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.modify'	Specifies the response type for domain modification.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
domain.authinfo	Character string (ASCII subset)	If present, this field contains the authinfo string that was automatically assigned to the domain (which may differ from the one originally specified).
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.modify
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
domain.authinfo: mySecret
domain.authinfo.expiration.date: 2008-12-24T18:00:00.0Z
domain.maintainer: http://www.myreseller.com
domain.comment: just a comment...
ns.1.name: ns1.domain.info
ns.1.id: host1-ID
ns.1.role: primary
ns.1.address.1.value: 123.145.167.212
ns.1.address.1.type: ipv4
contact.1.id: contact1-ID
contact.1.type: admin
domain.parked: false
telnic.whois.type: natural
telnic.whois.publish: true
icmregistry.member.contact.password: my-secret
nominet.auto.bill: 5
nominet.next.bill: 5
nominet.auto.period: 1
nominet.next.period: 1
nominet.note.1: example note for testing
nominet.reseller: ACME Inc.
nominet.renew.not.required: true
ens.auth.id: 12345678-airline
ens.auth.key: jGaA45
dnssec.urgent: true
dnssec.sign: false
dnssec.ds.1.ds.keytag: 38583
dnssec.ds.1.ds.alg: 3
dnssec.ds.1.ds.digesttype: 1
dnssec.ds.1.ds.digest.hex: 666F6F626172
dnssec.ds.1.ds.digest.base64: Zm9vYmFy
dnssec.ds.1.ds.maxsiglife: 1
dnssec.ds.1.key.flags: 256
dnssec.ds.1.key.protocol: 3
dnssec.ds.1.key.alg: 3
dnssec.ds.1.key.pubkey.hex: 666F6F626172
dnssec.ds.1.key.pubkey.base64: Zm9vYmFy
addon.*: foobar
gateway.*: foobar

Response:

response.type: domain.modify
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
domain.authinfo: jerjkI23!wer1ee

Table of contents

Command type: set web forwarding config

Description:

Set the web forwarding configuration for a domain; the previous configuration is completely replaced by the one given in the request. If no previous configuration is present, a new one is created. The command can also be used to remove all web forward configuration entries for a domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'webfwd.cfg.set'	Identifies the command type for web forward configuration modification.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
fwd.<1-∞>.name	Optional	Character string, min. 0, max. 255 characters (full Unicode charset)	The name of this forward entry, i.e. the domain prefix for the forward. This value must be unique within the list of entries for the domain. It may be left empty to indicate that this is the default forward for the domain (which is used if no specific matching entry is found).
fwd.<1-∞>.desturlbase	Optional	Character string, min. 1, max. 512 characters (full Unicode charset)	The destination base URL for a forward entry. This is marked optional because this command may lack any forward entries (to remove them completely from a domain), but the field must be present and non-empty for every specified forward.
fwd.<1-∞>.defaultrootdoc	Optional	Character string, min. 0, max. 255 characters (full Unicode charset)	The root document (appended to the base URL) for the forward entry.
fwd.<1-∞>.option.<1-∞>	Optional	One of: 'frames', 'asquerystring', 'matchallsubnames', 'scantitle', 'scanmeta', 'redirect-temporarily', 'redirect-permanently', 'redirect-see-other', 'redirect-temporary-redirect', 'tls-cs', 'no-path', 'no-query-string', 'no-magic-www'	An option flag to be associated with this forward entry. Refer to the Knipp web redirector documentation for more information.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'webfwd.cfg.set'	Specifies the response type for web forward configuration modifications.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: webfwd.cfg.set
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
fwd.1.name: www
fwd.1.desturlbase: http://members.dokom.de/~test
fwd.1.defaultrootdoc: index.html
fwd.1.option.1: frames

Response:

response.type: webfwd.cfg.set
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: set email forwarding config

Description:

set the email forwarding configuration for a domain; the previous configuration is completely replaced by the one given in the request. If no previous configuration is present, a new one is created. The command can also be used to remove all email forward configuration entries for a domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'emailfwd.cfg.set'	Identifies the command type for email forward configuration modification.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which email forward configuration is to be set. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain which email forward configuration is to be set. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
fwd.<1-∞>.name	Optional	Character string, min. 0, max. 128 characters (full Unicode charset)	The name of this forward entry, i.e. the recipient for the forward. It may be left empty to indicate that this is the default forward for the domain (which is used if no specific matching entry is found). Note that it is allowed to have multiple enties with the same name for a domain, resulting in multiple forwarded mails for a mail that is sent to this name.
fwd.<1-∞>.destaddr	Optional	Character string, min. 1, max. 512 characters (full Unicode charset)	The destination e-mail address for this forward entry, i.e. the address where mails which recipient matches this forward entry should be sent to. This is marked optional because this command may lack any forward entries (to remove them completely from a domain), but the field must be present and non-empty for every specified forward.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'emailfwd.cfg.set'	Specifies the response type for email forward configuration modifications.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: emailfwd.cfg.set
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
fwd.1.name: hans
fwd.1.destaddr: hans@members.dokom.de

Response:

response.type: emailfwd.cfg.set
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: set email forwarding config from pending objects

Description:

set the email forwarding configuration for a domain's pending objects; the previous configuration is completely replaced by the one given in the pending objects (if any). If no previous configuration is present, a new one is created; if no pending objects are present, the email forwarding configuration is removed.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'emailfwd.cfg.set.pending'	Identifies the command type for email forward configuration modification from pending objects.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required

Response format:

Key	Value type/content	Description
response.type	Fixed: 'emailfwd.cfg.set.pending'	Specifies the response type for email forward configuration modifications from pending objects.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: emailfwd.cfg.set.pending
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias

Response:

response.type: emailfwd.cfg.set
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: set zone config

Description:

set the zone configuration for a domain; the previous records are completely replaced by the one given in the request. If no previous zone is present, a new one is created. The command can also be used to remove all zone configuration entries for a domain, by not specifying any resource records.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'zone.cfg.set'	Identifies the command type for setting a new zone configuration. All resource records in the zone are removed and replaced by the resource records specified in the request. If no resource records are specified, the zone is deleted entirely.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain whose zone configuration is to be modified. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain whose zone configuration is to be modified. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
rr.<1-∞>.type	Optional	Character string (ASCII subset)	The type of this resource record (RR).
rr.<1-∞>.subtype	Optional	One of: 'stdmail', 'stdmailvw', 'stdmailsf', 'stdmailvwsf', 'redir', 'bakmail', 'monetizing', 'mailbox'	The type of this resource record. Only valid for records of type 'SPECIAL'.
rr.<1-∞>.owner	Optional	Character string, min. 0, max. 512 characters (full Unicode charset)	The owner (subdomain) for this resource record.
rr.<1-∞>.class	Optional	One of: 'IN', 'CH' (default value: IN)	The network class for this resource record. May be omitted, defaults to the most common value. Not valid for records of type 'SPECIAL'.
rr.<1-∞>.ttl	Optional	Integer value (default value: 0)	The time to live setting for this resource record. Defaults to 0 which means 'no value'.
rr.<1-∞>.priority	Optional	Integer value (default value: 0)	The priority for this resource record (only significant to records of type 'MX' or 'SPECIAL'). Defaults to 0 which means 'no value'.
rr.<1-∞>.rdata	Optional	Character string, min. 1 characters (full Unicode charset)	The rdata string for this resource record (the semantics are record type specific). Not valid for records of type 'SPECIAL'.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'zone.cfg.set'	Specifies the response type for zone configuration modifications.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: zone.cfg.set
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
rr.1.type: MX
rr.1.subtype: redir
rr.1.owner: www
rr.1.class: IN
rr.1.ttl: 10000
rr.1.priority: 10
rr.1.rdata: super.duper.edu

Response:

response.type: zone.cfg.set
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: add records to zone config

Description:

add records to the zone configuration for a domain; previously present records are retained and augmented by the one given in the request.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'zone.cfg.add'	Identifies the command type for add new records to a zone configuration. All previous resource records in the zone are retained.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain whose zone configuration is to be modified. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain whose zone configuration is to be modified. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
rr.<1-∞>.type	Optional	Character string (ASCII subset)	The type of this resource record (RR).
rr.<1-∞>.subtype	Optional	One of: 'stdmail', 'stdmailvw', 'stdmailsf', 'stdmailvwsf', 'redir', 'bakmail', 'monetizing', 'mailbox'	The type of this resource record. Only valid for records of type 'SPECIAL'.
rr.<1-∞>.owner	Optional	Character string, min. 0, max. 512 characters (full Unicode charset)	The owner (subdomain) for this resource record.
rr.<1-∞>.class	Optional	One of: 'IN', 'CH' (default value: IN)	The network class for this resource record. May be omitted, defaults to the most common value. Not valid for records of type 'SPECIAL'.
rr.<1-∞>.ttl	Optional	Integer value (default value: 0)	The time to live setting for this resource record. Defaults to 0 which means 'no value'.
rr.<1-∞>.priority	Optional	Integer value (default value: 0)	The priority for this resource record (only significant to records of type 'MX' or 'SPECIAL'). Defaults to 0 which means 'no value'.
rr.<1-∞>.rdata	Optional	Character string, min. 1 characters (full Unicode charset)	The rdata string for this resource record (the semantics are record type specific). Not valid for records of type 'SPECIAL'.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'zone.cfg.add'	Specifies the response type for adding records to a zone configuration.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: zone.cfg.add
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
rr.1.type: MX
rr.1.subtype: redir
rr.1.owner: www
rr.1.class: IN
rr.1.ttl: 10000
rr.1.priority: 10
rr.1.rdata: super.duper.edu

Response:

response.type: zone.cfg.add
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: remove records from zone config

Description:

remove records from the zone configuration for a domain. The command can also be used to remove all zone configuration entries for a domain, by specifying all existing resource records for removal.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'zone.cfg.remove'	Identifies the command type for removing records from a zone configuration. Previous resource records in the zone are retained unless they are specified for removal in the command. If no records are left in the zone after execution, the zone is deleted entirely.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain whose zone configuration is to be modified. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain whose zone configuration is to be modified. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
rr.<1-∞>.type	Optional	Character string (ASCII subset)	The type of this resource record (RR).
rr.<1-∞>.subtype	Optional	One of: 'stdmail', 'stdmailvw', 'stdmailsf', 'stdmailvwsf', 'redir', 'bakmail', 'monetizing', 'mailbox'	The type of this resource record. Only valid for records of type 'SPECIAL'.
rr.<1-∞>.owner	Optional	Character string, min. 0, max. 512 characters (full Unicode charset)	The owner (subdomain) for this resource record.
rr.<1-∞>.class	Optional	One of: 'IN', 'CH' (default value: IN)	The network class for this resource record. May be omitted, defaults to the most common value. Not valid for records of type 'SPECIAL'.
rr.<1-∞>.ttl	Optional	Integer value (default value: 0)	The time to live setting for this resource record. Defaults to 0 which means 'no value'.
rr.<1-∞>.priority	Optional	Integer value (default value: 0)	The priority for this resource record (only significant to records of type 'MX' or 'SPECIAL'). Defaults to 0 which means 'no value'.
rr.<1-∞>.rdata	Optional	Character string, min. 1 characters (full Unicode charset)	The rdata string for this resource record (the semantics are record type specific). Not valid for records of type 'SPECIAL'.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'zone.cfg.remove'	Specifies the response type for removing records from a zone configuration.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: zone.cfg.remove
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
rr.1.type: MX
rr.1.subtype: redir
rr.1.owner: www
rr.1.class: IN
rr.1.ttl: 10000
rr.1.priority: 10
rr.1.rdata: super.duper.edu

Response:

response.type: zone.cfg.remove
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: set stealth server

Description:

set the stealth server (hidden primary DNS) for a domain; the previous setting is completely replaced by the one given in the request. If no previous stealth server is present, a new one is created. The command can also be used to remove the stealth server from a domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'stealth.set'	Identifies the command type for stealth server modification.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain which web forward configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
stealth.addr.value	Optional	Character string (ASCII subset)	The IP address of the stealth server. It this field is omitted, the stealth server is completely removed from the domain.
stealth.addr.type	Optional	One of: 'ipv4', 'ipv6' (default value: ipv4)	The type of the stealth server's IP address (IPV4 or IPV6).

Response format:

Key	Value type/content	Description
response.type	Fixed: 'stealth.set'	Specifies the response type for stealth server modifications.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: stealth.set
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
stealth.addr.value: 100.103.44.15
stealth.addr.type: ipv4

Response:

response.type: stealth.set
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: set mailbox config

Description:

set the mailbox configuration for a domain; the previous configuration is completely replaced by the one given in the request. If no previous configuration is present, a new one is created. The command can also be used to remove all mailbox configuration entries for a domain.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'mailbox.cfg.set'	Identifies the command type for mailbox configuration modification.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Optional	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain whose mailbox configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
domain.id	Optional	Character string (ASCII subset)	The registry-assigned id of the domain whose mailbox configuration is to be inquired. Either `domain.name`, `domain.id` or `domain.iid` has to be specified.
mailbox.price.tier	Required	Character string (ASCII subset)	Specifies the mailbox price tier selected for the domain. Depending on the tier, the number of supported mailboxes may be restricted.
mailbox.<1-∞>.name	Optional	Character string, min. 0, max. 255 characters (full Unicode charset)	The name of this entry, i.e. the local name of the mailbox within the domain.
mailbox.<1-∞>.fullname	Optional	Character string, min. 1, max. 255 characters (full Unicode charset)	The full name of the mailbox user.
mailbox.<1-∞>.password	Optional	Character string, min. 1, max. 64 characters (ASCII subset)	The password for accessing the mailbox. This field is required for new mailboxes and optional for existing mailboxes (if not specified, the password of the existing mailbox is not changed).

Response format:

Key	Value type/content	Description
response.type	Fixed: 'mailbox.cfg.set'	Specifies the response type for mailbox configuration modifications.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: mailbox.cfg.set
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
mailbox.price.tier: tier1
mailbox.1.name: hans
mailbox.1.fullname: Hans Mustermann
mailbox.1.password: topsecret

Response:

response.type: mailbox.cfg.set
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: request domain transfer

Description:

Request for the gaining customer to transfer a domain.

Registry Specific Notes:

cnnic, cnnic.idn:

This command is not supported.

nominet:

This command is not supported.

atnic:

For nic.at, a transfer may be performed with or without an authinfo. If an authinfo is available, it may be specified, and the transfer will be completed immediately if the authinfo is correct. As a legacy solution, a transfer may also be started without an authinfo; in this case, the registrant will have to confirm the transfer directly with the registry, after which the transfer will be completed asynchronously.

Request format:

Key Occurrence Value type/content Description

request.type

Required

Fixed: 'domain.transfer.request'

Identifies the command type for a domain transfer request.

payload.version

Required

Fixed: '2.0'

Version of the payload format used in the request.

transaction.atp

Required only for commands sent via e-mail, else optional

Character string (ASCII subset)

The 'any time' password (specified by the customer using the web interface) to be used for the transaction.

customer.id

Required

Integer value

Id of the requesting customer.

person.id

Required

Integer value

Id of the requesting person.

request.feedback

Optional

Boolean value ('true' or 'false') (default value: true)

transaction.id

Required

Character string (ASCII subset)

The customer's arbitrary internal transaction id.

agent.id

Optional

Character string (ASCII subset)

The id of the agent (client program) that created the order.

registry.id

Optional

Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)

Registry Specific Notes:

afilias:

This field is fully supported.

Fixed: 'afilias'

occurrence: Optional

neulevel:

This field is fully supported.

Fixed: 'neulevel'

occurrence: Required

gnr:

This field is fully supported.

Fixed: 'gnr'

occurrence: Required

verisign:

This field is fully supported.

Fixed: 'verisign'

occurrence: Required

neustar:

This field is fully supported.

Fixed: 'neustar'

occurrence: Required

pir:

This field is fully supported.

Fixed: 'pir'

occurrence: Required

dotaero:

This field is fully supported.

Fixed: 'dotaero'

occurrence: Required

dotmobi:

This field is fully supported.

Fixed: 'dotmobi'

occurrence: Required

inregistry:

This field is fully supported.

Fixed: 'inregistry'

occurrence: Required

dotasia:

This field is fully supported.

Fixed: 'dotasia'

occurrence: Required

domen:

This field is fully supported.

Fixed: 'domen'

occurrence: Required

telnic:

This field is fully supported.

Fixed: 'telnic'

occurrence: Required

switch:

This field is fully supported.

Fixed: 'switch'

occurrence: Required

iis:

This field is fully supported.

Fixed: 'iis'

occurrence: Required

itnic:

This field is fully supported.

Fixed: 'itnic'

occurrence: Required

icmregistry:

This field is fully supported.

Fixed: 'icmregistry'

occurrence: Required

dottv:

This field is fully supported.

Fixed: 'dottv'

occurrence: Required

domain.name

Required (only if alternative field 'domain.id' is not specified)

Character string, min. 1, max. 131 characters (full Unicode charset)

The name of the domain to transfer.

Registry Specific Notes:

verisign, pir:

This field is fully supported.

Character string, min. 1, max. 67 characters

domain.name.language

Optional

Language tag according to RFC 1766

This field defines the language context of the domain name to be transferred.

domain.comment

Optional

Character string, min. 1, max. 255 characters (full Unicode charset)

An arbitrary text stored as a comment for the domain.

domain.id

Required (only if alternative field 'domain.name' is not specified)

Character string (ASCII subset)

The registry-assigned id of the domain to transfer.

Registry Specific Notes:

afilias, neulevel:

This field is not supported.

domain.authinfo

Optional

Character string, min. 4, max. 89 characters (full Unicode charset)

The authorization information (pass phrase/password) associated with the domain.

Note:

EPP alternatively allows specifying the id (ROID) of any of the domain's contacts and its authorization information; however, this is not supported by some registries (e.g. Afilias).

Registry Specific Notes:

afilias:

This field is fully supported.

Character string, min. 6, max. 16 characters

occurrence: Required

neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, twnic, dottv:

This field is fully supported.

occurrence: Required

atnic:

occurrence: Optional

denic, eurid:

This field is fully supported.

domain.newauthinfo

Optional

Character string, min. 4, max. 89 characters (ASCII subset)

The new authorization information to be assigned to the domain after successful transfer.

Registry Specific Notes:

afilias:

This field is fully supported.

Character string, min. 6, max. 16 characters

occurrence: Required

neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, twnic, dottv:

This field is fully supported.

occurrence: Required

denic:

This field is fully supported.

domain.newauthinfo.expiration.date

Optional

This date specifies the expiration date of the authinfo. If omitted, the maximum possible duration is taken. If the date is in the past, the authinfo is ignored/cleared.

Registry Specific Notes:

denic:

This field is fully supported.

This field is not supported.

telnic.whois.type

Optional

One of:

'legal', 'natural'

Specifies whether the domain is held by a corporation or individual.

Registry Specific Notes:

telnic:

This field is fully supported.

This field is not supported.

telnic.whois.publish

Optional

Boolean value ('true' or 'false') (default value: true)

Specifies whether to publish social data to WHOIS for an individually owned domain.

Registry Specific Notes:

telnic:

This field is fully supported.

This field is not supported.

period.unit

Optional

One of:

'y', 'm'

(default value: y)

The unit of measurement for the object's period (years or months).

Registry Specific Notes:

Only year may be specified as the period unit.

period.value

Optional

Integer value, min. 1, max. 99

The object's actual registration period as a multiple of the unit.

ns.<1-∞>.name

Optional

Character string, min. 1, max. 132 characters (full Unicode charset)

Registry Specific Notes:

afilias:

The registry requires zero or 2 to 13 name servers.

neulevel, neustar, dottv:

Up to 13 name servers may be specified.

verisign, pir:

The registry requires 0 to 13 name servers

ns.<1-∞>.id

Optional

Character string (ASCII subset)

The id of a host to be associated with the domain (may be specified as an alternative to the host's name). The same registry specific restrictions apply as to the ns.#.name field

ns.<1-∞>.role

Optional

One of:

'none', 'primary'

(default value: none)

The role of this host concerning the domain; currently, only 'none' (no particular role) or 'primary' (the host is the primary name server for the domain) are supported.

ns.<1-∞>.address.<1-∞>.value

Optional

Character string, min. 3, max. 45 characters (ASCII subset)

The IP address of the host given in the specified format. Note that this field is only evaluated for generic registries using hosts as domain attributes.

ns.<1-∞>.address.<1-∞>.type

Optional

One of:

'ipv4', 'ipv6'

This field specifies the address type of the given name server. Note that this field is only evaluated for generic registries using hosts as domain attributes.

contact.<1-∞>.id

Optional

Character string, min. 1 characters (ASCII subset)

The id of a contact to be associated with the domain. A contact with this name must exists in the involved registry. The number and types of required contacts are registry specific.

Registry Specific Notes:

eurid:

The registry requires 1 to 5 onsite contacts and exactly one registrant contact.

switch:

The Switch registry requires exactly one tech and exactly one registrant contact. Billing and admin contacts are not supported; the billing contact for .ch/.li domains is always the registrar.

There must be exactly one registrant, admin, tech and billing contact specified.

contact.<1-∞>.type

Optional

One of:

'admin', 'billing', 'registrant', 'tech', 'zone', 'onsite', 'ced', 'opn', 'member', 'abuse', 'general'

The type of the corresponding contact. The number and types of required contacts are registry specific.

Registry Specific Notes:

eurid:

There must be exactly one registrant contact specified; an optional onsite contact may also be specified. Other contact types are not allowed.

dotasia:

There must be one ced contact specified and in use as one of the other contacts like registrant, billing, admin, tech. Contact type onsite is not allowed. Contact type opn is optional.

switch:

One of:

'registrant', 'tech'

Only registrant and tech contacts are supported by the Switch registry.

atnic:

As registrant contacts, only contacts marked as "privateperson" or "organisation" may be specified. "role" contacts are not permitted as registrants.

denic:

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, dotaero, dotmobi, inregistry, domen, telnic, iis, itnic, icmregistry, nominet, sidn, dottv:

There must be exactly one registrant, admin, tech and billing contact specified.

dnssec.sign

Optional

Boolean value ('true' or 'false')

dnssec.ds.<1-∞>.ds.keytag

Optional

Integer value, min. 0, max. 65535

The key tag assigned to the DS record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.alg

Optional

Integer value, min. 0, max. 255

The algorithm of the related DNSKEY record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digesttype

Optional

Integer value, min. 0, max. 255

The digest type used for the hash of the related DNSKEY record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digest.hex

Optional

Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)

The hexadecimal representation of the hash of the DNSKEY record. Must be specified unless the data is given in the Base64 notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digest.base64

Optional

Base64 encoded binary data according to RFC 4648

The Base64 representation of the hash of the DNSKEY record. Must be given unless the data is given in hexadecimal notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.maxsiglife

Optional

Integer value, min. 1

The maximum lifetime of the signature of the DS record. This is only a recommendation, the registry is not obliged to respect the value.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.flags

Optional

Integer value, min. 0, max. 65535

The "flags" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.protocol

Optional

Integer value, min. 0, max. 255

The "protocol" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.alg

Optional

Integer value, min. 0, max. 255

The "algorithm" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.pubkey.hex

Optional

Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)

The hexadecimal representation of the public key data. Must be specified unless the data is given in the Base64 notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.pubkey.base64

Optional

Base64 encoded binary data according to RFC 4648

The Base64 representation of the public key data. Must be given unless the data is given in hexadecimal notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.transfer.request'	Specifies the response type for a domain transfer request.
expiration.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The new expire date of the domain according to the registry.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.transfer.request
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.name.language: en-US
domain.comment: just a comment...
domain.id: domain1-ID
domain.authinfo: mySecret
domain.newauthinfo: mySecret-new
domain.newauthinfo.expiration.date: 2008-12-24T18:00:00.0Z
telnic.whois.type: natural
telnic.whois.publish: true
period.unit: y
period.value: 2
ns.1.name: ns1.domain.info
ns.1.id: host1-ID
ns.1.role: primary
ns.1.address.1.value: 123.145.167.212
ns.1.address.1.type: ipv4
contact.1.id: contact1-ID
contact.1.type: admin
dnssec.sign: false
dnssec.ds.1.ds.keytag: 38583
dnssec.ds.1.ds.alg: 3
dnssec.ds.1.ds.digesttype: 1
dnssec.ds.1.ds.digest.hex: 666F6F626172
dnssec.ds.1.ds.digest.base64: Zm9vYmFy
dnssec.ds.1.ds.maxsiglife: 1
dnssec.ds.1.key.flags: 256
dnssec.ds.1.key.protocol: 3
dnssec.ds.1.key.alg: 3
dnssec.ds.1.key.pubkey.hex: 666F6F626172
dnssec.ds.1.key.pubkey.base64: Zm9vYmFy

Response:

response.type: domain.transfer.request
expiration.date: 2005-05-17T22:00:00.0Z
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: request domain transfer + trade

Description:

Request for the gaining customer to transfer + trade a domain, i.e. initiate an incoming transfer with parallel registrant change.

Registry Specific Notes:

This command is not supported.

Request format:

Key Occurrence Value type/content Description

request.type

Required

Fixed: 'domain.transfertrade.request'

Identifies the command type for a domain transfer + trade request.

payload.version

Required

Fixed: '2.0'

Version of the payload format used in the request.

transaction.atp

Required only for commands sent via e-mail, else optional

Character string (ASCII subset)

The 'any time' password (specified by the customer using the web interface) to be used for the transaction.

customer.id

Required

Integer value

Id of the requesting customer.

person.id

Required

Integer value

Id of the requesting person.

request.feedback

Optional

Boolean value ('true' or 'false') (default value: true)

transaction.id

Required

Character string (ASCII subset)

The customer's arbitrary internal transaction id.

agent.id

Optional

Character string (ASCII subset)

The id of the agent (client program) that created the order.

registry.id

Optional

Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)

Registry Specific Notes:

afilias:

This field is fully supported.

Fixed: 'afilias'

occurrence: Optional

neulevel:

This field is fully supported.

Fixed: 'neulevel'

occurrence: Required

gnr:

This field is fully supported.

Fixed: 'gnr'

occurrence: Required

verisign:

This field is fully supported.

Fixed: 'verisign'

occurrence: Required

neustar:

This field is fully supported.

Fixed: 'neustar'

occurrence: Required

pir:

This field is fully supported.

Fixed: 'pir'

occurrence: Required

dotaero:

This field is fully supported.

Fixed: 'dotaero'

occurrence: Required

dotmobi:

This field is fully supported.

Fixed: 'dotmobi'

occurrence: Required

inregistry:

This field is fully supported.

Fixed: 'inregistry'

occurrence: Required

dotasia:

This field is fully supported.

Fixed: 'dotasia'

occurrence: Required

domen:

This field is fully supported.

Fixed: 'domen'

occurrence: Required

telnic:

This field is fully supported.

Fixed: 'telnic'

occurrence: Required

switch:

This field is fully supported.

Fixed: 'switch'

occurrence: Required

iis:

This field is fully supported.

Fixed: 'iis'

occurrence: Required

itnic:

This field is fully supported.

Fixed: 'itnic'

occurrence: Required

icmregistry:

This field is fully supported.

Fixed: 'icmregistry'

occurrence: Required

dottv:

This field is fully supported.

Fixed: 'dottv'

occurrence: Required

domain.name

Required

Character string, min. 1, max. 131 characters (full Unicode charset)

The name of the domain to transfer + trade.

domain.authinfo

Optional

Character string, min. 4, max. 89 characters (full Unicode charset)

The authorization information (pass phrase/password) associated with the domain.

Note:

EPP alternatively allows specifying the id (ROID) of any of the domain's contacts and its authorization information; however, this is not supported by some registries (e.g. Afilias).

Registry Specific Notes:

eurid:

This field is fully supported.

occurrence: Required

eurid:

This field is fully supported.

ns.<1-∞>.name

Optional

Character string, min. 1, max. 132 characters (full Unicode charset)

Registry Specific Notes:

afilias:

The registry requires zero or 2 to 13 name servers.

neulevel, neustar, dottv:

Up to 13 name servers may be specified.

verisign, pir:

The registry requires 0 to 13 name servers

ns.<1-∞>.id

Optional

Character string (ASCII subset)

The id of a host to be associated with the domain (may be specified as an alternative to the host's name). The same registry specific restrictions apply as to the ns.#.name field

ns.<1-∞>.role

Optional

One of:

'none', 'primary'

(default value: none)

The role of this host concerning the domain; currently, only 'none' (no particular role) or 'primary' (the host is the primary name server for the domain) are supported.

ns.<1-∞>.address.<1-∞>.value

Optional

Character string, min. 3, max. 45 characters (ASCII subset)

The IP address of the host given in the specified format. Note that this field is only evaluated for generic registries using hosts as domain attributes.

ns.<1-∞>.address.<1-∞>.type

Optional

One of:

'ipv4', 'ipv6'

This field specifies the address type of the given name server. Note that this field is only evaluated for generic registries using hosts as domain attributes.

contact.<1-∞>.id

Optional

Character string, min. 1 characters (ASCII subset)

The id of a contact to be associated with the domain. A contact with this name must exists in the involved registry. The number and types of required contacts are registry specific.

Registry Specific Notes:

eurid:

The registry requires 1 to 5 onsite contacts and exactly one registrant contact.

switch:

The Switch registry requires exactly one tech and exactly one registrant contact. Billing and admin contacts are not supported; the billing contact for .ch/.li domains is always the registrar.

There must be exactly one registrant, admin, tech and billing contact specified.

contact.<1-∞>.type

Optional

One of:

'admin', 'billing', 'registrant', 'tech', 'zone', 'onsite', 'ced', 'opn', 'member', 'abuse', 'general'

The type of the corresponding contact. The number and types of required contacts are registry specific.

Registry Specific Notes:

eurid:

There must be exactly one registrant contact specified; an optional onsite contact may also be specified. Other contact types are not allowed.

dotasia:

There must be one ced contact specified and in use as one of the other contacts like registrant, billing, admin, tech. Contact type onsite is not allowed. Contact type opn is optional.

switch:

One of:

'registrant', 'tech'

Only registrant and tech contacts are supported by the Switch registry.

atnic:

As registrant contacts, only contacts marked as "privateperson" or "organisation" may be specified. "role" contacts are not permitted as registrants.

denic:

afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, dotaero, dotmobi, inregistry, domen, telnic, iis, itnic, icmregistry, nominet, sidn, dottv:

There must be exactly one registrant, admin, tech and billing contact specified.

dnssec.sign

Optional

Boolean value ('true' or 'false')

dnssec.ds.<1-∞>.ds.keytag

Optional

Integer value, min. 0, max. 65535

The key tag assigned to the DS record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.alg

Optional

Integer value, min. 0, max. 255

The algorithm of the related DNSKEY record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digesttype

Optional

Integer value, min. 0, max. 255

The digest type used for the hash of the related DNSKEY record. The field is required for a DS entry.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digest.hex

Optional

Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)

The hexadecimal representation of the hash of the DNSKEY record. Must be specified unless the data is given in the Base64 notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.digest.base64

Optional

Base64 encoded binary data according to RFC 4648

The Base64 representation of the hash of the DNSKEY record. Must be given unless the data is given in hexadecimal notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.ds.maxsiglife

Optional

Integer value, min. 1

The maximum lifetime of the signature of the DS record. This is only a recommendation, the registry is not obliged to respect the value.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.flags

Optional

Integer value, min. 0, max. 65535

The "flags" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.protocol

Optional

Integer value, min. 0, max. 255

The "protocol" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.alg

Optional

Integer value, min. 0, max. 255

The "algorithm" value of the related DNSKEY record.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.pubkey.hex

Optional

Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)

The hexadecimal representation of the public key data. Must be specified unless the data is given in the Base64 notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

dnssec.ds.<1-∞>.key.pubkey.base64

Optional

Base64 encoded binary data according to RFC 4648

The Base64 representation of the public key data. Must be given unless the data is given in hexadecimal notation.

Registry Specific Notes:

denic, switch:

This field is fully supported.

This field is not supported.

period.unit

Optional

One of:

'y', 'm'

(default value: y)

The unit of measurement for the object's period (years or months).

Registry Specific Notes:

Only year may be specified as the period unit.

period.value

Required

Integer value, min. 1, max. 99

The object's actual registration period as a multiple of the unit.

Registry Specific Notes:

afilias, neulevel, neustar, dottv:

This field is fully supported.

Integer value, min. 1, max. 10

verisign, pir:

This field is fully supported.

Integer value, min. 1, max. 10

inregistry:

This field is fully supported.

Integer value, min. 1, max. 5

switch:

Fixed: '1'

Switch only allows 1-year registrations initially.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.transfertrade.request'	Specifies the response type for a domain transfer + trade request.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.transfertrade.request
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.eu
domain.authinfo: mySecret
ns.1.name: ns1.domain.info
ns.1.id: host1-ID
ns.1.role: primary
ns.1.address.1.value: 123.145.167.212
ns.1.address.1.type: ipv4
contact.1.id: contact1-ID
contact.1.type: admin
dnssec.sign: false
dnssec.ds.1.ds.keytag: 38583
dnssec.ds.1.ds.alg: 3
dnssec.ds.1.ds.digesttype: 1
dnssec.ds.1.ds.digest.hex: 666F6F626172
dnssec.ds.1.ds.digest.base64: Zm9vYmFy
dnssec.ds.1.ds.maxsiglife: 1
dnssec.ds.1.key.flags: 256
dnssec.ds.1.key.protocol: 3
dnssec.ds.1.key.alg: 3
dnssec.ds.1.key.pubkey.hex: 666F6F626172
dnssec.ds.1.key.pubkey.base64: Zm9vYmFy
period.unit: y
period.value: 2

Response:

response.type: domain.transfertrade.request
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: request domain trade

Description:

Request for the customer to trade a domain, i.e. initiate a registry-mediated registrant change for a domain he already owns.

Registry Specific Notes:

itnic:

This command is fully supported.

This command is not supported.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.trade.request'	Identifies the command type for a domain trade request.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.authinfo	Optional	Character string, min. 4, max. 89 characters (full Unicode charset)	The authorization information specified by the registrant (pass phrase/password).
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain to trade.
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain to trade.
ns.<1-∞>.name	Optional	Character string, min. 1, max. 132 characters (full Unicode charset)	The fully qualified name of a host (name server) to be associated with the domain. A host with this name must exists in the involved registry. The number of required name servers is registry specific. Registry Specific Notes: afilias: The registry requires zero or 2 to 13 name servers. neulevel, neustar, dottv: Up to 13 name servers may be specified. verisign, pir: The registry requires 0 to 13 name servers
ns.<1-∞>.id	Optional	Character string (ASCII subset)	The id of a host to be associated with the domain (may be specified as an alternative to the host's name). The same registry specific restrictions apply as to the `ns.#.name` field
ns.<1-∞>.role	Optional	One of: 'none', 'primary' (default value: none)	The role of this host concerning the domain; currently, only 'none' (no particular role) or 'primary' (the host is the primary name server for the domain) are supported.
ns.<1-∞>.address.<1-∞>.value	Optional	Character string, min. 3, max. 45 characters (ASCII subset)	The IP address of the host given in the specified format. Note that this field is only evaluated for generic registries using hosts as domain attributes.
ns.<1-∞>.address.<1-∞>.type	Optional	One of: 'ipv4', 'ipv6'	This field specifies the address type of the given name server. Note that this field is only evaluated for generic registries using hosts as domain attributes.
contact.<1-∞>.id	Optional	Character string, min. 1 characters (ASCII subset)	The id of a contact to be associated with the domain. A contact with this name must exists in the involved registry. The number and types of required contacts are registry specific. Registry Specific Notes: eurid: The registry requires 1 to 5 onsite contacts and exactly one registrant contact. switch: The Switch registry requires exactly one tech and exactly one registrant contact. Billing and admin contacts are not supported; the billing contact for .ch/.li domains is always the registrar. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: There must be exactly one registrant, admin, tech and billing contact specified.
contact.<1-∞>.type	Optional	One of: 'admin', 'billing', 'registrant', 'tech', 'zone', 'onsite', 'ced', 'opn', 'member', 'abuse', 'general'	The type of the corresponding contact. The number and types of required contacts are registry specific. Registry Specific Notes: eurid: There must be exactly one registrant contact specified; an optional onsite contact may also be specified. Other contact types are not allowed. dotasia: There must be one ced contact specified and in use as one of the other contacts like registrant, billing, admin, tech. Contact type onsite is not allowed. Contact type opn is optional. switch: One of: 'registrant', 'tech' Only registrant and tech contacts are supported by the Switch registry. atnic: As registrant contacts, only contacts marked as "privateperson" or "organisation" may be specified. "role" contacts are not permitted as registrants. denic: Admin, tech and zone contacts are no longer supported by DENIC. While they are accepted by the system, they are no longer submitted to DENIC. Abuse and general contacts may be added, but are not required. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, dotaero, dotmobi, inregistry, domen, telnic, iis, itnic, icmregistry, nominet, sidn, dottv: There must be exactly one registrant, admin, tech and billing contact specified.
dnssec.sign	Optional	Boolean value ('true' or 'false')	Flag whether DRS shall automatically sign the zone and publish it on its name servers. Note that in this case the DNSSEC key data for the registry is automatically maintained. The DNSSEC key data specified in this request may be overwritten by the system at a later point in time.
dnssec.ds.<1-∞>.ds.keytag	Optional	Integer value, min. 0, max. 65535	The key tag assigned to the DS record. The field is required for a DS entry. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.alg	Optional	Integer value, min. 0, max. 255	The algorithm of the related DNSKEY record. The field is required for a DS entry. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.digesttype	Optional	Integer value, min. 0, max. 255	The digest type used for the hash of the related DNSKEY record. The field is required for a DS entry. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.digest.hex	Optional	Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)	The hexadecimal representation of the hash of the DNSKEY record. Must be specified unless the data is given in the Base64 notation. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.digest.base64	Optional	Base64 encoded binary data according to RFC 4648	The Base64 representation of the hash of the DNSKEY record. Must be given unless the data is given in hexadecimal notation. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.ds.maxsiglife	Optional	Integer value, min. 1	The maximum lifetime of the signature of the DS record. This is only a recommendation, the registry is not obliged to respect the value. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.flags	Optional	Integer value, min. 0, max. 65535	The "flags" value of the related DNSKEY record. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.protocol	Optional	Integer value, min. 0, max. 255	The "protocol" value of the related DNSKEY record. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.alg	Optional	Integer value, min. 0, max. 255	The "algorithm" value of the related DNSKEY record. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.pubkey.hex	Optional	Hexadecimal encoded binary data (see also Base16 encoding in RFC 4648)	The hexadecimal representation of the public key data. Must be specified unless the data is given in the Base64 notation. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.
dnssec.ds.<1-∞>.key.pubkey.base64	Optional	Base64 encoded binary data according to RFC 4648	The Base64 representation of the public key data. Must be given unless the data is given in hexadecimal notation. Registry Specific Notes: denic, switch: This field is fully supported. afilias, neulevel, gnr, verisign, neustar, dotcoop, cnnic, cnnic.idn, pir, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, iis, itnic, icmregistry, atnic, nominet, sidn, dottv: This field is not supported.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.trade.request'	Specifies the response type for a domain trade request.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.trade.request
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.authinfo: mySecret
domain.name: acme.eu
domain.id: domain1-ID
ns.1.name: ns1.domain.info
ns.1.id: host1-ID
ns.1.role: primary
ns.1.address.1.value: 123.145.167.212
ns.1.address.1.type: ipv4
contact.1.id: contact1-ID
contact.1.type: admin
dnssec.sign: false
dnssec.ds.1.ds.keytag: 38583
dnssec.ds.1.ds.alg: 3
dnssec.ds.1.ds.digesttype: 1
dnssec.ds.1.ds.digest.hex: 666F6F626172
dnssec.ds.1.ds.digest.base64: Zm9vYmFy
dnssec.ds.1.ds.maxsiglife: 1
dnssec.ds.1.key.flags: 256
dnssec.ds.1.key.protocol: 3
dnssec.ds.1.key.alg: 3
dnssec.ds.1.key.pubkey.hex: 666F6F626172
dnssec.ds.1.key.pubkey.base64: Zm9vYmFy

Response:

response.type: domain.trade.request
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: cancel domain transfer

Description:

Cancel a previously started transfer of a domain.

Registry Specific Notes:

cnnic, cnnic.idn:

This command is not supported.

nominet:

This command is not supported.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.transfer.cancel'	Identifies the command type for a domain transfer cancellation.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain for which the transfer should be cancelled. Registry Specific Notes: verisign, pir: This field is fully supported. Character string, min. 1, max. 67 characters
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain for which the transfer should be cancelled.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.transfer.cancel'	Specifies the response type for a domain transfer cancellation.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.transfer.cancel
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID

Response:

response.type: domain.transfer.cancel
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: reply domain transfer

Description:

Approve or reject the transfer of a domain (request for the losing customer).

Registry Specific Notes:

cnnic, cnnic.idn:

This command is not supported.

nominet:

This command is not supported.

atnic:

This command is not supported.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.transfer.reply'	Identifies the command type for a domain transfer reply.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain for which the transfer should be replied. Registry Specific Notes: verisign, pir: This field is fully supported. Character string, min. 1, max. 67 characters
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain for which the transfer should be replied.
transfer.reply	Required	One of: 'approve', 'reject'	Specifies whether the reply approves or rejects the transfer.
transfer.reply.reason	Optional	One of: 'fraud', 'udrpaction', 'courtorder', 'identity', 'payment', 'objection', 'lock', 'creationdate', 'transferdate'	If the customer rejects the transfer, this field is required and must contain one of the following tokens to specify a denial reason allowed by ICANN: `fraud`: Evidence of fraud `udrpaction`: UDRP action `courtorder`: Court order by a court of competent jurisdiction `identity`: Reasonable dispute over the identity of the Registered Name Holder or Administrative Contact `payment`: No payment for previous registration period (including credit card charge-backs) if the domain/e-mail address is past its expiration date or for previous or current registration periods if the domain/e-mail address has not yet expired. In all such cases, however, the domain/e-mail address must be put into 'Registrar Hold' status by the Registrar of Record prior to the denial of transfer. `objection`: Express written objection to the transfer from the Transfer Contact. (e.g. - email, fax, paper document or other processes by which the Transfer Contact has expressly and voluntarily objected through opt-in means) `lock`: A domain/e-mail address was already in 'lock status' provided that the Registrar provides a readily accessible and reasonable means for the Registered Name Holder to remove the lock status. `creationdate`: A domain/e-mail address is in the first 60 days of an initial registration period. `transferdate`: A domain/e-mail address is within 60 days (or a lesser period to be determined) after being transferred (apart from being transferred back to the original Registrar in cases where both Registrars so agree and/or where a decision in the dispute resolution process so directs). Registry Specific Notes: afilias, neulevel, gnr, verisign, dotcoop, pir, dottv: If the command is used to reject the transfer, the specification of this field is required. neustar, cnnic, cnnic.idn, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn: This field is not supported.
transfer.reply.comment	Optional	Character string (full Unicode charset)	If the customer rejects the transfer, this field may be used to add a free text comment explaining the denial.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.transfer.reply'	Specifies the response type for a domain transfer reply.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.transfer.reply
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
transfer.reply: approve
transfer.reply.reason: fraud
transfer.reply.comment: Authinfo obtained by hack.

Response:

response.type: domain.transfer.reply
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: create a forestalled domain transfer decision

Description:

Prepare the forthcoming outgoing transfer of a domain by creating a forestalled transfer decision for it; if such a decision is present for a domain, any outgoing transfer requests for the domain are immediately approved or rejected, depending on the decision's properties. All decisions that may already exist for the domain are replaced by the newly created one.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.transfer.decision.create'	Identifies the command type for creating forestalled domain transfer decisions.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which transfer is to be prepared. Registry Specific Notes: verisign, pir: This field is fully supported. Character string, min. 1, max. 67 characters
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain which transfer is to be prepared.
transfer.decision.validuntil	Optional	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	An optional date to denote a time limit for the validity of the decision; any outgoing transfer requests for the domain after this date are processed normally and are not affected by the forestalled decision.
transfer.registrar.gaining	Optional	Character string (ASCII subset)	An optional string denoting the valid gaining registrar for the transfer. If present, only requests by this registrar are affected by the decision. Note that this field is not yet supported by the DRS, since the gaining registrar can not be determined for an outgoing transfer in all cases.
transfer.approve	Required	Boolean value ('true' or 'false')	If set to `true`, any transfer matching the conditions of the decision is immediately approved. If `false`, the matching transfer is immediately rejected.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.transfer.decision.create'	Specifies the response type for creating forestalled domain transfer decisions.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.transfer.decision.create
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
transfer.decision.validuntil: 2003-05-17T22:00:00.0Z
transfer.registrar.gaining: NSI
transfer.approve: true

Response:

response.type: domain.transfer.decision.create
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: delete a forestalled domain transfer decision

Description:

Delete any forestalled transfer decisions for the given domain. Afterwards, any outgoing transfer requests for the domain are processed normally. The command does not yield an error if no decisions for the domain exist.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.transfer.decision.delete'	Identifies the command type for deleting forestalled domain transfer decisions.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain which transfer decision is to be removed Registry Specific Notes: verisign, pir: This field is fully supported. Character string, min. 1, max. 67 characters
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned id of the domain which transfer decision is to be removed

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.transfer.decision.delete'	Specifies the response type for deleting forestalled domain transfer decisions.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.transfer.decision.delete
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID

Response:

response.type: domain.transfer.decision.delete
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324

Table of contents

Command type: modify domain status

Description:

Modify the status of a domain object. Please note that the use of this request may require corresponding privileges.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'domain.status.modify'	Identifies the command type for modifying the state(s) of a registered domain
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
domain.name	Required (only if alternative field 'domain.id' is not specified)	Character string, min. 1, max. 131 characters (full Unicode charset)	The name of the domain to modify.
domain.id	Required (only if alternative field 'domain.name' is not specified)	Character string (ASCII subset)	The registry-assigned ID of the domain to modify.
domain.status.remove	Optional	Character string (ASCII subset)	Comma separated list of states that should be removed from the object. Only those states may be removed which the user is allowed to. The attempt to remove other states will result in an error. If a single asterisk is specified instead of the list, all states that are accessible by the user are removed.
domain.status.add	Optional	Character string (ASCII subset)	Comma separated list of states that should be added to the object. Only those states may be added which the user is allowed to. The attempt to add other states will result in an error. Adding a state that already exists will not cause the creation of a duplicate, but will reset associated dates (e.g. a timed on-hold state).

Response format:

Key	Value type/content	Description
response.type	Fixed: 'domain.status.modify'	Specifies the response type for the domain status modify request.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
registry.transaction.id	Character string (ASCII subset)	The transaction id assigned by the registry.
domain.status	Character string (ASCII subset)	A comma-separated list of status values for the domain. Refer to the status value specification below for a list of valid status values.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: domain.status.modify
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
domain.name: acme.info
domain.id: domain1-ID
domain.status.remove: hold
domain.status.add: lock

Response:

response.type: domain.status.modify
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
registry.transaction.id: tr493324
domain.status: lock

Table of contents

Command type: poll request

Description:

Retrieve service messages queued by the server (especially about pending transfer requests). The poll request command either retrieves a specific message or, if no message ID is specified, the oldest unread message. If the corresponding option is set, the message is automatically marked as read. Alternatively, this can be accomplished by the poll acknowledge command.

The details about the specific messages are described in the Messages section.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'poll.request'	Identifies the command type for poll requests.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
msg.id	Optional	Integer value, min. 1	Specifies the ID of the requested message. If this field is omitted, the oldest unread message is returned.
msg.autoack	Optional	Boolean value ('true' or 'false') (default value: false)	If set to `true`, the message is automatically marked as "read". If `false`, the message must be set to "read" by an additional "poll acknowledge" request.

Response format:

Key

Value type/content

Description

response.type

Fixed: 'poll.request'

Specifies the poll response type.

payload.version

Fixed: '2.0'

Version of the payload format used in the response.

result.code

Integer value

The overall numeric result code of the command.

result.msg

Character string (ASCII subset)

The overall result of the command in human-readable form.

transaction.id

Character string (ASCII subset)

The transaction id specified in the request.

result.<1-∞>.code

Integer value

Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.

result.<1-∞>.msg

Character string (ASCII subset)

The specific result of the command in human-readable form.

result.<1-∞>.error.<1-∞>

Character string (ASCII subset)

The field value from the request which caused the corresponding result.

result.<1-∞>.key.<1-∞>

Character string (ASCII subset)

The field (key) from the request which caused the corresponding result.

msg.id

Character string (ASCII subset)

The id of the server message returned during this poll. This id must be specified in the poll acknowledge command (see below) to mark this message as read.

msg.created

The point in time when the message has been created, i.e. queued in the message queue.

Note:

The messages in the queue are not necessarily sorted by this date (i.e. with increasing ID), as they are created before being queued. Nevertheless they appear in a nearly chronological order.

msg.originated

The point in time when the event that originated the message happened. This may either be the date of the original asynchrous order (the result of which is reported by this message), or the date of the original poll message (received from the registry) that corresponds to this message.

msg.state.id

Integer value

If this poll message is associated with an internal state machine process, this field is present and denotes the ID of that process.

msg.type

Character string (ASCII subset)

The type of the message returned during this poll. See the messages section for details about a specific message.

msg.transaction.id

Character string (ASCII subset)

The (client) transaction ID of the original asynchrous order (the result of which is reported by this message). If the message is not related to an asynchronous order, this field will not be present.

msg.server.transaction.id

Character string (ASCII subset)

The (server) transaction ID of the original asynchrous order (the result of which is reported by this message). If the message is not related to an asynchronous order, this field will not be present.

msg.count

Integer value

The total number of unread messages. Note that this count may be higher than the actual amount if messages are not polled in a strictly sequential manner.

Example:

Request:

request.type: poll.request
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
msg.id: 17
msg.autoack: false

Response:

response.type: poll.request
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
msg.id: 12345
msg.created: 2002-04-08T12:57:02.0Z
msg.originated: 2002-04-08T12:52:02.0Z
msg.state.id: 123
msg.type: transfer.end
msg.transaction.id: my-txn-id1
msg.server.transaction.id: srv-txn-id1
msg.count: 3

Table of contents

Command type: poll acknowledge

Description:

Confirm that a message has been received via a previous poll request command. It makes the server to mark the message as read.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'poll.acknowledge'	Identifies the command type for poll acknowledgement.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
msg.id	Required	Integer value, min. 1	The id of the server message to be acknowledged.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'poll.acknowledge'	Specifies the poll acknowledgement response type.
msg.unread.id	Integer value	The field contains the id of the first (oldest) unread message available (without the message just acknowledged). If all messages have been read, zero is returned instead.
msg.count	Integer value	The total number of unread messages. Note that this count may be higher than the actual amount if messages are not polled in a strictly sequential manner.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: poll.acknowledge
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
msg.id: 12345

Response:

response.type: poll.acknowledge
msg.unread.id: 26
msg.count: 3
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432

Table of contents

Command type: poll status

Description:

Returns information about the messages stored in the system, such as the total number of messages stored or the id of the oldest message.

Request format:

Key

Occurrence

Value type/content

Description

request.type

Required

Fixed: 'poll.status'

Identifies the command type for poll status.

payload.version

Required

Fixed: '2.0'

Version of the payload format used in the request.

transaction.atp

Required only for commands sent via e-mail, else optional

Character string (ASCII subset)

The 'any time' password (specified by the customer using the web interface) to be used for the transaction.

customer.id

Required

Integer value

Id of the requesting customer.

person.id

Required

Integer value

Id of the requesting person.

request.feedback

Optional

Boolean value ('true' or 'false') (default value: true)

transaction.id

Required

Character string (ASCII subset)

The customer's arbitrary internal transaction id.

agent.id

Optional

Character string (ASCII subset)

The id of the agent (client program) that created the order.

msg.before

Optional

Specifies the upper time boundary for messages investigated by this command. If omitted, no upper boundary will be used.

Note:

As there is no direct relation between the creation date of the messages and their order in the queue, it may happen that the resulting range contains messages with a creation date later than the specified date.

msg.after

Optional

Specifies the lower time boundary for messages investigated by this command. If omitted, no lower boundary will be used.

Note:

As there is no direct relation between the creation date of the messages and their order in the queue, it may happen that the resulting range contains messages with a creation date earlier than the specified date.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'poll.acknowledge'	Specifies the poll acknowledgement response type.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.
msg.first.id	Integer value	The field contains the id of the first (oldest) message available (in the given boundary, if specified). If there are no messages at all, zero is returned instead.
msg.unread.id	Integer value	The field contains the id of the first (oldest) unread message available (in the given boundary, if specified). If all messages have been read, zero is returned instead.
msg.last.id	Integer value	The field contains the id of the last (newest) message available (in the given boundary, if specified). If there are no messages at all, zero is returned instead.
result.<1-∞>.code	Integer value	Numeric code of a specific result of the command (one command may have more than one result). Only present in case of command failure.
result.<1-∞>.msg	Character string (ASCII subset)	The specific result of the command in human-readable form.
result.<1-∞>.error.<1-∞>	Character string (ASCII subset)	The field value from the request which caused the corresponding result.
result.<1-∞>.key.<1-∞>	Character string (ASCII subset)	The field (key) from the request which caused the corresponding result.

Example:

Request:

request.type: poll.status
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
msg.before: 2002-03-01T12:00:00.0Z
msg.after: 2002-03-31T12:00:00.0Z

Response:

response.type: poll.acknowledge
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432
msg.first.id: 23
msg.unread.id: 26
msg.last.id: 39

Table of contents

Command type: start e-mail verification

Description:

Start the verification of an e-mail address by sending a confirmation link to the address.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'email.verification.start'	Identifies the "start e-mail verification" command type.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
email.address	Required	Character string representing a valid e-mail address, min. 1, max. 132 characters	The e-mail address to which the verification e-mail shall be sent.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'email.verification.start'	Specifies the "start e-mail verification" response type. If the response's result code indicates success, the e-mails were successfully scheduled to be sent; note that this does not mean that they were successfully delivered to the recipient(s).
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.

Example:

Request:

request.type: email.verification.start
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
email.address: jdoe@acmesolutions.info

Response:

response.type: email.verification.start
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432

Table of contents

Command type: inquire an e-mail address's verification status

Description:

Determine the verification status of an e-mail address. address.

Request format:

Key	Occurrence	Value type/content	Description
request.type	Required	Fixed: 'email.verification.inquire'	Identifies the "inquire e-mail verification" command type.
payload.version	Required	Fixed: '2.0'	Version of the payload format used in the request.
transaction.atp	Required only for commands sent via e-mail, else optional	Character string (ASCII subset)	The 'any time' password (specified by the customer using the web interface) to be used for the transaction.
customer.id	Required	Integer value	Id of the requesting customer.
person.id	Required	Integer value	Id of the requesting person.
request.feedback	Optional	Boolean value ('true' or 'false') (default value: true)	If true, feedback concerning the successful completion of the request is sent to the customer, typically via e-mail. If false, no such notification is sent. If the field is not supplied, true is assumed. This field can be used to suppress customer feedback if need be.
transaction.id	Required	Character string (ASCII subset)	The customer's arbitrary internal transaction id.
agent.id	Optional	Character string (ASCII subset)	The id of the agent (client program) that created the order.
registry.id	Optional	Character string, pattern (regular expression): '^.?[a-z][a-z0-9._-]+$' (ASCII subset) (default value: afilias)	The identifier of the involved registry. May be a static identifier (like "afilias"), a configured generic identifier supported by GatewayNG (like "donuts") or any supported top-level domain, prefixed by a dot (like ".com" or ".de"). Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' occurrence: Optional neulevel: This field is fully supported. Fixed: 'neulevel' occurrence: Required gnr: This field is fully supported. Fixed: 'gnr' occurrence: Required verisign: This field is fully supported. Fixed: 'verisign' occurrence: Required neustar: This field is fully supported. Fixed: 'neustar' occurrence: Required pir: This field is fully supported. Fixed: 'pir' occurrence: Required dotaero: This field is fully supported. Fixed: 'dotaero' occurrence: Required dotmobi: This field is fully supported. Fixed: 'dotmobi' occurrence: Required inregistry: This field is fully supported. Fixed: 'inregistry' occurrence: Required dotasia: This field is fully supported. Fixed: 'dotasia' occurrence: Required domen: This field is fully supported. Fixed: 'domen' occurrence: Required telnic: This field is fully supported. Fixed: 'telnic' occurrence: Required switch: This field is fully supported. Fixed: 'switch' occurrence: Required iis: This field is fully supported. Fixed: 'iis' occurrence: Required itnic: This field is fully supported. Fixed: 'itnic' occurrence: Required icmregistry: This field is fully supported. Fixed: 'icmregistry' occurrence: Required dottv: This field is fully supported. Fixed: 'dottv' occurrence: Required
email.address	Required	Character string representing a valid e-mail address, min. 1, max. 132 characters	The e-mail address for which the verification status shall be inquired.

Response format:

Key	Value type/content	Description
response.type	Fixed: 'email.verification.inquire'	Specifies the "inquire e-mail verification" response type.
email.verification.status	One of: 'unknown', 'verified', 'unverified'	The (WAP) verification status of the specified e-mail address.
email.address	Character string representing a valid e-mail address	The e-mail address.
email.verification.email.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The date and time at which the most recent verification e-mail has been sent to the address. This field is not present if the status of the e-mail address is "verified", or if no verification e-mails have been sent yet.
payload.version	Fixed: '2.0'	Version of the payload format used in the response.
result.code	Integer value	The overall numeric result code of the command.
result.msg	Character string (ASCII subset)	The overall result of the command in human-readable form.
transaction.id	Character string (ASCII subset)	The transaction id specified in the request.

Example:

Request:

request.type: email.verification.inquire
payload.version: 2.0
transaction.atp: tOpSecrEt32
customer.id: 123
person.id: 456
request.feedback: true
transaction.id: mytrans-35432
agent.id: my_cool_srsio_script.pl v0.01
registry.id: afilias
email.address: jdoe@acmesolutions.info

Response:

response.type: email.verification.inquire
email.verification.status: unknown
email.address: joe@acmesolutions.net
email.verification.email.date: 2017-05-18T22:00:00.0Z
payload.version: 2.0
result.code: 10000
result.msg: Command completed successfully
transaction.id: mytrans-35432

Table of contents

Result codes

Code	Message	Description
10000	Command completed successfully	This is the nominal response code for a successfully completed command.
10100	Command initiated	The command has been started, but requires a longer time to process. After completion, an e-mail message will be sent.
13000	Command completed successfully; no messages	This response code is returned if responding to a poll command and the server message queue is empty.
13001	Command completed successfully; ack to dequeue	This response code is returned if responding to a poll command and a message has been retrieved from the server message queue.
13100	Command completed successfully; premium object detected	This response code is returned in case of a successfully completed command in which a "premium" object was involved, e.g. upon inquiry of a .mobi premium name.
13101	Command completed successfully; object transferred	This response code is returned in the case that a domain transfer request did not trigger the transfer process, but actually completed it successfully.
20000	Unknown command	This response code is returned if the server receives an unknown command.
20001	Command syntax error	This response code is returned if the server receives an improperly formed command.
20002	Command use error	This response code is returned if the server receives a properly formed command, but the command can not be executed due to a sequencing or context error. For example, a poll acknowledge command can not be executed without having first issued a poll request command.
20003	Required parameter missing	This response code is returned if the server receives a command for which a required field has not been provided.
20004	Parameter value range error	This response code is returned if the server receives a command parameter whose value is outside the range of values specified by the protocol.
20005	Parameter value syntax error	This response code is returned if the server receives a command containing a parameter whose value is improperly formed.
20101	Payload specification violation	This response code is returned if the server receives a command which violates the payload specification. Check the subresults for details.
20102	Field invalid	This response code is returned if the server receives a command containing a field which is either unknown or misplaced, i.e. not valid for the given command type.
20103	Illegal whitespace	This response code is returned if a field contains whitespace at the end of the line, which is a violation of the payload specification.
20104	Command not executed	The subrequest has not been executed.
20105	Command executed partially	This code is returned in the case that at least one of the subrequests had an error or was not executed at all.
21000	Unimplemented protocol version	This response code is be returned if the server receives a command specifying a protocol/payload version that is not implemented by the server.
21001	Unimplemented command	This response code is returned if the server receives a valid command that is not implemented by the server.
21004	Billing failure	This response code is returned if the server attempts to execute a billable operation and the command can not be completed due to a client billing failure.
21101	Registry unsupported	This response code is returned if a client attempts to access a registry that is not (or not yet) supported by the server.
21006	Object is not eligible for transfer	This response code is be returned when a client attempts to transfer an object that is not eligible for transfer in accordance with server policy, e.g. an object that is already owned by the client.
21102	Insufficient funds	This response code is returned if the server attempts to execute a billable operation and the command can not be completed due to the Knipp's insufficient funds at the backend registry.
22000	Authentication error	This response code is returned if the server notes an error while validating client credentials (e.g., a one time password or a PGP signature).
22001	Authorization error	This response code is returned if the server notes a client authorization error while executing a command. This error is used to note that a client lacks privileges to execute the requested command.
22002	Invalid authorization information	This response code is returned if the server receives invalid command authorization information required to confirm authorization to execute a command. This error is used to note that a client has the privileges required to execute the requested command, but the authorization information provided by the client does not match the authorization information archived by the server.
23000	Object pending transfer	This response code is returned if the server receives a command to transfer an object that is pending transfer due to an earlier transfer request.
23001	Object not pending transfer	This response code is returned if the server receives a command to confirm, reject, or cancel the transfer an object and no command has been made to transfer the object.
23002	Object exists	This response code is returned if the server receives a command to create an object that already exists in the repository.
23102	Object exists as premium name	This response code is returned if the server receives a command to create an object that already exists in the repository and/or is reserved as a premium name. Special measures will be required to create the object.
23003	Object does not exist	This response code is returned if the server receives a command to query or transform an object that does not exist in the repository.
23004	Object status prohibits operation	This response code is returned if the server receives a command to transform an object that cannot be completed due to server policy or business practices.
23005	Object association prohibits operation	This response code is returned if the server receives a command to transform an object that can not be completed due to dependencies on other objects that are associated with the target object. For example, a server may disallow delete commands while an object has active associations with other objects.
23006	Parameter value policy error	This response code is returned if the server receives a command containing a parameter value that is syntactically valid, but semantically invalid due to local policy.
23007	Unimplemented object service	This response code is returned if the server receives a command to operate on an object service that is not supported by the server.
23008	Data management policy violation	This response code is returned if a server receives a command whose execution results in a violation of server data management policies. For example, removing all attribute values or object associations from an object may be a violation of the server's data management policies.
23100	Object busy, operation may interfere	The object in question is involved in another operation. The requested operation could interfere with it. The request should be reissued after completion.
23101	Operation interrupted by requestor	The operation has been interrupted on external request, typically by user interaction.
23103	Transaction id not found	This response code is returned if the transaction id given in a status command is unknown to the server, i.e. cannot be associated with a previously submitted command.
23104	Transaction id ambiguous	This response code is returned if the transaction id given in a status command is ambiguous, i.e. it was used in more than one previously submitted command.
23105	Command unprocessed	This response code is returned if the command specified by the transaction id given in a status command has not yet been processed by the server.
23106	Object name ambiguous	This response code is returned if the name of an object given in a request is ambiguous, i.e. multiple objects with the same name exist. In this case, use the unique object id instead.
23107	Campaign policy violation	This response code is returned if a server receives a command whose execution results in a violation of the rules imposed by any currently running special advertising campaign. For instance, a (free) 1-year registration of a .info domain is only allowed if the registration is done during the corresponding special campaign; the used registrant handle may only be used in 25 domains for this purpose. If any of these rules is violated, this error message is returned.
23110	Invalid name server setup	It was attempted to perform a domain create or modify request with the specified name servers not being set up correctly (lame delegation etc.).
23112	Disallowed registrant change	The registrant contact that has been specified in the transfer request contains a different name than the registrant that is currently associated with the domain. The registry regards this as an attempt to change the registrant, which is disallowed during the transfer of a domain.
23113	Disallowed due to dispute	An attempt has been made to alter a domain or the associated registrant contact, while the domain is under dispute. This is disallowed.
23114	Object pending trade	This response code is returned if the server receives a command to trade an object that is pending trade due to an earlier trade request.
23115	Trade has been rejected	This response code is returned if the trade of an object has been rejected.
23116	Domain has not been delegated	This response is returned if the registration has been accepted, but the domain has not been delegated (i.e. added to the zone) due to name server configuration problems.
23117	Status invalid	This response code is returned if the server receives a command to assign an invalid status value to an object.
23118	Status values not supported	This response code is returned if the server receives a command to assign a status value to an object which doesn't support status values.
24000	Command failed	This response code is returned if the server is unable to execute a command due to an internal server error that is not related to the protocol. The failure may be transient.
24101	Registry unreachable	This response code is returned if the server of a registry involved in processing a command is unreachable or not responding.
24102	Registry communication error	This response code is returned if an error occurs durung a running communication with the server of the involved registry.
25000	Command failed; server ending session	This response code is returned if the server receives a command that can not be completed due to an internal server error that is not related to the protocol. The failure is not transient, and will cause other commands to fail as well.
25001	Timeout; server ending session	This response code is returned if the server receives a command that can not be completed due to a connection-oriented timeout.
25002	Session limit exceeded; server closing connection	This response code is returned if the server receives a command, and the command can not be completed because the client has exceeded a system-defined limit on the number of sessions/connections that the client can establish. It may be possible to establish a session by ending existing unused sessions/connections.
25100	Server shutting down, closing connection	This response is returned if the server is in the process of shutting down for maintenance purposes.

Messages

Table of contents

Command type: start transfer

Description:

This message notifies about the start of a domain transfer, i.e. another registrar or customer has requested a domain transfer.

Response format (in addition to the fields returned by the poll command itself):

Key	Value type/content	Description
msg.type	Fixed: 'transfer.start'	The type of the message returned.
msg.registry.id	One of: 'afilias', 'neulevel', 'dottv', 'gnr', 'verisign', 'neustar', 'dotcoop', 'cnnic', 'cnnic.idn', 'pir', 'twnic', 'dotmobi', 'inregistry', 'dotasia', 'domen', 'telnic', 'switch', 'iis', 'icmregistry'	The id of the registry which is concerned by the message returned during this poll, e.g. the registry a transferred domain is associated with. Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' neulevel: This field is fully supported. Fixed: 'neulevel' gnr: This field is fully supported. Fixed: 'gnr' verisign: This field is fully supported. Fixed: 'verisign' neustar: This field is fully supported. Fixed: 'neustar' pir: This field is fully supported. Fixed: 'pir' dotmobi: This field is fully supported. Fixed: 'dotmobi' inregistry: This field is fully supported. Fixed: 'inregistry' dotasia: This field is fully supported. Fixed: 'dotasia' domen: This field is fully supported. Fixed: 'domen' telnic: This field is fully supported. Fixed: 'telnic' switch: This field is fully supported. Fixed: 'switch' iis: This field is fully supported. Fixed: 'iis' icmregistry: This field is fully supported. Fixed: 'icmregistry' dottv: This field is fully supported. Fixed: 'dottv'
msg.domain.name	Character string (full Unicode charset)	The name of the domain for which a transfer has been initiated or ended.
msg.gaining.client.id	Character string (ASCII subset)	The client id of the registrar that requested the transfer.
msg.gaining.customer.id	Integer value	Id of the customer that requested the transfer (if the transfer is requested by a Knipp customer).
msg.losing.client.id	Character string (ASCII subset)	The client id of the registrar that loses the transferred object.
msg.losing.customer.id	Integer value	Id of the customer that loses the transferred object (if the object is owned by a customer before the transfer).
msg.transfer.direction	One of: 'incoming', 'outgoing'	The direction of the transfer.
msg.transfer.request.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	The date and time when the transfer was requested.
msg.transfer.completion.date	Date and time, formatted according to one variant of the extended date-time form defined in ISO-8601: 'yyyy-mm-ddThh:mm:ss.sZ'. 'T' and 'Z' have to be specified literally, the final 's' denotes the decimal fraction of the second.	If the transfer request is pending, the value identifies the date and time by which a response by the losing registrar is required before an automated response action is taken by the server. Else, the value identifies the date and time when the transfer was completed. The automated response action (e.g., auto-approve/auto-reject) depends on registry policy.

Example:

Response:

msg.type: transfer.start
msg.registry.id: afilias
msg.domain.name: domain.info
msg.gaining.client.id: clnt24-ID
msg.gaining.customer.id: 124
msg.losing.client.id: clnt23-ID
msg.losing.customer.id: 123
msg.transfer.direction: incoming
msg.transfer.request.date: 2001-03-17T21:23:00.0Z
msg.transfer.completion.date: 2001-03-23T21:23:00.0Z

Table of contents

Command type: stop transfer

Description:

This message denotes the end of a domain transfer, either by approval, rejection, cancellation or an error during processing. Each message type may have additional fields attached, see below.

Response format (in addition to the fields returned by the poll command itself):

Key	Value type/content	Description
msg.type	Fixed: 'transfer.end'	The type of the message returned.
msg.registry.id	One of: 'afilias', 'neulevel', 'dottv', 'gnr', 'verisign', 'neustar', 'dotcoop', 'cnnic', 'cnnic.idn', 'pir', 'twnic', 'dotmobi', 'inregistry', 'dotasia', 'domen', 'telnic', 'switch', 'iis', 'icmregistry'	The id of the registry which is concerned by the message returned during this poll, e.g. the registry a transferred domain is associated with. Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' neulevel: This field is fully supported. Fixed: 'neulevel' gnr: This field is fully supported. Fixed: 'gnr' verisign: This field is fully supported. Fixed: 'verisign' neustar: This field is fully supported. Fixed: 'neustar' pir: This field is fully supported. Fixed: 'pir' dotmobi: This field is fully supported. Fixed: 'dotmobi' inregistry: This field is fully supported. Fixed: 'inregistry' dotasia: This field is fully supported. Fixed: 'dotasia' domen: This field is fully supported. Fixed: 'domen' telnic: This field is fully supported. Fixed: 'telnic' switch: This field is fully supported. Fixed: 'switch' iis: This field is fully supported. Fixed: 'iis' icmregistry: This field is fully supported. Fixed: 'icmregistry' dottv: This field is fully supported. Fixed: 'dottv'
msg.transfer.done	Boolean value ('true' or 'false')	Specifies whether the domain has been sucessfully transferred (`true`) or not (`false`).
msg.transfer.actor	One of: 'gaining', 'losing', 'auto'	Specifies who caused the end of the transfer. `gaining` means: gaining registrar cancelled the transfer (`msg.transfer.done` is always `false` in this case). `losing` means: losing registrar approved the transfer (`msg.transfer.done` is `true`) or rejected it (`msg.transfer.done` is `false`). `auto` means: the registry ended the transfer by auto-approve (`msg.transfer.done` is `true`) or auto-reject (`msg.transfer.done` is `false`), or there has been an error during processing; the possible cases depend on registry policy.
msg.result.msg	Character string (ASCII subset)	In case of an error, this field specifies the error message in human-readable form.
msg.result.error	Character string (ASCII subset)	In case of an error, this field specifies the error message in machine-readable form.
msg.result.code	Character string (ASCII subset)	In case of an error, this field specifies the numeric error code.
msg.result.<n>.*	Character string (ASCII subset)	In case of an error, these fields specify additional information related to the error(s).

Example:

Response:

msg.type: transfer.end
msg.registry.id: afilias
msg.transfer.done: true
msg.transfer.actor: losing

Table of contents

Command type: registrant verification state change

Description:

This message is sent if the registrant's verification changes. This may happen during the registration of a domain where the mentioned contact has been used as a registrant for the first time. It may also happen if the registry reviews the contact and determines the the contact's state is incorrect. In the case that the state is set to refused, all domains that have this contact used as the registrant contact are deleted automatically by the registry.

Registry Specific Notes:

dotcoop:

This message is fully supported.

afilias, neulevel, gnr, verisign, neustar, cnnic, cnnic.idn, pir, denic, misc, alien, twnic, eurid, dotaero, dotmobi, inregistry, dotasia, domen, telnic, switch, iis, itnic, icmregistry, atnic, nominet, sidn, dottv:

This message is not supported.

Response format (in addition to the fields returned by the poll command itself):

Key	Value type/content	Description
msg.type	Fixed: 'contact.verification.change'	The type of the message returned.
msg.registry.id	One of: 'afilias', 'neulevel', 'dottv', 'gnr', 'verisign', 'neustar', 'dotcoop', 'cnnic', 'cnnic.idn', 'pir', 'twnic', 'dotmobi', 'inregistry', 'dotasia', 'domen', 'telnic', 'switch', 'iis', 'icmregistry'	The id of the registry which is concerned by the message returned during this poll, e.g. the registry a transferred domain is associated with. Registry Specific Notes: afilias: This field is fully supported. Fixed: 'afilias' neulevel: This field is fully supported. Fixed: 'neulevel' gnr: This field is fully supported. Fixed: 'gnr' verisign: This field is fully supported. Fixed: 'verisign' neustar: This field is fully supported. Fixed: 'neustar' pir: This field is fully supported. Fixed: 'pir' dotmobi: This field is fully supported. Fixed: 'dotmobi' inregistry: This field is fully supported. Fixed: 'inregistry' dotasia: This field is fully supported. Fixed: 'dotasia' domen: This field is fully supported. Fixed: 'domen' telnic: This field is fully supported. Fixed: 'telnic' switch: This field is fully supported. Fixed: 'switch' iis: This field is fully supported. Fixed: 'iis' icmregistry: This field is fully supported. Fixed: 'icmregistry' dottv: This field is fully supported. Fixed: 'dottv'
msg.contact.id	Character string (ASCII subset)	The ID of the contact this message refers to.
msg.contact.verification.state	One of: 'verified', 'pending', 'rejected', 'investigation', 'refused'	The registrant's new verification state.

Example:

Response:

msg.type: contact.verification.change
msg.registry.id: afilias
msg.contact.id: COR4543
msg.contact.verification.state: verified

Table of contents

Command type: command completion

Description:

This message is sent whenever an asynchronous request (which returned 10100/Command initiated) has been completed by the registry. When this notification is received, the original order has been updated to contain the final outcome of the request, including, but not limited to, a new result code.

Registry Specific Notes:

denic:

This message is fully supported.

This message is not supported.

Response format (in addition to the fields returned by the poll command itself):

Key	Value type/content	Description
msg.type	Fixed: 'command.completed'	The type of the message returned.
msg.transaction.id	Character string (ASCII subset)	The transaction id specified in the request that has been completed.

Example:

Response:

msg.type: command.completed
msg.transaction.id: mytrans-35432

Table of contents

Status values (registry specific)

Registry: afilias

General information

An object always has at least one associated status value. Status values may be set only by the client that sponsors an object and by the server on which the object resides.

A client must not alter status values set by the server. A server may alter or override status values set by a client subject to local server policies.

Status values that may be added or removed by a client are prefixed with "client". Corresponding status values that may be added or removed by a server are prefixed with "server".Status values that do not begin with either "client" or "server" are server-managed.

Contact object

	Status value		Description
	clientDeleteProhibited		Requests to delete the object must be rejected.
	serverDeleteProhibited		Requests to delete the object must be rejected.
	serverTransferProhibited		Requests to transfer the object must be rejected.
	clientUpdateProhibited		Requests to update the object (other than to remove this status) must be rejected.
	serverUpdateProhibited		Requests to update the object (other than to remove this status) must be rejected.
	linked		The contact object has at least one active association with another object, such as a domain object.
	ok		This is the nominal status value for a contact object at all times, whether or not the contact has pending operations or prohibitions.
	lock		The contact cannot be modified through any action. The contact object may be associated with domain objects and may be added or removed from a domain object in this state. Contacts created during the Sunrise or Land Rush Period will be locked at the time of creation subject to registry policies
	pendingDelete		A delete request has been received for the object, but the object has not yet been purged from the server database.
	pendingTransfer		A transfer request has been received for the object, and completion of the request is pending.

Host object

	Status value		Description
	clientLock		The host must not be modified through any action. The host object may be associated with domain objects and may be added or removed from a domain object in this state.
	clientDeleteProhibited		Requests to delete the object must be rejected.
	serverDeleteProhibited		Requests to delete the object must be rejected.
	clientUpdateProhibited		Requests to update the object (other than to remove this status) must be rejected.
	serverUpdateProhibited		Requests to update the object (other than to remove this status) must be rejected.
	linked		The host object has at least one active association with another object, such as a domain object.
	ok		This is the nominal status value for a host object at all times, whether or not the host has pending operations or prohibitions.
	lock		The host cannot not be modified through any action. The host object may be associated with domain objects and may be added or removed from a domain object in this state.
	pendingDelete		A delete request has been received for the object, but the object has not yet been purged from the server database.
	pendingTransfer		A transfer request has been received for the host object's superordinate domain object, and completion of the request is pending.

Domain object

	Status value		Description
	clientDeleteProhibited		Requests to delete the object must be rejected.
	serverDeleteProhibited		Requests to delete the object must be rejected.
	clientHold		Delegation information must be withheld from publication in the object's nominal zone.
	clientLock		The domain cannot be modified through any action. Hierarchical and associated objects cannot not be added or removed from the domain object.
	serverHold		Delegation information must be withheld from publication in the object's nominal zone.
	clientRenewProhibited		Requests to renew the object must be rejected.
	serverRenewProhibited		Requests to renew the object must be rejected.
	serverTransferProhibited		Requests to transfer the object must be rejected.
	clientUpdateProhibited		Requests to update the object (other than to remove this status) must be rejected.
	serverUpdateProhibited		Requests to update the object (other than to remove this status) must be rejected.
	active		The delegated domain can be modified and appears in a zone. This is the nominal status for a domain object once it has been published in a zone.
	inactive		Delegation information has not been associated with the object.
	ok		This is the nominal status value for a domain object at all times, whether or not the domain has pending operations or prohibitions.
	new		The domain can be modified and has not been published in a zone. This is the nominal status for a newly created domain object.
	hold		The domain will not be published in a zone for DNS resolution. The domain object may be modified through protocol actions.
	lock		The domain cannot be modified through any action. Hierarchical and associated objects cannot be added or removed from the domain object. Domain names registered during the Sunrise or Land Rush Period will be locked at the time of registration subject to registry policies.
	pendingDelete		A delete request has been received for the object, but the object has not yet been purged from the server database.
	pendingTransfer		A transfer request has been received for the object, and completion of the request is pending.