Skip to main content

Order GeoTrust DV SSL

POST https://www.digicert.com/services/v2/order/certificate/ssl_dv_geotrust_flex

Use this endpoint to request or renew a GeoTrust DV SSL certificate. To renew a certificate, you must place the request from the same account used to order the original certificate.

Public TLS/SSL certificates support Multi-year Plans. With Multi-year Plans, you pick the SSL/TLS certificate, the certificate validity period, and the duration of coverage you want. To order a Multi-year Plan with this endpoint, use the order_validity object to set the validity period of the order (up to three years). Optionally, use the certificate.cert_validity parameter to customize the validity of the first certificate issued for the order. For more information, see Multi-year Plans.

Warning

End of 4- to 6-year Multi-year Plans

On October 31, 2023, DigiCert will no longer sell 4- to 6-year Multi-year Plans for TLS and VMC certificates. We will continue to offer 1, 2, and 3-year Multi-year Plans. For more information, see End of 4- to 6-year Multi-year Plans.

Notice

Enterprise License Agreement (ELA) and Flat Fee contracts only support 1- and 2-year Multi-year Plans.

Example requests and responses

Request parameters

Notice

For information about allowed values for certificate fields, see Public certificates – Data entries that violate industry standards.

Name

Req/Opt

Type

Description

certificate

required

object

Certificate details.

.. common_name

required

string

Domain to be secured.

.. dns_names

optional

array

Additional domains to be secured. Can result in additional costs. (See Best practices – Get both versions of a domain for free.)

.. csr

required

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 and certificate.dns_names.

.. signature_hash

required

string

Hash algorithm used to signing the certificate.

Allowed values:sha256

.. organization_units

optional

array

Department in your organization the certificate is for.

Deprecated. This field is ignored for public TLS/SSL certificate requests. See our knowledge base article.

.. server_platform

optional

object

Server platform type.

Default:-1 (other)

.. .. id

required

int

Server platform ID. See Glossary – Server platforms.

.. cert_validity

optional

object 

Defines the validity period of certificates issued for this order. Cannot exceed order validity period.

If not provided, or if the cert_validity date is less than 365 days from the current date, the certificate's validity period defaults to the validity period of the order or the maximum certificate validity period defined by CA/B Forum baseline requirements, whichever is shorter.

This object is not used for requests from accounts that do not have Multi-year Plans enabled.

.. .. years

optional

int 

Number of years the certificate is valid after it is issued. Can be replaced with cert_validity.days or cert_validity.custom_expiration_date.

Allowed value: 1

.. .. days

optional

int 

Number of days the certificate is valid after it is issued. Overrides cert_validity.years.

Max: 397

.. .. custom_expiration_date

optional

string

A custom expiration date for the certificate. Overrides cert_validity.days and cert_validity.years.

Format: dd MMM YYYY (for example, "09 JUN 2021")

Range: Must be within 397 days of the date you request the certificate.

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

*This parameter is ignored if the option for ICA selection is not enabled for your account. For more information, see Configure the ICA certificate chain feature for your public TLS certificates.

renewed_thumbprint

optional*

string

If order is a renewal, enter the SHA-1 thumbprint of the previous order's primary certificate. For more information, see How to check a certificate's thumbprint.

*Renewal orders must include either a renewed_thumbprint or renewal_of_order_id value.

order_validity

required

object 

Defines the validity period of the order. Order validity determines the length of a Multi-year Plan.

.. years 

required*

int 

Number of years the order is valid.

*Can be replaced by order_validity.days or order_validity.custom_expiration_date.

Range: 1-3

.. days 

optional

int 

Number of days the order is valid. Overrides order_validity.years.

Max: 1095

.. custom_expiration_date 

optional

string 

Custom expiration date for the order. Overrides order_validity.days and order_validity.years.

Format: dd MMM YYYY (for example, "09 JUN 2025")

Range: Must be within three years of the date you request the order.

validity_years 

optional

int 

Number of years the order is valid.

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

Range: 1-3

validity_days 

optional

int 

Number of days the order is valid. Overrides validity_years.

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

Max: 1095

