Order Document Signing for Individual

certificate

required

object

Certificate details.

.. server_platform

optional

object

Server platform type.

Default:-1 (other)

.. .. id

required

int

Server platform ID. See Glossary – Server platforms.

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

.. usage_designation

required

object

Object that determines the primary use (KU) and additional uses (EKU) for the certificate.

.. .. primary_usage

required

string

Primary use for the certificate.

Allowed values: signing

.. .. additional_usages

optional

array

List of additional certificate uses.

Default: document_signing

Allowed values: adobe_authentic_documents_trustsigning, ms_document_signing, or document_signing.

cs_provisioning_method

required

string

Specify how you want to receive the token.

Default: email

Allowed values: email, ship_token, or client_app.

For more information about the provisioning methods, see Glossary – Provisioning methods

After placing the order, go to the Order your Document Signing for Individual certificate page in the CertCentral platform documentation, and view the What’s next subsection to carry out the subsequent tasks.

ship_info

optional

object

For orders with the cs_provisioning_method of ship_token, specify the shipping address for the hardware token.

.. name

required

string

First and last name of the recipient of the order.

.. addr1

required

string

Shipping address for the token.

.. addr2

required

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 or EXPEDITED (incurs additional cost).

.. csr

conditional

string

Certificate signing request (CSR) or public key in PEM format. Format the CSR/public key as a base64-encoded string without line breaks or escape characters. Include the PEM headers and footers (such as -----BEGIN CERTIFICATE REQUEST-----... and ...-----END CERTIFICATE REQUEST-----). For more information about generating a CSR, see Create a CSR.

Required if the cs_provisioning_method is email.

After placing the order, if the status of the order is pending, you can use the Update CSR endpoint to update the CSR. To check the status of the order, use the Order validation status endpoint.

Note: The Services API does not extract information from the CSR to fill in the details of a certificate request.

.. key_size

optional

int

Number of bits used in the key.

Default: 2048

Allowed values for RSA key type: 2048, 3072, or 4096.

Allowed values for ECC key type: p-256 or p-354.

.. csr_key_type

optional

string

Key type for the CSR.

Default: RSA

Allowed values: rsa or ecc.

.. signature_hash

optional

string

Hash algorithm used for signing the certificate.

Default: sha-256

Allowed values:: sha256, sha384, sha512.

comments

optional

string

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.

custom_renewal_message

optional

string

Custom message to be included in renewal notifications.

additional_emails

optional

array

Additional email addresses to receive certificate notification emails (for example, certificate issuance, duplicate certificate, and certificate renewals).

user_id_assignments

optional

array

List of User IDs that can manage the order.

csa_agreed_to

required

boolean

Specify if the Certificate Subscriber Agreement (CSA) has been agreed to. Set his parameter to true to indicate agreement and false for disagreement.

Default: true

Allowed values: 1 or 0.

promo_code

optional

string

Promotional code for the order.

order_validity

required

object 

Defines the validity period of the order. For public TLS/SSL certificates, order validity determines the length of a Multi-year Plan.

.. years 

required^*

int 

Total number of years the certificate and the order are valid.

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

Allowed value: 1, 2, or 3

.. days 

optional

int 

Total number of days the certificate and the order are 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.

individual

required

object

Information about the individual who is the intended certificate holder.

.. first_name

required

string

Individual's first name (given name). This can include middle names or initials, but do not include titles or prefixes such as "Dr.".

.. last_name

required

string

Individual's last name (given name). This can include middle names or initials, but do not include titles or prefixes such as "Dr.".

.. email

required

string

Individual's email address. This email address is used for processing the order request and receiving order approval notifications. This email address does not appear on the certificate.

.. telephone

required

string

Individual’s phone number with the country code (for example, +1-555-555-5555).

.. country

required

string

Individual's country, represented by a two-letter country code.

.. state

required

string

Individual's state or province.

.. city

optional

string

Iindividual's city.

.. zip

optional

string

Individual's postal code.

payment_method

required

string

Payment method for the order. Allowed values:

credit_card

required (if payment_method is card)

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

string

Credit card expiration month. Format as a two-digit number between 01 (Jan) and 12 (Dec).

.. expiration_year

required

string

Credit card expiration year. Format as a four-digit number. For example: 2026

.. cvv

required

string

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.

.. save_credit_card

optional

null

Specify whether to save the credit card details. true for saving the details, false for not saving the details, and null for not indicating the preference.

Allowed Values: true, false, or null.

.. set_as_default

required

string

Set the card as the default payment option or method. To set this card as your default payment method, use 1. To keep your default payment method, use 0.

Allowed Values: 1 or 0.

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.

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.