API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact [email protected]

Get Started

The tld_data associative array contains additional information that is required by some registries, such as the residency of the registrant. For instance, .AU domains require eligibility information to demonstrate Australian presence and this information is provided within the tld_data associative array, under au_registrant_info.

The allowed values for tld_data are:

  • au_registrant_info—Eligibility requirements for .AU registrants.
  • br_register_number—Legal Brazilian identifier.
  • ipr_data—Sponsored Community information associated with .XXX domains.
  • it_registrant_info—Regional presence requirements for .IT domains.
  • nexus —American presence requirements for .US domains.
  • professional_data—The professional designation information that is associated with the .PRO domain.
  • registrant_extra_info—Additional parameters that are required by various domain registries. See below for specific requirements for each TLD.

The tld_data information is used by the following commands: sw_register, modify domain, get domain, get_order_info, and trade domain (.FR only).

.AERO

Registration of .AERO domains is restricted to members of the aviation community such as airlines, airports, and qualifying companies and individuals.

To prove that they meet the requirements, registrants must provide an Eligibility and Name Selection (ENS) ID and password, which can be obtained by applying to the registry through this site: http://www.nic.aero/registration/manage_your_aero_id/apply

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/Valuesw_register (request)
aero_ens_idEligibility and Name Selection (ENS) identifierRequired
aero_ens_passwordEligibility and Name Selection (ENS) passwordRequired

.AU

Parameters within the au_registrant_info associative array are described below.

Parameter nameDefinition/Valuesw_ register (request)get domain (response)getorder info (response)
eligibility_idThe identifier of the eligibility document.

Important: This number will be verified, and if you submit an incorrect number, the registration will fail.
Required for .ASN.AU, .COM.AU .NET.AU, and .ORG.AU

Note: This value is optional for .ID.AU unless you specify an eligibility_id_type, in which case this value is required.
Always returnedReturned if submitted in the order
eligibility_id _typeThe Eligibility ID type. The allowed values depend on the eligibility_type specified.

Allowed value for Charity is ABN.

Allowed value for Club is ABN.

Allowed values for
Incorporated Association are ACT BN, NSW BN, NT BN, QLD BN, SA BN, TAS BN, VIC BN, and WA BN.

Allowed values for Non- profit Organization are ABN, ACT BN, ACN, NSW BN, NT BN, QLD BN, SA BN, TAS BN, VIC BN, WA BN, and OTHER.

Allowed value for Trade Union is OTHER.

Allowed value for Company is ACN.

Allowed value for Registered Business is OTHER.

Allowed value for Sole Trader is ABN.

Allowed value for Trademark Owner is TM.

Allowed value for Pending Trademark Owner is TM.

Allowed value for Partnership is ABN.
Required for .ASN.AU, .COM.AU, .NET.AU, and .ORG.AUAlways returnedReturned if submitted in the order
eligibility_ nameThe name on the eligibility ID document.Required for .ASN.AU, .COM.AU, .NET.AU, and .ORG.AUReturned if submitted in the orderReturned if submitted in the order
eligibility_ typeThe reason that the registrant is eligible for the domain name. The eligibility_type must correspond to the eligibility_name.

For example, if the registrant is using their company name to register the domain, then their eligibility_type is Company.

If they are using their Registered Business Name to register the domain, then their eligibility_type is Registered Business, even if they are also a company.

Allowed values for .ASN.AU and .ORG.AU domains are:

Charity

Club

Incorporated
Association

Non-profit
Organization

Trade Union

Allowed values for .COM.AU and .NET.AU domains are:

Company

Partnership

Pending TM Owner

Registered Business

Sole Trader

* Trademark
Owner

Allowed value for .ID.AU domains is Citizen/Resident
RequiredAlways returnedAlways returned
policy_ reasonThe name on the eligibility ID document.

Indicates the reason the registrant is entitled to the domain name.

Allowed values are:

1—The name exactly matches the acronym or abbreviation of the registrant's company or trading name, organization or association name, or trademark.

2—The name is connected closely and substantially to the registrant. This is the default.
RequiredReturned if submitted in the orderReturned if submitted in the order
registrant_ idThe registrant identifier. Must correspond to the registrant_id_type value (that is, the ABN or ACN),

