| 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. |
| Name | Req/Opt | Type | Description |
|---|---|---|---|
| certificate | required | object | Certificate details. |
| .. csr | conditional | string | Certificate signing request (CSR). Required for Code Signing and EV Code Signing certificates that will be installed on HSMs ( cs_provisioning_method is email). The CSR must use a key size your hardware supports.DigiCert rejects code_signing certificate requests that include a CSR if the cs_provisioning_method is not 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 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 sign the certificate. For more information, see Hash Types. Allowed values:sha256, sha384, and sha512. |
| .. ca_cert_id | optional | string | ID of the intermediate certificate authority (ICA) certificate to select as the issuing certificate. To get the ca_cert_id value for an ICA, use the Product list endpoint.Account administrators can customize the default and allowed ICAs for each product at the container or user role level. If you do not provide a value for this parameter, we issue the certificate using the default ICA. If you provide the ca_cert_id value for an ICA that is not allowed, the request returns an error*. To see the custom ICA settings for each product, use the Product limits endpoint.Note: Required if multiple CA certificates are configured. Also, this parameter is ignored if the option for ICA selection is not enabled for your account. To enable ICA selection, contact your account manager or the Support team. |
| .. server_platform | conditional | object | Server platform type. |
| .. .. id | conditional | int | Server platform ID. Allowed values: See Code Signing and EV Code Signing hardware platforms. Usage depends on provisioning method ( cs_provisioning_method):
Important! When DigiCert receives a Code Signing or EV Code Signing request with a server_platform.id of 51-57, we automatically convert the server_platform.id to -1 (other) before creating the order or order request. |
| .. 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_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. |
| 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. |
| 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 by providing an organization ID, or you can create a new organization by submitting new information with your order request. For examples, see Theorganizationobject.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. When creating a new organization:
When using an existing organization ID:
Note:
|
| .. .. contact_type | required | string | Contact type. Allowed values:organization_contact, technical_contact, verified_contact (formerly ev_approver*) *Note: To identify a verified contact for the organization, use verified_contact instead of ev_approver. While the API still accepts order requests that use ev_approver to identify verified contacts, ev_approver is a legacy label chosen when the only DigiCert products that required verified contacts were EV TLS/SSL certificates. Both contact type labels (verified_contact and ev_approver) have the same meaning, but verified_contact uses generalized terminology applicable to every product that requires a verified contact. |
| .. .. 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 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. The maximum validity period for a Public Code Signing certificate is 459 days. For more information, see Moving to 459-day validity for public Code Signing certificates. |
| .. 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. The requested validity period cannot exceed 459 days. Range: 1 |
| .. days | optional | int | Number of days the certificate and order are valid. Overrides order_validity.years. The requested validity period cannot exceed 459 days. |
| .. custom_expiration_date | optional | string | Custom expiration date for the certificate and order. Overrides order_validity.days and order_validity.years. Format: YYYY-MM-DD (for example, "2026-12-26") The requested validity period cannot exceed 459 days. |
| cs_provisioning_method | optional | string | For Code Signing or EV Code Signing orders, provisioning method for the certificate. Optional for both Code Signing and EV Code Signing certificates. If omitted, DigiCert creates the order using the default provisioning method from your CertCentral account settings. Allowed values: ship_token, client_app, email, keylocker. Learn more about code signing provisioning methods. |
| ship_info | optional | object | For Code Signing or EV Code Signing orders with a cs_provisioning_method of ship_token, specify the shipping address for the hardware token.Optional for both Code Signing and EV Code Signing certificates. For orders that omit the ship_info object, DigiCert uses the default token shipping address from your CertCentral account settings. |
| .. name | required | string | Name of the recipient. |
| .. addr1 | required | string | Shipping address for the token. |
| .. addr2 | optional | string | Secondary address field. |
| .. 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. |
| 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 | conditional | object | Account-specific custom fields. Whether 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. |
| vat_number | optional | string | If the payment method is card (new credit card) or profile (default credit card), use the vat_number request parameter to set a value-added tax (VAT) or goods and services tax (GST) identification number for the order transaction. DigiCert includes this number on the transaction receipt as a reference for your financial records.If omitted, DigiCert uses the VAT/GST number from the finance settings for the CertCentral account. If the VAT/GST number is absent from both the order request and account settings, DigiCert doesn't store a VAT/GST number for the transaction. Note
|
| 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. |
| Contact type | Description |
|---|---|
organization_contact |
Organization contact.
|
technical_contact |
Technical contact.
|
verified_contact |
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, DigiCert sends order approval emails to all CS or EV CS verified contacts for the organization. To send order approval emails to an additional verified_contact who is not yet validated for the organization, include that verified_contact in your order request.*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 verified_contact who should be allowed to approve CS or EV CS order requests for the organization.*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. |