Order Common Mark Certificate (CMC)
POST https://www.digicert.com/services/v2/order/certificate/mark_certificate
Use this endpoint to order an Common Mark Certificate (CMC).
CMCs allow companies to place a brand logo next to the "sender" field in customer inboxes—even before the message is opened. The logo acts as confirmation of your domain's DMARC (Domain-based Message Authentication, Reporting, and Conformance) status and your organization's authenticated identity. Digicert's CMC supports Prior Use Mark and Modified Registered Trademark. For more information, see Common Mark Certificate.
When you create an order for a CMC certificate, you can include the logo in your order request. To submit a logo with your order request:
Format the data for your SVG logo as a compressed, base64-encoded string.
For example, in a bash shell, run this command:
echo '<XML content for your SVG logo>' | gzip | base64
In the JSON payload, submit the string containing the encoded logo data as the value of the
vmc.logo
parameter.
Example requests and responses
Request parameters
Notice
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 for a Common Mark Certificate. If you submit an order request for a Common Mark Certificate without including logo data, you must add this data to the order before DigiCert can issue the certificate. To update this information on an existing order, use the following endpoints: Note: Your CMC order request may include a logo that already exists in your account for another CMC order.
|
.. logo | conditional | string | Compressed logo file, formatted as a base64-encoded string. To see if a logo is formatted correctly: It is recommended to include the logo in the request; otherwise, you must upload an SVG logo to a pending order. |
.. enable_hosting | optional | bool | If 1, DigiCert hosts the image and certificate files. Otherwise, 0 (default). When image and certificate file hosting is enabled, the Order info endpoint returns the location of the hosted files in the |
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 |
order_validity | required | object | Object that defines the validity period of the order. DigiCert offers Multi-year Plan support for CMC certificates. When you submit an order request for a CMC certificate, the order validity determines the duration of coverage you want for the Multi-year Plan (up to three years). When the active certificate for the Multi-year Plan is about to expire, you reissue the certificate to maintain your coverage. Note: DigiCert does not support custom certificate validity periods for CMC certificates. Instead, DigiCert issues CMC certificates using the maximum certificate validity allowed by industry standards. This means:
|
.. years | required | int | Number of years the order is valid. Range: |
comments | optional | string | |
auto_renew | optional | int | Specify if the certificate should automatically renew. Allowed values: Default: |
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: |
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 |
payment_method | optional | string | Payment method for the order. Allowed values:
|
credit_card | conditional | object | Object with information about the credit card charged for the order. Required if |
.. number | required | string | Credit card number. |
.. expiration_month | required | integer | Credit card expiration month. Format as a two-digit number between |
.. expiration_year | required | integer | Credit card expiration year. Format as a four-digit number. For example: |
.. cvv | required | integer | Card verification value (CVV). Format as a three- or four-digit number. For example: |
.. cardholder_name | required | string | Cardholder’s first and last name. |
billing_address | conditional | object | Object with information about the billing address. Required if |
.. address | required | string | Billing street address. |
.. address2 | optional | string | Continuation of street address. |
.. city | required | string | Billing city. |
.. state | conditional | string | Billing state or province. Optional for some countries. |
.. country | required | string | Billing country. |
.. zip | conditional | string | Billing zip or postal code. Optional for some countries. |
vat_number | optional | string | |
dcv_method | optional | string | DCV method to use when verifying domain control. See Glossary – DCV methods. To change the domain control validation (DCV) method, use the Change domain DCV method endpoint. |
skip_approval | optional | bool | Specify if the order should skip the approval step and be immediately submitted for validation and issued when complete. Default: |
organization_contact | optional | object | Organization contact for the order. Include this object at the root of the request body to create the order with a different organization contact than the one assigned to the Note: The order-level |
.. first_name | required | string | Contact first name. |
.. last_name | required | string | Contact last name. |
required | string | Contact email address. | |
.. job_title | optional | string | Contact job title. |
.. telephone | optional | string | Contact telephone number. |
.. telephone_extension | optional | string | Telephone extension. |
technical_contact | optional | object | Technical contact for the order. Include this object at the root of the request body to create the order with a different technical contact than the one assigned to the Note: The order-level |
.. first_name | required | string | Contact first name. |
.. last_name | required | string | Contact last name. |
required | string | Contact email address. | |
.. job_title | optional | string | Contact job title. |
.. telephone | optional | string | Contact telephone number. |
.. telephone_extension | optional | string | Telephone extension. |
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 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.
To override this behavior and force the request to create a new organization, set the 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 Default: |
.. contacts | conditional | array | |
.. .. contact_type | required | string | |
.. .. 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 |
.. .. last_name | optional | string | Last name of the new contact. Note: Required when omitting |
.. .. job_title | optional | string | Job title of the new contact. Note: Required when omitting |
.. .. telephone | optional | string | Telephone number of the new contact. Note: Required when omitting |
optional | string | Email address of the new contact. Note: Required when omitting | |
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 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 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 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 |
.. 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 |
.. .. 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 |
.. .. http_token_url | string | Filename and location for the .txt file. Only returned if the DCV method is |
requests | array | Contains information about the request. |
.. id | int | Request ID. |
.. status | string | Request status. Possible values: |
certificate_id | int | Certificate ID. Returned if request status is |
vmc | object | Object with CMC details. |
.. logo_id | int | ID of the CMC logo on the order. Only returned when the logo in the request matches an existing CMC logo. When the logo matches an existing logo, we use the existing logo for the order instead of uploading a duplicate image. |