Important: This number will be verified, and if you submit an incorrect number, the registration will fail.
Required if
registrant_ id_type = ACN or ABN
Always returnedAlways returned
registrant_ id_typeThe Registrant ID type. Allowed values are:

ACN—Australian Company Number

ABN—Australian Business Number
RequiredAlways returnedAlways returned
registrant nameThe legal entity such as a company, incorporated association, government agency or individual person. Cannot be a registered business name or trademark.RequiredAlways returnedAlways returned

.CL

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_numberThe number of the individual's identity card.Optional: can be submitted when registrant_ type = individualOptional: can be submitted when registrant_ type = individualReturned if applicable and is_success = trueReturned if applicable and is_success = true
registrant_typeThe entity type of registrant.
Allowed values are individual or organization.
RequiredRequiredReturned if
is_success = true
Returned if
is_success = true
registrant_vat_idValue Added Tax registration number.Optional: can be submitted when registrant_ type = organizationOptional: can be submitted when registrant_ type = organizationReturned if applicable and is_success = trueReturned if applicable and is_success = true

.COM.AR .PT .COM.PT

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_numberThe number of the individual's identity card.Required when
registrant_ type = individual
Required when
registrant_ type = individual
Returned if
is_success = true
Returned if
is_success = true registrant_ type = individual
registrant_ typeThe entity type of registrant.
Allowed values are individual or organization.
RequiredRequiredReturned if
is_success = true
Returned if
is_success = true
tax_numberThe number used for tax purposes.RequiredRequiredReturned if
is_success = true
Returned if
is_success = true

.COM.BR

Parameters within the tld_data associative array are described below.

Parameter namename Definition/Valuesw_ register (request)get domain (response)getorder info (response)
br_register_numberThe Brazilian legal identifier. For organizations, this is the SNPJ (Business Identifier/Cadastro Nacional de Pessoa Juridica)

For individuals, this is the CPF (Individual Tax Number/Cadastro de Pessoa Fisica)
RequiredReturned if
is_success = true
Returned if
is_success = true

.COOP

Registration of .COOP domains is restricted to cooperatives and related organizations.

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/ Valuesw_ register (request)modify domain (request)get domain (response)getorder info (response)
coopverification codeThe coop verification code (CVC) is issued by dotCoop, and proves that the registrant is eligible to register the domain name.RequiredRequiredReturned if
is_success = true
Returned if
is_success = true

.ES

Registration of a .es domain requires validation by identification number ( in most cases an NIF or NIF number)

If registrant_extra_info is not provided in the API, or the es_id_type='other', the default values which will be provided to the registry are as follows:

  • EsTipoIdentificacion => 0 (other)
  • EsIdentificacion => "111111"

Parameters within the registrant_extra_info associative array are described below.

Parameter nameObligationDefinition/Valuesw_registerget_order_info
es_id_typeRequired.Possible values include:

other
NIE
* NIF
Required.Returned if
is_success = true.
es_id_numberRequired if es_id_type is NIF or NIEThe NIE or NIF number.Required.Returned if
is_success = true.

.EU

As of October 19th 2019, EU Citizens (Natural Persons) situated outside the EU must specify an EU country of citizenship

Parameter nameObligationsw_registermodifyupdate_contacts
country_of_citizenshipAllowed Values

AT
BE
BG
CY
CZ
DE
DK
EE
ES
FI
FR
GB
GR
HR
HU
IE
IT
LT
LU
LV
MT
NL
PL
PT
RO
SE
SI
SK
Required if Owner Contact is Blank & Owner Country is not in EU.Required if Owner Contact is Blank & Owner Country is not in EU.Required if Owner Contact is Blank & Owner Country is not in EU.

.DE

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/ Valuesw_register (request)get domain (response)get_order_info (response)
registrant_typeThe entity type of registrant.

Allowed values are individual or organization.
RequiredReturned if
is_success = true
Returned if
is_success = true

.DK

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/ Valuesw_register (request)trade domain (request)get domain (response)getorder info (response)
registrant_typeThe entity type of
registrant.

Allowed values are individual or organization.
RequiredRequiredReturned if
is_success = true
Returned if
is_success = true
registrant_ vat_idValue Added Tax
registration number.
Required when registrant_ type = organizationRequired when
registrant_ type = organization
Returned if is_success = true and type = organizationReturned if is_success = true and type = organization

