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

TLD Data

Suggest Edits

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 name

Definition/Value

sw_register (request)

aero_ens_id

Eligibility and Name Selection (ENS) identifier

Required

aero_ens_password

Eligibility and Name Selection (ENS) password

Required

.AU

Parameters within the au_registrant_info associative array are described below.

Parameter name

Definition/Value

sw_ register (request)

get domain (response)

getorder info (response)

verify (action)

eligibility_id

The 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 returned

Returned if submitted in the order

Always returned

eligibility_id _type

The 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 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.AU

Always returned

Returned if submitted in the order

Always returned

eligibility_ name

The name on the eligibility ID document.

Required for .ASN.AU, .COM.AU, .NET.AU, and .ORG.AU

Returned if submitted in the order

Returned if submitted in the order

Always returned

eligibility_ type

The 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.

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

  • Sole Trader

  • Trademark
    Owner

Allowed value for .ID.AU domains is Citizen/Resident

Required

Always returned

Always returned

Always returned

policy_ reason

The 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.

Required

Returned if submitted in the order

Returned if submitted in the order

Always returned

registrant_ id

The 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 returned

Always returned

Always returned

registrant_ id_type

The Registrant ID type. Allowed values are:

  • ACN—Australian Company Number

  • ABN—Australian Business Number

Required

Always returned

Always returned

Always returned

registrant name

The legal entity such as a company, incorporated association, government agency or individual person. Cannot be a registered business name or trademark.

Required

Always returned

Always returned

Always returned

(.AU) Example for Verify

Request

<?xml version="1.0"?>
<OPS_envelope>
  <header>
    <version>0.9</version>
  </header>
  <body>
    <data_block>
      <dt_assoc>
        <item key="protocol">XCP</item>
        <item key="action">verify</item>
        <item key="object">DOMAIN</item>
        <item key="domain">example.com.au</item>
        <item key="attributes">
          <dt_assoc>
            <item key="data">tld_data</item>
          </dt_assoc>
        </item>
      </dt_assoc>
    </data_block>
  </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
 <header>
  <version>0.9</version>
  </header>
 <body>
  <data_block>
   <dt_assoc>
    <item key="action">REPLY</item>
    <item key="response_code">200</item>
    <item key="response_text">Command Successful</item>
    <item key="is_success">1</item>
    <item key="protocol">XCP</item>
    <item key="attributes">
     <dt_assoc>
      <item key="tld_data">
       <dt_assoc>
        <item key="au_registrant_info">
         <dt_assoc>
          <item key="eligibility_id">11111111111</item>
          <item key="eligibility_name">Example PTY LTD</item>
          <item key="registrant_id">1111111111</item>
          <item key="eligibility_id_type">ABN</item>
          <item key="registrant_id_type">ABN</item>
          <item key="policy_reason">2</item>
          <item key="registrant_name">Example PTY LTDD</item>
          <item key="eligibility_type">Company</item>
         </dt_assoc>
        </item>
       </dt_assoc>
      </item>
     </dt_assoc>
    </item>
    <item key="object">DOMAIN</item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

.CL

Parameters within the registrant_extra_info associative array are described below.

Parameter name

Definition/ Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

id_card_number

The number of the individual's identity card.

Optional: can be submitted when registrant_ type = individual

Optional: can be submitted when registrant_ type = individual

Returned if applicable and is_success = true

Returned if applicable and is_success = true

registrant_type

The entity type of registrant.
Allowed values are individual or organization.

Required

Required

Returned if
is_success = true

Returned if
is_success = true

registrant_vat_id

Value Added Tax registration number.

Optional: can be submitted when registrant_ type = organization

Optional: can be submitted when registrant_ type = organization

Returned if applicable and is_success = true

Returned if applicable and is_success = true

.COM.AR .PT .COM.PT

Parameters within the registrant_extra_info associative array are described below.

Parameter name

Definition/ Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

id_card_number

The 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_ type

The entity type of registrant.
Allowed values are individual or organization.

Required

Required

Returned if
is_success = true

Returned if
is_success = true

tax_number

The number used for tax purposes.

Required

Required

Returned if
is_success = true

Returned if
is_success = true

.COM.BR

Parameters within the tld_data associative array are described below.

Parameter name

name Definition/Value

sw_ register (request)

get domain (response)

getorder info (response)

br_register_number

The 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)

Required

Returned 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 name

Definition/ Value

sw_ register (request)

modify domain (request)

get domain (response)

getorder info (response)

coopverification code

The coop verification code (CVC) is issued by dotCoop, and proves that the registrant is eligible to register the domain name.

