Domain Request EPP

Sends the Request EPP command to the registrar for the domain

Connects to the registrar and attempts to obtain the EPP Code for the domain. Not all registrars return the EPP code but send them directly to the client.


Method URI

Request Parameters

Parameter Type Description Required
HTTP headers: Authorization string Bearer + the token to access APIs Required
domainid integer The id of the domain to obtain the EPP for Required w/o domainname
domainname string The name of the domain to obtain the EPP for Required w/o domainid

Response Parameters

Parameter Type Description
result string The result of the operation: success or error
eppcode string If supported, the EPP code. No returned EPP code without error suggests it is sent directly to client. A returned EPP code may include HTML character entities intended for display and should be decoded prior to any direct use.

Example Request (PHP Curl)


                    $curl = curl_init();
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                                    'domainid' = > 1,
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;


Example Request (jQuery AJAX)

                    var form = new FormData();
                    form.append("domainid", "1");

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form

                    $.ajax(settings).done(function (response) {

Example Response (JSON payload)

                        "result": "success",

Error Responses

Possible error condition responses include:

  • Domain ID Not Found
  • Registrar Error Message