Table of Contents

Description

Some TLDs require additional information for domain contacts for the registration of domains. These are indicated by extensions.

General Extensions

Keyword JSONKeyword  XMLOccursTypeFormat

Description

-

mode

0 - 1

enum

AddonUpdateMode

You use this Keyword to influence how the additional information is handled during the update. Only possible for ContactUpdate.

-verification0 - 1enumGenericStatusEnum

Verification status of the contact.

citizenshipcitizenship0 - 1string

Citizenship. For EU citizens living outside the EU

birth.country

birthcountry

0 - 1

string


Birth country (ISO 3166 Country Code)

birth.day

birthday

0 - 1*)

string

date

Birthday (yyyy-MM-dd)

birth.pcode

birthpcode

0 -1*)

string


Postal code of the birth place

birth.place

birthplace

0 - 1*)

string


birth place

companyNumber

companynumber

0 - 1*)

string


Company number

gender

gender

0 - 1*)

enum

Gender

Gender

vatNumber

vatnumber

0 - 1*)

string


VAT number

identification.authority

id_authority0 - 1*)string

Issuing authority of the identification card.

identification.dateOfIssueid_date_of_issue0 - 1*)string

date

Date on which the identification card was issued.

identification.number

idnumber

0 - 1*)

string


ID card number.

identification.validTillid_valid_till0 - 1*)string

date

Date on which the validity of the identification card expires.

language

language

0 - 1

string

Language of the contact RFC 3066 z.B. "de" or "de_ch"

mobilePhone

mobile_phone


0 - 1


string

phone

Mobile phone number

e.g. +49-123-123

strict

strict

0-1

boolean


Ensures that the data for transfer to the registry is not modified.

0 = active

1 = not active

Default = 0

trademark.appdate

trademark_appdate

0 - 1*)

string

date

Application date of the trade mark (yyyy-MM-dd)

trademark.country

trademark_country

0 - 1*)

string


Country in which the trade mark is valid (ISO 3166 Country Code).

trademark.name

trademark_name

0 - 1*)

string


Trademark name

trademark.number

trademark_number

0 - 1*)

string


Trademark number

trademark.officetrademark_office0 - 1*)string

The trademark office where the trademark is registered at.

trademark.regdate

trademark_regdate

0 - 1*)

string

date

Registration date

*) Depends on the registry

.aero

