Contacts
For a complete list of contact handle prefixes used across all TLDs, please refer to the Contact Prefix Reference Table
query-contact-list
Accepts:
| pattern | pattern to match (against handle) |
| from | start from this item in list |
| to | end by this item in list |
| tld | limits output to contact handles which may be used with specified toplevel domain (tld), like "com". |
| extended-format | provides additional information for every contact listed: name & organization. May be "1" or "0", defaults to "0" |
Returns:
List of registered contacts (handles), one per line.
When "extended-format" is requested, output columns are separated by tabs ("\t"), and "Columns" header provides column names.
Example:
https://dmapi.joker.com/request/query-contact-list?pattern=coco-47*&tld=com&auth-sid=<your-current-session-id>
contact-create
Requires:
| tld | target TLD where this contact is intended to be used. |
| name | full name (if empty, fname + lname will be used) |
| fname | first name (required for .FI contacts) |
| lname | last name (required for .FI contacts) |
| title | (optional) |
| individual | (optional) Y, Yes, N, No |
| organization | (optional if individual) |
| email address of the contact | |
| address-1 | street address |
| address-2 | (optional) |
| city | |
| state | (optional) |
| postal-code | |
| country | ISO country code (2 letters) |
| phone | |
| fax | (optional) |
| lang | language to use for .EU contacts |
|
app-purpose |
required for .US contacts |
|
nexus-category |
required for .US contacts |
| nexus-category-country | required for .US contacts |
| account-type | required for .UK contacts, if used as owner contact |
| company-number |
required for .UK contacts with specific account types |
| orgid |
required for .SE/.NU contacts |
| vatid |
(optional) for .SE/.NU contacts |
| x-ficora-type |
required for .FI contacts |
| x-ficora-is-finnish | (yes/no) required for .FI contacts |
| x-ficora-registernumber | required for .FI contacts, if ficora-type is company |
| x-ficora-identity | required for .FI contacts, if type is person and finnish |
| x-ficora-birthdate | required for .FI contacts, if type is persion and not finnish |
| x-ficora-legalemail | (optional) for .FI contacts |
Either "name" or "lname" and "fname" must be provided.
Fields not marked '(optional)' are mandatory (and must not be empty).
Parameters "lname" and "fname", if provided, will be converted to "name" (simple concatenation of "fname" and "lname"), because registries support only "name" format. In general, use of "fname" and "lname" is deprecated, and support for these fields will be removed in version 1.2.
"orgid" represents Swedish personal or organisational number and is required for .SE/.NU contacts.
It starts with ISO 3166 Alpha-2 country code in square brackets. If the country code for Sweden is given [SE] a valid Swedish personal or organisational number must be given (6 digits, dash, 4 digits), otherwise 1 to 123 characters can follow.
If organization is empty and the country code for Sweden [SE] is given, orgid must be a personal number, not an organisational number.
"vatid" is optional for .SE/.NU contacts. It starts with a two letter country code (uppercase), followed by an optional space, followed by a country specific string containing digits 0-9, and letters a-z and A-Z, maximum 64 Chars.
For .fi contacts:
"x-ficora-type" is required for .fi contacts. The following values are accepted: privateperson, company, corporation, institution, politicalparty, township, government, publiccommunity
"x-ficora-registernumber" is required if x-ficora-type is set to "company".
"x-ficora-is-finnish" is always required for .fi contacts: yes = finnish company or person, no = not a finnish person or company
"x-ficora-identity" is required for .fi contacts, if x-ficora-type is set to 'privateperson' and x-ficora-is-finnish is set to 'yes'
"x-ficora-birthdate" is required for .fi contacts, if x-ficora-type is set to 'privateperson' and x-ficora-is-finnish is set to 'no' in the following date format "YYYY-MM-DD".
For .uk contacts:
"account-type" is a required for all .UK contacts which will be used as domain owner contacts. Possible values are:
| Value | Meaning |
| LTD | UK Limited Company |
| PLC | UK Public Limited Company |
| PTNR | UK Partnership |
| STRA | UK Sole Trader |
| LLP | UK Limited Liability Partnership |
| IP | UK Industrial/Provident Registered Company |
| IND | UK Individual (representing self) |
| SCH | UK School |
| RCHAR | UK Registered Charity |
| GOV | UK Government Body |
| CRC | UK Corporation by Royal Charter |
| STAT | UK Statutory Body |
| OTHER | UK Entity that does not fit into any of the above (e.g. clubs, associations, many universities) |
| FIND | Non-UK Individual (representing self) |
| FCORP | Non-UK Corporation |
| FOTHER | Non-UK Entity |
By default, if "account-type" is not provided, value "FIND" or "IND" will be used
(dependent "country" value - for GB and UK it will be "IND", for everything else "FIND").
"company-number" is required when "account-type" is one of: SCH, RCHAR, LTD, PLC, LLP, IP
Known extensions, grouped by TLD
.be
| Extension | Value | Meaning |
|---|---|---|
| x-be-lang | (en|fr|nl) | Language for emails from the registry to contact. |
| x-be-type | (owner|admin|tech|licensee|onsite) | type for the contact |
| x-be-vatid | Vatid of the company |
.ca
| Extension | Value |
|---|---|
| x-ca-legal-type | (ABO|ASS|CCO|CCT|EDU|GOV|HOP|INB|LAM|LGR|MAJ|OMK|PLT|PRT|RES|TDM|TRD|TRS) |
.cn
| Extension | Value | Meaning |
|---|---|---|
| x-cn-owner-id-number | [\x20-\xff]{1,30} | Passport ID or company ID from official docs |
| x-cn-owner-id-type | (SFZ|HZ|GAJMTX|TWJMTX|WJLSFZ|GAJZZ|TWJZZ|JGZ|QT|ORG|QT|YYZZ|TYDM|BDDM|JDDWFW|SYDWFR|WGCZJG|SHTTFR|ZJCS|MBFQY|JJHFR|LSZY|WGZHWH|WLCZJG|SFJD|JWJG|SHFWJG|MBXXBX|YLJGZY|GZJGZY|BJWSXX|QTTYDM) | for I only (SFZ, HZ, GAJMTX, TWJMTX, WJLSFZ, GAJZZ, TWJZZ, JGZ, QT) allowed! |
| x-cn-owner-type | (E|I) | E=Enterprise, I=Individual |
at, co.at, or.at
| Extension | Value | Meaning |
|---|---|---|
| x-atnic-type | (privateperson|role|organisation) | type for the contact |
.uk, .co.uk, .me.uk, .net.uk, .plc.uk, .org.uk, .ltd.uk
| Extension | Value | Meaning |
|---|---|---|
| x-nominet-trading-name | [\x20-\xff]{1,50} | The trading name of the organization |
| x-nominet-company-no | [\x20-\xff]{1,30} | The registered company number |
| x-nominet-type | (LTD|PLC|PTNR|STRA|LLP|IP|IND|SCH|RCHAR|GOV|CRC|STAT|OTHER|FIND|FCORP|FOTHER) | account type |
.de
| Extension | Value | Meaning |
|---|---|---|
| x-de-type | (person|role|org) | type for the contact |
.dk
| Extension | Value | Meaning |
|---|---|---|
| x-dk-user-id-number | .* | user id for .dk domains |
| x-dk-user-type | (COMPANY|PERSON|PUBORG|ASSOCIATION) | user type for .dk domains |
.eu, .xn--e1a4c, .xn--qxa6a
| Extension | Value | Meaning |
|---|---|---|
| x-eu-natural-person | (true|false) | if set it is used |
| x-eu-country-of-citizenship | [A-Z]{2,2} | country code |
| x-eu-lang | (bg|cs|da|de|el|en|es|et|fi|fr|ga|hr|hu|it|lt|lv|mt|nl|pl|pt|ro|sk|sl|sv) | Sets the domain owners language displayed in the EURid WHOIS. |
| x-eu-type | (owner|admin|onsite) | type for the contact |
.fi
| Extension | Value | Meaning |
|---|---|---|
| x-ficora-birthdate | \d{4}-\d{2}-\d{2} | birthdate for owner contact |
| x-ficora-identity | ([\w\-]{5,20}) | identity number of private individuals |
| x-ficora-is-finnish | (yes|no) | Is it a Finnish person or company? |
| x-ficora-legalemail | if type=company, it must be present | |
| x-ficora-registernumber | .{3,30} | registration number for companies |
| x-ficora-role | (billing|admin|tech|owner) | role of contact |
| x-ficora-type | (association|privateperson|company|corporation|institution|politicalparty|township|government|publiccommunity|municipality) | type of contact |
.fr
| Extension | Value | Meaning |
|---|---|---|
| x-fr-announce | \d+ | "The ""announce"" attribute shows the number of the announcement(e.g. 5). Only digits allowed" |
| x-fr-birthcity | [\x20-\xff]{1,30} | Only for natural persons born in France... |
| x-fr-birthdate | \d{4}-\d{2}\-d{2} | The registrant's birthdate |
| x-fr-birthpc | [\x20-\xff]{1,30} | postcode of the place of birth |
| x-fr-birthplace | [A-Z]{2} | birthplace country code |
| x-fr-date-association | \d{4}-\d{2}\-d{2} | date of association |
| x-fr-date-publication-jo | \d{4}-\d{2}\-d{2} | date of publication JO |
| x-fr-duns | [\x20-\xff]{1,30} | Company DUNS |
| x-fr-local | [\x20-\xff]{1,30} | Company Local |
| x-fr-numero-de-page-announce-jo | \d+ | page number of announcement |
| x-fr-restrict-pub | \d{1} | 0=show, 1=do not show |
| x-fr-siren-or-siret | [\x20-\xff]{1,30} | SIREN/SIRET number |
| x-fr-trademark | [\x20-\xff]{1,30} | Trademark number |
| x-fr-vatid | [\x20-\xff]{1,30} | Company VAT ID |
| x-fr-waldec | \d+ | Waldec ID |
.ie
| Extension | Value | Meaning |
|---|---|---|
| x-ie-applicant | .* | Name of applicant |
| x-ie-applicant-class | (Company|Business Owner|Club/Band/Local Group| School/College|State Agency|Blogger/Other) |
.it
| Extension | Value |
|---|---|
| x-it-consentforpublishing | [0|1] |
| x-it-entity-type | [1|2|3|4|5|6|7] |
| x-it-pin | (.*) |
| x-it-sect3-liability | [0|1] |
| x-it-sect5-personal-data-for-registration | [0|1] |
| x-it-sect6-personal-data-for-diffusion | [0|1] |
| x-it-sect7-explicit-acceptance | [0|1] |
.nl
| Extension | Value | Meaning |
|---|---|---|
| x-nl-legal-form | (ANDERS|BGG|BRO|BV|BVI/O|COOP|CV|EENMANSZAAK|EESV|KERK|MAATSCHAP|NV|OWM|PERSOON|REDR|STICHTING|VERENIGING|VOF) | legal form of the contact |
| x-nl-legal-form-registration-no | [\x20-\xff]{1,30} | registration number of the company. |
.nu
| Extension | Value | Meaning |
|---|---|---|
| x-iinu-orgid | [\x20-\xff]{1,30} | organisation id for the contact |
| x-iinu-vatid | [\x20-\xff]{1,30} | vatid for the contact |
.se, .pp.se
| Extension | Value | Meaning |
|---|---|---|
| x-iise-vatid | [\x20-\xff]{1,30} | vatid for the contact |
| x-iise-orgid | [\x20-\xff]{1,30} | organisation id for the contact |
.sk
| Extension | Value | Meaning |
|---|---|---|
| x-sk-contact-ident-number | .* | commercial registration number for companies; personal ID for natural persons |
| x-sk-contact-legal-form | (CORP|PERS) | CORP=Company/org; PERS=natural person |
.us
| Extension | Value | Meaning |
|---|---|---|
| x-us-app-purpose | [Pp][12345] | .us purpose of contact |
| x-us-nexus-category | ([Cc])(11|12|21|31|32) | .us nexus category |
| x-us-nexus-category-country | !@country | .us nexus category country |
.xxx
| Extension | Value | Meaning |
|---|---|---|
| x-xxx-membership-token | [\x20-\xff]{1,30} | Registrar tag for domains |
Please note:
- Parameters listed here (except "tld") may be used (or are required) in other requests, this is indicated by referring to "Contact fields".
- "lang" must contain two-letter ISO country (language) code, and is only required when creating .EU contacts. The purpose is to specify language to be used in notifications emails, sent from EURid. Please note - this field cannot be modified later, and the default is 'EN' (English)!
- "app-purpose", "nexus-category" and "nexus-category-contry" are required only when creating .US contacts, and cannot be modified later.
Example:
https://dmapi.joker.com/request/contact-create?tld=com&name=John Doe&email=johnd@someisp.com&address-1=Smartroad 1&city=Smalltown&postal-code=40122&country=US&phone=+1.422.8001&auth-sid=<your-current-session-id
contact-modify
Requires:
| handle | contact handle to modify. |
Accepts:
Field names exactly like in contact-create request, except that omitted fields won't be modified. That is, if you specify a field, it will be used as a new value, if you omit it, the old value will remain.
The field "tld" is not relevant for this request and will be ignored if present.
contact-delete
Requires:
| handle | contact handle to delete |
With this request you can delete previously registered contacts
Example:
https://dmapi.joker.com/request/contact-delete?handle=coco-4711&auth-sid=<your-current-session-id>