Wooxy API v.3.0

Verify Domain

The Verify Domain method allows you to verify your domain with a single request after the necessary records have been added.

Request

POST

https://api.wooxy.com/v3/domain/verify

IMPORTANT: Do not send more than 10 concurrent API requests.

Body Example

                                        {
            "domainId": "YOUR_DOMAIN_ID",
            "domain": "YOUR_DOMAIN",
        }

Parameters

Title	Type	Default	Description
domainId optional	string		Unique identifier of the domain that needs to be verified. One of the parameters (domainId or domain) is required.
domain optional	string		The domain that needs to be verified. One of the parameters (domainId or domain) is required.

Response

                                        {
  "result": true,
  "data": {
    "id": "YOUR_DOMAIN_ID",
    "domain": "YOUR_DOMAIN",
    "dnsSubdomain": "YOUR_SUBDOMAIN",
    "emailVerified": false,
    "dnsVerified": true,
    "warmupStatus": 1,
    "warmupDay": 0,
    "createdAt": "2013-07-13 13:53:31",
    "dnsRecords": [
      {
        "type": "RECORD_TYPE",
        "name": "RECORD_NAME",
        "value": "RECORD_VALUE"
      },
      {
        "type": "RECORD_TYPE",
        "name": "RECORD_NAME",
        "value": "RECORD_VALUE"
      },
      {
        "type": "RECORD_TYPE",
        "name": "RECORD_NAME",
        "value": "RECORD_VALUE"
      }
    ]
  },
  "resolve": [
    {
      "type": "RECORD_TYPE",
      "name": "RECORD_NAME",
      "value": "RECORD_VALUE",
      "presentInZone": true,
      "isValid": true,
      "error": ""
    },
    {
      "type": "RECORD_TYPE",
      "name": "RECORD_NAME",
      "value": "RECORD_VALUE",
      "presentInZone": true,
      "isValid": true,
      "error": ""
    },
    {
      "type": "RECORD_TYPE",
      "name": "RECORD_NAME",
      "value": "RECORD_VALUE",
      "presentInZone": true,
      "isValid": true,
      "error": ""
    }
  ]
}

Parameters

Title	Type	Description
result	boolean	Indicated that the query was successful or not: true: The value indicates that the query was successful. false: The value indicates that the query wasn't successful.
data	object	Object with data about the domain being verified.
data.id	string	Unique identifier of the verified domain.
data.domain	string	Title of the verified domain.
data.dnsSubdomain	string	Title of the verified subdomain.
data.emailVerified	boolean	Information about whether the domain has been verified using domain email.
data.dnsVerified	string	Information about whether the domain has been verified using necessary DNS records.
data.warmupStatus	integer	Information about whether your domain is on warming: 1 - yes 0 - no.
data.warmupDay	integer	The warm-up day on which the domain is located.
data.createdAt	string	The creation date of the domain.
data.dnsRecords	array	An array of objects with the necessary records, including all the required data to be added on your side for domain verification.
data.dnsRecords.type	string	The type of record that needs to be added on your side.
data.dnsRecords.name	string	The name of the record that needs to be added on your side. When adding the record, the name must be exactly as received in the response.
data.dnsRecords.value	string	The value of the record that needs to be added on your side. When adding the record, the value must be exactly as received in the response.
resolve	array	An array of objects with verified records and information about them.
resolve.type	string	The type that the record being verified should have.
resolve.name	string	The name that the record being verified should have.
resolve.value	string	The value that the record being verified should have.
resolve.presentInZone	boolean	Indicator of whether the domain and records were present in the verified zone.
resolve.isValid	boolean	Indicator of whether the added record is valid and matches the required one.
resolve.error	string	Error that occurred during the record check.
resolve.errorText	string	Error text that occurred during the verification of the required record.

Method Errors

                                        {
  "result": false,
  "errors": [
    "Error Description"
  ]
}

Error
"Argument domainId must be a non-empty string"
"Domains limit {limit} is reached"
"Domain {id} not found"
"Domain {id} is not verified"
"Domain was already verified. Please contact our support"
"Domain has not subdomain for DNS. Please contact our support"
"Argument domain must be a non-empty string"
"Argument domain must be a valid domain name"
"Domain {domain} is already registered"
"Domain {domain} is on removing stage. Try to create it later"
"Domain {domain} is a registered ESP"
"Domain {domain} has unknown TLD"
"Domains limit {limit} is reached"
"Minimum one unique domain identification (domainId or domain) is required."
"Invalid authorization token!"
"Internal server error"
"Bad Request"
"no matches found for access token {accessToken}"
"user {id} not enabled"
"no data found for key {userId}"
"access token check failed for key/secret $key/$accessToken"
"Argument {argument} required"

Code Examples

PHP

                $accessToken = 'YOUR_API_KEY';
$url = 'https://api.wooxy.com/v3/domain/verify';

$body = json_encode([
    'domainId' => 'YOUR_DOMAIN_ID',
    'domain' => 'YOUR_DOMAIN',
]);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Access-Token: $accessToken",
    'Content-Type: application/json',
    'Content-Length: ' . strlen($body),
]);

$result = curl_exec($ch);

if ($result === false) {
    echo 'cURL error: ' . curl_error($ch) . PHP_EOL;
} else {
    echo strval($result) . PHP_EOL;
}

curl_close($ch);