Description
Associates mandatory extra details with the specified Contact to register .US, .COOP, .ASIA, .CA, .ES, .RU, .PRO and .NL domain names.
Parameters
Name |
Data Type |
Required / Optional |
Description |
auth-userid |
Integer |
Required |
Authentication Parameter |
api-key or auth-password |
String |
Required |
Authentication Parameter |
contact-id |
Integer |
Required |
The Contact with which you want to associate extra details |
attr-name |
Map[name] |
Required |
Mapping key of the extra details to be associated for the specified Contact. 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 .ASIA domain name:
The input can be:
attr-name1=locality&attr-value1;={Two-lettered Country code}
attr-name2=legalentitytype&attr-value2;={naturalPerson | corporation | cooperative | partnership | government | politicalParty | society | institution | other}
attr-name3=otherlegalentitytype&attr-value3;={Mention legal entity type. Mandatory if legalentitytype chosen as 'other'}
attr-name4=identform&attr-value4;={passport | certificate | legislation | societyRegistry | politicalPartyRegistry | other}
attr-name5=otheridentform&attr-value5;={Mention Identity form. Mandatory if identform chosen as 'other'}
attr-name6=identnumber&attr-value6;={Mention Identification Number}]
Note
This information can be associated with any one of the Contacts of the domain name.
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 hide/display the details associated with the Registrant Contact of a .CA domain name:
The input can be:
attr-name1=privateWhois&attr-value1;={true | false}
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
To associate the Contact with a .NL domain name:
The input can be:
attr-name1=legalForm&attr-value1;={PERSOON | ANDERS}
Note
This information gets associated with all Contacts of the .NL domain name.
To associate the Contact with a .PRO domain name:
To associate the Contact with a .US domain name:
Pipe-separated values are the Registry defined constants. Select any one of the given set of values.
You have to mention the values where the set of pre-defined values are not provided.
Example:
attr-name1=purpose&attr-value1;={P1 | P2 | P3 | P4 | P5}&attr-name2;=category&attr-value2;={C11 | C12 | C21 | C31 | C32}]
Following is the mapping of the .US Nexus Category (category):
C11: A natural person who is a United States citizen.
C12: A natural person who is a permanent resident of the United States of America, or any of its possessions or territories.
C21: A US-based organization or company (A US-based organization or company formed within one of the fifty (50) U.S. states, the District of Columbia, or any of the United States 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).
C31: A foreign entity or organization (A foreign entity or organization that has a bona fide presence in the United States of America or any of its possessions or territories who 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 United States.
Following is the mapping of the .US Nexus Application Purpose (purpose):
P1 : Business use for profit
P2: Non-profit business, club, association, religious organization, etc
P3: Personal use
P4: Education purposes
P5: Government purposes
Note
This information has to be associated with the Registrant Contact of the domain name.
|
product-key |
Array of Strings |
Required |
The product keys for which the details are to be associated. They can be one of the set (domus | dotcoop | dotasia | dotca | dotes | dotpro | dotnl). |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/contacts/set-details.json?auth-userid=0&api-key;=key&contact-id;=0&attr-name1;=sponsor1&attr-value1;=0&product-key;=dotcoop
Response
Returns true (Boolean) if the extra details are successfully associated with the specified Contact; false otherwise.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.