.. _epp-domain-check:

Domain Check
============

Command allows to check availability of a domain name before attempting a :ref:`domain:create <epp-domain-create>` request to register it.
Command follows standard EPP Domain name mapping, `RFC-5731`_, without extensions.

Client request
--------------

The only parameter is a list of ``domain:name`` elements, containing domain name in :term:`ACE-encoded form <ACE-encoded domain name>` or IDN (UTF-8) form.
(e.g., "xn--elja-cva35d.lv" and "želēja.lv" means the same domain name and either form can be used).

.. note ::

   up to 30 domain names can be provided in one request.

.. code-block :: xml

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
      <command>
        <check>
          <domain:check
           xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
           xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd">

             <domain:name>example-test-arcijsg.lv</domain:name>
             <domain:name>three.part.lv</domain:name>
             <domain:name>StillAFreeName.lv</domain:name>
             <domain:name>doMĒns.lv</domain:name>
             <domain:name>xn--doMns-kza.lv</domain:name>
             <domain:name>-badsyntax-</domain:name>
          </domain:check>
        </check>
        <clTRID>GiPX8nh0DVn3nZp6pSem</clTRID>
      </command>
    </epp>

Server response
---------------

For each ``domain:name`` given in the request, the server responds with a ``domain:cd`` tag containing a
``domain:name`` element with:

* ``avail`` attribute set to "1" if a domain name is currently available for new registrations.
* or ``avail`` attribute set to "0" if the domain is either reserved, already in use, it's syntax was bad or
  the Registry does not allow this type of domain names to be registered.
  In this case, also a ``domain:reason`` element will be present containing a human-readable
  an explanation of why the name is not available.

Example to the above request:

.. code-block :: xml

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">

      <response>
        <resData>
          <domain:chkData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" xsi:schemaLocation="urn:ietf:params:xml:ns:domain-1.0 domain-1.0.xsd">

            <domain:cd>
              <domain:name avail="0">example-test-account.lv</domain:name>
              <domain:reason>Domain name is in use</domain:reason>
            </domain:cd>
            <domain:cd>
              <domain:name avail="0">three.part.lv</domain:name>
              <domain:reason>Not a valid LV domain name</domain:reason>
            </domain:cd>
            <domain:cd>
              <domain:name avail="1">StillAFreeName.lv</domain:name>
            </domain:cd>
            <domain:cd>
              <domain:name avail="1">doMĒns.lv</domain:name>
            </domain:cd>
            <domain:cd>
              <domain:name avail="1">xn--doMns-kza.lv</domain:name>
            </domain:cd>
            <domain:cd>
              <domain:name avail="0">-badsyntax-</domain:name>
              <domain:reason>Not a valid LV domain name</domain:reason>
            </domain:cd>
          </domain:chkData>
        </resData>
        <result code="1000">
          <msg>Command completed successfully</msg>
        </result>
        <trID>
          <clTRID>GiPX8nh0DVn3nZp6pSem</clTRID>
          <svTRID>LVNIC-20110604-316caa1120aa07ffa57963d71257a722-4</svTRID>
        </trID>
      </response>
    </epp>


.. include:: /ref_links.rst