--- title: "Domain info" source_url: https://dev.digicert.com/certcentral-apis/services-api/domains/domain-info.html api_method: GET api_endpoint: "/services/v2/domain/{{domain_id}}" api_url: "https://www.digicert.com/services/v2/domain/{{domain_id}}?include_dcv=true&include_validation=true" --- **GET** `https://www.digicert.com/services/v2/domain/{{domain_id}}?include_dcv=true&include_validation=true` Use this endpoint to get details for a domain. To get IDs for the domains in your account, use the [List domains](https://dev.digicert.com/md/certcentral-apis/services-api/domains/list-domains.md) endpoint. ## Example requests and responses **cURL** ```bash curl -X GET \ 'https://www.digicert.com/services/v2/domain/{{domain_id}}?include_dcv=true&include_validation=true' \ -H 'Content-Type: application/json' \ -H 'X-DC-DEVKEY: {{api_key}}' ``` **Python** ```python import requests url = "https://www.digicert.com/services/v2/domain/{{domain_id}}" querystring = {"include_dcv":"true","include_validation":"true"} headers = { 'X-DC-DEVKEY': "{{api_key}}", 'Content-Type': "application/json" } response = requests.request("GET", url, headers=headers, params=querystring) print(response.text) ``` **Go** ```go package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "https://www.digicert.com/services/v2/domain/{{domain_id}}?include_dcv=true&include_validation=true" 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)) } ``` **NodeJS** ```javascript var request = require("request"); var options = { method: 'GET', url: 'https://www.digicert.com/services/v2/domain/{{domain_id}}', qs: { include_dcv: 'true', include_validation: 'true' }, 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 ```json { "id": 12345678, "is_active": true, "status": "pending", "is_pending_validation": true, "name": "example.com", "date_created": "2021-04-27T14:49:28+00:00", "dcv_approval_datetime": "2021-05-27T22:11:22+00:00", "dcv_expiration_datetime": "2022-05-27T22:11:22+00:00", "organization": { "id": 12345678, "status": "active", "name": "Example Corp.", "display_name": "Example Corp.", "is_active": "1" }, "validations": [ { "type": "ov", "name": "OV", "description": "Normal Organization Validation", "validated_until": "2022-05-27T14:51:31+00:00", "status": "active", "dcv_status": "complete" }, { "type": "ev", "name": "EV", "description": "Extended Organization Validation (EV)", "validated_until": "2022-05-27T14:51:31+00:00", "status": "active", "dcv_status": "complete" } ], "dcv_method": "dns-txt-token", "dcv_token": { "token": {{dcv_token}}, "status": "active", "expiration_date": "2022-02-24T16:25:52+00:00" }, "dcv_expiration": { "ev": "2022-05-27", "ov": "2022-05-27" }, "container": { "id": 123456, "name": "Example Corp." }, "base_domain": "example.com", "dcv__approval_method": "dns-txt-token" } ``` ## Path parameters
Name Req/Opt Description
domain_id required ID of the domain to query.
## URL query strings
Name Req/Opt Type Description
include_dcv optional boolean If true, returns domain control validation (DCV) details in the response.
Default: false
include_validation optional boolean If true, returns validation details in the response. Validation details are returned in the validations array.
Default: false
include_validation_reuse_status optional boolean If true, the dcv_expiration object in the response includes ov_shortened, ov_status, ev_status, and dcv_approval_date response parameters.
Default: false
## Response parameters
Name Type Description
id integer Domain ID.
is_active boolean Active status of the domain.
status
Deprecated*
string Validation status of the domain.
*Note: DigiCert has deprecated the status response parameter.
  • In integrations that use Domain info response data, you can safely remove or ignore the value of the status parameter.
  • To get a more comprehensive validation status for your domains, include the query parameter include_validation=true when you submit your request. The validations array returns the status for each type of validation on the domain.
is_pending_validation boolean Pending status of the domain.
name string Name of the domain.
date_created string Timestamp of when the domain was added.
Format: UTC timezone and ISO 8601 date
domain_locking_status string Domain lock status. Domain locking prevents users in other CertCentral accounts from requesting certificates for the domain.
A domain only returns the domain_locking_status property if domain locking is enabled for the account. See Domain locking – Enable domain locking for your account.
Possible values:
  • disabled: Domain lock disabled. Users in other CertCentral accounts can request certificates for the domain.
  • pending: Domain lock pending. To finish setting up domain locking, place the account token (account_token) on the DNS Certificate Authority Authorization (CAA) resource record for the domain (see Domain locking – Locking a domain, step 6). Then, submit a request to the Check CAA (domain lock) endpoint.
  • enabled: Domain lock enabled. Only users belonging to your CertCentral account can request certificates for the domain.
account_token string Account token to use for domain locking.
A domain only returns the account_token parameter if these conditions are met:
  • Domain locking is enabled for the account. See Domain locking – Enable domain locking for your account.
  • Domain locking has been activated for the domain at least once. If domain locking has never been activated, no token exists for the domain, and the domain object does not include an account_token parameter.
