reseller

is added when reseller has a customer specific business

Deleting a Contact

Description

Deletes the specified Contact.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
contact-id Integer Required The Contact that you want to delete

HTTP Method

POST

Example Test URL


https://test.httpapi.com/api/contacts/delete.json?auth-userid=0&api-key=key&contact-id=0

Response

Returns a hash map containing the below details:

  • Contact ID (entityid)

  • Action Type (actiontype)

  • Description of the Contact Deletion Action (actiontypedesc)

  • Action ID of the Contact Deletion Action (eaqid)

  • Contact Deletion Action Status (actionstatus)

  • Description of the Contact Deletion Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Associating Extra Details with a specified Contact

Description

Associates mandatory extra details with the specified Contact to register domain names under the TLDs below:

  • .ASIA


  • .BR


  • .CA


  • .COOP


  • .CN


  • .ES


  • .JOBS


  • .NL


  • .RU


  • .US

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key 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 .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. 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).


  • 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 .COOP domain name:

    Input should have value as ROID of Sponsor (Co-operative Reference) to be associated with the Contact ID as follows:

    attr-name1=sponsor1&attr-value1=12345

    Note

    This information has to be associated with Registrant Contact of the domain name.

  • To associate the Contact with a .CN domain name, the input can be:

    • attr-name1=organisationVerificationId&attr-value1={Mention any ID associated with the organization}
  • 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 .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

  • 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 (dotasia | dotca | dotcoop | dotes | dotjobs | dotnl | dotpro | dotru | domus).

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.

Getting the Default Contact Details

Description

Gets the details of the Default Contacts for the Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required The Customer for whom you want to get the Default Contacts
type Array of Strings Required Type of default contact to be returned. It can be one or more of following contacts types : Contact, CoopContact, UkContact, EuContact, CnContact, CoContact, CaContact, DeContact, EsContact.

HTTP Method

POST

Example Test URL


https://test.httpapi.com/api/contacts/default.json?auth-userid=0&api-key=key&customer-id=0&type=Contact&type=CnContact

Response

Returns a hash map containing the below details of the Default Contacts for each Contact Type requested:

  • registrantContactDetails / adminContactDetails / techContactDetails / billingContactDetails:

    • Contact ID (entity.entityid)

    • Name (contact.name)

    • Company (contact.company)

    • Contact Type (contact.type)

    • Email Address (contact.emailaddr)

    • Telephone Number Country Code (contact.telnocc)

    • Telephone Number (contact.telno)

    • First line of address of the Contact (contact.address1)

    • Second line of address of the Contact (contact.address2)

    • Third line of address of the Contact (contact.address3)

    • City (contact.city)

    • State (contact.state)

    • Country Code (contact.country)

    • ZIP Code (contact.zip)

    • Current Status in the System (entity.currentstatus)

    • Creation Date in the System (contact.creationdt)

    • Creation Date at the Registry (contact.timestamp)

    • Customer ID associated with the Contact (entity.customerid)

  • Registrant Contact ID (registrant)

  • Admin Contact ID (admin)

  • Tech Contact ID (tech)

  • Billing Contact ID (billing)

  • Contact Type (type)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Searching for Contacts

Description

This method provides detailed information of the contacts that match the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required The Customer for which you want to get the Contact Details
no-of-records Integer Required Number of Records to be returned
page-no Integer Required Page Number for which records are required
contact-id Array of Integers Optional Array of Contact Ids for listing of specific Contacts
status Array of Strings Optional List of Contact statuses. These can take any values from: InActive, Active, Suspended, Deleted
name String Optional Name of Contact
company String Optional Name of the Company
email String Optional Email address of the Contact
type String Optional Type of contact. Valid values are: Contact, CoopContact, UkContact, EuContact, Sponsor, CnContact, CoContact, CaContact, DeContact, EsContact.
include-invalid Boolean Optional Use this option to include details of invalid contacts. Such contacts are not returned by default.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/contacts/search.json?auth-userid=0&api-key=key&customer-id=0&contact-id=0&no-of-records=10&page-no=1

Response

