WAPI – Domain Contacts

In this article, you will find information on managing domain contacts with the following supported TLDs:

• CZ
• EU
• SK
• PL
• gTLD a nTLD

and also on the following commands:

• contact-check – check contact availability
• contact-info – list contact information
• contact-create – create new contact
• contact-update – edit contact data
• contact-transfer – transfer contact from another registrar
• contact-send-auth-info – send contact AUTH-ID

---

Domain Contacts by Individual Registries

Each domain registry manages contacts differently, there are different rules for contact identifiers, mandatory items in the details and so on.

CZ Domains

When creating a contact for a CZ domain, you can specify a name. Use the contact-check to check if the chosen name is available (not used, blocked, ..).

The contact name can only contain uppercase letters of the English alphabet, numbers and a hyphen. If you do not specify a name when creating a contact, the system will generate one automatically.

In the contact detail, you can set:

• cname – contact name (only when creating a new one); omit this parameter or leave blank it to generate a pseudo-random name)
• company
• fname – name – required
• lname – surname – required
• email – required
• phone – phone number +XXX XXXXXXXXX
• fax – fax number +XXX XXXXXXXXX
• dic – VAT ID
• addr_street – street address and house number – required
• addr_city – city address – required
• addr_zip – ZIP code – required
• addr_country – country (two-letter ISO code, lowercase) – required
• addr_state – state or region
• ident_type – type of ID document (ico (company ID), op (personal ID), birthday (date of birth in DD.MM.YYYY format), passport, mpsv (MPSV ID))
• ident – ID document number (depending on ident_type)
• notify_email – notification email address
• disclose_phone – hide phone
• disclose_fax – hide fax
• disclose_email – hide email
• disclose_ident – hide ID document number
• disclose_notify_email – hide notification email

For CZ domain contacts, it is possible to hide some items in the contact details. Use the disclose_* entries in the contact detail with a 0/1 flag (1 = hidden, 0 = public) to specify whether that information should be hidden. If this information is flagged as hidden, it cannot be viewed without authorization.

From mid-January 2018, you can set a delivery address for CZ domain contacts. When creating/editing a contact, enter the following items:

• del_addr=1 – acive delivery address (required)
• del_addr_street1 – street (required)
• del_addr_street2 – street (optional)
• del_addr_street3 – street (optional)
• del_addr_city – city (required)
• del_addr_state – state or region
• del_addr_country – country (two-letter ISO code, lowercase) (required)

To deactivate the delivery address for a contact, enter del_addr=0 when creating/editing a contact.

EU Domains

When creating a contact in the EURid registry, you cannot specify its name. Система завжди призначає його автоматично.

In the contact detail, you can set:

• company
• fname – name – required
• lname – surname – required
• email – required
• phone – phone number +XXX XXXXXXXXX
• fax – fax number +XXX XXXXXXXXX
• dic – VAT ID
• addr_street – street address and house number – required
• addr_city – city address – required
• addr_zip – ZIP code – required
• addr_country – country (two-letter ISO code, lowercase) – required
• addr_state – state or region

SK Domains

When creating a contact for an SK domain, you can specify a name. Use the contact-check to check if the chosen name is available (not used, blocked, ..).

The contact name can only contain uppercase letters of the English alphabet, numbers, dashes and periods. The minimum length of the contact name is 5 characters, the maximum length is 16 characters. If you do not specify a name when creating a contact, the system will generate it automatically. The format of the automatically generated contact name is WEDOS-XXX-YYYY (where XXX is a combination of letters and numbers and YYYY is only digits).

In the contact detail, you can set:

• cname – contact name (only when creating a new one); omit this parameter or leave blank it to generate a pseudo-random name)
• company
• fname – name – required
• lname – surname – required
• email – required
• phone – phone number +XXX XXXXXXXXX
• fax – fax number +XXX XXXXXXXXX
• dic – VAT ID
• addr_street – street address and house number – required
• addr_city – city address – required
• addr_zip – ZIP code – required
• addr_country – country (two-letter ISO code, lowercase) – required
• addr_state – state or region
• ident_type – subject type, can be set only once (PERS = фізична особа, CORP = компанія)
• ident – identification value (PERS = дата народження у форматі РРРР-ММ-ДД, CORP = ідентифікаційний номер компанії)
• disclose_name – hide name
• disclose_org – hide company name
• disclose_addr – hide adsress
• disclose_phone – hide phone
• disclose_fax – hide fax
• disclose_email – hide email address

