Order code signing certificate

code_signing_certificate_id

required

Product identifier of the code signing certificate you want to order.

Allowed values:

For a list of all product identifiers, see Glossary - Product identifiers.

certificate

required

object

Certificate details.

.. csr

conditional

string

Certificate signing request (CSR).

To learn more about CSR requirements, 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 organization.id. If you are creating a new organization with your certificate request, you must provide values for all required parameters of the organization object.

.. signature_hash

required

string

Hash algorithm used to signing the certificate.

Allowed values:sha256

.. server_platform

required^*

object

Server platform type.

^*Required if cs_provisioning_method is client_app or not provided.

.. .. id

required

int

Server platform ID.

Allowed values: See Glossary - Code signing certificates. For EV code signing certificate orders, see Glossary - EV Code signing certificates.

.. organization_units

optional

array

Department in your organization associated with the certificate.

auto_renew

optional

int

Number of times the certificate should renew automatically.

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.

skip_approval

optional

bool

Specify if the order should skip the certificate request approval step and be immediately submitted for validation and issued when complete.

Default:false.

The skip_approval option skips only the approval step (for example, from your organization), but does not skip the validation step required by Digicert for a certificate.

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.

To override this behavior and force the request to create a new organization, set the 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

conditional

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.

Omit this value if you are creating a new organization with your request.

.. name

conditional

string

Legal name of the organization. Required when creating a new organization.

Character limit: 64 if assumed_name is empty or not provided. If the request includes an assumed_name value, the combined length of the submitted name + assumed_name values cannot exceed 61 characters. Three characters are reserved for spacing and punctuation.

.. assumed_name

optional

string

Public name of the organization. Also called Doing Business As (DBA) name.

Character limit: The combined length of the submitted name + assumed_name values cannot exceed 61 characters. Three characters are reserved for spacing and punctuation.

.. country

conditional

string

Two-letter country code for the country where the organization is located. Required when creating a new organization.

Format: Must be a valid ISO 3166-1 alpha-2 code.

.. address

conditional

string

Address of the organization. Required when creating a new organization.

Character limit: 64

.. address2

optional

string

Second line of the organization's address.

Character limit: 64

.. city

conditional

string

City where the organization is located. Required when creating a new organization.

Character limit: 64

.. state

conditional

string

State or province where the organization is located. Use the full name instead of an abbreviation. Required when creating a new organization.

Character limit: 64

.. zip

conditional

string

Postal code of the organization. Required when creating a new organization.

Character limit: 128

.. telephone

conditional

string

Organization telephone number. Required when creating a new organization.

Character limit: 32

.. contacts

conditional

string

List of objects with information about the organization contact, technical contact, and verified contacts for the organization.

Whether you need to provide a list of contacts depends on your usage requirements and whether the order is for a new or existing organization. For detailed information about how the API handles contacts in this array, see Contact types.

.. .. contact_type

required

string

Contact type.

Possible values: See Contact types.

.. .. user_id

conditional

string

To add an existing user as the contact, provide the user ID.

For verified contacts:

.. .. first_name

required

string

First name of the contact.

Character limit: 128

.. .. last_name

required

string

Last name of the contact.

Character limit: 128

.. .. job_title

conditional

string

Job title of the contact. Required for verified contacts.

Character limit: 64

.. .. telephone

conditional

string

Telephone number that can be used to reach the contact. Required for verified contacts.

Character limit: 32

.. .. telephone_extension

optional

string

Phone extension of the contact.

Character limit: 16

.. .. email

required

string

Email address that can be used to reach the contact.

Character limit: 255

.. 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

required

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. Overrides validity_years

Deprecated. Use the order_validity object to set the validity period of the certificate and order.

Format:yyyy-MM-dd

cs_provisioning_method^*

required^*

string

For EV code signing certificates, specify how you want to receive the token.

See Glossary – Provisioning methods

^*Required for EV code signing certificates.

ship_info^*

optional

object

For EV code signing certificates, specify the shipping address for the token.

.. name

required

string

Name of the recipient.

.. addr1

required

string

Shipping address for the token.

.. addr2

optional

string

.. city

required

string

Shipping city.

.. state

required

string

Shipping state.

.. zip

required

string

Shipping postal code.

.. country

required

string

Shipping country.

.. method

required

string

Shipping priority for the token.

Allowed values:STANDARD, EXPEDITED (incurs added cost)

subject

optional

object

Object containing subject details.

.. email

optional

string

Subject email address. Must have a validated domain. The Services API only supports the subject.email field for OV code signing certificates (code_signing). We ignore this field in order requests for EV code signing certificates (code_signing_ev).

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.

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.