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 mandatory extra details with the specified Contact to register domain names under the TLDs below:

  • .BR

  • .CN

  • .NL

  • .RU

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

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.