reseller

is added when reseller has a customer specific business

Modifying Customer Details

Description

Modifies the Account details 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 Customer Id of the Customer whose details need to be modified
username String Required Username for the Customer account. Username should be an email address.
name String Required Name of the Customer
company String Required Company name of the Customer
address-line-1 String Required Address line 1 of the Customer's address
city String Required City
state String Required State. In case the State information is not available, you need to pass the value for this parameter as Not Applicable.
other-state String Optional

This parameter needs to be included if the State information is not available.

Mention an appropriate value for this parameter.

country String Required Country Code as per ISO 3166-1 alpha-2
zipcode String Required ZIP code
phone-cc String Required Phone number Country Code
phone String Required Phone number
lang-pref String Required Language Code as per ISO
address-line-2 String Optional Address line 2 of the customer's address
address-line-3 String Optional Address line 3 of the Customer's address
alt-phone-cc String Optional Alternate phone Country Code
alt-phone String Optional Alternate phone number
fax-cc String Optional Fax number Country Code
fax String Optional Fax number
mobile-cc String Optional Mobile country code
mobile String Optional Mobile number
vat-id String Optional VAT ID for EU VAT

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/customers/modify.json?auth-userid=0&api-key=key&customer-id=0&[email protected]&name=name&company=company&lang-pref=en&address-line-1=address-line-1&city=city&state=state&country=US&zipcode=0000&phone-cc=0&phone=000000

Response

Returns true (Boolean) if the Customer's Account details are modified successfully.

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

Signing Up

Description

Creates a Customer Account using the details provided.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
username String Required Username for the Customer Account. Username should be an email address.
passwd String Required

Password for the Customer Account.

name String Required Name of the Customer
company String Required Name of the Customer's company
address-line-1 String Required Address line 1 of the Customer's address
city String Required City
state String Required State. In case the State information is not available, you need to pass the value for this parameter as Not Applicable.
other-state String Optional

This parameter needs to be included if the State information is not available.

Mention an appropriate value for this parameter.

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 Phone number
lang-pref String Required Language Code as per ISO
address-line-2 String Optional Address line 2 of the Customer's address
address-line-3 String Optional Address line 3 of the Customer's address
alt-phone-cc String Optional Alternate phone country code
alt-phone String Optional Alternate phone number
fax-cc String Optional Fax number country code
fax String Optional Fax number
mobile-cc String Optional Mobile country code
mobile String Optional Mobile number
sms-consent Boolean Optional In case of a US based customer, consent is required to receive renewal reminder SMSes
vat-id String Optional VAT ID for EU VAT
accept-policy Boolean Optional Accept Terms and Conditions and Privacy Policy to create an account
marketing-email-consent Boolean Optional In case of EEA (European Economic Area) countries capture consent to receive marketing emails

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/customers/v2/signup.xml?auth-userid=0&api-key=key&[email protected]&passwd=password9&name=name
&company=company&address-line-1=address-line-1&city=city&state=state&country=US&zipcode=0000&phone-cc=0&phone=000000&lang-pref=en

Response

Creates a Customer Account and returns the Customer ID (Integer) of the newly added Customer.

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

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.

Modifying a Sub-Reseller's Profile Details

You may update your Sub-Reseller's Profile Details by following the below mentioned process:

  1. Search for the Sub-Reseller and proceed to the Sub-Reseller Details view. See details

  2. In the Sub-Reseller Details views, click the Modify button.

  3. Here, you can modify the Sub-Reseller's Profile Details.

  4. Click the Modify button to submit the changes.

Note
  • This process allows you to modify your Sub-Reseller's Email Address (Username of his Control Panel) if the existing Email Address is no
    longer in use or your Sub-Reseller has lost control over it.

  • The Personal Identification Number (PIN) of your Sub-Reseller cannot be modified.

Modifying a Customer's Profile Details

You may update your Customer's Profile Details by following the below mentioned process:

  1. Search for the Customer and proceed to the Customer Details view. See details

  2. In the Customer Details view, click the Modify button.

  3. Here, you can modify the Customer's Profile Details.

  4. Click the Modify button to submit the changes.

Note
  • This process allows you to modify your Customer's Email Address
    (Username of his Control Panel) if the existing Email Address is no
    longer in use or your Customer has lost control over it.

  • The Personal Identification Number (PIN) of your Customer cannot be modified.

Change your Personal Identification Number (PIN)

When you sign up for a Reseller Account with firstfoot Interactive Pvt Ltd.,
an email containing the Account details will be sent to you. The Account details
include a numeric code known as Personal Identification Number (PIN).
The PIN will also be listed in the Reseller
Profile Details view, which can be accessed by clicking on the icon at the top right corner of the page and then
clicking on Your Account & Security within your Reseller Control Panel. firstfoot Interactive Pvt Ltd.
may request you to authenticate yourself through this PIN, when you request
support.

You can easily modify your Personal
Identification Number (PIN) by following the below
process:

  1. Log in to your Reseller Control Panel. See details

  2. Click on the icon at the top right corner of the page and then click on Your Account & Security.

  3. On the Account & Security page, under the Security section, click on View / Change your PIN.

  4. In the modal window click on the Change link and enter a new PIN.

      Note

      You need to consider the following, in relation with your Personal Identification Number (PIN):

      • The PIN should consist of 4 numeric characters.

      • Change the PIN on a regular basis.

      • Avoid using a PIN that contains personal information (social security number, birth date, etc.).

      • Avoid using repeating (1111) or sequential (1234) numbers.

      • Do not disclose your PIN to any unauthorized person.

  5. Click on the Change PIN button to submit your change.

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

Attention

This API Call has been deprecated. Associating extra details with a specified contact is no longer allowed and only New Contacts can be created and associated with a domain while associating extra details.

Description

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

  • .ASIA


  • .BR


  • .CA



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