Domain emails

3 minute read

GET https://www.digicert.com/services/v2/domain/{{domain_id}}/dcv/emails

Use this endpoint to get the email addresses that receive validation emails from DigiCert for the email domain control validation (DCV) method.

Example requests and responses

curl -X GET \
  'https://www.digicert.com/services/v2/domain/{{domain_id}}/dcv/emails' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'

import requests

url = "https://www.digicert.com/services/v2/domain/{{domain_id}}/dcv/emails"

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

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

print(response.text)

package main

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

func main() {

	url := "https://www.digicert.com/services/v2/domain/{{domain_id}}/dcv/emails"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/domain/{{domain_id}}/dcv/emails',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

200 OK

{
  "name_scope": "sub.digicert.com",
  "base_emails": [
    "admin@sub.digicert.com",
    "webmaster@sub.digicert.com",
    "postmaster@sub.digicert.com",
    "hostmaster@sub.digicert.com",
    "administrator@sub.digicert.com"
  ],
  "dns_txt_emails": [
    "alice@digicert.com",
    "bob@digicert.com"
  ]
}

Path parameters

Name	Req/Opt	Description
domain_id	required	ID of the domain to get DCV email addresses for. To get the ID of a domain, use the List domains endpoint. To get the DCV email addresses for any domain in your account without using the domain ID, replace domain_id with the FQDN.

URL query parameters

Name	Req/Opt	Type	Description
consider_dcv_email_preferences	optional	bool	If true, response only includes email addresses your CertCentral account settings allow you to choose from when limiting who receives DCV emails for the domain. This means: If false (default), response includes all possible DCV email recipients for the domain, regardless of your account settings. In this case, the `base_emails` array includes all constructed emails for the domain, and the response includes all DNS-based contact email addresses discovered in DNS TXT (`dns_txt_emails`) records. To view your account settings, in the left main menu, go to Settings > Preferences. Then, on the Preferences page, expand Advanced Settings, and look under Send Verification DCV Emails to.

Response parameters

Name	Type	Description
name_scope	string	Domain name scope of the email addresses.
base_emails	array	List of constructed email addresses for the domain.
dns_txt_emails	array	List of email addresses found in the DNS TXT record for the domain. Note: These are the email addresses we find in the DNS TXT record on the _validation-contactemail subdomain of the domain being validated. For more information about using contacts from DNS TXT records for DCV checks, see the following topics:
email_array	array	Complete list of email addresses you can choose from when limiting who receives DCV emails for the domain. Configure this list in your CertCentral account.*
The email_array response parameter is only returned if you changed the default settings for which email addresses can receive verification DCV emails for your account.
*To view your account settings, in the left main menu, go to Settings > Preferences. Then, on the Preferences page, expand Advanced Settings, and look under Send Verification DCV Emails to.