Required

Required

Returned 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 name

Obligation

Definition/Value

sw_register

get_order_info

es_id_type

Required.

Possible values include:

  • other
  • NIE
  • NIF

Required.

Returned if
is_success = true.

es_id_number

Required if es_id_type is NIF or NIE

The 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 name

Obligation

sw_register

modify

update_contacts

country_of_citizenship

Allowed Values

AT
BE
BG
CY
CZ
DE
DK
EE
ES
FI
FR
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 name

Definition/ Value

sw_register (request)

get domain (response)

get_order_info (response)

registrant_type

The entity type of registrant.

Allowed values are individual or organization.

Required

Returned if
is_success = true

Returned if
is_success = true

.DK

Parameters within the registrant_extra_info associative array are described below.

Parameter name

Definition/ Value

sw_register (request)

trade domain (request)

get domain (response)

getorder info (response)

registrant_type

The entity type of
registrant.

Allowed values are individual or organization.

Required

Required

Returned if
is_success = true

Returned if
is_success = true

registrant_ vat_id

Value Added Tax
registration number.

Required when registrant_ type = organization

Required when
registrant_ type = organization

Returned if is_success = true and type = organization

Returned if is_success = true and type = organization

.FI .MY .SG

Parameters within the registrant_extra_info associative array are described below.

Parameter name

Definition/Value

sw_register (request)

trade domain (request)

get domain (response)

getorder info (response)

id_card_number

The number of the
individual's identity card.

Required when registrant_ type = organization

Required when registrant_ type = organization

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.

Required

Required

Returned if
is_success = true

Returned if
is_success = true

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

date_of_birth

.FI Only
Date of birth of registrant, format is YYYY-MM-DD

Required when registrant_type = individual

Required when registrant_type = individual

Returned if type = all_info and is_success = true

Returned if is_success = true

.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 name

Definition/Value

sw_ register (request)

get_order_info (response)

trade domain (request)

registrant_ type

The entity type of registrant.

Allowed values are individual and organization.

Required

Always returned

Required

registrant_ vat_id

The Value Added Tax (VAT) number of the organization.

Optional, but recommended for organizations located in France

Returned if submitted in the order

Optional, but recommended for organizations located in France

siren_siret

The 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 France

Returned if submitted in the order

Optional, but recommended for organizations located in France

trademark_ number

The organization's trademark registrationnumber,if applicable.

Optional, but recommended for organizations located in France

Returned if submitted in the order

Optional, but recommended for organizations located in France

.HK

Parameters within the registrant_extra_info associative array are described below.

Parameter name

Definition/ Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

date_of_birth

The registrant's
date of birth in the format YYYY-MM-DD.

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_number

The 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 and organization.

Required

Required

Returned if
is_success = true

Returned if
is_success = true

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

.HU .CO.HU

Parameters within the registrant_extra_info associative array are described below.

Parameter name

Definition/ Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

id_card_number

The 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.

Required

Required

Returned if
is_success = true

Returned if
is_success = true

registrant_vat_id

Value 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 name

Definition/Value

sw_ register (request)

get domain (response)

getorder info (response)

entity_type

The 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

Required

Always returned

Always returned

nationality_ code

The 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.

Optional

Returned if submitted in order

Returned if submitted in order

reg_code

An 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.

Required

Always returned

Always 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 name

Definition/Value

sw_register (request)

modify domain (request)

get domain (response)

jobs_admin_type

Indicates whether the registrant is the Admin contact.

Allowed values are Yes or No.

Required

Required

Always returned

jobs_association _member

Indicates whether the registrant is a member of SHRM.
Allowed values are Yes or No.

Required

Required

Always returned

jobs_industry_type

The type of business.

Optional

Optional

Returned if submitted in order

jobs_title

The registrant's job title.

Optional

Optional

Returned if submitted in order

jobs_website

The URL for the registrant's company.

Required

Required

Always returned

.LAW .ABOGADO

Parameters within the registrant_extra_info associative array are described below.

Parameter name

Definition/ Value

sw_ register (request)

qli_accreditation_id

Qualified Lawyer's Accreditation ID

Required

qli_accreditation_body

Qualified Lawyer's Accreditation Body

Required

qli_jurisdiction_country

Accreditation 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_state

Accreditation Jurisdiction State/Province

Optional

qli_accreditation_year

Qualified 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 name

Definition/Value

sw_register (request)

modify domain (request)

get domain (response)

getorder info (response)

id_card_number

The 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 = organization

Required 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.

