Order Swiss Client Authentication Certificate

7 minute read

POST https://certcentral.digicert.eu/services/v2/order/certificate/dtm_client_authentication_ch

Use this endpoint to order a Swiss Client Authentication certificate. Swiss Client Authentication certificates authenticate individuals, applications, or devices when connecting to protected services.

The Swiss Client Authentication Certificate is only available in CertCentral Europe. Only use the CertCentral Europe base URL, https://certcentral.digicert.eu/services/v2, to construct your Swiss Qualified Certificate for Individual API request.

Example requests and responses

cURL

curl -X POST \
  'https://certcentral.digicert.eu/services/v2/order/certificate/dtm_client_authentication_ch' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "certificate": {
      "common_name": "Estrella Daugherty",
      "emails": [
        "estrella.daugherty@example.com"
      ],
      "signature_hash": "sha256",
      "csr": "{{csr}}"
    },
    "auto_renew": 2,
    "organization": {
      "id": 2042709
    },
    "container": {
      "id": 2003927
    },
    "csa_agreed_to": true,
    "order_validity": {
      "years": 2
    },
    "payment_method": "balance"
  }'

{
  "id": 112233,
  "requests": [
    {
      "id": 113,
      "status": "pending"
    }
  ]
}

{
  "id": 112233,
  "requests": [
    {
      "id": 113,
      "status": "approved"
    }
  ],
  "certificate_id": 845166333113
}

Request parameters

Name	Req/Opt	Type	Description
certificate	required	object	Certificate details.
.. common_name	conditional	string	Common name to include in the certificate subject. Use a name that identifies the certificate holder, such as the individual's full name.
.. emails	required	array	Email addresses associated with the certificate holder and is included in the certificate.
.. signature_hash	required	string	Hash algorithm used for signing the certificate. Swiss Client Authentication certificates support only SHA-256 hash algorithm.
.. dns_names	optional	array	DNS names to include in the certificate's Subject Alternative Name extension.
.. csr	optional	string	Certificate signing request (CSR) or public key must be 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. After placing the order, if the status of the order is `pending`, you can use the Update CSR endpoint to update the 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, certificate.dns_names, and organization.id.
.. 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, seeConfigure the ICA certificate chain feature for your public TLS certificates.
auto_renew	optional	int	Number of times the certificate should renew automatically. Default: `null` - if you do not want automatic renewal of the certificate. Supported values: `null`, `1`, `2`, `3`, `4`, `5`, `10`, `25`, `99`.
renewal_of_order_id	optional	int	If order is a renewal, enter the previous order's ID.
organization	conditional	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. 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.
container	optional	object	If needed, specify the container the order should be placed under.
.. id	optional	int	Container ID.
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 this parameter to `true` to indicate agreement and `false` for disagreement. 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. *Can be replaced by `order_validity.days` or `order_validity.custom_expiration_date`. Range: 1-3
.. days	optional	int	Number of days the certificate and order are valid. Overrides `order_validity.years`.
.. 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")
payment_method	required	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	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.

Response parameters

Name	Type	Description
id	int	Order ID.
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.
organization	object	Container for new organization details. Only returned if a new organization was created with the order.
.. id	int	ID of the newly created organization.