Update site seal settings

PUT
https://www.digicert.com/services/v2/order/certificate/{{order_id}}/site-seal

Use this endpoint to update the settings for a site seal.

DigiCert Smart Seal

Secure Site and Secure Site Pro SSL/TLS certificates support the option to display a DigiCert Smart Seal on your website. The DigiCert Smart Seal is enabled for Secure Site and Secure Site Pro certificates when the seal_number parameter is set to a value of 18. To switch to a basic site seal, set the seal_number parameter to a value of 15 (Norton), 16 (GeoTrust), or 17 (Thawte).

Updating your site seal

Some modifications, such as changing the size of the site seal, do not require you to reinstall the site seal code.* Changes automatically appear within two hours of submitting the update. However, if you modify the hover effect, you must reinstall the site seal code for those changes to take effect on your website.

Hover effect modifications include:

  • Enabling or disabling the Smart Seal hover effect (seal_hover).
  • Using the Smart Seal with the hover effect enabled, and then switching to a basic site seal (see DigiCert Smart Seal above).

*Note

On March 25, 2021, DigiCert improved how CertCentral stores your site seal settings. Now, you can update most of the settings for your site seal without replacing the site seal code on your website (see Updating your site seal). This change affects all site seal codes you receive and implement after March 25, 2021.

For codes you received and implemented before March 25, 2021:

If you don’t change the settings for your site seal:

  • No action is required.
  • Your existing site seal code will continue to work as expected.

If you update the settings for your site seal via CertCentral or the Services API:

  • You must replace the site seal code on your website for those changes to appear.
  • After you replace the seal code on your website, you can update the settings for the seal by changing those settings within CertCentral, or by using the Update site seal endpoint.

Changes may take up to two hours to appear on websites that use the new seal code.

Example requests and responses

cURL
curl --request PUT 'https://www.digicert.com/services/v2/order/certificate/123456789/site-seal' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "seal_size": "m",
  "seal_number": 18,
  "seal_hover": true,
  "seal_autoplay": true,
  "seal_use_logo": true,
  "display_malware_scan": true,
  "display_ct_log": true,
  "display_pci_scan": true,
  "display_blocklist_check": true,
  "display_verified_customer": true
}'
Python
import requests

url = "https://www.digicert.com/services/v2/order/certificate/123456789/site-seal"

payload="{\n  \"seal_size\": \"m\",\n  \"seal_number\": 18,\n  \"seal_hover\": true,\n  \"seal_autoplay\": true,\n  \"seal_use_logo\": true,\n  \"display_malware_scan\": true,\n  \"display_ct_log\": true,\n  \"display_pci_scan\": true,\n  \"display_blocklist_check\": true,\n  \"display_verified_customer\": true\n}"
headers = {
  'X-DC-DEVKEY': {{api_key}},
  'Content-Type': 'application/json'
}

