Sign in

v1

latestSwagger 2.02026-07-132946124.7 KB
v2

Retrieve domain verification status

This method can be used to retrieve the domain verification status for a certificate request.<ul><li>shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>"

get/v2/customers/{customerId}/certificates/{certificateId}/domainVerifications

Path parameters

customerIdstring required

An identifier for a customer

certificateIdstring required

Certificate id to lookup

Response

Domain verification status list for specified certificateId.

domainstring domain required

Domain name

domainEntityIdinteger required

A unique identifier that can be leveraged for retrieving domain verification related information. Primarily used when troubleshooting a request

dceTokenstring

DCE verification type token (if DCE verification type).

status'COMPLETED' | 'FAILED_VERIFICATION' | 'VERIFIED_POSSIBLE_FRAUD' | 'DROPPED' | 'DROPPED_CERTIFICATE_AUTHORITY_AUTHORIZATION' | 'DROPPED_GOOGLE_SAFE_BROWSING' | 'INVALID' | 'AWAITING' | 'PENDING_POSSIBLE_FRAUD' | 'REVOKED_CERTIFICATE' required

Domain verification status:

  • AWAITING - Verification pending customer input
  • INVALID - SAN connected to a cancelled request
  • COMPLETED - Verification completed
  • FAILED_VERIFICATION - Verification failed
  • PENDING_POSSIBLE_FRAUD - Flagged for a system level fraud review
  • VERIFIED_POSSIBLE_FRAUD - Fraud detection reviewed but verified
  • DROPPED - SAN dropped from request
  • REVOKED_CERT - Certificate revoked
  • DROPPED_GOOGLE_SAFE_BROWSING - SAN dropped from request due to Google Safe Browsing check
  • DROPPED_CERTIFICATE_AUTHORITY_AUTHORIZATION - SAN dropped from request due to Certificate Authorization Authority DNS record check
createdAtstring iso-datetime required

Timestamp indicating when the domain verification process was started

modifiedAtstring iso-datetime required

Timestamp indicating when the domain verification process was last updated

type'DOMAIN_CONTROL_EMAIL' | 'AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMIN' | 'AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMINSTRATOR' | 'AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_HOST_MASTER' | 'AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_POST_MASTER' | 'AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_WEB_MASTER' | 'DOMAIN_ACCESS_EMAIL' | 'DOMAIN_ACCESS_LETTER' | 'DOMAIN_ZONE_CONTROL' | 'MANUAL_DOMAIN_ACCESS_EMAIL' | 'PREVIOUS_DOMAIN_ACCESS_EMAIL' | 'REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER' | 'REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL' | 'REGISTRATION_AUTHORITY_OVERRIDE' | 'REGISTRATION_AUTHORITY_WEBSITE_CONTROL' | 'CUSTOMER_OWNED' | 'WEBSITE_CONTROL' required

Domain verification type:

  • AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMIN - Domain verified using domain control verification email sent to admin@<your.domain.com>
  • AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMINSTRATOR - Domain verified using domain control verification email sent to administrator@<your.domain.com>
  • AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_HOST_MASTER - Domain verified using domain control verification email sent to hostmaster@<your.domain.com>
  • AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_POST_MASTER - Domain verified using domain control verification email sent to postmaster@<your.domain.com>
  • AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_WEB_MASTER - Domain verified using domain control verification email sent to webmaster@<your.domain.com>
  • DOMAIN_ACCESS_EMAIL - Domain verified using a domain access email
  • DOMAIN_ACCESS_LETTER - Customer completed a domain access letter which was used for domain verification
  • DOMAIN_CONTROL_EMAIL - Domain verified using HTML file or DNS zone file text value
  • DOMAIN_ZONE_CONTROL - DNS zone file containing a pre-generated text value used for domain verification
  • MANUAL_DOMAIN_ACCESS_EMAIL - DAE sent to an email address manually entered by a rep
  • PREVIOUS_DOMAIN_ACCESS_EMAIL - Customers domain access email for a prior certificate request was used for domain verification
  • REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER - Representative reviewed a customer provided domain access letter and verified domain
  • REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL - Representative verified domain using a manual domain zone control check
  • REGISTRATION_AUTHORITY_OVERRIDE - Representative verified domain using alternative methods
  • REGISTRATION_AUTHORITY_WEBSITE_CONTROL - Representative verified domain using a manual website control check
  • CUSTOMER_OWNED - Validated customer account information used for domain control verification
  • WEBSITE_CONTROL - HTML file in root website directory containing pre-generated value used for domain control verification
usage'COMMON_NAME' | 'SUBJECT_ALTERNATIVE_NAME' required

Type of domain name used for domain verification