Returns a hash map containing the below details of the Contacts that match the search criteria:

  • Number of Contacts requested matching the search criteria (recsonpage)

    Following details of each Contact:

    • Contact ID (entity.entityid)

    • Name (contact.name)

    • Company (contact.company)

    • Contact Type (contact.type)

    • Email Address (contact.emailaddr)

    • Telephone Number Country Code (contact.telnocc)

    • Telephone Number (contact.telno)

    • First line of address of the Contact (contact.address1)

    • Second line of address of the Contact (contact.address2)

    • Third line of address of the Contact (contact.address3)

    • City (contact.city)

    • State (contact.state)

    • Country Code (contact.country)

    • ZIP Code (contact.zip)

    • Current Status in the System (entity.currentstatus)

    • Creation Date in the System (contact.creationdt)

    • Creation Date at the Registry (contact.timestamp)

    • Customer ID associated with the Contact (entity.customerid)

    • Designated Agent Status (dastatus)

    • Contact validation details (whoisValidity), viz.

      • If this contact is valid (valid)

      • Invalid fields, if any (invalidData)

  • Number of Contacts in the System matching the search criteria (recsindb)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Note
  • Any contact that contains invalid information, such as an invalid ZIP code or country calling code, will not be included in the search results by default.
  • Unused Contacts (except Default Contacts) that were created more than six months ago are archived. This API call will not search for archived Contacts.
Additional Information

Default Contacts

Getting Contact Details

Description

Gets the details for the specified Contact.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
contact-id Integer Required The Contact Id for which details are required

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/contacts/details.json?auth-userid=0&api-key=key&contact-id=0

Response

Returns a hash map containing the below details:

  • Contact ID (entityid)

  • Name (name)

  • Company (company)

  • Contact Type (type)

  • Email Address (emailaddr)

  • Telephone Number Country Code (telnocc)

  • Telephone Number (telno)

  • First line of address of the Contact (address1)

  • Second line of address of the Contact (address2)

  • Third line of address of the Contact (address3)

  • City (city)

  • State (state)

  • Country Code (country)

  • ZIP Code (zip)

  • Current Status in the System (currentstatus)

  • Status at the Registry (contactstatus)

  • Customer ID associated with the Contact (customerid)

  • Reseller Chain by RID (parentkey)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Note

Unused Contacts (except Default Contacts) that were created more than six months ago are archived. This API call will not return details for archived Contacts.

Additional Information

Default Contacts

Modifying Contact Details

Attention

This API Call will be deprecated from 1st December 2016 due to IRTP changes in the system. Modifying a Contact is no longer allowed and only New Contacts can be created and associated with a domain.

Description

Modifies the details of the specified Contact.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
contact-id Integer Required Contact ID of the Contact whose details you want to modify
name String Required Name of Contact
company String Required Name of the Company
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
zipcode String Required ZIP code
phone-cc String Required Telephone number Country Code
phone String Required Telephone number
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).

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
  • You will encounter the below error message in case the Contact is associated with one or more suspended domain name(s):

    Attention

    Change of this contact is not allowed as it is associated with a suspended domain

  • Unused Contacts (except Default Contacts) that were created more than six months ago are archived. Details of archived Contacts cannot be modified using this API call.

    Additional Information

    Default Contacts

  • You may not modify the name, company and country for Contacts associated with a .AT domain name.

  • You may not modify through this API call any Contact Details of any of the Contacts, of a registered .ES domain name.

    If you wish to transfer the ownership of a .ES domain name to another entity, the transfer procedure needs to be followed.

    You may add another .ES Contact and select the same as the Admin, Technical and / or Billing Contact.

  • You may not modify through this API call any Contact Details of any of the Contacts, of a registered .NYC domain name.

    You may add another .NYC Contact and select the same as the Registrant, Admin, Technical and / or Billing Contact.

  • You may only modify the phone-cc, phone, fax-cc, fax and email
    values for Contacts associated with a .RU domain name. See details

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/contacts/modify.json?auth-userid=0&api-key=key&contact-id=0&name=abc&company=company&email=dummy@abc.com&address-line-1=address1&address-line-2=address2&city=city&country=nn&zipcode=0&phone-cc=0&phone=0

Response

Returns a hash map containing the below details:

  • Contact ID (entityid)

  • Action Type (actiontype)

  • Description of the Contact Modification Action (actiontypedesc)

  • Action ID of the Contact Modification Action (eaqid)

  • Contact Modification Action Status (actionstatus)

  • Description of the Contact Modification Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Add Contact

Description

Adds a Contact to the domain using the details provided.

Parameters

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

Note
  • Max length 255 characters (general) or 50 characters (.EU)

  • In case of AtContact, the Name should consist of at least two words.

company String Required

Name of the Company

Note
  • Max length 255 characters (general) or 100 characters (.EU)

  • In case of EuContact, if there is no associated Company, you may mention NA for this parameter.

  • 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 AtContact, if there is no associated Company, you may mention N/A, NA, Not Available or Not Applicable for this parameter.

