Update site seal settings

PUT https://www.digicert.com/services/v2/order/certificate/123456789/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 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).

Example requests and responses

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
}'
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)
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))
}
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

NameReq/OptDescription
order_idrequiredID of the order associated with the seal.

Request parameters

NameReq/OptTypeDescription
seal_numberoptionalintegerNumber that identifies the type of seal to display.
Allowed values:
Note:
seal_sizeoptionalstringSite seal size.
Allowed values:
seal_hover*optionalbooleanIf 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*optionalbooleanIf 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*optionalbooleanIf 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_scanoptionalbooleanIf 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_logoptionalbooleanIf true, the site seal information page displays the date you enabled CT log monitoring for the domain. Otherwise, false.
Note
display_pci_scanoptionalbooleanIf true, the site seal information page displays the date of the most recently completed PCI compliance scan. Otherwise, false.
Note
display_blocklist_checkoptionalbooleanIf 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_customeroptionalbooleanIf true, the site seal information page displays how long you have been a DigiCert customer.

Response parameters

NameTypeDescription
order_idintegerID of the order associated with the site seal.
product_name_idstringProduct ID for the type of certificate on the order. See Glossary - Product identifiers.
seal_hashstringSite seal hash.
seal_numberstringNumber that identifies the type of seal to display.
Possible values:
*Note: On October 17, 2023, DigiCert will replace the Norton site seal image with our DigiCert site seal image wherever it appears on websites secured by Secure Site or Secure Site Pro TLS certificates.
seal_sizestringSite seal size.
Possible values:
seal_hover*booleanIf true, when visitors hover on the seal, it magnifies and displays additional details. Otherwise, false.
seal_autoplay*booleanIf 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*booleanIf 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_scanbooleanIf 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_logbooleanIf true, the site seal information page displays the date you enabled CT log monitoring for the domain. Otherwise, false.
Note
display_pci_scanbooleanIf true, the site seal information page displays the date of the most recently completed PCI compliance scan. Otherwise, false.
Note
display_blocklist_checkbooleanIf 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_customerbooleanIf true, the site seal information page displays how long you have been a DigiCert customer.
eligible_ct_logbooleanIf 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_checkbooleanIf 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_scanbooleanIf 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_enabledbooleanIf 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_enabledbooleanIf 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_codestringSite seal embed code, formatted as an HTML string.
seal_logostringSVG 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.