Order Swiss Regulated Certificate for Organisation
10 minute read
POST
Use this endpoint to order a Swiss Regulated Certificate for Organisation. This certificate is issued to a legal entity (organisation) to apply regulated electronic seals to digital documents or data under Swiss law.https://certcentral.digicert.eu/services/v2/order/certificate/swiss_regulated_organisation
Regulated electronic signing refers to signatures that comply with specific legal, sectoral, or contractual requirements in Switzerland (such as those outlined in ZertES), but that do not require the full identity verification and legal equivalence of a qualified electronic signature (QES).
Warning
The Swiss Regulated Certificate for Organisation is only available in CertCentral Europe. Only use the CertCentral Europe base URL,https://certcentral.digicert.eu/services/v2, to construct your Swiss Regulated Certificate for Organisation API request.Example requests and responses
cURL
curl -X POST \
'https://certcentral.digicert.eu/services/v2/order/certificate/swiss_regulated_organisation' \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}' \
-d '{
"certificate": {
"signature_hash": "sha256",
"is_rsassa_pss": true
},
"container": {
"id": "662962"
},
"csa_agreed_to": true,
"provisioning_method": "qscd",
"ship_info": {
"name": "Swiss shipping info",
"addr1": "Wankdorfallee 5",
"addr2": "Bldg 39",
"city": "Bern",
"state": "Switzerland",
"zip": "3030",
"country": "ch",
"method": "STANDARD"
},
"requester": {
"first_name": "Valentina",
"last_name": "Franklin",
"email": "valentina.franklin@requester.com",
"telephone": "+41 848 888 888",
"job_title": "Engineer",
"contact_type": "existing_contact"
},
"organization": {
"id": "2042709",
"contacts": [
{
"user_id": "2812497",
"first_name": "John",
"last_name": "Doe",
"job_title": "Project Manager",
"telephone": "123-456-7890",
"email": "john.doe@example.com",
"contact_type": "organization_contact"
},
{
"user_id": "4532300",
"first_name": "John",
"last_name": "Smith",
"job_title": "Engineer",
"telephone": "1801-903-4284",
"email": "john.smith@example.com",
"contact_type": "verified_contact"
}
]
},
"order_validity": {
"years": 1
},
"payment_method": "balance"
}
201 Created (skip)
{
"id": 112233,
"certificate_id": 113
}
Request parameters
| Name | Req/Opt | Type | Description |
|---|---|---|---|
| certificate | required | object | Certificate details. |
| .. signature_hash | required | string | Hash algorithm used for signing the certificate. Swiss Regulated certificates support only SHA-256 hash algorithm. |
| .. profile_option | optional | string | Select a profile option that best defines the certificate usage. Swiss regulated certificates support only nonrepudiation profile option.For more information, see Certificate profile options. |
| .. is_rsassa_pss | optional | boolean | If true, DigiCert issues the end-entity certificate with an RSASSA-PSS signature. If false (default), DigiCert issues the end-entity certificate with an RSA signature.Important: This parameter is only honored when the issuing ICA certificate has an RSA key. If the issuing ICA certificate has an ECC key, DigiCert issues the end-entity certificate with an ECC signature that has same key size as the issuing ICA certificate. |
| container | optional | object | If needed, specify the container under which the order should be placed. This refers to the account or sub-account in DigiCert CertCentral where the certificate order will reside. |
| .. id | required | int | Specify the container ID. Each account or sub-account has a unique container ID, and specifying it correctly simplifies managing and billing of certificates. |
| 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 |
| provisioning_method | required | string | Specify the key provisioning method. Key provisioning method refers to where the private key and the certificate will be stored. Currently, only Qualified signature/seal creation device (QSCD) key provisioning method is supported. Although this method uses a certified hardware token for secure key storage, the certificate issued under this profile is a Swiss regulated certificate, not a qualified certificate. If you select the qscd provisioning method in the request body, DigiCert ships the QSCD hardware token to you. You must include shipping details in the ship_info object to receive the QSCD. After receiving the device and the PIN, you must use the DigiCert Trust Assistant to initialize and install your certificate on the token. To do so, use the certificate’s order details page on the CertCentral Europe platform user interface to download and install the DigiCert Trust Assistant. You can use the DigiCert Trust Assistant to unlock and install the certificate on your QSCD token. |
| ship_info | optional | object | For orders with the provisioning_method of qscd, 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 | Continuation of street address. |
| .. 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). |
| requester | required | string | Details of the individual submitting the certificate order. |
| .. first_name | required | string | First name of the requester. |
| .. last_name | required | string | Last name of the requester. |
| required | string | Email address of the requester. | |
| .. telephone | required | string | Contact number of the requester. |
| .. job_title | required | string | Job title or role of the requester. |
| 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 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 | required | integer | 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. For details on how to create a new organization, see Create organization. |
| .. contacts | required | array | List of contacts for the organization. |
| When creating a new organization: | |||
| Providing a verified_contact is required while ordering certificates. You can add multiple verified contacts, with a maximum limit of fifteen. | |||
| The verified contact is your organization’s authorized representative. The authorized representative must be included in the company registry, must represent the organization, and has the authority to approve your certificate order. | |||
| Providing an organization_contact is conditional. An organization_contact is required if the request is from a service user. If omitted, the organization is created and the authenticated user is used as the organization contact. | |||
| Providing a technical_contact is optional. If omitted, the organization is created with no technical contact. | |||
| When using an existing organization ID: | |||
| Providing an organization_contact and technical_contact is optional. If provided, the new organization and technical contact replace the existing contacts stored on the organization. | |||
| Providing a verified_contact is required. | |||
| Note: By default, DigiCert creates the order with the organization contact and technical contact (if one exists) assigned to the organization on the request. To create the order with a different organization or technical contact than those assigned to the organization, include the organization_contact or technical_contact object at the root of the request payload. | |||
| .. .. first_name | optional | string | First name of the new contact. Note: Required when omitting user_id. If user_id is not omitted, the specified user’s information will be updated with the new value. |
| .. .. last_name | optional | string | Last name of the new contact. Note: Required when omitting user_id. If user_id is not omitted, the specified user’s information will be updated with the new value. |
| optional | string | Email address of the new contact. Note: Required when omitting user_id. If user_id is not omitted, the specified user’s information will be updated with the new value. | |
| .. .. job_title | optional | string | Job title of the new contact. Note: Required when omitting user_id. If user_id is not omitted, the specified user’s information will be updated with the new value. |
| .. .. telephone | optional | string | Telephone number of the new contact. Note: Required when omitting user_id. If user_id is not omitted, the specified user’s information will be updated with the new value. |
| .. .. contact_type | required | string | Contact type. |
| Allowed values: organization_contact, technical_contact, or verified_contact. | |||
| Note: This parameter is required when creating a new authorized representative or when using an existing verified contact as an authorized representative. | |||
| .. .. user_id | required* | integer | ID of existing user or contact for the account. *Can be omitted if adding a new contact. |
| .. order_validity | optional | object | Defines the validity period of certificates issued for this order. Cannot exceed order validity period. If not provided, or if the certificate 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, 2, or 3 |
| .. .. 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. |
| 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. |
Response parameters
| Name | Type | Description |
|---|---|---|
| id | int | Order ID. |
| 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 | Organization ID for the new organization. |
Was this page helpful?
Provide feedback