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. Sistem ga vedno dodeli samodejno.

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 = fizična oseba, CORP = podjetje)
• ident – identification value (PERS = datum rojstva v obliki LLLL-MM-DD, CORP = ID podjetja)
• 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. Sistem ga vedno dodeli samodejno.

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 = kontakt je bil uspešno ustvarjen
• 2201 = neveljaven tld
• 2216 = neveljavno ime kontakta
• 2218 = ime kontakta se ustvari samodejno
• 2219 = element podjetje ni izpolnjen
• 2220 = element z imenom ni izpolnjen
• 2221 = priimek ni izpolnjen
• 2222 = e-naslov ni izpolnjen
• 2223 = napačna oblika e-naslova
• 2224 = e-naslov2 ni izpolnjen
• 2225 = napačna oblika e-naslova2
• 2226 = telefon ni izpolnjen
• 2227 = napačna oblika telefona
• 2228 = faks ni izpolnjen
• 2229 = napačna oblika faksa
• 2230 = ID podjetja ni izpolnjen
• 2231 = ID podjetja je v napačni obliki
• 2232 = ID za DDV ni izpolnjen
• 2233 = ID za DDV je v napačni obliki
• 2234 = ulica ni izpolnjena
• 2235 = mesto ni izpolnjeno
• 2236 = Poštna številka ni izpolnjena
• 2237 = država ni izpolnjena
• 2238 = napačna oblika države
• 2239 = zvezna država ni izpolnjena
• 2240 = drugi podatki niso izpolnjeni
• 2241 = napačna oblika drugih podatkov
• 3228 = domena ne deluje s kontakti
• 3230 = ustvarjanje kontakta ni uspelo
• 3231 = ime kontakta je že v uporabi
• 3232 = kontakta ni mogoče uporabiti – razlog ni znan
• 3233 = kontakta ni mogoče uporabiti
• 3234 = kontakta ni mogoče uporabiti – v karanteni
• 3235 = kontakta ni mogoče uporabiti – rezerviran
• 3236 = kontakta ni mogoče uporabiti – blokiran
• 3237 = kontakt je pri nas že registriran
• 4211 = preverjanje kontakta ni uspelo – napaka pri komunikaciji
• 4213 = ustvarjanje kontakta ni uspelo – napaka pri komunikaciji

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 = neveljaven TLD
• 2207 = neveljavna skladnja v imenu kontakta
• 2216 = neveljavno ime kontakta
• 2219 = element podjetje ni izpolnjen
• 2220 = element ime ni izpolnjen
• 2221 = element priimek ni izpolnjen
• 2222 = element e-naslov ni izpolnjen
• 2223 = napačna oblika elementa e-naslov
• 2224 = element e-naslov2 ni izpolnjen
• 2225 = napačna oblika elementa e-naslov2
• 2226 = element telefon ni izpolnjen
• 2227 = napačna oblika elementa telefon
• 2228 = element faks ni izpolnjen
• 2229 = napačna oblika elementa faks
• 2230 = element matična številka ni izpolnjen
• 2231 = napačna oblika elementa matična številka
• 2232 = element davčna številka ni izpolnjen
• 2233 = napačna oblika elementa davčna številka
• 2234 = element ulica ni izpolnjen
• 2235 = element mesto ni izpolnjen
• 2236 = element poštna številka ni izpolnjen
• 2237 = element država ni izpolnjen
• 2238 = napačna oblika elementa država
• 2239 = element zvezna država ni izpolnjen
• 2240 = element drugi podatki ni izpolnjen
• 2241 = napačna oblika elementa drugi podatki
• 3211 = napaka – kontakta ni bilo mogoče pridobiti
• 3238 = napaka pri avtorizaciji
• 3239 = operacija ni uspela
• 4202 = kontakt ni na voljo – napaka povezave, poskusite znova pozneje
• 4215 = izvedba ni uspela – napaka povezave, poskusite znova pozneje

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 = neveljaven TLD
• 2215 = manjka parameter auth_info
• 2216 = neveljaven identifikator kontakta
• 2244 = Ta domena ne podpira prenosa kontakta
• 3229 = kontakt ni na voljo
• 3237 = kontakt je pri nas že registriran
• 3240 = napaka pri avtorizaciji
• 3241 = prenos ni uspel
• 4216 = neuspešno – napaka povezave

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 = neveljaven TLD
• 2216 = neveljavno ime kontakta
• 2243 = pošiljanje auth_info ni dovoljeno
• 3213 = kontakt ni na voljo
• 3215 = pošiljanje auth-id ni uspelo
• 3228 = kontakt za to domeno ni podprt
• 4217 = pošiljanje ni uspelo – napaka pri komunikaciji

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",
  }
}

Ali vam je bil ta članek v pomoč?

Vaše mnenje nam pomaga izboljšati naše članke.

DaNe

Bi nam radi sporočili kaj o tem članku? (neobvezno)

Vaše sporočilo prejme ekipa za dokumentacijo, ki nanj ne odgovarja. Če potrebujete pomoč, nas kontaktirajte prek kontaktnega obrazca. Ne vpisujte gesel ali osebnih podatkov.

Tega polja ne izpolnjujte