An .aero domain can be registered with an ENS Auth ID and an ENS Keyword (Link to apply for an aero-ID https://www.information.aero/node/add/request-aero-id)

Keyword JSONKeyword XMLOccursTypeFormatDescription
ensAuthId

aero_ens_auth_id

0 - 1

string


Aero Authentication ID.

ensKey

aero_ens_key

0 - 1

string


Aero ENS key

.au

Keyword JSONKeyword XMLOccursTypeFormatDescription
eligibilityId

au_eligibility_id

0 - 1

integer

int32

The corresponding ID number for the eligibility name if applicable, if in doubt just use the same details as your registrant id.

eligibilityIdType

au_eligibility_id_type

0 - 1

enum

AuEligibilityIdTypeConstants

The type of eligibility id as above.

eligibilityName

au_eligibility_name

0 - 1

string


This field is optional and whether it is required is determined by your policy reason for the domain registration, if in doubt just use the same details as your registrant name.

eligibilityType

au_eligibility_type

0 - 1

enum

AuEligibilityTypeConstants

The type of entity that the registrant is.

policaReason

au_policy_reason

0 - 1

enum

AuPolicyReasonConstants

Reason for eligibility.

registrantId

au_registrant_id

0 - 1

integer

int32

"Australian Business Number" or "Registered Business Number"

registrantIdType

au_registrant_id_type

0 - 1

enum

AuRegistrantIdTypeConstants

Concerns the registrant id which you have selected in the registrant id form field. Select the matching entry in the list.

registrantName


au_registrant_name

0 - 1

string


Name of the registrant.

.bank

Keyword JSONKeyword XMLOccursTypFormatDescription
ftldToken

ftld_token

0 - 1

integer

int32

Registration token that you receive by email after successful verification by the registry.

.barcelona

Keyword JSONKeyword XMLOccursTypFormatDescription
intendedUse

barcelona_intended_use

0 - 1

string


The intended use for the domain.

.ca

Keyword JSONKeyword XMLOccursTypeFormatDescription
cpr

cpr_category

1

enum

CiraCprConstants


Canadian Presence Requirements.

Enter the reason for the authorization to register a .ca domain.
officialRepresentative

cira_official_representative

0 - 1string

Offical representative.

trusteePercentagecirca_trustee_percentage0 - 1numberdoubleShare of Canadians in a trust. Value must be <= 66. Mandatory if CPR = TRS (Trust).

.cat

A .cat domain is registered by a deferred check up. As requestor the registry will send you the registration policies via email. If you confirm the policies the domain will be assigned to you. Later the registry will check if the use of the domain is according to the intended use.

Keyword JSONKeyword XMLOccursTypeFormatDescription
intendedUse

cat_intended_use

0 - 1

string


The intended use for the domain.

.hk

Keyword JSONKeyword XMLOccursTypeFormatDescription
above18

hk_above_18

0 - 1

boolean


For "Person" only. Is the person 18 years of age or older?

Values:

  • Yes = the person is 18 years of age or older
  • No = the person is younger than 18

Default = No

documentNumber

hk_document_number

0 - 1

string


Document number, e.g. ID card number.

documentOrigin

hk_document_origin

0 - 1

string


Country of issuing authority.

documentType

hk_document_type

0 - 1

enum

HkDocumentTypeConstants

Dokument type für persons and organizations.
others

hk_others

0 - 1

string


Additional description field for OTHIDV und OTHORG.

industryType

industry_type

0 - 1

enum

HkIndustryTypeConstants

Industry type

.ie

Keyword JSONKeyword XMLOccursTypeFormatDescriprion
contactTypeie_contact_type

1

enum


Describes the connection to Ireland that is eligible for domain registration.

Possible values:

  • Company - for Irish companies with CRO number
  • Charity - is not supported by us
  • Other - person or organization without CRO number
ieSupportingNumberie_supporting_number0 - 1string

Can be an EU trademark number or an Irish RBN. Needed for other person or organization of type OTH (Other).

For type COM (Commercial) the company number from the general contact details is used.

.it

Keyword JSONKeyword XMLOccursTypeFormatDescription
entityType

it_entity_type

0 - 1

enum

ItEntityTypeConstants

Entity the contact belongs to.

Depending on what you have entered in it_entity_type, other data must also be specified. You can find a description of this data in the section "General Extensions".


.jobs

Keyword JSONKeyword XMLOccursTypeFormatDescription
adminType

jobs_admin_type

0 - 1

boolean


Here you enter whether the contact is the administrative contact with the permission to act as an independent agent /recruiter on behalf of the listed registrant.

  • 0 = No
  • 1 = Yes

Default = 0

contactTitle

jobs_contact_title

0 - 1

string


Title of the contact in the organization.

hrMember

jobs_hr_member

0 - 1

boolean


Choose whether the contact is is a member of the „Human Resource Organization.

  • 0 = No
  • 1 = Yes

Default = 0

industryClass

jobs_industry_class

0 - 1

enum

JobsIndustryClassConstants

The industry class in which the company is active in.

website

jobs_website

0 - 1

string


The website URL of the company.

.jp

Keyword JSONKeyXMLOccursTypeFormatDescription
first

jp_fname_b64

0 - 1

string


First Name. Japanese characters must be used.

last

jp_lname_b64

0 - 1string
Last Name. Japanese characters must be used.
organization

jp_organization_b64

0 - 1string
Organization Name. Japanese characters must be used.
adressLine1

jp_address1_b64

0 - 1string
First address line. Japanese characters must be used.
adressLine2

jp_address2_b64

0 - 1string
Second address line. Japanese characters must be used.
adressLine3

jp_address3_b64

0 - 1string
Third address line. Japanese characters must be used.

.luxe

Keyword JSONKeyword XMLOccursTypeFormatDescription
walletAddress

luxe_wallet_address

0 - 1



The wallet address

.madrid

Keyword JSONKeyword XMLOccursTypeFormatDescription
intendedUse

madrid_intended_use

0 - 1

string


The intended use for the domain.

.nz

Keyword JSONKeyword XMLOccursTypeFormatDescription
irpo

nz_irpo

0 - 1

boolean


Hide contact data in the Whois. Address, telephone, fax are affected.

  • 0 = Contact is displayed
  • 1 = Contact data is hidden

Default = 0

Permitted only for natural persons ("individuals") who do not use the domain name to a significant extent in "trading" as defined and used in the Fair Trading Act 1986.

.ro

Keyword JSONKeyword XMLOccursTypeFormatDescription
personType

extension /ro_person_type 

0 - 1

enum

RoPersonTypeConstants

Type of group that the contact belongs to.

.ru

These extensions are required if the owner is a company from Russia (OwnerC = ORG). If the owner is a person, ID card data is required (OwnerC = PERSON).

Keyword JSONKeyword XMLOccursTypeFormatDescription
taxpayerIdentificationNumber

ru_taxpayer_identification_number

0 - 1

string


Taxpayer Identification Number (code). Mandatory for organisations which belong to the Russian Federation.

territoryLinkedTaxpayerNumber

ru_territory_linked_taxpayer_number

0 - 1

string


Territory-linked Taxpayer Number (kpp). Mandatory for organisations which belong to the Russian Federation.

.scot

Keyword JSONKeyword XMLOccursTypeFormatDescription
intendedUse

scot_intended_use

0 - 1

string


The intended use for the domain.

.sport

Keyword JSONKeyword XMLOccursTypeFormatDescription
intendedUse

sport_intended_use

0 - 1

string


The intended use for the domain.

.swiss

Keyword JSONKeyword XMLOccursTypeFormatDescription
enterpriseId

swiss_enterprise_id

0 - 1

string


For companies

The enterprise ID, in the specific context of .swiss based on current rules, is the Swiss UID/IDE/IDI.

The full name is

  • in German "Unternehmens-ID"
  • in French "Numéro d’identification des entreprises (IDE)" and
  • in Italian "Numero d’identificazione delle imprese" (IDI).

For natural persons:

  • Swiss social security number (OASI / AHV / AVS) 
intendedUse

swiss_intended_use

0 - 1

string


The intended use for the domain.

.uk

The <uk_type> extension was introduced to categorize the organization types. If you want certain contact data not to be displayed in the Whois, use the organization types IND or FIND.

Keyword JSONKeyword XMLOccursTypeFormatDescription
entityType

uk_type

0 - 1*)

enum

UkTypeConstants

Organization type.

For the subdomains ltd.uk, net.uk and plc.uk the selection of <uk _type> is mandatory.

For co.uk and me.uk the selection of <uk_type> is not mandatory.

*) Depends on the registry

.xxx

Keyword JSONKeyword XMLOccursTypeFormatDescription
membershipId

xxx_membership_id

0 - 1

string


Membership ID (token) for the .XXX community. You receive your ID after you have finished the ICM registry membership process successfully and having created an account there.

nonResolverDomain

xxx_non_resolver_domain

0 - 1

boolean


XXX community membership. Members have a membership ID (token).

Possible values:

  • true = member
  • false = no member

Default = false

.zuerich

Keyword JSONKeyword XMLOccursTypeFormat
isAuthority

zuerich_is_authority

0 - 1

boolean


Indicates whether the registrant is a public corporation or not.

  • 0 = not a public corporation
  • 1 = public corporation

Default = 0

enterpriseId
zuerich_enterprise_id
0 - 1string

The enterprise ID, in the specific context of .zuerich based on current rules, is the Swiss UID/IDE/IDI.

Usage