PL Domains

When creating a PL contact, you cannot specify its name. Система завжди призначає його автоматично.

In the contact detail, you can set:

• company
• fname – name, cannot be changed for legal_type = individual – required
• lname – surname, cannot be changed for legal_type = individual – required
• email – required
• phone – phone number +XXX XXXXXXXXX
• fax – fax number +XXX XXXXXXXXX
• dic – VAT ID
• addr_street – street address and house number – required
• addr_city – city address – required
• addr_zip – ZIP code – required
• addr_country – country (two-letter ISO code, lowercase) – required
• addr_state – state or region
• legal_type – legal type (company, individual), cannot be changed – required

gTLD and nTLD Domains

When creating a contact for gTLD and nTLD domains, you cannot specify its name, the system creates it automatically.

In the contact detail, you can set:

• company
• fname – name – required
• lname – surname – required
• email – required
• phone – phone number +XXX XXXXXXXXX
• fax – fax number +XXX XXXXXXXXX
• dic – VAT ID
• addr_street – street address and house number – required
• addr_city – city address – required
• addr_zip – ZIP code – required
• addr_country – country (two-letter ISO code, lowercase) – required
• addr_state – state or region

---

contact-check

Use the contact-check request to verify the availability of a contact name.

Parameters

• tld – TLD to create the contact for (e.g. eu)
• cname – contact name

Return Values

• 1000 – contact is free and can be used
• 2201 – invalid TLD
• 2216 – invalid contact format
• 2218 – name is generated automatically (for some TLD can not specify a contact name)
• 3231 – contact already exists
• 3233 – contact cannot be used
• 3234 – contact cannot be used – in quarantine
• 3235 – contact cannot be used – reserved
• 3236 – contact cannot be used – blocked
• 4211 – verification failed – communication error, repeat the command later

Response Data

The request returns no data.

Templates

JSON request:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "contact-check",
    "clTRID": "your ID",
    "data": {
      "tld": "tld",
      "cname": "contact id"
    }
  }
}

JSON response (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "contact-check"
  }
}

---

contact-info

The contact-info command returns detailed information about a contact.

Parameters

• tld – TLD – required
• cname – contact name – required
• auth_info – contact AUTH-ID – optional (if the domain supports it, entering the AUTH-ID will reveal the contact’s hidden data)
• reg_key – registry ID – optional

Return Values

• 1000 – contact Information received successfully
• 2201 – invalid TLD
• 2216 – invalid contact syntax 
• 3215 – contact send auth info failed
• 3228 – unsupported value
• 3229 – error loading contact
• 3236 – contact blocked
• 4212 – connection error
• 5001 – not logged in

Response Data

If successful (code 1000), the command returns information about the contact in the contact node.

Templates

JSON request (CZ.NIC contact):

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "contact-info",
    "clTRID": "your ID",
    "data": {
      "tld": "cz",
      "cname": "contact-id",
      "auth_info": "auth-info-string",
      "reg_key": "cznic",
    }
  }
}

JSON response (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "contact-info",
    "data": {
      "contact": {
        "contact_id": "contact id",
        "status": "status",
        "name": "name and surname",
        "company": "company",
        "addr_street": "street and number",
        "addr_city": "city",
        "addr_zip": "zip code",
        "addr_state": "state or region",
        "addr_country": "country iso code",
        "phone": "full phone number",
        "email": "email",
        "fax": "full fax number",
        "reg_owner": "",
        "reg_creator": "",
        "reg_update": "",
        "created_date": "YYYY-MM-DD hh:mm:ss",
        "updated_date": "YYYY-MM-DD hh:mm:ss",
        "transfer_date": "YYYY-MM-DD hh:mm:ss",
        "fname": "name",
        "lname": "surname",
        "email2": "",
        "ic": "company id",
        "dic": "vat id",
        "taxpayer": "",
        "disclose": "",
        "other": {
          "notify_email": "",
          "ident_type": "",
          "ident": ""
        }
      }
    }
  }
}