response = requests.request("PUT", 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/123456789/site-seal"
		method := "PUT"

		payload := strings.NewReader(`{
  "seal_size": "m",
  "seal_number": 18,
  "seal_hover": true,
  "seal_autoplay": true,
  "seal_use_logo": true,
  "display_malware_scan": true,
  "display_ct_log": true,
  "display_pci_scan": true,
  "display_blocklist_check": true,
  "display_verified_customer": true
}`)

		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': 'PUT',
  'url': 'https://www.digicert.com/services/v2/order/certificate/123456789/site-seal',
  'headers': {
    'X-DC-DEVKEY': {{api_key}},
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({"seal_size":"m","seal_number":18,"seal_hover":true,"seal_autoplay":true,"seal_use_logo":true,"display_malware_scan":true,"display_ct_log":true,"display_pci_scan":true,"display_blocklist_check":true,"display_verified_customer":true})

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
200 OK
{
  "order_id": 123456789,
  "product_name_id": "ssl_securesite_pro",
  "seal_hash": {{seal_hash}},
  "seal_size": "m",
  "seal_number": 18,
  "seal_hover": true,
  "seal_autoplay": true,
  "seal_use_logo": true,
  "display_malware_scan": true,
  "display_ct_log": true,
  "display_pci_scan": true,
  "display_blocklist_check": true,
  "display_verified_customer": true,
  "eligible_malware_scan": true,
  "eligible_ct_log": true,
  "eligible_blocklist_check": true,
  "eligible_pci_scan": true,
  "ct_log_enabled": true,
  "pci_scan_enabled": true,
  "seal_code": {{seal_code}},
  "seal_logo": {{seal_logo}}
}

Path parameters

Name Req/Opt Description
order_id required ID of the order associated with the seal.

Request parameters

Parameters with an asterisk (*) are DigiCert Smart Seal features.

Name Req/Opt Type Description
seal_number optional integer Number that identifies the type of seal to display.
Allowed values:
  • 15 (Norton)
  • 16 (GeoTrust)
  • 17 (Thawte)
  • 18 (DigiCert)

Note: To enable DigiCert Smart Seal features, the seal_number parameter must be set to a value of 18. Smart Seal features are only available for Secure Site and Secure Site Pro certificates.
seal_size optional string Site seal size.
Allowed values:
  • s (small)
  • m (medium)
  • l (large)
seal_hover* optional boolean If true, when visitors hover on the seal, it magnifies and displays additional details. Otherwise, false.
Note: When you enable or disable the hover feature, you must update the site seal code on your website.
seal_autoplay* optional boolean If true, when visitors come to your site, the seal slowly and continually evolves between the seal and the additional details. Otherwise, false.
Note: To enable this feature, seal_hover must be true.
seal_use_logo* optional boolean If true, your company logo displays in the site seal. Otherwise, false.

To upload or replace your company logo, use the Upload site seal logo endpoint.
display_malware_scan optional boolean If true, the site seal information page displays the date of the most recently completed malware scan. Otherwise, false.
Note: This feature is only available for Secure Site Pro and Secure Site certificates.
display_ct_log optional boolean If true, the site seal information page displays the date you enabled CT log monitoring for the domain. Otherwise, false.
Note
  • This feature is only available for Secure Site Pro and Secure Site EV certificates.
  • The date only displays in the site seal information page if the display_ct_log, eligible_ct_log, and ct_log_enabled properties all return a value of true.
display_pci_scan optional boolean If true, the site seal information page displays the date of the most recently completed PCI compliance scan. Otherwise, false.
Note
  • This feature is only available for Secure Site Pro and Secure Site EV certificates.
  • The date only displays in the site seal information page if the display_pci_scan, eligible_pci_scan, and pci_scan_enabled properties all return a value of true.
display_blocklist_check optional boolean If true, the site seal information page displays a blocklist check for the domain. Otherwise, false.
Note: This feature is only available for Secure Site Pro and Secure Site certificates.
display_verified_customer optional boolean If true, the site seal information page displays how long you have been a DigiCert customer.

Response parameters

Parameters with an asterisk (*) are DigiCert Smart Seal features.

Name Type Description
order_id integer ID of the order associated with the site seal.
product_name_id string Product ID for the type of certificate on the order.
See Glossary - Product identifiers.
seal_hash string Site seal hash.
seal_number string Number that identifies the type of seal to display.
Possible values:
  • 15 (Norton)
  • 16 (GeoTrust)
  • 17 (Thawte)
  • 18 (DigiCert)

Note: To enable Smart Seal features, the seal_number parameter must be set to a value of 18. Smart Seal features are only available for Secure Site and Secure Site Pro certificates.
seal_size string Site seal size.
Possible values:
  • s (small)
  • m (medium)
  • l (large)
seal_hover* boolean If true, when visitors hover on the seal, it magnifies and displays additional details. Otherwise, false.
seal_autoplay* boolean If true, when visitors come to your site, the seal slowly and continually evolves between the seal and the additional details. Otherwise, false.
Note: To use this feature, seal_hover must be true.
seal_use_logo* boolean If true, your company logo displays in the site seal. Otherwise, false.

To upload or replace your company logo, use the Upload site seal logo endpoint.
display_malware_scan boolean If true, the site seal information page displays the date of the most recently completed malware scan. Otherwise, false.
Note: This feature is only available for Secure Site Pro and Secure Site certificates.
display_ct_log boolean If true, the site seal information page displays the date you enabled CT log monitoring for the domain. Otherwise, false.
Note
  • This feature is only available for Secure Site Pro and Secure Site EV certificates.
  • The date only displays in the site seal information page if the display_ct_log, eligible_ct_log, and ct_log_enabled properties all return a value of true.
display_pci_scan boolean If true, the site seal information page displays the date of the most recently completed PCI compliance scan. Otherwise, false.
Note
  • This feature is only available for Secure Site Pro and Secure Site EV certificates.
  • The date only displays in the site seal information page if the display_pci_scan, eligible_pci_scan, and pci_scan_enabled properties all return a value of true.
display_blocklist_check boolean If true, the site seal information page displays a blocklist check for the domain. Otherwise, false.
Note: This feature is only available for Secure Site Pro and Secure Site certificates.
display_verified_customer boolean If true, the site seal information page displays how long you have been a DigiCert customer.
eligible_ct_log boolean If true, the order is eligible to display the date you enabled Certificate Transparency log monitoring for the domain on the site seal information page. Otherwise, false.
Note: CT Log monitoring is only available for Secure Site Pro certificates.
eligible_blocklist_check boolean If true, the order is eligible to display a blocklist check for the domain on the site seal information page. Otherwise, false.
Note: Blocklist check is only available for Secure Site Pro and Secure Site certificates.
eligible_pci_scan boolean If true, the order is eligible to display the date of the most recently completed PCI compliance scan on the site seal information page. Otherwise, false.
Note: PCI compliance scans are only available for Secure Site Pro and Secure Site EV certificates.
ct_log_enabled boolean If true, Certificate Transparency log monitoring is enabled for the order. Otherwise, false.
Note: CT Log monitoring is only available for Secure Site Pro certificates.
pci_scan_enabled boolean If true, the vulnerability assessment service is enabled for the order. Otherwise, false.
Note: PCI compliance scans are only available for Secure Site Pro and Secure Site EV certificates.
seal_code string Site seal embed code, formatted as an HTML string.
seal_logo string SVG data for the site seal logo, formatted as an XML string.
Note: Seal logo is only available for Secure Site Pro and Secure Site certificates.