Order code signing certificate
POST https://www.digicert.com/services/v2/order/certificate/{{code_signing_certificate_id}}
Use this endpoint to submit a request to create an order for a Code Signing (CS) or EV Code Signing (EV CS) certificate. In the endpoint path, replace code_signing_certificate_id
with the ID of the certificate you want to order:
Code Signing:
code_signing
EV Code Signing:
code_signing_ev
Important
Industry moved to RSA 3072-bit key minimum for code signing certificates
To comply with industry changes, DigiCert has made the following changes to our code signing certificate process:
Only issues RSA 3072-bit key or larger code signing certificates*
Uses new intermediate CA and root certificates to issue our code signing and EV code signing certificates: RSA and ECC.
eToken and Hardware Security Module (HSM) changes
DigiCert supports two eTokens:
5110 CC for RSA 4096-bit and ECC P-256-bit key certificates
5110 FIPS for ECC P-256 and P-384-bit key certificates
HSM must:
Support ECC P-256 or RSA 3072-bit key sizes or larger
Be a FIPS 140-2 Level 2+ or Common Criteria EAL4+ compliant device
*Note: All existing 2048-bit key code signing certificates issued before June 1, 2021 will remain active. You can continue to use these certificates to sign code until they expire.
Learn more about the change to 3072-bit key code signing certificates.
Example requests and responses
Path parameters
Name | Req/Opt | Description |
---|---|---|
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. |
Request parameters
Notice
Parameters with an asterisk (*) are used only for EV code signing orders.
Name | Req/Opt | Type | Description |
---|---|---|---|
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 |
.. signature_hash | required | string | Hash algorithm used to signing the certificate. Allowed values: |
.. server_platform | required* | object | Server platform type. *Required if |
.. .. 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: The |
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 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 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 | optional | string | Public name of the organization. Also called Doing Business As (DBA) name. Character limit: The combined length of the submitted |
.. 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 |
required | string | Email address that can be used to reach the contact. Character limit: 255 | |
.. skip_duplicate_org_check | optional | bool | Use Default: |
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 Range: |
.. days | optional | int | Number of days the certificate and order are valid. Overrides |
.. custom_expiration_date | optional | string | Custom expiration date for the certificate and order. Overrides Format: |
validity_years | optional | int | Number of years the certificate and order are valid. Deprecated. Use the Allowed values: |
custom_expiration_date | optional | string | Custom expiration date for the certificate and order. Overrides Deprecated. Use the Format: |
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: |
subject | optional | object | Object containing subject details. |
optional | string | Subject email address. Must have a validated domain. The Services API only supports the | |
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 |
.. number | required | string | Credit card number. |
.. expiration_month | required | integer | Credit card expiration month. Format as a two-digit number between |
.. expiration_year | required | integer | Credit card expiration year. Format as a four-digit number. For example: |
.. cvv | required | integer | Card verification value (CVV). Format as a three- or four-digit number. For example: |
.. cardholder_name | required | string | Cardholder’s first and last name. |
billing_address | conditional | object | Object with information about the billing address. Required if |
.. 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 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 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 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: 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: |
certificate_id | int | Certificate ID. Returned if request status is |
Contact types
Contact type | Description |
---|---|
| Organization contact.
Existing organizations When using an existing organization in your request:
New organizations When creating a new organization with your order request, you are required to include an |
| Technical contact.
Existing organizations When using an existing organization in your request:
New organizations When creating a new organization with your order request, including a |
| Before DigiCert can issue your certificate, a verified contact must approve the requestor's authority to order a certificate for the organization. An organization can have multiple verified contacts. Existing validated organizations When using an existing organization that is already validated or pending validation for CS or EV CS certificate issuance:
Unvalidated or new organizations When creating a new organization, or when using an existing organization neither validated nor pending validation for CS or EV CS certificate issuance, include information about each By default, if you do not specify a verified contact for a new or unvalidated organization, DigiCert attempts to add the authenticated user (the user who owns the API key in the request) as a verified contact for the organization. DigiCert applies this default when:
Note*DigiCert must validate new verified contacts before they can approve CS or EV CS orders for the organization. |
CS and EV CS organization validation
Code Signing (CS) and EV Code Signing (EV CS) certificate orders must include information about the organization to associate with the code signing certificate. DigiCert must validate the organization before issuing the certificate. The following examples show three ways to add an organization to your CS or EV CS certificate order.
Use existing organization (validated)
When including an organization already submitted for CS or EV CS validation, either by itself or as part of an earlier certificate order request, you only need to include the organization's ID in your new order request:
{ "certificate": { ... } "organization": { "id": 12345 }, ... }
If needed, you can update the organization contact or technical contact and add new verified contacts to the organization. Use the organization.contacts
array to provide information about each new contact. To learn more, see Contact types.
{ "certificate": { ... } "organization": { "id": 12345, "contacts": [ { "contact_type": "verified_contact", "user_id": 12345 }, { "contact_type": "organization_contact", "user_id": 56789 }, { "contact_type": "technical_contact", "first_name": "Jane", "last_name": "Doe", "job_title": "Technician", "telephone": "1234567890", "email": "jane.doe@example.com" } ] }, ... }
Use existing organization (not validated)
When including an existing organization never submitted for CS or EV CS validation, you can submit the organization for validation as part of your certificate order request:
In the
organization
object, provide theid
of the existing organization.In the
organization.contacts
array, provide a list of verified contacts to submit as CS or EV CS approvers for the organization.After creating the order, the organization is automatically submitted for the validation type corresponding to the chosen product (CS or EV CS).
For example:
{ "certificate": { ... } "organization": { "id": 12345, "contacts": [ { "contact_type": "verified_contact", "user_id": 12345 } }, ... }
Use a new organization
When adding a new organization, use the organization
object to provide the organization's name, location, and phone number. Make sure to include an organization_contact
and at least one verified_contact
(see Contact types). When you create the order, the new organization is added to your CertCentral account and submitted for CS or EV CS validation.
{ "certificate": { ... }, "organization": { "name": "New Organization", "assumed_name": "New Organization", "country": "us", "address": "123 Example Street", "address2": "Floor 08", "city": "Lehi", "state": "Utah", "zip": "12345", "telephone": "123-456-789", "contacts": [ { "contact_type": "verified_contact", "first_name": "John", "last_name": "Doe", "job_title": "Technician", "telephone": "1234567890", "email": "john.doe@example.com" }, { "contact_type": "organization_contact", "first_name": "Jane", "last_name": "Doe", "job_title": "Supervisor", "telephone": "1234567890", "email": "jane.doe@example.com" }, { "contact_type": "technical_contact", "first_name": "Alex", "last_name": "Doe", "job_title": "Technician", "telephone": "1234567890", "email": "alex.doe@example.com" } ] }, ... }