.FI .MY .SG

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/Valuesw_register (request)trade domain (request)get domain (response)getorder info (response)
id_card_numberThe number of the
individual's identity card.
Required when registrant_ type = organizationRequired when registrant_ type = organizationReturned if
is_success = true and registrant_ type = individual
Returned if
is_success = true and registrant_ type = individual
registrant_typeThe entity type of
registrant.

Allowed values are individual or organization.
RequiredRequiredReturned if
is_success = true
Returned if
is_success = true
registration_numberThe business number of the
organization.
Required when
registrant_ type = organization
Required when
registrant_ type = organization
Returned if
is_success = true and registrant_ type = organization
Returned if
is_success = true and registrant_ type = organization

.FR

.FR domains are available to any individuals and organizations located in the European Union, Switzerland, Norway, Iceland, or Liechtenstein. Individuals must reside within one of the qualifying countries; organizations must have their registered or main office located in a qualifying country; therefore, when registering or transferring .FR domains, you must provide additional residency information.

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/Valuesw_ register (request)get_order_info (response)trade domain (request)
registrant_ typeThe entity type of registrant.

Allowed values are individual and organization.
RequiredAlways returnedRequired
registrant_ vat_idThe Value Added Tax (VAT) number of the organization.Optional, but recommended for organizations located in FranceReturned if submitted in the orderOptional, but recommended for organizations located in France
siren_siretThe 9 digit SIREN code or the 14 digit SIRET code that is used to identify the business for tax reasons.Optional, but recommended for organizations located in FranceReturned if submitted in the orderOptional, but recommended for organizations located in France
trademark_ numberThe organization's trademark registrationnumber,if applicable.Optional, but recommended for organizations located in FranceReturned if submitted in the orderOptional, but recommended for organizations located in France

.HK

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
date_of_birthThe registrant's
date of birth in the format YYYY-MM-DD.
Required when registrant_ type = individualRequired when registrant_ type = individualReturned if is_success = true and registrant_ type = individualReturned if is_success = true and registrant_ type = individual
id_card_numberThe number of the
individual's identity card.
Required when registrant_ type = individualRequired when registrant_ type = individualReturned if
is_success = true and registrant_ type = individual
Returned if
is_success = true and registrant_ type = individual
registrant_typeThe entity type of
registrant.
Allowed values are individual and organization.
RequiredRequiredReturned if
is_success = true
Returned if
is_success = true
registration_numberThe business number of the organization.Required when registrant_ type = organizationRequired when registrant_ type = organizationReturned if
is_success = true and registrant_ type = organization
Returned if
is_success = true and registrant_ type = organization

.HU .CO.HU

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_numberThe number of the individual's identity cardRequired when registrant_ type = individualRequired when registrant_ type = individualReturned if is_success = true and registrant_type = individualReturned if is_success = true and registrant_type = individual
registrant_typeThe entity type of registrant.

Allowed values are individual or organization.
RequiredRequiredReturned if
is_success = true
Returned if
is_success = true
registrant_vat_idValue Added Tax registration number.Required when
registrant_ type = organization
Required when
registrant_ type = organization
Returned if
is_success = true and registrant_ type = organization
Returned if
is_success = true and registrant_ type = organization

.IT

Parameters within the it_registrant _info associative array are described below.

Parameter nameDefinition/Valuesw_ register (request)get domain (response)getorder info (response)
entity_typeThe legal entity type of registrant.

Allowed values are:

1—Italian and foreign natural persons

2—Companies/one man companies
3—Freelance workers/professiona ls

4—Non-profit organizations

5—Public organizations

6—Other subjects

* 7—Foreigners who match 2-6
RequiredAlways returnedAlways returned
nationality_ codeThe 2-digit ISO 3166-1 code that identifies the Registrant's nationality.

If entity_type = 1, nationality or owner's country or both must be an EU country.

If entity_type = 2-6, this value must be IT.

If entity_type = 7, this value must match owner's country and must be an EU country other than IT.

Note: Be sure to use capital letters.
OptionalReturned if submitted in orderReturned if submitted in order
reg_codeAn identifying number, usually the VAT or Codice Fiscale (numeric tax code). The value that you need to enter depends on the entity type of the registrant.

Italian citizens must enter their Codice Fiscale.

Non Italians not living in Italy can enter n.a.

