Name |
Data Type |
Required / Optional |
Description |
auth-userid |
Integer |
Required |
Authentication Parameter |
api-key |
String |
Required |
Authentication Parameter |
name |
String |
Required |
Name of the Contact
|
company |
String |
Required |
Name of the Company
Note
-
Max length 255 characters
-
In case of RuContact, the Company Name should have at least 2 words.
If there is no associated Company, you may mention N A or Not Applicable for this parameter. You will encounter the following error message, if values containing a single word such as NA or N/A are mentioned:
Attention
Company Name should contain at least two words.
- In case of EsContact, the company parameter is only required if the registrant is a non-individual/ company. If the registrant is an natural person/ individual, please do not pass the company parameter in the API request while creating a registrant contact.
Additionally, since the Administrative, Technical and Billing contacts must be natural persons/individuals only, please ensure you do not pass the company parameter in the API request while creating these contacts.
|
email |
String |
Required |
Email address of the Contact |
address-line-1 |
String |
Required |
First line of address of the Contact
|
city |
String |
Required |
Name of the City
Note
Max length 64 characters
|
country |
String |
Required |
Country code as per ISO 3166-1 alpha-2
Note
For UkServiceContact Contact type, the country code can only be GB (United Kingdom), IM (Isle of Man), JE (Jersey) or GG (Guernsey).
|
zipcode |
String |
Required |
ZIP code
Note
Max length 10 characters
Attention
ZIP Code will be validated against the Country selected during the contact create process. An invalid zipcode will return an error message.
|
phone-cc |
String |
Required |
Telephone number country code
Note
Between 1-3 digits
Attention
Only valid telephone number country code will be accepted.
|
phone |
String |
Required |
Telephone number
Note
Between 4-12 digits (general) or between 4-13 digits (.RU)
|
customer-id |
Integer |
Required |
The Customer under whom you want to create the Contact |
type |
String |
Required |
The Contact Type. This can take following values:
|
address-line-2 |
String |
Optional |
Second line of address of the Contact |
address-line-3 |
String |
Optional |
Third line of address of the Contact |
state |
String |
Optional |
Name of the State
|
fax-cc |
String |
Optional |
Fax number country code
|
fax |
String |
Optional |
Fax number
Note
Between 4-12 digits (general) or between 4-13 digits (.RU)
|
attr-name |
Map[name] |
Optional |
Mapping key of any extra information to be associated for the contact that is being added. Refer the description of attr-value. |
attr-value |
Map[value] |
Required |
Mapping value of the extra details required to be associated with a particular Contact before registering a domain name. This together with attr-name shall contain the extra details.
-
To associate the Contact with a .BR domain name, the input can be:
attr-name1=organisationId&attr-value1={Organisation ID}
Note
-
Organisation ID: Only Brazilian nationals or organizations can register .BR domains. Hence, a tax ID (CPF in case of an individual contact) or an organisation ID (CNPJ in case of a company contact) of the person/organisation needs to be supplied for the Registrant contact (BrOrgContact). The tax/organization ID must either not be currently registered in our database or it should be a transferred authority to the registrar through the .BR registry web interface.
-
In addition, depending on the contact, you will need to specify the “type” as BrOrgContact (for the Registrant contact) or BrContact (for the Admin/technical/Billing contact). The Admin, technical and Billing contact should not be associated with the organization ID mentioned above. This is only needed for the Registrant contact.
-
To associate the Contact with a .CA domain name, the input can be:
attr-name1=CPR&attr-value1={Three-letter CPR code mentioned below}
CPR |
Description |
Type |
CCO |
Corporation (Canada or Canadian province or territory) |
Non-individual |
CCT |
Canadian citizen |
Individual |
RES |
Permanent Resident of Canada |
Individual |
GOV |
Government or government entity in Canada |
Non-individual |
EDU |
Canadian Educational institution |
Non-individual |
ASS |
Canadian Unincorporated Association |
Non-individual |
HOP |
Canadian Hospital |
Non-individual |
PRT |
Partnership Registered in Canada |
Non-individual |
TDM |
Trade-mark registered in Canada (by a non-Canadian owner) |
Non-individual |
TRD |
Canadian Trade union |
Non-individual |
PLT |
Canadian Political party |
Non-individual |
LAM |
Canadian Library, Archive or Museum |
Non-individual |
TRS |
Trust established in Canada |
Non-individual |
ABO |
Aboriginal Peoples (individuals or groups) indigenous to Canada |
Individual |
INB |
Indian Band recognized by the Indian Act of Canada |
Non-individual |
LGR |
Legal Representative of a Canadian Citizen or Permanent Resident |
Individual |
OMK |
Official mark registered in Canada |
Non-individual |
MAJ |
Her Majesty the Queen |
Non-individual |
attr-name2=AgreementVersion&attr-value2={Value of the GetRegistrantAgreement version}
attr-name3=AgreementValue&attr-value3={'y' indicating that the Registrant has agreed to the .CA Registrant Agreement}
Note
This information should be associated with the Registrant Contact of the domain name.
-
To associate the Contact with a .ES domain name, the input can be:
-
es_form_juridica: The Registrant Contact of a .ES domain name may either be a natural person/individual or a company. However, the Admin, Technical and Billing Contacts must be natural persons/individuals only.
Value |
Legal Entity Type |
1 |
Natural person or individual |
39 |
Economic Interest Grouping |
47 |
Association |
59 |
Sports Association |
68 |
Trade Association |
124 |
Savings Bank |
150 |
Community Property |
152 |
Condominium |
164 |
Religious Order or Institution |
181 |
Consulate |
197 |
Public Law Association |
203 |
Embassy |
229 |
Municipality |
269 |
Sports Federation |
286 |
Foundation |
365 |
Mutual Insurance Company |
434 |
Provincial Government Body |
436 |
National Government Body |
439 |
Political Party |
476 |
Trade Union |
510 |
Farm Partnership |
524 |
Public Limited Company / Corporation |
525 |
Sports Public Limited Company |
554 |
Partnership |
560 |
General Partnership |
562 |
Limited Partnership |
566 |
Cooperative |
608 |
Worker-owned Company |
612 |
Limited Liability Company |
713 |
Spanish (company) Branch |
717 |
Temporary Consortium / Joint Venture |
744 |
Worker-owned Limited Company |
745 |
Provincial Government Entity |
746 |
National Government Entity |
747 |
Local Government Entity |
877 |
Others |
878 |
Designation of Origin Regulatory Council |
879 |
Natural Area Management Entity |
attr-name1=es_form_juridica&attr-value1={Any of the values mentioned above}
-
es_tipo_identificacion: Provide either of the following identification details:
Type of ID |
Explanation |
Value |
DNI or NIF |
Provide either the Spanish National Personal ID or company VAT ID number. |
1 |
NIE |
Provide the Spanish resident alien ID number |
3 |
Other ID |
If you do not have any of the above mentioned IDs, provide either your Passport number, any Foreign ID document number, Company Registration number, Driver’s License number, etc. |
0 |
attr-name2=es_tipo_identificacion&attr-value2={Any of the values mentioned above}
-
es_identificacion: Depending upon which es_tipo_identificacion you provided, mention that ID's number as a value.
attr-name3=es_identificacion&attr-value3=1
-
You need to pass the country of citizenship if the registrant is an individual/natural person and the country of residence is not one of the EU/EEA countries or in EU territories:
attr-name1=countryOfCitizenship&attr-value1={Two-lettered country code}
Note
List of two-letter country codes
- AT,BE, BG, CY, CZ, DE, DK, ES, EE, FI, FR, GR, HR, HU, IE, IT, LT, LU, LV, MT, NL, PL, PT, RO, SE, SI, SK
-
To associate the Contact with a .JOBS domain name, the input can be:
attr-name1=title&attr-value1={Title of the Contact in the Company} attr-name2=website&attr-value2={Company Website} attr-name3=industry_type&attr-value3={Type / Classification of the industry in which the company conducts its business} attr-name4=is_admin_contact&attr-value4={true | false} attr-name5=is_association_member&attr-value5={true | false}
Note
This information has to be associated with all Contacts of the .JOBS domain name.
-
To associate the Contact with a .NL domain name, the input can be:
attr-name1=legalForm&attr-value1={PERSOON | ANDERS}
Note
This information has to be associated with all Contacts of the .NL domain name.
-
To associate the Contact with a .RU domain name, the input can be:
- contract-type: This value indicates that the Contact Type is an Organization. Use PRS for Individual. It is mandatory to send this name-value pair.
attr-name1=contract-type&attr-value1=ORG
- birth-date: The value needs to be sent as numerals in DD.MM.YYYY format. It is mandatory to send this name-value pair for Individual Contact Type.
attr-name2=birth-date&attr-value2=08.08.1900
- org-r: This value indicates the legally registered company name as mentioned in the Company Formation documents. This value needs to include at least 2 words and is mandatory for the Organization Contact Type.
attr-name3=org-r&attr-value3=some company
- person-r: This is the Registrant's full name (preferably in Russian). It is mandatory to send this name-value pair for Individual Contact Type.
attr-name4=person-r&attr-value4=FirstName LastName
- address-r: This value indicates the Registrant's address (preferably in Russian). This value needs to include at least 2 words and is mandatory for the Organization Contact Type.
attr-name5=address-r&attr-value5=Some Address
- kpp: This value is the Territory-linked Taxpayer number. This is a 9 digit number and is mandatory for the Organization Contact Type, when the Country is Russia.
attr-name6=kpp&attr-value6=123456789
- code: This value is the Taxpayer Identification Number (TIN). This is a 10 digit number and is mandatory for Organization Contact Type, when the Country is Russia.
attr-name7=code&attr-value7=0987654321
- passport: This is value needs to include the Document number, Issued by, Issued Date details. It is mandatory to send this name-value pair for Individual Contact Type.
attr-name8=passport&attr-value8=12 34 567890, issued by the 123 police station of Moscow, 30.01.1990
|