Order Verified Mark Certificate (VMC)

POST
https://www.digicert.com/services/v2/order/certificate/vmc_basic

Use this endpoint to request or renew an order for a Verified Mark Certificate (VMC). To renew a certificate, you must place the request from the same account used to order the original certificate.

You must assign a logo, trademark country, and trademark registration number to your VMC order before DigiCert can issue your certificate. If you do not have this information when submitting the order request, you must add this information to the order before DigiCert can issue the certificate.

Example requests and responses

cURL
curl --request POST 'https://www.digicert.com/services/v2/order/certificate/vmc_basic' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "certificate": {
    "dns_names": [
        "example.com"
    ]
  },
  "vmc": {
    "logo": {{compressed_base64_encoded_svg_logo}},
    "trademark_country_code": "us",
    "trademark_registration_number": "A1234-B1234"
  },
  "organization": {
    "id": {{organization_id}},
    "contacts": [
      {
        "contact_type": "ev_approver",
        "first_name": "First",
        "last_name": "Last",
        "telephone": "123-456-7890",
        "job_title": "Project Manager",
        "email": "first.last@example.com"
      }
    ]
  },
  "order_validity": {
    "years": 1
  },
  "payment_method": "balance"
}'
Python
import requests
import json

url = "https://www.digicert.com/services/v2/order/certificate/vmc_basic"

