Sectigo Legacy Rest API | Sectigo® Official

Domain control validation resource

Any domain added to CCM must pass Domain Control Validation (DCV) before Comodo can issue certificates to it. DCV is a procedure of validation of the Applicant’s control of the domain which needs to appear in the subject of the certificate. This resource is used to perform DCV.

Start validation HTTP

Start Domain Control Validation using HTTP method.

Response fields

Path	Type	Description
`url`	`String`	URL
`firstLine`	`String`	First line
`secondLine`	`String`	Second line

Example request

$ curl 'https://ccm.com/api/dcv/v1/validation/start/domain/http' -i -X POST \
 -H 'Content-Type: application/json' \
 -H 'login: admin_customer14050' \
 -H 'password: mLZxWzJh1+DZAPjHgnwzxaU/KVo=' \
 -H 'customerUri: cst14050' \
 -d '{"domain":"ccmqa.com"}'

Path	Type	Description
`orderStatus`	`String`	Order status
`message`	`String`	Message
`status`	`String`	Status

Path	Type	Description	Constraints
domain	String	Domain to validate	[Must not be empty, Size must be between 0 and 255 inclusive]
email	String	E-mail	[Must be a well-formed email address, Must not be empty]

Path	Type	Description
`status`	`String`	Validation status
`orderStatus`	`String`	Validation order status
`expirationDate`	`String`	Validation expiration date

Parameter	Description
`position`	Position shift
`size`	Count of entries
`domain`	Domain
`org`	Organization ID
`department`	Department ID
`dcvStatus`	DCV Status
`orderStatus`	DCV Order status
`expiresIn`	Expires in (days)

Path	Type	Description
`[]`	`Array`	Array of DCV domains
`[].domain`	`String`	Domain
`[].dcvStatus`	`String`	DCV Status
`[].dcvOrderStatus`	`String`	DCV Order status
`[].dcvMethod`	`String`	DCV Method

Path	Type	Description
`id`	`Number`	Custom field ID
`name`	`String`	Custom field name
`mandatories`	`Array`	List of access methods for which this field is mandatory
`certType`	`String`	Custom field certificate type
`state`	`String`	State

Path	Type	Description
`[]`	`Array`	Array of custom fields
`[].id`	`Number`	Custom field ID
`[].name`	`String`	Custom field name
`[].mandatories`	`Array`	List of access methods for which this field is mandatory
`[].certType`	`String`	Custom field certificate type
`[].state`	`String`	State

Path	Type	Description	Constraints
taskId	Number	Task ID	[Must not be null, Size must be between 1 and 256 inclusive]
name	String	Task name	[Must not be null, Size must be between 1 and 256 inclusive]
agent	String	Agent name	[Must not be empty]
ranges	Array	Array of ranges	[Must not be empty]
ranges[].address	String	Range address
ranges[].ports	String	Range port
rules	Array	Array of rules	[Must not be empty]
frequency	String	Task frequency	[Must not be empty]
timeZone	String	Time zone	[Must not be empty]
time	Object	Time	[Must not be null]
time.hours	Number	Hours	[]
time.minutes	Number	Minutes	[]

Path	Type	Description
`[]`	`Array`	Array of scan results
`[].scanResultId`	`Number`	Scan result ID
`[].date`	`String`	Date
`[].status`	`String`	Status
`[].sslCertsFound`	`Number`	Number of found certificates

Path	Type	Description
`[]`	`Array`	Array of SSL results
`[].ipAddress`	`String`	IP address
`[].hostName`	`String`	Host name
`[].commonName`	`String`	Common name
`[].validTo`	`String`	Valid to
`[].issuer`	`String`	Issuer name
`[].subject`	`String`	Subject
`[].validFrom`	`String`	Valid from
`[].subjectAltName`	`String`	Subject alternative name
`[].keyAlgorithm`	`String`	Key algorithm
`[].keySize`	`Number`	Key size
`[].signatureAlgorithm`	`String`	Signature algorithm
`[].inventory`	`String`	Inventory
`[].serialNumber`	`String`	Serial number
`[].md5Fingerprint`	`String`	MD5 fingerprint
`[].sha1Fingerprint`	`String`	SHA1 fingerprint
`[].foundTime`	`String`	Found Time
`[].cipher`	`String`	Cipher
`[].keyUsage`	`String`	Key usages
`[].extendedKeyUsage`	`String`	Extended key usages

Path	Type	Description
`name`	`String`	Assignment rule name
`orgId`	`Number`	Assignment rule organization ID
`filters[]`	`Array`	Array of rule filters
`filters[].filterType`	`String`	Rule filter type
`filters[].matchType`	`String`	Rule match type
`filters[].value`	`String`	Rule value

Path	Type	Description
`state`	`String`	State of Client Admin. Possible values: 'ALIVE', 'EXPIRED' and 'NEVER_EXPIRE'
`expirationDate`	`String`	Expiration date of Client Admin’s password

Path	Type	Description
`code`	`Number`	Code of error if error has occurred
`description`	`String`	Error message

Path	Type	Description	Constraints
name	String	Domain name	[Must not be null, Size must be between 4 and 255 inclusive]
description	String	Domain description (optional)	[Must not be null, Size must be between 0 and 255 inclusive]
active	Boolean	Required domain state	Set 'false' if you want to create domain in suspended state
delegations[]	Array	Domain delegations list	[Must not be null, Size must be between 1 and 2147483647 inclusive]
delegations[].orgId	Number	Organization ID	[Must be at least 1, Must not be null]
delegations[].certTypes	Array	Domain delegation certificate types	Allowed values: [SSL, SMIME, CodeSign]

Path	Type	Description
`id`	`Number`	Domain id
`name`	`String`	Domain name
`delegationStatus`	`String`	Domain delegation status. Available values are: [REQUESTED, ACTIVE, AWAITING_ME]
`state`	`String`	Domain state. Available values are: [SUSPENDED, ACTIVE]
`validationStatus`	`String`	Domain validation status. This field is shown only if DCV is enabled for customer. Available values are: [Not validated, Validated, Expired]
`dcvExpiration`	`String`	DCV expiration date. This field is shown only if DCV is enabled for customer. Format: yyyy-MM-dd
`delegations[]`	`Array`	List of domain delegations, filtered by client admin credentials.
`delegations[].orgId`	`Number`	Organization id
`delegations[].certTypes`	`Array`	Certificate types. Available values are: [SSL, SMIME, CodeSign]
`delegations[].status`	`String`	Delegation status. Available values are: [REQUESTED, ACTIVE, AWAITING_ME]

Parameter	Description
`size`	Count of returned entries
`position`	Position shift
`name`	Name filter
`state`	State filter
`status`	Status filter
`orgId`	Organization ID filter

Path	Type	Description
`[]`	`Array`	Array of requested domains
`[].name`	`String`	Domain
`[].id`	`Number`	Domain ID

Path	Type	Description	Constraints
orgId	Number	Organization ID	[Must be at least 1, Must not be null]
certTypes	Array	Certificate types	Allowed values: [SSL, SMIME, CodeSign]

Path	Type	Description
`[]`	`Array`	Array of requested organizations
`[].name`	`String`	Organization name
`[].id`	`Number`	Organization ID
`[].certTypes`	`Array`	Array of allowed certificate types
`[].departments[]`	`Array`	Departments array
`[].departments[].name`	`String`	Department name
`[].departments[].id`	`Number`	Department ID
`[].departments[].certTypes[]`	`Array`	Array of allowed certificate types