Italian companies, freelancers, and other subjects must enter their 11 digit VAT number or tax identification number.

Italian non-profit organizations must enter their VAT number or tax identification number; however, if they do not have one, they can enter n.a.

* Non Italian entities other than persons (organizations, freelancers, companies, etc.) may enter their VAT number or n.a.
RequiredAlways returnedAlways returned

.JOBS

Registration of .JOBS domains is restricted to those who are involved in Human Resource management. To be eligible, registrants must be a member of the Society for Human Resource Management (SHRM) or involved in HR practices that meet any of the following criteria:

  • Possess salaried-level human resource management experience.
  • Are certified by the Human Resource Certification Institute.
  • Are supportive of the SHRM Code of Ethical and Professional Standards in Human Resource Management, as amended from time to time.

Consequently, when registering a .JOBS domain, registrants must complete some additional information.

For more information on the restrictions and policies regarding .JOBS registrations, see http://www.policy.jobs/

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/Valuesw_register (request)modify domain (request)get domain (response)
jobs_admin_typeIndicates whether the registrant is the Admin contact.

Allowed values are Yes or No.
RequiredRequiredAlways returned
jobs_association _memberIndicates whether the registrant is a member of SHRM.
Allowed values are Yes or No.
RequiredRequiredAlways returned
jobs_industry_typeThe type of business.OptionalOptionalReturned if submitted in order
jobs_titleThe registrant's job title.OptionalOptionalReturned if submitted in order
jobs_websiteThe URL for the registrant's company.RequiredRequiredAlways returned

.LAW .ABOGADO

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/ Valuesw_ register (request)
qli_accreditation_idQualified Lawyer's Accreditation IDRequired
qli_accreditation_bodyQualified Lawyer's Accreditation BodyRequired
qli_jurisdiction_countryAccreditation Jurisdiction Country.

Allowed value is an uppercase 2-letter ISO country code. Must be one of the following:

AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BX, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, EU, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, OT, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZR, ZW
Required
qli_jurisdiction_stateAccreditation Jurisdiction State/ProvinceOptional
qli_accreditation_yearQualified Lawyer's Accreditation Year. Allowed value is 4 digits.Required

.LV .COM.LV

Parameters within the registrant_extra_info associative array are described below.

Parameter nameDefinition/Valuesw_register (request)modify domain (request)get domain (response)getorder info (response)
id_card_numberThe number of the individual's
identity card.
Required when
registrant_ type = individual
Required when
registrant_ type = individual
Returned if is_success = true and registrant_ type = individualReturned if is_success = true and registrant_ type = individual
registration_numberThe business number of the organization.Required when registrant_type = organizationRequired when registrant_type = organizationReturned if is_success = true and registrant_ type = organizationReturned if is_success = true and registrant_ type = organization
registrant_
type
The entity
type of
registrant.
Allowed values
are individual or
organization.
RequiredRequiredReturned if
is_success =
true
Returned if
is_success =
true
registrant_
vat_id
The Value
Added Tax
(VAT) number
of the
organization
Required
when
registrant_
type =
organization
Required
when
registrant_
type =
organization
Returned if
is_success =
true
and
registrant_
type =
organization
Returned if
is_success =
true
and
registrant_
type =
organization

.MX .COM.MX .CO.ZA

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition/ Valuesw_ register (request)modify domain (request)get domain (response)getorder info (response)
registrant_
type
The entity
type of
registrant.
Allowed values
are
individual or
organization.
RequiredRequiredReturned if
is_success =
true
Returned if
is_success =
true

.NO

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
registration_numberNorwegian company register number. This number can be verified
here.
RequiredRequiredReturned if is_success = trueReturned if is_success = true

.NYC

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition/ Valuesw_ register (request)get domain (response)get_order_info (response)
registrant_
type
The entity
type of
registrant.
Allowed values
are individual
or
organization.
RequiredReturned if
is_success =
true
Returned if
is_success =
true