Required

Required

Returned 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 name

Definition/ Value

sw_ register (request)

modify domain (request)

get domain (response)

getorder info (response)

registrant_
type

The entity
type of
registrant.
Allowed values
are
individual or
organization.

Required

Required

Returned if
is_success =
true

Returned if
is_success =
true

.NO

Parameters within the registrant_extra_info associative array are described
below.

Parameter name

Definition/ Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

registration_number

Norwegian company register number. This number can be verified
here.

Required

Required

Returned if is_success = true

Returned if is_success = true

.NYC

Parameters within the registrant_extra_info associative array are described
below.

Parameter name

Definition/ Value

sw_ register (request)

get domain (response)

get_order_info (response)

registrant_
type

The entity
type of
registrant.
Allowed values
are individual
or
organization.

Required

Returned 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 name

Definition/ Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

registrant_type

The entity
type of
registrant.
Allowed values
are individual
and
organization.

Required

Required

Returned if
is_success =
true

Returned if
is_success =
true

registrant_vat_id

The 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_number

The 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_number

The 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 name

Definition/Value

sw_ register (request)

modify domain (request)

get domain (response)

get_order _info (response)

authority

The name of the authority from which the registrant receives their professional credentials.

Optional

Optional

Returned 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.

Optional

Optional

Returned if submitted
in order

Returned if submitted
in order

license_
number

The license number of the registrant's credentials, if applicable.

Optional

Optional

Returned if submitted
in order

Returned if submitted
in order

profession

The stated profession of
the registrant.

Required

Required

Always
returned

Always
returned

.RO .COM.RO

Parameters within the registrant_extra_info associative array are described
below.

Parameter name

Definition/ Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

id_card_number

The 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 = organization

Required 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.

Required

Required

Returned 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 name

Definition /Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

date_of_birth

The 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_authority

The 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_date

The 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_number

The 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_birth

The 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_type

The entity type of registrant. Allowed values are individual
and organization.

Required

Required

Returned if is_success = true

Returned if is_success = true

.SE .NU

Parameters within the registrant_extra_info associative array are described
below.

Parameter name

Definition/ Value

sw_ register (request)

trade domain (request)

get domain (response)

getorder info (response)

id_card_number

The 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.

Required

Required

Returned 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

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 name

Definition/Value

sw_ register (request)

modify domain (request)

get domain (response)

get_order _info (response)

travel_uin

The Unique Identifying
Number that proves the
registrant is a participant in the travel and tourism
industry

Optional

Optional

Returned if
submitted
in order

Returned if
submitted
in order

.UK

Parameters within the registrant_extra_info associative array are described
below.

Parameter name

Definition/Value

sw_ register (request)

modify domain (request)

get domain (response)

get_order _info (response)

registrant_type

CRC
FCORP
FIND
FOTHER
GOV
IND
IP
LLP
LTD
OTHER
PLC
PTNR
RCHAR
SCH
STAT
STRA

Required

Required

Required

Required

registration_number

Organization 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_name

The 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 Code

Definition/Value

CRC

UK Corporation by Royal Charter

FCORP

Non-UK Corporation

FIND

Foreign Individual

FOTHER

Non-UK Entity that does not fit another category

GOV

Uk Government Body

IND

Individual

IP

UK Industrial/Provident Registered Company

LLP

UK Limited Liability Partnership

LTD

UK Limited Company

OTHER

UK Entity that does not fit another category

PLC

UK Public Limited Company

PTNR

UK Partnership

RCHAR

UK Registered Charity

SCH

UK School

STAT

UK Statutory Body

STRA

UK Sole Trader

.US

Parameters within the nexus associative array are described below.

Parameter name

Definition/Value

sw_ register (request)

modify domain (request)

get domain (response)

get_order _info (response)

app_purpose

A 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.

Required

Required

Always
returned

Always
returned

category

A 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.

Required

Required

Always
returned

Always
returned

validator

The 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 name

Definition/Value

sw_ register (request)

modify domain (request)

get domain (response)

get_order _info (response)

icm_membership_id

The 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.

Optional

Optional

Returned if
submitted
in the order

Returned if
submitted
in the order

ipr_email

The email address to which all communications from
the registry will be
addressed.

Optional

N/A

N/A

N/A

ipr_name

The name (in the format
firstname lastname) to
which all communications
from the registry will be
addressed.

Optional

N/A

N/A

Returned if
submitted
in the
order

ipr_non_resolver

When this value is set to 1 the domain will not
resolve.

Optional

N/A

N/A

N/A

Updated 8 days 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.