Order PKIo Authentication or Encryption - Citizen

6 minute read

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

Use this endpoint to order a PKIo Authentication or Encryption - Citizen certificate. This certificate is issued to a Dutch citizen and enables secure digital signing or encryption. It supports the creation of advanced or qualified electronic signatures that are tamper-proof and legally compliant with Dutch regulations. The certificate can also be used to encrypt sensitive data or communications to ensure confidentiality.

Public Key Infrastructure for Organizations (PKIo) certificates are part of the PKIoverheid framework (a public key infrastructure managed by the Dutch government). PKIo certificates are primarily used in Netherlands and Belgium.

Example requests and responses

curl -X POST \
  'https://certcentral.digicert.eu/services/v2/order/certificate/pkio_burger' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "certificate": {
		"signature_hash": "sha256",
		"profile_option": "encryption",
                "is_rsassa_pss": true,
		"individual": {
			"first_name": "John",
			"last_name": "Doe",
			"email": "john.doe@example.com",
			"telephone": "+31(0)20 254 7999",
			"country": "nl",
			"city": "Amsterdam",
			"state": "Amsterdam",
			"zip": "1013 AA"
		}		
	},
	"csa_agreed_to": true,
	"provisioning_method": "token",
	"ship_info": {
		"name": "John Doe",
                "addr1": "813 Lincoln Street",
                "addr2": "Suite 20",
                "city": "Amsterdam",
                "state": "Amsterdam",
                "zip": "1013 AA",
                "country": "nl",
                "method": "STANDARD"
	},        
	"order_validity": {
                "years": 1
        },
	"payment_method": "balance"
}

curl -X POST \
  'https://certcentral.digicert.eu/services/v2/order/certificate/pkio_burger' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "certificate": {
		"signature_hash": "sha256",
		"profile_option": "nonrepudiation",
                "is_rsassa_pss": true,
		"individual": {
			"id": 21
		}
	},
	"csa_agreed_to": true,
	"provisioning_method": "token",
	"ship_info": {
		"name": "John Doe",
                "addr1": "813 Lincoln Street",
                "addr2": "Suite 20",
                "city": "Amsterdam",
                "state": "Amsterdam",
                "zip": "1013 AA",
                "country": "nl",
                "method": "STANDARD"
	},   
	"order_validity": {
                "years": 1
        },
	"payment_method": "balance"
}

201 Created (skip)

{
  "id": 843668399,  
  "certificate_id": 845503702
}

Request parameters

Name	Req/Opt	Type	Description
certificate	required	object	Certificate details.
.. signature_hash	required	string	Hash algorithm used for signing the certificate. PKIO certificates support only SHA-256 hash algorithm.
.. profile_option	required	string	Select a profile option that best defines the certificate usage. The options are:
.. 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.
.. individual	required	object	Information about the individual who is the intended certificate holder. This object requires either the `id` or the full set of identifying information (for example, first_name, last_name, email, telephone, country, and zip).
.. .. id	conditional	integer	Unique identifier for the individual. Note: Use this parameter only if you are ordering the certificate for an existing individual, whose details are already stored in the CertCentral database. If you are adding a new individual, omit this parameter and provide the full details instead.
.. .. first_name	conditional	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	conditional	string	Individual’s last name (surname). You may include generational suffixes, such as “Sr.” and “III”..
.. .. email	conditional	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	conditional	string	Individual’s phone number with the country code (for example, +31-0-72 568 7878).
.. .. country	conditional	string	Individual’s country, represented by a two-letter country code.
.. .. state	conditional	string	Individual’s state or province.
.. .. city	conditional	string	Iindividual’s city.
.. .. zip	conditional	string	Individual’s postal code.
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, we support only token-based key provisioning method. After you select `token` as the provisioning method in the request body while ordering the certificate, DigiCert ships the hardware token to you. You must include shipping details in the `ship_info` object to receive the token. 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 token.
ship_info	required	object	For orders with the `provisioning_method` of `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	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).
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.