Site seal settings

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

Use this endpoint to get the site seal settings for a certificate order.

A site seal is associated with a single certificate order. The seal is only valid on the domains included in that order.

Example requests and responses

cURL
curl -X GET \
  'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/site-seal' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'
Python
import requests

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

payload = ""
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

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

print(response.text)
Go
package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
NodeJS
var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/site-seal',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(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 Type Description
order_id string ID of the order associated with the site seal.

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.