.PM .RE .TF .WF .YT

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
registrant_typeThe entity
type of
registrant.
Allowed values
are individual
and
organization.
RequiredRequiredReturned if
is_success =
true
Returned if
is_success =
true
registrant_vat_idThe Value
Added Tax
(VAT) number
of the
organization.
Optional. May
be used when
registrant_
type =
organization
Optional. May
be used when
registrant_
type =
organization
Returned if
is_success =
true
if
submitted in
the order
Returned if
is_success
= true if
submitted
registration_numberThe business
number of the
organization.
Optional, but
recommended
for
organizations
located in
France
Optional, but
recommended
for
organizations
located in
France
Returned if
is_success =
true
if
submitted in
the order
Returned if
is_success
= true
if
submitted in
the order
trademark_numberThe number
assigned to
the
organization’s
pending or
registered
trademark.
Optional but
recommended
when
registrant_
type =
organization
Optional but
recommended
when
registrant_
type =
organization
Returned if
is_success =
true
if
submitted in
the order
Returned if
is_success
= true
if
submitted in
the order

.PRO

In order to register a .PRO domain name, the registrant must belong to an
accredited profession.

Parameters within the professional_data associative array are described
below.

Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
authorityThe name of the authority from which the registrant receives their professional credentials.OptionalOptionalReturned if submitted
in order
Returned if submitted
in order
authority_
website
The URL to an online
resource for the authority, preferably, a member search directory.
OptionalOptionalReturned if submitted
in order
Returned if submitted
in order
license_
number
The license number of the registrant's credentials, if applicable.OptionalOptionalReturned if submitted
in order
Returned if submitted
in order
professionThe stated profession of
the registrant.
RequiredRequiredAlways
returned
Always
returned

.RO .COM.RO

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_numberThe number of
the individual's
identity card.
Required when
registrant_
type = individual
Required when
registrant_
type = individual
Returned if is_success = true and
registrant_type =
individual
Returned if
is_success = true and
registrant_type =
individual
registration_
number
The business number of the organization.Required when registrant_type = organizationRequired when
registrant_type = organization
Returned if
is_success = true and
registrant_type =
organization
Returned if
is_success = true and
registrant_type =
organization
registrant_
type
The entity type of
registrant. Allowed values are individual or
organization.
RequiredRequiredReturned if
is_success = true
Returned if
is_success = true
registrant_
vat_id
The Value Added Tax
(VAT) number of the
organization
Required when
registrant_type =
organization
Required when
registrant_type =
organization
Returned if
is_success = true and
registrant_type =
organization
Returned if
is_success = true and
registrant_type =
organization

.RU

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition /Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
date_of_birthThe registrant's
date of birth in the
format YYYY-MMDD.
Required when
registrant_type = individual
Required when
registrant_type =
individual
Returned if is_success = true and registrant_type =
individual
Returned if is_success =true and registrant_type =
individual
id_card_authorityThe name of the issuer.Required when
registrant_type = individual
Required when
registrant_type =
individual
Returned if is_success = true and registrant_type =
individual
Returned if is_success = true and
registrant_type =
individual
id_card_issue_dateThe date that the ID card was issued, in the format
YYYY-MMDD
Required when registrant_type =
individual
Required when registrant_type =
individual
Returned if
is_success = true and
registrant_type =
individual
Returned if is_success = true and registrant_type =
individual
id_card_numberThe number of the
individual's identity
card.
Required when
registrant_type =
individual
Required when
registrant_type =
individual
Returned if
is_success = true and
registrant_type =
individual
Returned if
is_success = true and
registrant_type = individual
place_of_birthThe city in which the
individual was born.
Required when
registrant_type =
individual
Required when
registrant_type =
individual
Returned if
is_success = true and
registrant_type =
individual
Returned if
is_success = true and
registrant_type =
individual
registrant_typeThe entity type of registrant. Allowed values are individual
and organization.
RequiredRequiredReturned if is_success = trueReturned if is_success = true

.SE .NU

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_numberThe number of
the individual's
identity card.
Required when registrant_type =
individual
Required when
registrant_type =
individual
Returned if is_success = true and registrant_type =
individual
Returned if is_success = true and registrant_type =
individual
registrant_
type
The entity
type of
registrant.
Allowed values
are
individual or
organization.
RequiredRequiredReturned if
is_success = true
Returned if
is_success = true
registrant_
vat_id
The Value
Added Tax
(VAT) number
of the
organization
Required when
registrant_type =
organization
Required when
registrant_type =
organization
Returned if is_success = true and registrant_type = organizationReturned if is_success = true and registrant_type = organization
registration_
number
The business
number of the
organization
Required when
registrant_type =
organization
Required when
registrant_type =
organization
Returned if is_success = true and
registrant_type =
organization
Returned if is_success = true and
registrant_type =
organization

