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. Il sistema lo assegna sempre automaticamente.

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 = persona fisica, CORP = azienda)
• ident – identification value (PERS = data di nascita nel formato AAAA-MM-GG, CORP = ID azienda)
• 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. Il sistema lo assegna sempre automaticamente.

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 = contatto creato correttamente
• 2201 = tld non valido
• 2216 = nome del contatto non valido
• 2218 = il nome del contatto viene creato automaticamente
• 2219 = voce società non compilata
• 2220 = il nome della voce non è compilato
• 2221 = cognome non compilato
• 2222 = e-mail non compilata
• 2223 = formato dell’e-mail non valido
• 2224 = e-mail2 non compilata
• 2225 = formato di e-mail2 non valido
• 2226 = telefono non compilato
• 2227 = formato del telefono non valido
• 2228 = fax non compilato
• 2229 = formato del fax non valido
• 2230 = ID azienda non compilato
• 2231 = formato dell’ID azienda non valido
• 2232 = Partita IVA non compilata
• 2233 = Formato della partita IVA non valido
• 2234 = via non compilata
• 2235 = città non compilata
• 2236 = CAP non compilato
• 2237 = paese non compilato
• 2238 = formato del paese non valido
• 2239 = provincia/stato non compilato
• 2240 = altri dati non compilati
• 2241 = formato degli altri dati non valido
• 3228 = il dominio non gestisce i contatti
• 3230 = creazione del contatto non riuscita
• 3231 = il nome del contatto è già in uso
• 3232 = il contatto non può essere utilizzato – motivo sconosciuto
• 3233 = il contatto non può essere utilizzato
• 3234 = il contatto non può essere utilizzato – in quarantena
• 3235 = il contatto non può essere utilizzato – riservato
• 3236 = il contatto non può essere utilizzato – bloccato
• 3237 = il contatto è già registrato presso di noi
• 4211 = verifica del contatto non riuscita – errore di comunicazione
• 4213 = creazione del contatto non riuscita – errore di comunicazione

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 non valido
• 2207 = sintassi non valida nel nome del contatto
• 2216 = nome del contatto non valido
• 2219 = voce società non compilata
• 2220 = voce nome non compilata
• 2221 = voce cognome non compilata
• 2222 = voce e-mail non compilata
• 2223 = formato non valido della voce e-mail
• 2224 = voce e-mail2 non compilata
• 2225 = formato non valido della voce e-mail2
• 2226 = voce telefono non compilata
• 2227 = formato non valido della voce telefono
• 2228 = voce fax non compilata
• 2229 = formato non valido della voce fax
• 2230 = voce ID società non compilata
• 2231 = formato non valido della voce ID società
• 2232 = voce partita IVA non compilata
• 2233 = formato non valido della voce partita IVA
• 2234 = voce via non compilata
• 2235 = voce città non compilata
• 2236 = voce CAP non compilata
• 2237 = voce paese non compilata
• 2238 = formato non valido della voce paese
• 2239 = voce provincia/stato non compilata
• 2240 = voce altri dati non compilata
• 2241 = formato non valido della voce negli altri dati
• 3211 = errore – recupero del contatto non riuscito
• 3238 = errore di autorizzazione
• 3239 = operazione non riuscita
• 4202 = contatto non disponibile – errore di connessione, riprova più tardi
• 4215 = esecuzione non riuscita – errore di connessione, riprova più tardi

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 non valido
• 2215 = parametro auth_info mancante
• 2216 = identificatore del contatto non valido
• 2244 = Questo dominio non supporta il trasferimento del contatto
• 3229 = il contatto non è disponibile
• 3237 = il contatto è già registrato presso di noi
• 3240 = errore di autorizzazione
• 3241 = trasferimento non riuscito
• 4216 = non riuscito – errore di connessione

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 non valido
• 2216 = nome del contatto non valido
• 2243 = non è consentito inviare auth_info
• 3213 = il contatto non è disponibile
• 3215 = invio di auth-id non riuscito
• 3228 = il contatto non è supportato per questo dominio
• 4217 = invio non riuscito – errore di comunicazione

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

Questo articolo le è stato utile?

Il suo giudizio ci aiuta a migliorare i nostri articoli.

SìNo

Desidera scriverci qualcosa su questo articolo? (facoltativo)

Il suo messaggio viene letto dal team della documentazione, che però non risponde. Se ha bisogno di aiuto, contattici tramite il modulo di contatto. Non inserisca password né dati personali.

Lasci vuoto questo campo