Upload site seal logo

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

Use this endpoint to upload your company logo to display in the site seal on your website.

Notice

Secure Site and Secure Site Pro SSL/TLS certificates support the option to display a DigiCert Smart Seal on your website. With the Smart Seal, you can add your company logo to the site seal that displays on your website.

Request format

To submit a request to the Upload site seal logo endpoint:

Set the Content-Type header to image/svg+xml.
Submit the raw XML data for the SVG image as the payload of the request.

Logo approval

After uploading your company logo, DigiCert must approve it before it appears in the site seal on your website.

Approval times may vary. Your logo appears in the site seal within two hours of being approved.
DigiCert only stores one approved logo for your site seal.
DigiCert deletes unapproved logos.

Display logo

Uploading the logo only submits the logo for approval. For the logo to appear in the site seal, you must also:

Turn on the option to display the logo.
With the Services API, use the Update site seal settings endpoint to set the seal_use_logo parameter to a value of true.
Turn on the Smart Seal hover feature.
With the Services API, use the Update site seal settings endpoint to set the seal_hover parameter to a value of true.

Logo format

Before uploading your logo, make sure it meets these requirements:

File format must be SVG Tiny Portable/Secure file. Learn how to render this file type.
The image should have a square aspect ratio (1:1).
Center the image. Centered images display optimally in a circle.
Use non-transparent backgrounds.

Replace logo

Uploading a logo replaces any existing logo for the site seal.

We delete the existing logo from your account and remove it from the site seal on your website.
After we approve the new logo, it will appear in the site seal on your website.

Approval times may vary. Your new logo will replace the old logo within two hours of being approved.

Example requests and responses

Notice

In the examples below, replace {{svg_xml}} with the XML data for your own SVG image.

Example 1. cURL

curl --request POST 'https://www.digicert.com/services/v2/order/certificate/123456789/site-seal/logo' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: image/svg+xml' \
--data-raw {{svg_xml}}

Example 2. Python

import requests

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

payload={{svg_xml}}
headers = {
  'X-DC-DEVKEY': {{api_key}},
  'Content-Type': 'image/svg+xml'
  }

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

print(response.text)

Example 3. Go

package main

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

func main() {

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

		payload := strings.NewReader({{svg_xml}})

		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", "image/svg+xml")

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

Example 4. NodeJS

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://www.digicert.com/services/v2/order/certificate/123456789/site-seal/logo',
  'headers': {
    'X-DC-DEVKEY': {{api_key}},
    'Content-Type': 'image/svg+xml'
  },
  body: {{svg_xml}}

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example 5. 204 No Content

// No content

Example 6. 400 Bad Request (MIME type mismatch)

{
  "errors": [
    {
      "code": "mime_type_mismatch",
      "message": "The Content-Type header does not match the MIME type of the POSTed file."
    }
  ]
}

Example 7. 400 Bad Request (Invalid product)

{
  "errors": [
    {
      "code": "invalid_product_for_seal",
      "message": "Site seals are not supported for this product."
    }
  ]
}

Example 8. 400 Bad Request (Upload failed)

{
  "errors": [
    {
      "code": "upload_failed",
      "message": "Upload failed."
    }
  ]
}

Path parameters

Name	Req/Opt	Description
order_id	required	ID of the order associated with the seal. Must be a Secure Site or Secure Site Pro certificate order.

In this section:

Upload site seal logo

Notice

Request format

Logo approval

Display logo

Logo format

Replace logo

Related topics

Example requests and responses

Notice

Path parameters

Search results