custom_expiration_date 

optional

string 

Custom expiration date for the order. Overrides validity_days and validity_years.

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

Format: yyyy-MM-dd

Range: Must be within three years of the date you request the order.

comments

optional

string

apply_cr_discount

optional

bool

When true, applies any competitive replacement discounts that are available for the domains on the order. To calculate competitive replacement discounts before you place an order, use the List replacement benefits endpoint.

Default: false

serial_number

optional

string

Serial number of the non-DigiCert certificate for which you expect to receive a competitive replacement discount when you place the order. If not provided, we use the information from your order request to look for a match among certificates on the CT log servers, and we apply a discount based on the best match we can find.

auto_renew

optional

int

Specify if the certificate should automatically renew.

Allowed values:0 (disabled) or 1 (enabled)

Default:0

auto_reissue

optional

int

Auto-reissue setting for the order. When auto-reissue is enabled for a Multi-year Plan, DigiCert automatically creates a reissue request for the most recently issued certificate when that certificate is within 30 days of expiring. Auto-reissue repeats until the order expires. To learn more about reissuing certificates in a Multi-year Plan, seeMulti-year Plans

Allowed values:0 (disabled) or 1 (enabled)

Default:0 (disabled)

Note: We ignore the auto_reissue request parameter if:

  • The product does not support Multi-year Plans.

  • Multi-year Plans are disabled for the account.

custom_renewal_message

optional

string

Custom message to be included in renewal notifications.

disable_renewal_notifications

optional

bool

Specify if renewal notification emails should be disabled.

Default:false

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.

*Renewal orders must include either a renewed_thumbprint or renewal_of_order_id value.

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

dcv_method

optional

string

DCV method to use when verifying domain control. See Glossary – DCV methods.

dcv_emails

optional

array

List specifying the email scope when sending DCV emails. You can add an entry for each DNS name being secured by the certificate.

.. dns_name

required

string

DNS name on the certificate that this scope should apply to.

.. email_domain

required

string

WHOIS domain record to use to verify email addresses. This value must match the dns_names base domain.

.. email

optional

string

Email address to use when sending DCV emails. This email address must appear on the WHOIS record for the domain specified in the email_domain parameter.

locale

optional

string

Language that the DCV email should use. See Glossary – Locale codes.

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

disable_ct

optional

bool

Specify if CT logging for the certificate should be disabled. Order-specific CT logging must be enabled, or this will be ignored. See Allow users to keep certificates out of CT logs.

Default:false

container

optional

object

If needed, specify the container the order should be placed under.

.. id

required

int

Container ID.

custom_fields

optional*

array

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.

technical_contact

optional

object

Technical contact details.

.. first_name

required

string

First name of the technical contact.

.. last_name

required

string

Last name of the technical contact.

.. telephone

required

string

Telephone number of the technical contact.

.. job_title

optional

string

Job title of the technical contact.

.. email

required

string

Email address of the technical contact.

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.

use_auth_key

optional

bool

certificate_dcv_scope

optional

string

Response parameters

Name

Type

Description

id

int

Order ID.

certificate_id

int

Certificate ID.

dcv_random_value

string

Random value used for domain control validation. Only returned when using dns-txt-token, dns-cname-token, or http-token as the DCV method. Not returned if use_auth_key is true.

certificate_chain

array

Ordered list of objects with information about each certificate in the certificate chain (for example, SSL certificate, intermediate CA certificate, and root certificate). The first object in the array contains the end-entity certificate. The next objects contain the intermediate CA certificates. The final object contains the root certificate. Each certificate is signed by the certificate in the object that follows it. For example, the end-entity certificate is signed by the intermediate CA certificate.

Note: This endpoint only returns the certificate_chain array for TLS certificates that DigiCert issues immediately. To get the certificate chain after DigiCert issues a certificate, use the Certificate chain endpoint.

.. subject_common_name

string

Common name on the certificate.

.. pem

string

PEM-encoded certificate data.

requests

array

Contains information about the request.

.. id

int

Request ID.

.. status

string

Request status.

Possible values:pending, submitted, approved, rejected