dcv_approval_datetime string Completion date and time (UTC) of the most recent DCV check for the domain. Only returned if request URL contains include_dcv=true and you have completed a DCV check for the domain at least once.
Format: UTC timezone and ISO 8601 date
dcv_expiration_datetime string Expiration date and time (UTC) of the most recent DCV check for the domain. Only returned if request URL contains include_dcv=true and you have completed a DCV check for the domain at least once.
Format: UTC timezone and ISO 8601 date
organization object Organization attached to the domain.
.. id integer Organization ID.
.. status string Organization status.
Possible values:active, inactive. For more information, see Glossary - Organization status.
.. name string Legal name of the organization.
.. assumed_name string Public name of the organization. Also called DBA name.
.. display_name string Full name of the organization. Constructed using name + assumed_name.
.. is_active string Active status of the organization.
validations array List of objects with details about each type of validation on the domain. Only returned if request URL contains include_validation=true.
For information about the data structure and key/value pairs for objects returned in the validations array, see Structures – Validations object.
.. type string Type of validation.
.. name string Name of validation.
.. description string Description of validation.
.. status string Status of validation.
.. dcv_status string DCV status of validation.
dcv_method string Latest DCV method configured for the domain. Only returned if request URL contains include_dcv=true.
Possible values: See Glossary – DCV methods
dcv_token object If DCV method uses a random value, this object is returned and contains token information. Only returned if request URL contains include_dcv=true.
.. token string Random value used to complete DCV. For DNS CNAME validation, this value is used to construct the CNAME record target.
.. status string Status of the domain validation process.
.. expiration_date string Timestamp of when the token will expire.
Format: UTC timezone and ISO 8601 date
higher_level_domains array of objects List of existing higher-level domains with a complete domain control validation (DCV) check for the same organization as the queried domain. If none exist, the response omits the higher_level_domains array.
Use the higher_level_domains list to see if there are any domains in your account with active validations you can reuse to prove control over the queried domain. When you complete DCV for a higher-level domain, you prove you control any subdomains of the validated domain. You can request an OV or EV TLS certificate for those subdomains without completing a new DCV check.
Note: The response only includes the higher_level_domains array if the request URL includes the query string include_dcv=true.
.. name string Domain name (FQDN) of the higher-level domain.
.. id integer Domain ID of the higher-level domain.
.. dcv_expiration_datetime string Expiration date and time (UTC) of the most recent DCV check for the higher-level domain.
Format: UTC timezone and ISO 8601 date
dcv_expiration string If DCV is completed, this object is returned with information about when OV and EV domain validations expire. Only returned if request URL contains include_dcv=true.
.. ev string Expiration date for EV domain validation.
Format: YYYY-MM-DD
.. ov string Expiration date for OV domain validation.
Format: YYYY-MM-DD
Note: On September 27, 2021, the expiration date for existing OV domain validations will shorten to 397 days from the date validation was completed. Learn more about this policy change: Domain validation changes in 2021.
.. ov_shortened string New expiration date for OV domain validation after industry changes to shorten the domain validation reuse period go into effect on September 27, 2021. Only returned if request URL contains include_validation_reuse_status=true.
Format: YYYY-MM-DD
Note: After September 27, 2021, the dcv_expiration.ov_shortened parameter will return the same date as the dcv_expiration.ov parameter. Learn more about this policy change: Domain validation changes in 2021.
.. ov_status string OV domain validation status. Only returned if request URL contains include_validation_reuse_status=true.
Possible values:
  • expired: OV domain validation is expired.
  • expiring_soon: OV domain validation expires in the next 60 days.
  • valid: OV domain validation is valid.
  • industry_shortened_expired: On September 27, 2021, OV domain validation will be reduced. The reduced validation period will be expired.
  • industry_shortened_expiring_soon: On September 27, 2021, OV domain validation will be reduced. The reduced validation period will expire before December 1, 2021.

Note: After September 27, 2021, the ov_status parameter stopped returning industry_shortened_expired and industry_shortened_expiring_soon values. Learn more about this policy change: Domain validation changes in 2021.
.. ev_status string EV domain validation status.
Possible values:
  • expired: EV domain validation is expired.
  • expiring_soon: EV domain validation expires in the next 60 days.
  • valid: EV domain validation is valid.
.. dcv_approval_date string Date of the most recent DCV approval for the domain. Only returned if request URL contains include_validation_reuse_status=true.
Format: YYYY-MM-DD
container object Container the domain is attached to.
.. id int Container ID.
.. parent_id int ID of the container's parent.
.. name string Name of the container.
.. is_active bool Active status of the container.
base_domain string Base domain of the domain.
dcv_approval_method string DCV method used to complete the most recent DCV check. Only returned if request URL contains include_dcv=true.
Possible values: See Glossary – DCV methods