JSON response (Contact not found):

{
  "response":
  {
    "code":3215,
    "result":"Contact send auth info failed",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command":"contact-info"
  }
}

---

contact-create

Use the contact-create request to create a new contact that you can use with your domains registered with the corresponding registry. Each contact is identified by its name, which is always unique. You can find more information about working with contacts with individual registries in the chapter Domain Contacts by Individual Registries.

Parameters

• tld – domain TLD
• contact – array of contact items:
  • cname – contact name (empty = generate automatically)
  • fname – name
  • lname – surname
  • company – company
  • addr_street – street and house number
  • addr_city – city
  • addr_zip – zip code
  • addr_state – state or region
  • addr_country – country (two-letter ISO code, lowercase)
  • phone
  • fax
  • email
  • other items depending on registry

Return Values

• 1000 = контакт успішно створено
• 2201 = недійсний tld
• 2216 = недійсне ім’я контакту
• 2218 = назву контакту створено автоматично
• 2219 = не заповнено елемент «компанія»
• 2220 = назву елемента не заповнено
• 2221 = прізвище не заповнено
• 2222 = e-mail не заповнено
• 2223 = e-mail вказано в неправильному форматі
• 2224 = email2 не заповнено
• 2225 = email2 вказано в неправильному форматі
• 2226 = телефон не заповнено
• 2227 = телефон вказано в неправильному форматі
• 2228 = fax не заповнено
• 2229 = fax вказано в неправильному форматі
• 2230 = не вказано ідентифікаційний номер компанії
• 2231 = неправильний формат ідентифікаційного номера компанії
• 2232 = Не вказано номер платника ПДВ
• 2233 = Неправильний формат номера платника ПДВ
• 2234 = вулицю не заповнено
• 2235 = не вказано місто
• 2236 = Не вказано поштовий індекс
• 2237 = країну не заповнено
• 2238 = країну вказано в неправильному форматі
• 2239 = область не заповнено
• 2240 = інші дані не заповнено
• 2241 = інші дані вказано в неправильному форматі
• 3228 = домен не працює з контактами
• 3230 = не вдалося створити контакт
• 3231 = назву контакту вже використано
• 3232 = контакт не можна використати – причина невідома
• 3233 = контакт не можна використати
• 3234 = контакт не можна використати – у карантині
• 3235 = контакт не можна використати – зарезервовано
• 3236 = контакт не можна використати – заблоковано
• 3237 = контакт у нас уже зареєстровано
• 4211 = не вдалося перевірити контакт – помилка зв’язку
• 4213 = не вдалося створити контакт – помилка зв’язку

Response Data

The contact returns the following data:

• cname – created contact name

Templates

JSON request:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "contact-create",
    "clTRID": "your ID",
    "data": {
      "tld": "cz",
      "contact": {
        "fname": "name",
        "lname": "surname",
        "email": "email",
        "addr_street": "street and number",
        "addr_city": "city",
        "addr_zip": "zip code",
        "addr_country": "country ISO code",
        "phone": "full phone number",
        "notify_email": "notification email"
      }
    }
  }
}

JSON response (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "contact-create",
    "data": {
      "cname": "contact id"
    }
  }
}

---

contact-update

Use the contact-update request to edit contact entries.

You can find more information about working with contacts with individual registries in the chapter Domain Contacts by Individual Registries.

Parameters

• tld – TLD
• cname – contact name
• auth_info – AUTH-ID
• contact – contact items
  • fname – name
  • lname – surname
  • company
  • addr_street – street and number
  • addr_city – city
  • addr_zip – zip code
  • addr_state – state or region
  • addr_country – country (two-letter ISO code, lowercase)
  • phone
  • fax
  • email
  • other items according to registry

Return Values

