Order SSL (type_hint)

POST
https://www.digicert.com/services/v2/order/certificate/ssl

This endpoint automatically determines the appropriate SSL product for the request based on the submitted data. If a product cannot be determined, a 400 ambiguous_product error is returned.

Use this endpoint to request or renew an SSL certificate using the product type_hint. To renew a certificate, you must place the request from the same account used to order the original certificate.

Example requests and responses

cURL
curl -X POST \
  https://www.digicert.com/services/v2/order/certificate/ssl \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
  "certificate": {
    "common_name": "example.com",
    "dns_names": [
      "example2.com",
      "example3.com"
    ],
    "csr": "<csr>",
    "signature_hash": "sha256",
    "organization_units": [
      "Not Fake Company Inc."
    ],
    "organization": {
      "id": 112233
    },
    "server_platform": {
      "id": 2
    }
  },
  "validity_years": 1,
  "comments": "Example certificate for API documentation.",
  "container": {
    "id": 11
  },
  "product": {
    "type_hint": "ov"
  },
  "auto_renew": 1,
  "disable_renewal_notifications": false,
  "additional_emails": [
    "john.smith@digicert.com"
  ],
  "disable_ct": false,
  "skip_approval": true,
  "organization": {
    "id": 112233
  }
}'
Python
import requests

url = "https://www.digicert.com/services/v2/order/certificate/ssl"

payload = "{\n  \"certificate\": {\n    \"common_name\": \"example.com\",\n    \"dns_names\": [\n      \"example2.com\",\n      \"example3.com\"\n    ],\n    \"csr\": \"<csr>\",\n    \"signature_hash\": \"sha256\",\n    \"organization_units\": [\n      \"Not Fake Company Inc.\"\n    ],\n    \"organization\": {\n      \"id\": 112233\n    },\n    \"server_platform\": {\n      \"id\": 2\n    }\n  },\n  \"validity_years\": 1,\n  \"comments\": \"Example certificate for API documentation.\",\n  \"container\": {\n    \"id\": 11\n  },\n  \"product\": {\n    \"type_hint\": \"ov\"\n  },\n  \"auto_renew\": 1,\n  \"disable_renewal_notifications\": false,\n  \"additional_emails\": [\n    \"john.smith@digicert.com\"\n  ],\n  \"disable_ct\": false,\n  \"skip_approval\": true,\n  \"organization\": {\n    \"id\": 112233\n  }\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

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

print(response.text)
Go
package main

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

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/ssl"

	payload := strings.NewReader("{\n  \"certificate\": {\n    \"common_name\": \"example.com\",\n    \"dns_names\": [\n      \"example2.com\",\n      \"example3.com\"\n    ],\n    \"csr\": \"<csr>\",\n    \"signature_hash\": \"sha256\",\n    \"organization_units\": [\n      \"Not Fake Company Inc.\"\n    ],\n    \"organization\": {\n      \"id\": 112233\n    },\n    \"server_platform\": {\n      \"id\": 2\n    }\n  },\n  \"validity_years\": 1,\n  \"comments\": \"Example certificate for API documentation.\",\n  \"container\": {\n    \"id\": 11\n  },\n  \"product\": {\n    \"type_hint\": \"ov\"\n  },\n  \"auto_renew\": 1,\n  \"disable_renewal_notifications\": false,\n  \"additional_emails\": [\n    \"john.smith@digicert.com\"\n  ],\n  \"disable_ct\": false,\n  \"skip_approval\": true,\n  \"organization\": {\n    \"id\": 112233\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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: 'POST',
  url: 'https://www.digicert.com/services/v2/order/certificate/ssl',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { certificate: 
      { common_name: 'example.com',
        dns_names: [ 'example2.com', 'example3.com' ],
        csr: '<csr>',
        signature_hash: 'sha256',
        organization_units: [ 'Not Fake Company Inc.' ],
        organization: { id: 112233 },
        server_platform: { id: 2 } },
     validity_years: 1,
     comments: 'Example certificate for API documentation.',
     container: { id: 11 },
     product: { type_hint: 'ov' },
     auto_renew: 1,
     disable_renewal_notifications: false,
     additional_emails: [ 'john.smith@digicert.com' ],
     disable_ct: false,
     skip_approval: true,
     organization: { id: 112233 } },
  json: true };

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

  console.log(body);
});
201 Created (one-step approval)
{
  "id": 112233,
  "requests": [
      {
          "id": 113,
          "status": "pending"
      }
  ],
  "domains": [
      {
          "id": 1469,
          "name": "example.com"
      },
      {
          "id": 1470,
          "name": "example2.com"
      },
      {
          "id": 1471,
          "name": "example3.com"
      }
  ]
}
201 Created (two-step approval)
{
  "id": 112233,
  "requests": [
      {
          "id": 113,
          "status": "submitted"
      }
  ],
  "domains": [
      {
          "id": 1469,
          "name": "example.com"
      },
      {
          "id": 1470,
          "name": "example2.com"
      },
      {
          "id": 1471,
          "name": "example3.com"
      }
  ]
}
201 Created (auto approval)
{
  "id": 112233,
  "requests": [
      {
          "id": 113,
          "status": "approved"
      }
  ],
  "domains": [
      {
          "id": 1469,
          "name": "example.com"
      },
      {
          "id": 1470,
          "name": "example2.com"
      },
      {
          "id": 1471,
          "name": "example3.com"
      }
  ],
  "certificate_id": 113
}

