Home
/
API reference
/
API documentation (JSON/XML)
/
Objects

Contact object

API reference (XML/JSON) · Updated 2023-09-25

Description

The Contact (Previously called Handle) object represents the contact information required for domains.

Note on Migration from XML to JSON

Most XML keywords separated by underscores are written in JSON in CamelCase, starting with a lowercase letter.

Example:

confirm_order becomes confirmOrder
price_class becomes priceClass

Some keywords have been simplified in addition to spelling changes.

Example:

use_auto_dnssec becomes autoDnsSec.

Structure

Keyword JSON	Keyword XML	Occurs	Type	Format	Description
address	address	1 - 3	string		Street or post box. Depending on the registry, up to 65,536 characters may be possible.
alias	alias	0 - 1	string		A string that is either automatically generated when an alias is not sent or a self-defined string that can be set by the user for the purpose of identifying the domain contact.
city	city	1	string		The city of the contact.
comment	comment	0 - 1	string		A freely definable text that can be set for a contact. May only be composed of ASCII characters.
confirmOwnerConsent	confirm_owner_consent	1	boolean		Confirmation of the domain holder that he agrees to the changes. false or blank= Refuse confirmation. Order will not be accepted. true = Confirm Default value = false For XML, 0 (false) and 1 (true) can also be used. This confirmation has been required since December 7, 2016 due to ICANN's new change of ownership procedure for changes to the domain holder's name, email address or organization. Only for gTLDs and new gTLDs.
country	country	1	string		Country (ISO 3166-1 alpha-2) Country Code Certain strings, such as "Germany", are mapped to DE.
created	created	0 - 1	string	date-time	Date the contact was created on.
domainsafe	domainsafe	0 - 1	boolean		Indicates whether the domain contact is in the DomainSafe.
email	email	0 - 1*)	string	email	Email address
extensions	extension	0 - 1	object	ContactExtensions	Additional data for contacts required by certain TLDs.
fax	fax	0 - 1*)	string	phone	Fax number e.g. +49-123-12345
fname	fname	1	string		First name
id	id	0 - 1	string		Domain contact ID
lname	lname	1	string		Last name
nicRef	nic_ref	0 - n	string		Manually create a NIC reference for the domain contact. This is not required, since the NIC references are always created automatically. This will no longer be supported in the future.
organization	organization	1	string		The name of the organization to be used for the contact.
owner	owner		object	BasicUser	User, the object belongs to
pcode	pcode	1	string		The postal code (“zip-code”) of the contact. For the countries Canada, Norway, Poland and Spain the format of the postal code is checked for validity. Canada (.ca): Six characters in LNL or NLN formats, where "L" represents a letter and "N" represents a number. Example: M5V 3H5, H3Z2Y7 Norway (.no): Four digits between 0001 and 9990. Example: 0010, 9990 Poland (.pl): Five digits. Hyphen ("-") after the second digit. Example: 12-345 Spain (.es): Five digits. Each can be any digit from 0 to 9. Example: 28040
phone	phone	0 - 1*)	string	phone	Phone number e.g. +49-123-12345
protection	protection	1	enum	ContactProtection	Determines if data is shown in the Whois.
remarks	remarks	0 - n	string		Comment shown in the Whois. Nur für .de.
state	state	0 - 1	string		The local state in the country.
title	title	0 - 1	string		A prefix to a person’s name such as Dr. / Prof.
type	type	1	enum	ContactTypeEnum	Domain contact type
verification	verification	0 - 1	enum	GenericStatusEnum	The status of domain contact verification. SUCCESS: Domain contact verification successful PENDING: Domain contact verification in progress FAILED: Domain Contact Verification failed NOT_SET: Domain contact verification not started

^{*) Depends on the respective registry}