REST API Verification Status
Get Domain Verification Status GET
To retrieve information about the domain verification status for a specific certificate using the ZeroSSL API,
simply make an HTTPS GET request to the API endpoint below, specifying your certificate using its ID (hash)
inside the URL's {id} parameter, as shown below.
Only for Email Verification
Please note that the verification status endpoint is only useful if Email Verification is your selected domain verification method. Other verification methods (CNAME and File Upload) usually provide instant verification results using the Verify Domains endpoint.API Request URL:
api.zerossl.com/certificates/{id}/status
GET Request Parameters:
| Parameter | Description |
|---|---|
access_key |
[Required] Use this parameter to specify your API access key. |
{id} |
[Required] Use this parameter to specify your certificate ID / hash. |
API Response:
If your API request has been successful, you will receive a JSON API response containing verification status information for each of the domains in your certificate.
{
"validation_completed": 0,
"details": {
"domain.com": {
"method": "[email protected]",
"status": "Email Sent"
},
"www.domain.com": {
"method": "[email protected]",
"status": "Email Sent"
}
}
}
Response Objects:
| Parameter | Description |
|---|---|
validation_completed |
Returns 1 or 0 depending on whether domain verification has been completed.
|
details |
Returns a sub-object for each domain (or a pair of www and non-www domains) containing verification information. |
method |
Returns the verification email selected for the given domain. |
status |
Returns the current verification status of the given domain. |