Request parameters

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 Details about the certificate.
.. common_name required string Domain to be secured.
.. dns_names optional array Additional domains to be secured.
Can result in additional costs. (See Best practices – Get both versions of a domain for free.)
.. csr required* string Certificate signing request (CSR).
*See Glossary – CSR requirements
Note: The Services API does not extract information from the CSR to fill in the details of a certificate request. You must provide values for all relevant request parameters, including certificate.common_name, certificate.dns_names, certificate.organization_units, and organization.id. If you are requesting a certificate for an organization without an existing ID, you must provide values for all required parameters of the organization object.
.. signature_hash required string Hash algorithm used to sign the certificate.
Code signing certificates support only SHA-256.
.. ca_cert_id required* string ID of the CA certificate that should sign the certificate.
*Only required if type_hint is private.
.. organization_units optional array Department in your organization the certificate is for.
.. server_platform optional object Server platform type.
Required for code signing certificate orders.
Default: -1 (other)
.. .. id required int Server platform ID.
See Glossary – Server platforms
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 renewed_thumbprint or renewal_of_order_id value.
validity_years required int Number of years the certificate is valid.
Can be replaced by validity_days or custom_expiration_date.
Allowed values: 1, 2
validity_days optional int Number of days the certificate is valid after it is issued.
Overrides validity_years
custom_expiration_date optional string Custom expiration date for the certificate. Date must be less than 825 days in the future.
Overrides validity_days and validity_years
Format: yyyy-MM-dd
comments optional string Comments about the order for the approver.
apply_cr_discount optional bool When true, applies any competitive replacement discounts that are available for the domains on the order. To calculate competitive replacement discounts before you place an order, use the List replacement benefits endpoint.
Default: false
serial_number optional string Serial number of the non-DigiCert certificate for which you expect to receive a competitive replacement discount when you place the order. If not provided, we use the information from your order request to look for a match among certificates on the CT log servers, and we apply a discount based on the best match we can find.
product optional object Details about the product.
.. type_hint optional string Specify the product type being passed.
Allowed values: ov, ev, grid, private
auto_renew optional int Specify if the certificate should automatically renew.
Default: 0
Allowed values: 0 (disabled), 1 (enabled)
disable_renewal_notifications optional bool Specify if renewal notification emails should be disabled.
Default: false
additional_emails optional array Additional email addresses to receive certificate notification emails (e.g., certificate issuance, duplicate certificate, certificate renewals, etc.).
renewal_of_order_id optional* int If order is a renewal, enter the previous order's ID.
*Renewal orders must include either a renewed_thumbprint or renewal_of_order_id value.
dcv_method required string DCV method to use when verifying domain control.
See Glossary – DCV methods
skip_approval optional bool Specify if the order should skip the approval step and be immediately submitted for validation and issued when complete.
Default: false
disable_ct optional bool Specify if CT logging for the certificate should be disabled.
Order-specific CT logging must be enabled or this will be ignored. See Allow Users to Keep Certificates Out of CT Logs.
Default: false
organization required object Container for organization details.
.. id required int ID of the organization to associate with the order.
container optional object If needed, specify the container the order should be placed under.
.. id required int Container ID.

Response parameters

Name Type Description
id int Order ID.
organization object Container for new organization details.
Only returned if a new organization was created with the order.
.. id int Organization ID for the new organization.
domains object Container for domain details.
Returned for new and existing domains on the order.
.. id int Domain ID for the domain.
.. name int Name of the domain.
requests array Contains information about the request.
.. id int Request ID.
.. status string Request status.
Possible values: pending, submitted, approved, rejected
certificate_id int Certificate ID.
Returned if request status is approved.