payload = "{\n  \"certificate\": {\n    \"dns_names\": [\n        \"example.com\"\n    ]\n  },\n  \"vmc\": {\n    \"logo\": {{compressed_base64_encoded_svg_logo}},\n    \"trademark_country_code\": \"us\",\n    \"trademark_registration_number\": \"A1234-B1234\"\n  },\n  \"organization\": {\n    \"id\": {{organization_id}},\n    \"contacts\": [\n      {\n        \"contact_type\": \"ev_approver\",\n        \"first_name\": \"First\",\n        \"last_name\": \"Last\",\n        \"telephone\": \"123-456-7890\",\n        \"job_title\": \"Project Manager\",\n        \"email\": \"first.last@example.com\"\n      }\n    ]\n  },\n  \"order_validity\": {\n    \"years\": 1\n  },\n  \"payment_method\": \"balance\"\n}"
headers = {
  'X-DC-DEVKEY': '{{api_key}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
Go
package main

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

func main() {

		url := "https://www.digicert.com/services/v2/order/certificate/vmc_basic"
		method := "POST"

		payload := strings.NewReader(`{
  "certificate": {
    "dns_names": [
        "example.com"
    ]
  },
  "vmc": {
    "logo": {{compressed_base64_encoded_svg_logo}},
    "trademark_country_code": "us",
    "trademark_registration_number": "A1234-B1234"
  },
  "organization": {
    "id": {{organization_id}},
    "contacts": [
      {
        "contact_type": "ev_approver",
        "first_name": "First",
        "last_name": "Last",
        "telephone": "123-456-7890",
        "job_title": "Project Manager",
        "email": "first.last@example.com"
      }
    ]
  },
  "order_validity": {
    "years": 1
  },
  "payment_method": "balance"
}`)

		client := &http.Client {
		}
		req, err := http.NewRequest(method, url, payload)

		if err != nil {
				fmt.Println(err)
				return
		}
		req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
		req.Header.Add("Content-Type", "application/json")

		res, err := client.Do(req)
		if err != nil {
				fmt.Println(err)
				return
		}
		defer res.Body.Close()

		body, err := ioutil.ReadAll(res.Body)
		if err != nil {
				fmt.Println(err)
				return
		}
		fmt.Println(string(body))
}
NodeJS
var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://www.digicert.com/services/v2/order/certificate/vmc_basic',
  'headers': {
    'X-DC-DEVKEY': '{{api_key}}',
    'Content-Type': 'application/json'
  },
  body: '{\n  "certificate": {\n    "dns_names": [\n        "example.com"\n    ]\n  },\n  "vmc": {\n    "logo": {{compressed_base64_encoded_svg_logo}},\n    "trademark_country_code": "us",\n    "trademark_registration_number": "A1234-B1234"\n  },\n  "organization": {\n    "id": {{organization_id}},\n    "contacts": [\n      {\n        "contact_type": "ev_approver",\n        "first_name": "First",\n        "last_name": "Last",\n        "telephone": "123-456-7890",\n        "job_title": "Project Manager",\n        "email": "first.last@example.com"\n      }\n    ]\n  },\n  "order_validity": {\n    "years": 1\n  },\n  "payment_method": "balance"\n}'

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
201 (one-step)
{
  "id": 144457095,
  "requests": [
    {
      "id": 11963702,
      "status": "pending"
    }
  ]
}
201 (two-step)
{
  "id": 144457092,
  "requests": [
    {
      "id": 11963700,
      "status": "submitted"
    }
  ]
}
201 (auto)
{
  "id": 144457096,
  "requests": [
    {
      "id": 11963703,
      "status": "approved"
    }
  ],
  "domains": [
    {
      "id": 3612638,
      "name": "example.com",
      "dns_name": "example.com"
    }
  ],
  "certificate_id": 145451175
}
201 (skip)
{
  "id": 144457097,
  "domains": [
    {
      "id": 3612638,
      "name": "example.com",
      "dns_name": "example.com"
    }
  ],
  "certificate_id": 145451176
}

Request parameters

For information about allowed values for certificate fields, see Publicly Trusted Certificates – Data Entries that Violate Industry Standards.

Name Req/Opt Type Description
certificate required object Object with certificate details.
.. dns_names optional array List of domains to be secured. Ordering a certificate for multiple domains can result in additional costs.
vmc optional object Object with logo data and trademark details for a Verified Mark Certificate.

If you submit an order request for a Verified Mark Certificate without including the logo or trademark information, you must add this information to the order before DigiCert can issue the certificate. To update this information on an existing order, use the following endpoints:Note: Your VMC order request may include a logo that already exists in your account for another VMC order.
  • If the existing logo is pending approval, we update all pending VMC orders that use the logo with trademark information from the new order request. If the new order request does not include trademark information, the logo on the new order inherits the trademark information that already exists for the logo.
  • If the existing logo is approved, any trademark information in the new order request should match the trademark information for the existing approved logo. Otherwise, the API returns an error.
.. logo conditional string Compressed logo data, formatted as a base64-encoded string. To see if a logo is formatted correctly:
Note: A logo is required when submitting a trademark country code or registration number in your request.
.. trademark_country_or_region optional string Two-letter code for the country or region where the logo is trademarked.
Allowed values:
  • us – United States
  • ca – Canada
  • em – European Trademark Office
  • gb – Great Britain
  • de – Germany
  • jp – Japan
  • au – Australia
  • es – Spain
.. trademark_registration_number optional string Trademark registration number of the logo.
renewed_thumbprint optional* string If order is a renewal, enter the SHA-1 thumbprint of the previous order's primary certificate. For more information, see How to check a certificate's thumbprint.
*Renewal orders must include either a renewed_thumbprint or renewal_of_order_id value.
order_validity required object Object that defines the validity period of the order and certificate.
.. years required int Number of years the order and certificate are valid.
Allowed values1
comments optional string Comments about the order for the approver.
auto_renew optional int Specify if the certificate should automatically renew.
Allowed values: 0 (disabled) or 1 (enabled)
Default: 0
custom_renewal_message optional string Custom message to be included in renewal notifications.
disable_renewal_notifications optional bool Specify if renewal notification emails should be disabled.
Default: false
additional_emails optional array Additional email addresses to receive certificate notification emails (for example, certificate issuance, certificate duplication, certificate renewals, etc.).
locale optional string Language that the DCV email should use.
See Glossary – Locale codes
renewal_of_order_id optional* int If order is a renewal, enter the previous order's ID.
*Renewal orders must include either a renewed_thumbprint or renewal_of_order_id value.
payment_method optional string Specify the payment method to use.
Allowed values: balance, card, profile
Default: balance
dcv_method optional string DCV method to use when verifying domain control.
See Glossary – DCV methods
skip_approval optional bool Specify if the order should skip the approval step and be immediately submitted for validation and issued when complete.
Default: false
organization required object Object with information about the organization to associate with the request. You can associate the request with an existing organization, or you can create a new organization when you submit the order request.

To associate the request with an existing organization, pass the ID of the organization as the value of organization.id in the body of your request. To create a new organization, include the details of the organization in the organization object. For more information about the structure and required parameters of the organization object, see the Create organization documentation.

Note: When you submit an order with organization details instead of providing an organization ID, we check the organizations that already exist in your account to avoid creating a duplicate.
  • If we find one matching organization, we automatically associate the order with that organization instead of creating a new one.
  • If we find two or more matching organizations, we automatically associate the order with the oldest matching organization in your account instead of creating a new one.
To override this behavior and force the request to create a new organization, set the organization.skip_duplicate_org_check parameter to true in the body of your request.

Important: When you want to associate an order with an existing organization, we recommend always using the ID of the organization instead of the organization's details in the body of your request. To get the ID values for organizations in your account, use the List organizations endpoint. Additionally, we recommend deactivating unused organizations to ensure they are never accidentally assigned to a new order request. To deactivate an organization, use the Deactivate organization endpoint.
.. id conditional* int The ID of an existing organization to associate with the order. To get the ID of organizations in your account, use the List organizations endpoint.
*Requests that do not include organization details must include an organization ID.
.. skip_duplicate_org_check optional bool Use true to skip the check for duplicate organizations in your account. When you skip this check, you force the request to create a new organization, regardless of whether the details you provide in the request match the details of an organization that already exists in your account.
Default: false
.. contacts required array List of organization contacts for the order.
Note: You must include an ev_approver contact. To get potential EV approvers, see List approvers.
.. .. contact_type required string Type of contact to add to the order.
Allowed values: organization_contact, technical_contact, ev_approver
.. .. user_id required* int ID of existing user for the account.
*Can be omitted if adding a new contact.
.. .. first_name optional string First name of the new contact.
Note: Required when omitting user_id. If user_id is not omitted, the specified user's information will be updated with the new value.
.. .. last_name optional string Last name of the new contact.
Note: Required when omitting user_id. If user_id is not omitted, the specified user's information will be updated with the new value.
.. .. job_title optional string Job title of the new contact.
Note: Required when omitting user_id. If user_id is not omitted, the specified user's information will be updated with the new value.
.. .. telephone optional string Telephone number of the new contact.
Note: Required when omitting user_id. If user_id is not omitted, the specified user's information will be updated with the new value.
.. .. email optional string Email address of the new contact.
Note: Required when omitting user_id. If user_id is not omitted, the specified user's information will be updated with the new value.
container optional object If needed, specify the container the order should be placed under.
.. id required int Container ID.
custom_fields optional* array Account-specific custom fields.
*Whether or not these fields are required depends on your custom field settings.
.. metadata_id required int Custom field ID.
.. value required string Value for the custom field.
Data validation type depends on your custom field settings.
alternative_order_id optional string A custom alphanumeric ID to assign the order. To see the alternative_order_id assigned to an order, use the Order info endpoint.

Alternative order IDs do not replace the unique order ID that DigiCert assigns each order request. You cannot use alternative order IDs to search for or identify orders in API calls that require an order_id parameter in the URL path or request body.

If the Require unique alternative order IDs option is enabled in your account settings, you cannot submit order requests with an alternative order ID that is already assigned to an order in your account. Use this feature to enable nonce order requests, or to prevent your integration from creating duplicate orders in cases where you do not receive a response from the API. Account administrators can toggle this option from the CertCentral console. From the Settings > Preferences page, open the Advanced Settings menu, and look for the Alternative order ID option.

This parameter is always optional, even if the Require unique alternative order IDs option is enabled in your account. If a request does not use this parameter, no alternative_order_id value is assigned to the order.

Maximum length: 64 characters
Note: The Require unique alternative order IDs option may not appear in the advanced settings menu for all CertCentral accounts. To enable this option for your account, contact your account manager or our Support team.

Response parameters

Name Type Description
id int Order ID.
domains array List of objects with details about the domains in your account that are submitted for validation with the certificate order request. You must have an active validation for the domains in this array to prove you control the SANs on the order.
.. id int Domain ID of the domain in your account.
.. name int Name of the domain in your account.
.. dns_name string A SAN from the order request. To prove you control this domain, you must have an active validation for the domain associated with the domains[].name and domains[].id key/value pairs.
.. dcv_token object Object with details about the domain control validation (DCV) token for the domain. Not returned when using email as the DCV method.

Note: The dcv_token object is not returned for domains that will be validated under the scope of another domain on the order, for domains that already exist in your account, or for subdomains of existing domains. For example, if you request a certificate to secure the newly created domains example.com, www.example.com, and subdomain.example.com, the response only includes a dcv_token object for example.com. To get the DCV token for an existing domain, use the Domain info endpoint.
.. .. token string Random value used to prove control over the domain.
.. .. 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
.. .. verification_value string Value for the DNS record target host field.
Only returned if the DCV method is dns-cname-token.
.. .. http_token_url string Filename and location for the .txt file.
Only returned if the DCV method is http-token.
requests array Contains information about the request.
.. id int Request ID.
.. status string Request status.
Possible values: pending, submitted, approved, rejected
certificate_id int Certificate ID.
Returned if request status is approved.
vmc object Object with VMC details.
.. logo_id int ID of the VMC logo on the order.
Only returned when the logo in the request matches an existing VMC logo. When the logo matches an existing logo, we use the existing logo for the order instead of uploading a duplicate image.