.TRAVEL

In order to register a .TRAVEL domain name, the registrant must be a
participant in the travel and tourism industry, and they must have a Unique
Identifying Number (UIN).

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
travel_uinThe Unique Identifying
Number that proves the
registrant is a participant in the travel and tourism
industry
OptionalOptionalReturned if
submitted
in order
Returned if
submitted
in order

.UK

Parameters within the registrant_extra_info associative array are described
below.

Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
registrant_typeCRC
FCORP
FIND
FOTHER
GOV
IND
IP
LLP
LTD
OTHER
PLC
PTNR
RCHAR
SCH
STAT
STRA
RequiredRequiredRequiredRequired
registration_numberOrganization ID issued by the government.registrant type =
LTD
PLC
LLP
IP
SCH
RCHAR
registrant type =
LTD
PLC
LLP
IP
SCH
RCHAR
registrant type =
LTD
PLC
LLP
IP
SCH
RCHAR
registrant type =
LTD
PLC
LLP
IP
SCH
RCHAR
trading_nameThe trading name of the organization.Required if registrant type = LTD
PLC
LLP
IP
RCHAR
FCORP
OTHER
FOTHER
STRA
Required if registrant type = LTD
PLC
LLP
IP
RCHAR
FCORP
OTHER
FOTHER
STRA
Required if registrant type = LTD
PLC
LLP
IP
RCHAR
FCORP
OTHER
FOTHER
STRA
Required if registrant type = LTD
PLC
LLP
IP
RCHAR
FCORP
OTHER
FOTHER
STRA

.UK registrant_type

Registrant Type CodeDefinition/Value
CRCUK Corporation by Royal Charter
FCORPNon-UK Corporation
FINDForeign Individual
FOTHERNon-UK Entity that does not fit another category
GOVUk Government Body
INDIndividual
IPUK Industrial/Provident Registered Company
LLPUK Limited Liability Partnership
LTDUK Limited Company
OTHERUK Entity that does not fit another category
PLCUK Public Limited Company
PTNRUK Partnership
RCHARUK Registered Charity
SCHUK School
STATUK Statutory Body
STRAUK Sole Trader

.US

Parameters within the nexus associative array are described below.

Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
app_purposeA description of the
domain's application
purpose:

P1—Business use
for profit.

P2—Non-profit
business, club,
association,
religious organization, and so on.

P3—Personal use.

P4—Education
purposes.

* P5—Government
purposes.
RequiredRequiredAlways
returned
Always
returned
categoryA description of the
domain's nexus category:

C11—A citizen of the U.S. or any of
its territories.

C12—A permanent resident of the U.S. or any of its
territories.

C21—An
organization incorporated within the U.S.

C31—An entity that regularly engages in
lawful activities in
the U.S.

* C32—An entity that has an office or
other facility in the
U.S.
RequiredRequiredAlways
returned
Always
returned
validatorThe domain owner's
country of citizenship.
Value must be a valid two letter country code.
Required if category =
C31 or C32
Required if category =
C3 or C32
Returned if category =
C31 or C32
Returned if category =
C31 or C32

.XXX

.XXX domains are available to those within the adult entertainment industry
who are members of the Sponsored Community (SC). The ipr_data
associative array contains information to prove that the registrant is a
member of the Sponsored Community.

Parameters within the ipr_data associative array are described below.

Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
icm_membership_idThe ID number that was provided when the
registrant successfully
completed the XXX
Sponsored Community
validation process. If this
value is not submitted with the domain registration, the registry will contact the registrant with instructions on how to become a member of the Sponsored Community.

If you submit this value,
you do not need to submit any of the other ipr_data values.
OptionalOptionalReturned if
submitted
in the order
Returned if
submitted
in the order
ipr_emailThe email address to which all communications from
the registry will be
addressed.
OptionalN/AN/AN/A
ipr_nameThe name (in the format
firstname lastname) to
which all communications
from the registry will be
addressed.
OptionalN/AN/AReturned if
submitted
in the
order
ipr_non_resolverWhen this value is set to 1 the domain will not
resolve.
OptionalN/AN/AN/A

Updated 9 months ago

TLD Data


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.