Skip to main content

Order document signing certificate

POST https://www.digicert.com/services/v2/order/certificate/{{document_certificate_id}}

Notice

This page describes products with the document_signing group name (see Glossary – Product identifiers).

Use this endpoint to submit a document signing certificate request order using document_signing_org_1 or document_signing_org_2 as the document_certificate_id.

Request parameters

Name

Req/Opt

Type

Description

certificate

required

object

Certificate details.

.. csr

optional*

string

Certificate signing request (CSR).

*Required if cs_provisioning_method is email.

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 requesting a certificate for an organization without an existing ID, you must provide values for all required parameters of the organization object.

.. server_platform

optional

object

Server platform type.

Default: -1 (other)

.. .. id

required

int

Server platform ID. See Glossary – Server platforms.

.. signature_hash

required

string

Hash algorithm used to signing the certificate.

Allowed values: sha256

cs_provisioning_method

optional

string

Specify how you want to receive the token.

See Glossary – Provisioning methods

use_org_as_common_name

optional

bool

Specify if the organization name should be used as the common name on the certificate.

Default: true

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.

Range: 1-3

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, 2, 3

comments

optional

string

organization_contact

optional

object

Organization contact for the order.

Include this object at the root of the request body to create the order with a different organization contact than the one assigned to the organization on the request. If omitted, the order uses the same organization contact assigned to the organization.

Note: The order-level organization_contact is only used on the order. It does not replace the organization contact assigned to the organization on the request.

.. first_name

required

string

Contact first name.

.. last_name

required

string

Contact last name.

.. email

required

string

Contact email address.

.. job_title

optional

string

Contact job title.

.. telephone

optional

string

Contact telephone number.

.. telephone_extension

optional

string

Telephone extension.

technical_contact

optional

object

Technical contact for the order.

Include this object at the root of the request body to create the order with a different technical contact than the one assigned to the organization on the request. If omitted, the order uses the same technical contact assigned to the organization.

Note: The order-level technical_contact is only used on the order. It does not replace the technical contact assigned to the organization on the request.

.. first_name

required

string

Contact first name.

.. last_name

required

string

Contact last name.

.. email

required

string

Contact email address.

.. job_title

optional

string

Contact job title.

.. telephone

optional

string

Contact telephone number.

.. telephone_extension

optional

string

Telephone extension.

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.

  • If we find one matching organization, we automatically associate the order with that organization instead of creating a new one.

  • If we find two or more matching organizations, we automatically associate the order with the oldest matching organization in your account instead of creating a new one.

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

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.

.. contacts

conditional

array of objects

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

ship_info

optional

object

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

required

object

Subject information for the certificate.

.. name

required

string

Subject's full name.

.. job_title

required

string

Subject job title.

.. phone

required

string

Subject phone number.

.. email

required

string

Subject email address.

custom_fields

optionals

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.

user_id_assignments

optional

array

List of User IDs that can manage the order.

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

payment_method

optional

string

Payment method for the order. Allowed values:

  • balance (default): Pay with account balance. Returns an error if the option to bill to account balance is disabled for the account, or if the account balance has insufficient funds. Learn how to debit purchases against your CertCentral account balance.

  • profile: Pay with the account’s default credit card. Returns an error if no default credit card is configured for the account. Learn how to set up a default credit card.

  • card: Pay with a new credit card. Requests that use card as the payment method must include a credit_card and billing_address object. Returns an error if the option to pay with a credit card is disabled for the account.

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.

vat_number

optional

string

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.

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.

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.