email String Required Email address of the Contact
address-line-1 String Required First line of address of the Contact
Note
  • Max length 64 characters

  • For NycContact Contact type, a physical street address in the New York City must be provided.

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 (general) or 16 characters (.EU)

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:

  • Contact

  • AtContact

  • BrContact or BrOrgContact

  • CaContact

  • CnContact

  • CoContact

  • CoopContact

  • DeContact

  • EsContact

  • EuContact

  • MxContact

  • NlContact

  • NycContact

  • RuContact

  • UkContact or UkServiceContact

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

Note
  • Max length 64 characters

  • For EsContact contact type, mention one of the following provinces:

    • Albacete

    • Alicante

    • Almeria

    • Araba

    • Asturias

    • Avila

    • Badajoz

    • Barcelona

    • Bizkaia

    • Burgos

    • Caceres

    • Cadiz

    • Cantabria

    • Castellon

    • Ceuta

    • Ciudad Real

    • Cordoba

    • Coruña, A

    • Cuenca

    • Gipuzkoa

    • Girona

    • Granada

    • Guadalajara

    • Huelva

    • Huesca

    • Illes Balears

    • Jaen

    • Leon

    • Lleida

    • Lugo

    • Madrid

    • Malaga

    • Melilla

    • Murcia

    • Navarra

    • Ourense

    • Palencia

    • Palmas, Las

    • Pontevedra

    • Rioja, La

    • Salamanca

    • Santa Cruz de Tenerife

    • Segovia

    • Sevilla

    • Soria

    • Tarragona

    • Teruel

    • Toledo

    • Valencia

    • Valladolid

    • Zamora

    • Zaragoza

fax-cc String Optional Fax number country code
Note

Between 1-3 digits

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 .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 .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 .COOP domain name:

    Input should have value as ROID of Sponsor (Co-operative Reference) to be associated with the Contact ID as follows:

    attr-name1=sponsor1&attr-value1=12345

    Note

    This information has to be associated with Registrant Contact of the domain name.

  • To associate the Contact with a .CN domain name, the input can be:

    • attr-name1=organisationVerificationId&attr-value1={Mention any ID associated with the organization}
  • 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 .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

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

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&company=company&email=urname@domain.com&address-line-1=address1&city=city&country=nn&zipcode=0&phone-cc=0&phone=0&customer-id=0&type=Contact

Response

Returns the Contact Id (Integer) of newly added Contact. Multiple Contacts can be added for the same Name and Company Name behavior.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Sample error message when Single Field is invalid
{"status":"ERROR","message":"{telnocc=TelephoneNo Country Code is invalid}"}

Sample error message when Multiple Fields are invalid
{"status":"ERROR","message":"{telnocc=TelephoneNo Country Code is invalid, zip=Postal Code is invalid}"}

Contacts

Note

It is recommended, that you read TLD and their Contacts specific information, prior to visiting the below-mentioned
links. See details

Add Contact

Adds a Contact using the details provided for the specified type.

Modify Contact Details

Modifies the details of the specified Contact.

Get Contact Details

Gets all the Contact Details for the specified Contact.

Search Contacts

Gets the list of Contact Details which matches the Search criteria.

Get Default Contact

Gets the default Contact for the specified Customer.

Associate Extra Details

Associates extra details with the Contact, which are mandatory to register .US, .COOP, .ASIA domain names.

Delete

Deletes the specified Contact.

Add .COOP Sponsor

Adds a Sponsor for the specified .COOP domain name Customer.

Get Sponsors

Gets a list of system-default Sponsors and Sponsors of the specified Customer.

Getting a Customer's Default Name Servers

Description

Gets the default Name Servers of the specified Customer.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
customer-id Integer Required The Customer for whom you want to fetch the default Name Servers.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/customer-default-ns.json?auth-userid=0&api-key=key&customer-id=0

Response

Returns the Default Name Servers (Array of Strings) of the Customer.

Releasing a .UK Domain Name

Description

Releases (transfers out) the specified .UK domain name to the specified Registrar.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration Order which you want to release (transfer out)
new-tag String Required

Tag of the new Registrar. For a two character tag, it is necessary to prepend the tag with a # character.

Example: The tag VI needs to be mentioned as #VI.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/uk/release.json?auth-userid=0&api-key=key&order-id=0&new-tag=newregistrartag

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Description of the Domain Release Action (actiontypedesc)

  • Action ID of the Domain Release Action (eaqid)

  • Domain Release Action Status (actionstatus)

  • Description of the Domain Release Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.