• 1000 = OK
• 2201 = недійсний TLD
• 2207 = недійсний синтаксис в імені контакту
• 2216 = недійсне ім’я контакту
• 2219 = не заповнено елемент «компанія»
• 2220 = не заповнено елемент «ім’я»
• 2221 = не заповнено елемент «прізвище»
• 2222 = не заповнено елемент «e-mail»
• 2223 = неправильний формат елемента «e-mail»
• 2224 = не заповнено елемент «email2»
• 2225 = неправильний формат елемента «email2»
• 2226 = не заповнено елемент «телефон»
• 2227 = неправильний формат елемента «телефон»
• 2228 = не заповнено елемент «fax»
• 2229 = неправильний формат елемента «fax»
• 2230 = не заповнено елемент «ідентифікаційний код компанії»
• 2231 = неправильний формат елемента «ідентифікаційний код компанії»
• 2232 = не заповнено елемент «ІПН»
• 2233 = неправильний формат елемента «ІПН»
• 2234 = не заповнено елемент «вулиця»
• 2235 = не заповнено елемент «місто»
• 2236 = не заповнено елемент «поштовий індекс»
• 2237 = не заповнено елемент «країна»
• 2238 = неправильний формат елемента «країна»
• 2239 = не заповнено елемент «область»
• 2240 = не заповнено елемент «інші дані»
• 2241 = неправильний формат в інших даних
• 3211 = помилка – не вдалося отримати контакт
• 3238 = помилка авторизації
• 3239 = операцію не вдалося виконати
• 4202 = контакт недоступний – помилка з’єднання, спробуйте пізніше
• 4215 = не вдалося виконати – помилка з’єднання, спробуйте пізніше

Response Data

The request returns no data.

Templates

JSON příkaz:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "contact-update",
    "clTRID": "your ID",
    "data": {
      "tld": "cz",
      "contact": {
        "fname": "name",
        "lname": "surname",
        "email": "email",
        "addr_street": "street and number",
        "addr_city": "city",
        "addr_zip": "zip code",
        "addr_country": "country ISO code",
        "phone": "full phone number",
        "notify_email": "email"
      }
    }
  }
}

JSON response (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "contact-update",
  }
}

contact-transfer

Use the contact-transfer request to transfer a contact from another registrar to WEDOS.

Parameters

• tld – TLD
• cname – contact name
• auth_info – AUTH-ID

Return Values

• 1000 = OK
• 2201 = недійсний TLD
• 2215 = відсутній параметр auth_info
• 2216 = недійсний ідентифікатор контакту
• 2244 = Цей домен не підтримує перенесення контакту
• 3229 = контакт недоступний
• 3237 = контакт у нас уже зареєстровано
• 3240 = помилка авторизації
• 3241 = не вдалося перенести
• 4216 = не вдалося – помилка з’єднання

Response Data

The request returns no data.

Templates

JSON request:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "contact-transfer",
    "clTRID": "your ID",
    "data": {
      "tld": "cz",
      "cname": "contact id",
      "auth_info": "auth-id"
    }
  }
}

JSON response (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "contact-transfer",
  }
}

---

contact-send-auth-info

Use the contact-send-auth-info request to send an email with the contact AUTH-ID.

Parameters

• tld – TLD
• cname – contact name

Return Values

• 1000 = OK
• 2201 = недійсний TLD
• 2216 = недійсне ім’я контакту
• 2243 = надсилання auth_info не дозволено
• 3213 = контакт недоступний
• 3215 = не вдалося надіслати auth-id
• 3228 = контакт не підтримується для цього домену
• 4217 = не вдалося надіслати – помилка зв’язку

Response Data

The request returns no data.

Templates

JSON request:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "contact-send-auth-info",
    "clTRID": "your ID",
    "data": {
      "tld": "tld",
      "cname": "contact id",
    }
  }
}

JSON response (OK):

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "contact-send-auth-info",
  }
}

Чи була ця стаття корисною?

Ваша оцінка допомагає нам покращувати статті.

ТакНі

Хочете щось повідомити нам про цю статтю? (необов’язково)

Ваше повідомлення прочитає редакція документації, але вона на нього не відповідає. Якщо вам потрібна допомога, звертайтеся до нас через контактну форму. Не вказуйте тут паролі чи особисті дані.

Не заповнюйте це поле