Endpoint: GetDCVDetailsMC

Endpoint: !GetDCVDetailsMC

https://secure.trust-provider.com/products/!GetDCVDetailsMC

Use the POST method for this endpoint.

Submit parameters in the x-www-form-urlencoded format.

Request parameters

The following table displays the required, optional, and conditional parameters.

Parameter Requirement Type Max.Length Description

loginName

required

string

64 chars

Your account username.

This value is case-sensitive.

loginPassword

required

string

128 chars

Your account password.

This value is case-sensitive.

orderNumber

required

string

128 chars

The VMC or CMC certificate order number for which to retrieve DCV information.

Sample request

curl --location 'https://secure.trust-provider.com/products/!GetDCVDetailsMC' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=login_name' \
--data-urlencode 'loginPassword=login_password' \
--data-urlencode 'orderNumber=1234567890'

Response

The response is returned in JSON format with the MIME type application/json; charset=UTF-8.

The request is successful when the server returns a response with the status code equals 0.

Any status code less than 0 indicates an error condition.

Response parameters

The response may contain the following parameters:

Parameter Description

errorCode

A numeric code that identifies the type of the error. For more information, see Error codes.

errorMessage

A description of the error.

orderNumber

The requested order number.

domains

An array of domains awaiting DCV, sorted by domain name.

The array may be empty. Validated domains are omitted.

domainName

The domain name associated with the order.

domainUUID

The unique identifier for the domain.

dcvStatus

The current stored DCV status.

The possible values are:

  • AWAITING_SELECTION — A DCV method has not been selected.

  • SELECTED — A DCV method has been selected.

  • SENT — DCV is in the sent state. This status is relevant only for email DCV.

  • ERROR — DCV is in an error state.

  • UNKNOWN — Any other non-null stored status.

dcvOptions

An array of available non-email DCV options for the domain.

candidate

The validation candidate. Use it as the DNS record name or file-validation location, depending on the DCV method.

protocol

The code identifying the domain control validation (DCV) method.

The possible values are:

  • CNAMERNDVAL — DNS CNAME random value.

  • HTTPRNDVAL — HTTP random value.

  • HTTPSRNDVAL — HTTPS random value.

  • DNSTXTRNDVAL — DNS TXT random value.

verificationValue

The value to publish for the candidate. Depending on the DCV method, this is the DNS record value or target, or the content of the validation file.

Sample success response

{
  "orderNumber": "1234567890",
  "certificateID": 12345678901,
  "domains": [
    {
      "domainName": "mail.example.com",
      "domainUUID": "01234567-89ab-cdef-0123-456789abcdef",
      "dcvStatus": "SELECTED",
      "dcvOptions": [
        {
          "candidate": "_validation-token.mail.example.com",
          "protocol": "CNAMERNDVAL",
          "verificationValue": "dcv.yourdomain.com"
        }
      ]
    }
  ],
  "error": {
    "code": 0,
    "description": null,
    "item": null
  }
}

Error codes

Error Code Error Message Description

-1

Request was not made over HTTPS.

The request must use HTTPS protocol.

-2

'xxxx' is an unrecognized argument.

The provided argument is not recognized.

-3

The 'xxxx' argument is missing.

The required argument is missing from the request.

-4

The value of the 'xxxx' argument is invalid.

The argument value does not meet validation requirements.

-14

An unknown error occurred.

An unknown error occurred.

-16

Permission denied.

Authentication failed due to permission issues.

-17

Request used GET rather than POST.

The request method should be POST.

-42

Call limit reached. Try again later.

The maximum number of allowed API requests has been exceeded. Please wait before submitting additional requests.

Sample error response

{
  "error": {
    "code": -4,
    "description": "The value of the 'orderNumber' argument is invalid!",
    "item": "orderNumber"
  }
}