API Format Extensions Additional Data Customer

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Format specification > Customer Extension Additional Data)
(→Format specification > Customer Extension Additional Data)
 
(12 intermediate revisions not shown)
Line 6: Line 6:
|'''Conditions'''
|'''Conditions'''
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.us'''
+
|colspan="2" style="background-color:#EEEEEE;"|'''.aero'''
|-
|-
|
|
-
'''nexusCategory'''
+
'''ensAuthId'''
-
|Field is always required with next possible options => ['C11', 'C12', 'C21', 'C31', 'C32']
+
|This field is mandatory and must be filled with [https://www.information.aero/node/add/request-aero-id aero authentication ID].
-
A natural person,
+
-
'''C11''' - Who is a United States citizen.
+
-
'''C12''' - Who is a permanent resident of the United States of America or any of its possessions or territories.
+
-
A U.S. Organization incorporated within one of the fifty (50) U.S. States, the District of Columbia, or any of the U.S. Possessions or territories or organized or otherwise constituted under the laws of a state of the United States of America, the District of Columbia or any of its possessions or territories or a U.S. Federal, state, or local government entity or a political subdivision thereof.
+
-
'''C21''' - U.S. Organization incorporated within one of the 50 states or a U.S. Territory
+
-
An entity or organization that has a bona fide presence in the United States of America or any of its possessions or territories.
+
-
'''C31''' - Regularly engages in lawful activities (sales of goods or services or other business, commercial or non-commercial, including not-for-profit relations in the United States).
+
-
'''C32''' - Entity has an office or other facility in the US.
+
|-
|-
-
|'''applicantPurpose'''
+
|
-
|This field is mandatory.  
+
'''ensKey'''
-
Enter one of the following purposes:
+
|This field is mandatory and should be filled with aero ENS key.
-
'''P1''' - Business use for profit;
+
-
'''P2''' - Non-profit business, club, association, religious organization, etc;
+
-
'''P3''' - Personal use;
+
-
'''P4''' - Education purposes;
+
-
'''P5''' - Government purposes;
+
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.travel'''
+
|colspan="2" style="background-color:#EEEEEE;"|'''.es'''
|-
|-
|
|
-
'''uin'''
+
'''companyRegistrationNumber'''
-
|In order to register .TRAVEL domains the registrant has to provide a UIN "Unique Identification Number". The UIN can be provided to the registrant through an Association Authentification Partner (further information can be found at http://www.travel.travel/index.php/authenticate-register/).
+
|Required in case if domain requester is a legal entity
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.xxx'''
+
|
 +
'''socialSecurityNumber'''
 +
or
 +
'''passportNumber'''
 +
|Required in case if domain requester is a private individual
 +
|-
 +
|colspan="2" style="background-color:#EEEEEE;"|'''.eu, .ею and .ευ'''
|-
|-
|
|
-
'''communityId'''
+
'''whoisEmail'''
-
|This field is required to activate the domain by the member of the "Sponsored Community".
+
|Alternative e-mail, replacing the owner's e-mail in a web-based whois query
|-
|-
 +
|
 +
'''countryOfCitizenship'''
 +
|Country of citizenship of the domain holder, in case his residence address is in a country that is not eligible for .eu registrations.
 +
|-
 +
|colspan="2" style="background-color:#EEEEEE;"|'''.fi'''
 +
|-
 +
|
 +
'''orgType'''
 +
|Enter one of the following values:
 +
* 0 - Private person
 +
* 1 - Company
 +
* 2 - Corporation
 +
* 3 - Institution
 +
* 4 - Political party
 +
* 5 - Township
 +
* 6 - Government
 +
* 7 - Public community
 +
Organisation type must be specified for .fi registration.
 +
Note that the company registration number (companies), passport/ID number (Finnish private individuals) or birth date (foreign private individuals) are required.
 +
In all cases, the state/province is a required field as well.
 +
'''Tech handle''' must be a company with an a registration number filled in.
 +
|-
 +
|colspan="2" style="background-color:#EEEEEE;"|'''.hu'''
 +
|-
 +
|
 +
'''vat'''
 +
|Required in case if domain requester is a legal entity
 +
|-
 +
|
 +
'''passportNumber'''
 +
|Required in case if domain requester is a private individual
|-
|-
|colspan="2" style="background-color:#EEEEEE;"|'''.jobs'''
|colspan="2" style="background-color:#EEEEEE;"|'''.jobs'''
Line 53: Line 77:
|This field is optional, and describes the "industry class" with the next possible values => [2, 3, 21, 5, 4, 12, 6, 7, 13, 19, 10, 11, 15, 16, 17, 18, 20, 9, 26, 22, 14, 23, 8, 24, 25].
|This field is optional, and describes the "industry class" with the next possible values => [2, 3, 21, 5, 4, 12, 6, 7, 13, 19, 10, 11, 15, 16, 17, 18, 20, 9, 26, 22, 14, 23, 8, 24, 25].
Industry classes list:
Industry classes list:
-
2: Accounting/Banking/Finance;
+
* 2: Accounting/Banking/Finance;
-
3: Agriculture/Farming;
+
* 3: Agriculture/Farming;
-
4: Construction/Building Services;
+
* 4: Construction/Building Services;
-
5: Computer/Information Technology;
+
* 5: Computer/Information Technology;
-
6: Education/Training/Library;
+
* 6: Education/Training/Library;
-
7: Entertainment;
+
* 7: Entertainment;
-
8: Telemarketing;
+
* 8: Telemarketing;
-
9: Parks & Recreation;
+
* 9: Parks & Recreation;
-
10: Government/Civil Service;
+
* 10: Government/Civil Service;
-
11: Healthcare;
+
* 11: Healthcare;
-
12: Consulting;
+
* 12: Consulting;
-
13: Environmental;
+
* 13: Environmental;
-
14: Restaurant/Food Service;
+
* 14: Restaurant/Food Service;
-
15: HR/Recruiting;
+
* 15: HR/Recruiting;
-
16: Insurance;
+
* 16: Insurance;
-
17: Legal;
+
* 17: Legal;
-
18: Manufacturing;
+
* 18: Manufacturing;
-
19: Hospitality;
+
* 19: Hospitality;
-
20: Media/Advertising;
+
* 20: Media/Advertising;
-
21: Biotechnology/Science;
+
* 21: Biotechnology/Science;
-
22: Real Estate;
+
* 22: Real Estate;
-
23: Retail;
+
* 23: Retail;
-
24: Transportation;
+
* 24: Transportation;
-
25: Other;
+
* 25: Other;
-
26: Pharmaceutical;
+
* 26: Pharmaceutical;
|-
|-
|
|
Line 91: Line 115:
|This field is optional and should be filled with '''1''' if administrative contact is a member of the „Human Resource Organization“.
|This field is optional and should be filled with '''1''' if administrative contact is a member of the „Human Resource Organization“.
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.aero'''
+
|colspan="2" style="background-color:#EEEEEE;"|'''.no'''
|-
|-
|
|
-
'''ensAuthId'''
+
'''companyRegistrationNumber'''
-
|This field is mandatory and must be filled with [https://www.information.aero/node/add/request-aero-id aero authentication ID].
+
|Required in case if domain requester is a legal entity
|-
|-
|
|
-
'''ensKey'''
+
'''socialSecurityNumber'''
-
|This field is mandatory and should be filled with aero ENS key.
+
|Required in case if domain requester is a private individual
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.ru & .рф (xn--p1ai)'''
+
|colspan="2" style="background-color:#EEEEEE;"|'''.ro'''
 +
|-
 +
|
 +
'''companyRegistrationNumber'''
 +
|Required in case if domain requester is a legal entity
 +
|-
 +
|
 +
'''socialSecurityNumber'''
 +
|Required in case if domain requester is a private individual
 +
|-
 +
|colspan="2" style="background-color:#EEEEEE;"|'''.ru (also used for.рф (xn--p1ai))'''
|-
|-
|-
|-
Line 107: Line 141:
|-
|-
|
|
-
'''сompanyNameCyrillic'''
+
'''companyNameCyrillic'''
|Company name in cyrillic, filled according to the company registration documents.
|Company name in cyrillic, filled according to the company registration documents.
|-
|-
|
|
-
'''сompanyNameLatin'''
+
'''companyNameLatin'''
|Company name in latin.
|Company name in latin.
|-
|-
Line 236: Line 270:
|-
|-
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.ro, .no'''
+
|colspan="2" style="background-color:#EEEEEE;"|'''.sg, .com.sg'''
|-
|-
|
|
'''companyRegistrationNumber'''
'''companyRegistrationNumber'''
-
|Required in case if domain requester is a legal entity
+
|Required in case if domain requester country is 'SG'
 +
|-
 +
|colspan="2" style="background-color:#EEEEEE;"|'''.travel'''
|-
|-
|
|
-
'''socialSecurityNumber'''
+
'''uin'''
-
|Required in case if domain requester is a private individual
+
|In order to register .TRAVEL domains the registrant has to provide a UIN "Unique Identification Number". The UIN can be provided to the registrant through an Association Authentification Partner (further information can be found at http://www.travel.travel/index.php/authenticate-register/).
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.es'''
+
|colspan="2" style="background-color:#EEEEEE;"|'''.uk, .co.uk, .org.uk, .me.uk, .ltd.uk'''
|-
|-
|
|
-
'''companyRegistrationNumber'''
+
'''legalType'''
-
|Required in case if domain requester is a legal entity
+
|Enter one of the following abbreviations:
 +
* LTD (UK Limited Company)
 +
* PLC (UK Public Limited Company)
 +
* PTNR (UK Partnership)
 +
* STRA (UK Sole Trader)
 +
* LLP (UK Limited Liability Partnership)
 +
* IP (UK Industrial/Provident Registered Company)
 +
* IND (UK Individual)
 +
* SCH (UK School)
 +
* RCHAR (UK Registered Charity)
 +
* GOV (UK Government Body)
 +
* CRC (UK Corporation by Royal Charter)
 +
* STAT (UK Statutory Body)
 +
* FIND (Non-UK Individual)
 +
* FCORP (Non-UK Corporation)
 +
* FOTHER (Other Non-UK Entity (e.g. clubs, associations, many universities))
 +
* OTHER (Other UK Entity (e.g. clubs, associations, many universities))
|-
|-
-
|
+
|colspan="2" style="background-color:#EEEEEE;"|'''.us'''
-
'''socialSecurityNumber'''
+
-
or
+
-
'''passportNumber'''
+
-
|Required in case if domain requester is a private individual
+
-
|-
+
-
|colspan="2" style="background-color:#EEEEEE;"|'''.sg, .com.sg'''
+
|-
|-
|
|
-
'''companyRegistrationNumber'''
+
'''nexusCategory'''
-
|Required in case if domain requester country is 'SG'  
+
|Field is always required with next possible options => ['C11', 'C12', 'C21', 'C31', 'C32']
 +
* A natural person,
 +
** '''C11''' - Who is a United States citizen.
 +
** '''C12''' - Who is a permanent resident of the United States of America or any of its possessions or territories.
 +
* A U.S. Organization incorporated within one of the fifty (50) U.S. States, the District of Columbia, or any of the U.S. Possessions or territories or organized or otherwise constituted under the laws of a state of the United States of America, the District of Columbia or any of its possessions or territories or a U.S. Federal, state, or local government entity or a political subdivision thereof.
 +
** '''C21''' - U.S. Organization incorporated within one of the 50 states or a U.S. Territory
 +
* An entity or organization that has a bona fide presence in the United States of America or any of its possessions or territories.
 +
** '''C31''' - Regularly engages in lawful activities (sales of goods or services or other business, commercial or non-commercial, including not-for-profit relations in the United States).
 +
** '''C32''' - Entity has an office or other facility in the US.
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.ru'''
+
|'''applicantPurpose'''
 +
|This field is mandatory.
 +
Enter one of the following purposes:
 +
* '''P1''' - Business use for profit;
 +
* '''P2''' - Non-profit business, club, association, religious organization, etc;
 +
* '''P3''' - Personal use;
 +
* '''P4''' - Education purposes;
 +
* '''P5''' - Government purposes;
|-
|-
-
|
+
|colspan="2" style="background-color:#EEEEEE;"|'''.music'''
-
'''birthDate'''
+
-
|Required in case if domain requester is a private individual
+
|-
|-
|
|
-
'''passportNumber'''
+
'''musicNexusConnectionToMusic'''
-
|Required in case if domain requester is a private individual
+
|This field is always is mandatory
 +
* '''MSCN''' - Musician (solo/band/band member).
 +
* '''PRO''' - Industry Pro (songwriter/creator/other)
 +
* '''ENT''' - Music Entity (business/org/inc/llc/other)
 +
* '''EDU''' - Music Educator (teachers/instructors)
 +
* '''OTHER''' - Music Other (triggers audit sooner)
|-
|-
-
|colspan="2" style="background-color:#EEEEEE;"|'''.hu'''
+
|'''musicNexusRegistryPoliciesAttestation'''
 +
|This field is mandatory.
 +
Select one of the following options:
 +
* '''YES''' - YES;
 +
* '''NO''' - NO.
|-
|-
|
|
-
'''vat'''
+
'''communityId'''
-
|Required in case if domain requester is a legal entity
+
|This field is required to activate the domain by the member of the "Sponsored Community".
|-
|-
-
|
 
-
'''passportNumber'''
 
-
|Required in case if domain requester is a private individual
 
|}
|}

Current revision as of 12:12, 6 December 2024

Format specification > Customer Extension Additional Data

Overview of customer extension additional data which is required per TLD

Field Conditions
.aero

ensAuthId

This field is mandatory and must be filled with aero authentication ID.

ensKey

This field is mandatory and should be filled with aero ENS key.
.es

companyRegistrationNumber

Required in case if domain requester is a legal entity

socialSecurityNumber or passportNumber

Required in case if domain requester is a private individual
.eu, .ею and .ευ

whoisEmail

Alternative e-mail, replacing the owner's e-mail in a web-based whois query

countryOfCitizenship

Country of citizenship of the domain holder, in case his residence address is in a country that is not eligible for .eu registrations.
.fi

orgType

Enter one of the following values:
  • 0 - Private person
  • 1 - Company
  • 2 - Corporation
  • 3 - Institution
  • 4 - Political party
  • 5 - Township
  • 6 - Government
  • 7 - Public community

Organisation type must be specified for .fi registration. Note that the company registration number (companies), passport/ID number (Finnish private individuals) or birth date (foreign private individuals) are required. In all cases, the state/province is a required field as well.

Tech handle must be a company with an a registration number filled in.

.hu

vat

Required in case if domain requester is a legal entity

passportNumber

Required in case if domain requester is a private individual
.jobs

website

This field is mandatory and should be filled with the correct website URL of the organization.

industryClass

This field is optional, and describes the "industry class" with the next possible values => [2, 3, 21, 5, 4, 12, 6, 7, 13, 19, 10, 11, 15, 16, 17, 18, 20, 9, 26, 22, 14, 23, 8, 24, 25].

Industry classes list:

  • 2: Accounting/Banking/Finance;
  • 3: Agriculture/Farming;
  • 4: Construction/Building Services;
  • 5: Computer/Information Technology;
  • 6: Education/Training/Library;
  • 7: Entertainment;
  • 8: Telemarketing;
  • 9: Parks & Recreation;
  • 10: Government/Civil Service;
  • 11: Healthcare;
  • 12: Consulting;
  • 13: Environmental;
  • 14: Restaurant/Food Service;
  • 15: HR/Recruiting;
  • 16: Insurance;
  • 17: Legal;
  • 18: Manufacturing;
  • 19: Hospitality;
  • 20: Media/Advertising;
  • 21: Biotechnology/Science;
  • 22: Real Estate;
  • 23: Retail;
  • 24: Transportation;
  • 25: Other;
  • 26: Pharmaceutical;

adminType

This field is mandatory and should be filled with 1 if contact is the administrative contact with the permission to act as an independent agent/recruiter on behalf of the registrant. Or 0 in other case

contactTitle

This field is optional text field and can be filled with the title of the domain contact in the organization.

hrMember

This field is optional and should be filled with 1 if administrative contact is a member of the „Human Resource Organization“.
.no

companyRegistrationNumber

Required in case if domain requester is a legal entity

socialSecurityNumber

Required in case if domain requester is a private individual
.ro

companyRegistrationNumber

Required in case if domain requester is a legal entity

socialSecurityNumber

Required in case if domain requester is a private individual
.ru (also used for.рф (xn--p1ai))
If domain owner is a legal entity (company) and resident of Russian federation

companyNameCyrillic

Company name in cyrillic, filled according to the company registration documents.

companyNameLatin

Company name in latin.

mobilePhoneNumber

Mobile phone number with SMS function.

legalAddressCyrillic

Company legal address in cyrillic, filled according to the company registration documents.

postalAddressCyrillic

Company postal address in cyrillic.

taxPayerNumber

Tax payer number (INN).
If domain owner is a private person (or individual entrepreneur) and resident of Russian federation

firstNameCyrillic

First name of domain owner in cyrillic.

middleNameCyrillic

Middle name of domain owner in cyrillic.

lastNameCyrillic

Last name of domain owner in cyrillic.

firstNameLatin

First name of domain owner in latin.

middleNameLatin

Middle name of domain owner in latin.

lastNameLatin

Last name of domain owner in latin.

passportSeries

Passport series.

passportNumber

Passport number.

passportIssuer

Passport issuer.

passportIssueDate

Passport issue date.

birthDate

Domain owner birth date.

mobilePhoneNumber

Mobile phone number with SMS function.

legalAddressCyrillic

Legal address in cyrillic, filled from the passport information.

taxPayerNumber

Tax payer number (INN). Field is required only if domain owner is individual entrepreneur.
If domain owner is a legal entity (company) and is NOT resident of Russian federation

companyNameLatin

Company name in latin.

mobilePhoneNumber

Mobile phone number with SMS function.
If domain owner is private person and is NOT resident of Russian federation

firstNameLatin

First name of

domain owner in latin.

lastNameLatin

Last name of domain owner in latin.

passportSeries

Passport series.

passportNumber

Passport number.

passportIssuer

Passport issuer.

passportIssueDate

Passport issue date.

birthDate

Domain owner birth date.

mobilePhoneNumber

Mobile phone number with SMS function.
.sg, .com.sg

companyRegistrationNumber

Required in case if domain requester country is 'SG'
.travel

uin

In order to register .TRAVEL domains the registrant has to provide a UIN "Unique Identification Number". The UIN can be provided to the registrant through an Association Authentification Partner (further information can be found at http://www.travel.travel/index.php/authenticate-register/).
.uk, .co.uk, .org.uk, .me.uk, .ltd.uk

legalType

Enter one of the following abbreviations:
  • LTD (UK Limited Company)
  • PLC (UK Public Limited Company)
  • PTNR (UK Partnership)
  • STRA (UK Sole Trader)
  • LLP (UK Limited Liability Partnership)
  • IP (UK Industrial/Provident Registered Company)
  • IND (UK Individual)
  • SCH (UK School)
  • RCHAR (UK Registered Charity)
  • GOV (UK Government Body)
  • CRC (UK Corporation by Royal Charter)
  • STAT (UK Statutory Body)
  • FIND (Non-UK Individual)
  • FCORP (Non-UK Corporation)
  • FOTHER (Other Non-UK Entity (e.g. clubs, associations, many universities))
  • OTHER (Other UK Entity (e.g. clubs, associations, many universities))
.us

nexusCategory

Field is always required with next possible options => ['C11', 'C12', 'C21', 'C31', 'C32']
  • A natural person,
    • C11 - Who is a United States citizen.
    • C12 - Who is a permanent resident of the United States of America or any of its possessions or territories.
  • A U.S. Organization incorporated within one of the fifty (50) U.S. States, the District of Columbia, or any of the U.S. Possessions or territories or organized or otherwise constituted under the laws of a state of the United States of America, the District of Columbia or any of its possessions or territories or a U.S. Federal, state, or local government entity or a political subdivision thereof.
    • C21 - U.S. Organization incorporated within one of the 50 states or a U.S. Territory
  • An entity or organization that has a bona fide presence in the United States of America or any of its possessions or territories.
    • C31 - Regularly engages in lawful activities (sales of goods or services or other business, commercial or non-commercial, including not-for-profit relations in the United States).
    • C32 - Entity has an office or other facility in the US.
applicantPurpose This field is mandatory.

Enter one of the following purposes:

  • P1 - Business use for profit;
  • P2 - Non-profit business, club, association, religious organization, etc;
  • P3 - Personal use;
  • P4 - Education purposes;
  • P5 - Government purposes;
.music

musicNexusConnectionToMusic

This field is always is mandatory
  • MSCN - Musician (solo/band/band member).
  • PRO - Industry Pro (songwriter/creator/other)
  • ENT - Music Entity (business/org/inc/llc/other)
  • EDU - Music Educator (teachers/instructors)
  • OTHER - Music Other (triggers audit sooner)
musicNexusRegistryPoliciesAttestation This field is mandatory.

Select one of the following options:

  • YES - YES;
  • NO - NO.

communityId

This field is required to activate the domain by the member of the "Sponsored Community".
Retrieved from "https://doc.openprovider.eu/API_Format_Extensions_Additional_Data_Customer"
Views
Personal tools