reseller

is added when reseller has a customer specific business

Customers

Sign Up

Creates a Customer account.

Modify Customer Details

Modifies the details of the specified Customer.

Get Customer Details by Username

Gets the details of the specified Customer by specifying their Username (email address).

Get Customer Details by ID

Gets the details of the specified Customer by specifying their ID.

Generate Token

Authenticates Customer and returns an authentication token if user is authenticated successfully.

Authenticate Token

Authenticates token generated by the Generate Token method & returns the Customer details if authenticated.

Change Password

Changes the Customer's password.

Delete Customer

Deletes the specified Customer.

Getting .COOP Sponsors associated with a Customer

Description

Gets a list of system default .COOP Sponsors (Co-operative Reference) and associated Sponsor 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 get the list of Sponsors

HTTP Method

GET

Example Test URL Request


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

Response

Returns a hash map containing a list of system default .COOP Sponsors (Co-operative Reference) and associated Sponsor of the specified Customer, alongwith the below details:

  • Company (company)

  • Name (name)

  • Email Address (emailaddr)

  • Country (country)

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

Adding a .COOP Sponsor

Description

Adds a Sponsor (Co-operative Reference) for a specified Customer.

Note

You need to specify only a single Sponsor (Co-operative Reference).

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
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
country String Required Country Code as per ISO 3166-1 alpha-2
zipcode String Required ZIP code
phone-cc String Required Telephone number Country Code
phone String Required Telephone number
customer-id Integer Required The Customer under whom your are creating the Sponsor
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

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/contacts/coop/add-sponsor.json?auth-userid=0&api-key=key&name=abc&company=company&[email protected]&address-line-1=address1&city=city&country=nn&zipcode=0&phone-cc=0&phone=0&customer-id=0

Response

Returns the sponsor-id (Integer) of the newly added Sponsor. If a Sponsor exists with same Name and Company, then the existing sponsor-id is returned.

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:



  • .CA







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

Gets the Contact Details 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.

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)

  • 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

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

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

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 protected]&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)
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.
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

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

  • CaContact

  • CoContact

  • EuContact

  • MxContact

  • 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
fax-cc String Optional Fax number country code
Note

Between 1-3 digits
fax String Optional Fax number
Note

Between 4-12 digits

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 .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 .PRO domain name, input should have professional information to be associated with the Contact ID as follows:

    attr-name1=profession&attr-value1={Any of the values mentioned below}

    • Acupuncturists

    • Allied Health Professionals

    • Ambulance Services

    • Architects

    • Asbestos Removal Professionals

    • Barbers and Barber Shops

    • Certified Financial Analysts

    • Certified Financial Planners

    • Certified Public Accountants

    • Check Cashers

    • Chiropractors

    • Contractors, Home Improvement

    • Cosmetologists and Aestheticians

    • Debt Collectors

    • Dentists and Dental Hygienists

    • Dieticians and Nutritionists

    • Doctors

    • Educators

    • Electricians

    • Electrologists

    • Emergency Medical Technician

    • Engineers and Land Surveyors

    • Finance Companies

    • Financial Professional

    • Funeral Services

    • Health Care

    • Hearing Instrument Specialists

    • Home Inspectors

    • HVAC Technicians

    • Insurance

    • Investment Advisors

    • Landscape Architects

    • Lawyers

    • Lead Paint Inspectors

    • Manufactured Building Producers

    • Massage Therapy

    • Money Transmitters

    • Mortgage Lenders and Brokers

    • Municipal Building Inspectors

    • Nurses and Nurse Aides

    • Nursing Home Administrators

    • Nutritionists

    • Opticians

    • Optometrists

    • Perfusionist

    • Pharmacists

    • Physical Therapists

    • Physician Assistants

    • Physicians

    • Plumbers and Gas Fitters

    • Podiatrists

    • Psychologists

    • Public Relations

    • Radio and TV Technicians

    • Real Estate

    • Real Estate Appraisers

    • Respiratory Therapists

    • Sanitarians

    • Social Workers

    • Speech Pathologists and Audiologists

    • Veterinarians

    • Water Plant Operator

    • X-Ray Technicians

    • Internet Professional

    • Medical Professional

    • Legal Professional

    • Other (If your profession does not match any of the above mentioned values, you may provide your own value and it will be included under Other in our system.)

    Note

    This information has to be associated with Registrant Contact of the 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.

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 protected]&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.

Subscribe to reseller