Email validation status

2 minute read

GET https://www.digicert.com/services/v2/order/certificate/38584158/email-validation

Use this endpoint to get the validation status for all email addresses on a client certificate order.

Replace {{order_id}} in the URL with the ID for a client certificate order. To get IDs for the orders in your account, use the List orders endpoint.

Example requests and responses

curl -X GET \
'https://www.digicert.com/services/v2/order/certificate/38584158/email-validation' \
-H 'X-DC-DEVKEY: {{api_key}}' \
-H 'Content-Type: application/json'

import requests

url = "https://www.digicert.com/services/v2/order/certificate/38584157/email-validation"

payload = {}
headers = {
  'X-DC-DEVKEY': '{{api_key}}',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://www.digicert.com/services/v2/order/certificate/38584157/email-validation"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://www.digicert.com/services/v2/order/certificate/38584157/email-validation',
  'headers': {
    'X-DC-DEVKEY': '{{api_key}}',
    'Content-Type': 'application/json'
  }
};
request(options, function (error, response) { 
  if (error) throw new Error(error);
  console.log(response.body);
});

200 OK

{
    "delivery_options": [
        "api",
        "browser"
    ],
    "emails": [
        {
            "email": "estrella.franklin@aol.com",
            "status": "unvalidated",
            "date_emailed": "2020-08-17"
        }
    ]
}

Response parameters

Name	Type	Description
delivery_options	array	List of methods an administrator can use to send validation emails for the order. Possible values: api (CertCentral Services API), browser (CertCentral UI)
emails	array	List of objects with details about the validation status for each email address on the order.
.. email	string	Email address.
.. status	string	Validation status of the email address. Possible values: validated or unvalidated
.. date_emailed	string	Date the validation email was sent. Format:
YYYY-MM-DD