This page is for ordering products with the client_certificate
group name (see Glossary – Product identifiers).
Use this endpoint to submit a client certificate request order.
Replace {{client_certificate_id}}
in the URL with the product identifier for the type of certificate to order:
client_premium
- Premiumclient_digital_signature_plus
- Digital Signature Plusclient_authentication_plus
- Authentication Plusclient_email_security_plus
- Email Security Plusclass1_smime
- Class 1 S/Mime CertificateYou can only order certificates that are enabled for your account. Use the Product list endpoint to get the list of products available for your account.
curl -X POST \
'https://www.digicert.com/services/v2/order/certificate/{{client_certificate_id}}' \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}' \
-d '{
"certificate": {
"common_name": "Lock Cole",
"emails": [
"locke.cole@example.com"
],
"signature_hash": "sha256",
"csr": "<csr>"
},
"skip_approval": true,
"organization": {
"id": 112233
},
"container": {
"id": 445566
},
"order_validity": {
"years": 1
},
"payment_method": "balance"
}'
import requests
url = "https://www.digicert.com/services/v2/order/certificate/{{client_certificate_id}}"
payload = "{\n \"certificate\": {\n \"common_name\": \"Lock Cole\",\n \"emails\": [\n \"locke.cole@example.com\"\n ],\n \"signature_hash\": \"sha256\",\n \"csr\": \"<csr>\"\n },\n \"skip_approval\": true,\n \"organization\": {\n \"id\": 112233\n },\n \"container\": {\n \"id\": 445566\n },\n \"order_validity\": {\n \"years\": 1\n },\n \"payment_method\": \"balance\"\n}"
headers = {
'X-DC-DEVKEY': "{{api_key}}",
'Content-Type': "application/json"
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v2/order/certificate/{{client_certificate_id}}"
payload := strings.NewReader("{\n \"certificate\": {\n \"common_name\": \"Lock Cole\",\n \"emails\": [\n \"locke.cole@example.com\"\n ],\n \"signature_hash\": \"sha256\",\n \"csr\": \"<csr>\"\n },\n \"skip_approval\": true,\n \"organization\": {\n \"id\": 112233\n },\n \"container\": {\n \"id\": 445566\n },\n \"order_validity\": {\n \"years\": 1\n },\n \"payment_method\": \"balance\"\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))
}
var request = require("request");
var options = { method: 'POST',
url: 'https://www.digicert.com/services/v2/order/certificate/{{client_certificate_id}}',
headers:
{ 'Content-Type': 'application/json',
'X-DC-DEVKEY': '{{api_key}}' },
body:
{ certificate:
{ common_name: 'Lock Cole',
emails: [ 'locke.cole@example.com' ],
signature_hash: 'sha256',
csr: '<csr>' },
skip_approval: true,
organization: { id: 112233 },
container: { id: 445566 },
order_validity: { years: 1 },
payment_method: 'balance' },
json: true };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
{
"id": 112233,
"requests": [
{
"id": 113,
"status": "pending"
}
]
}
{
"id": 112233,
"requests": [
{
"id": 113,
"status": "submitted"
}
]
}
{
"id": 112233,
"requests": [
{
"id": 113,
"status": "approved"
}
],
"certificate_id": 113
}
Name | Req/Opt | Type | Description |
---|---|---|---|
certificate | required | object | Certificate details. |
.. common_name | required | string | Name to be secured. |
.. emails | required | array | Emails to be placed on the certificate. |
.. signature_hash | required | string |
Hash algorithm used to signing the certificate. Allowed values: sha256
|
.. organization_units | optional | array | Department in your organization associated with the certificate. |
.. csr | optional | string |
Certificate signing request (CSR). 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 , 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.
|
auto_renew | optional | int | Number of times the certificate should renew automatically. |
renewal_of_order_id | optional | int | If order is a renewal, enter the previous order's ID. |
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
|
organization | required | object |
Object with information about the organization to associate with the request. You can associate the request with an existing organization, or you can create a new organization when you submit the order request. To associate the request with an existing organization, pass the ID of the organization as the value of organization.id in the body of your request. To create a new organization, include the details of the organization in the organization object. For more information about the structure and required parameters of the organization object, see the Create organization documentation.Note: When you submit an order with organization details instead of providing an organization ID, we check the organizations that already exist in your account to avoid creating a duplicate.
organization.skip_duplicate_org_check parameter to true in the body of your request.Important: When you want to associate an order with an existing organization, we recommend always using the ID of the organization instead of the organization's details in the body of your request. To get the ID values for organizations in your account, use the List organizations endpoint. Additionally, we recommend deactivating unused organizations to ensure they are never accidentally assigned to a new order request. To deactivate an organization, use the Deactivate organization endpoint. |
.. id | required* | int |
The ID of an existing organization to associate with the order. To get the ID of organizations in your account, use the List organizations endpoint. *Not required if you are creating a new organization with your request. |
.. skip_duplicate_org_check | optional | bool |
Use true to skip the check for duplicate organizations in your account. When you skip this check, you force the request to create a new organization, regardless of whether the details you provide in the request match the details of an organization that already exists in your account. Default: false
|
container | optional | object | If needed, specify the container the order should be placed under. |
.. id | optional | int | Container ID. |
order_validity | required | object | Defines the validity period of the certificate and order. |
.. years | required* | int |
Number of years the certificate and order are valid. *Can be replaced by order_validity.days or order_validity.custom_expiration_date .Range: 1 -3
|
.. days | optional | int |
Number of days the certificate and order are valid. Overrides order_validity.years .
|
.. custom_expiration_date | optional | string |
Custom expiration date for the certificate and order. Overrides order_validity.days and order_validity.years .Format: dd MMM YYYY (for example, "09 JUN 2025" )
|
validity_years | optional | int |
Number of years the certificate and order are valid. Deprecated. Use the order_validity object to set the validity period of the certificate and order.Allowed values: 1 - 3
|
custom_expiration_date | optional | string |
Custom expiration date for the certificate and order. Deprecated. Use the order_validity object to set the validity period of the certificate and order.Overrides validity_years Format: yyyy-MM-dd
|
custom_fields | optional* | object |
Account-specific custom fields. *Whether or not these fields are required depends on your custom field settings. |
.. metadata_id | required | int | Custom field ID. |
.. value | required | string |
Value for the custom field. Data validation type depends on your custom field settings. |
payment_method | optional | string |
Payment method for the order. Allowed values:
|
credit_card | conditional | object |
Object with information about the credit card charged for the order. Required if payment_method is card .
|
.. number | required | string | Credit card number. |
.. expiration_month | required | integer |
Credit card expiration month. Format as a two-digit number between 01 (Jan) and 12 (Dec).
|
.. expiration_year | required | integer |
Credit card expiration year. Format as a four-digit number. For example: 2026
|
.. cvv | required | integer |
Card verification value (CVV). Format as a three- or four-digit number. For example: 333 or 4444
|
.. cardholder_name | required | string | Cardholder’s first and last name. |
billing_address | conditional | object |
Object with information about the billing address. Required if payment_method is card .
|
.. address | required | string | Billing street address. |
.. address2 | optional | string | Continuation of street address. |
.. city | required | string | Billing city. |
.. state | conditional | string | Billing state or province. Optional for some countries. |
.. country | required | string | Billing country. |
.. zip | conditional | string | Billing zip or postal code. Optional for some countries. |
alternative_order_id | optional | string |
A custom alphanumeric ID to assign the order. To see the alternative_order_id assigned to an order, use the Order info endpoint.Alternative order IDs do not replace the unique order ID that DigiCert assigns each order request. You cannot use alternative order IDs to search for or identify orders in API calls that require an order_id parameter in the URL path or request body.If the Require unique alternative order IDs option is enabled in your account settings, you cannot submit order requests with an alternative order ID that is already assigned to an order in your account. Use this feature to enable nonce order requests, or to prevent your integration from creating duplicate orders in cases where you do not receive a response from the API. Account administrators can toggle this option from the CertCentral console. From the Settings > Preferences page, open the Advanced Settings menu, and look for the Alternative order ID option. This parameter is always optional, even if the Require unique alternative order IDs option is enabled in your account. If a request does not use this parameter, no alternative_order_id value is assigned to the order.Maximum length: 64 characters Note: The Require unique alternative order IDs option may not appear in the advanced settings menu for all CertCentral accounts. To enable this option for your account, contact your account manager or our Support team. |
enable_guest_access | optional | int |
Whether to enable guest access for the order. This parameter is not allowed if guest access is disabled in your account settings. Allowed values: 1 (enabled) or 0 (disabled)Default: The default configuration for new orders is determined by your account settings. Account administrators can change these settings from the Guest Access page in the CertCentral console. |
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. |
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 .
|