Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Request

Used to request a certificate

  • POSTMethod
  • /v2/ssl/certificatesURL
  • application/jsonContent-Type
Request parameters
Name Type Required / Optional Description Restrictions
quote Boolean Optional If true, validate the request and request a quote for the action
Request content fields
Name Type Required / Optional Description Restrictions
customer String Required The customer handle
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
product String Required The product defines the type of certificate to create
period Integer Required The validity period of the certificate in months, Multi year certificates are delivered as a subscription service.
csr String Required A valid Certificate Signing Request
domainName String Optional Overrides the common name in the CSR, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Regular expression: (?:\*\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 4
  • Maximum length: 255
san List <String> Optional List of SAN domains, overrides the alternative names in CSR, only applicible for multi domain certificates. Free www/non-www (when applicable) names are not automatically added for multi domain certificates, they must be specified. To exclude the free www/non-www name from your single-domain certificate, set this field to an empty list (`[]`).
  • Regular expression: (?:\*\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 4
  • Maximum length: 255
organization String Optional The organization, overrides the Organization field in CSR
  • Minimum length: 1
  • Maximum length: 64
department String Optional Deprecated The department, overrides the Organisational Unit field in CSR
  • Minimum length: 1
  • Maximum length: 60
country String Optional The country, will be taken from the CSR when not explicitly passed
  • Minimum length: 2
  • Maximum length: 2
state String Optional The state, will be taken from the CSR when not explicitly passed
  • Minimum length: 1
  • Maximum length: 60
address String Optional The address, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 1
  • Maximum length: 60
postalCode String Optional The postal code, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 1
  • Maximum length: 10
city String Optional The city, overrides the City field in CSR
  • Minimum length: 1
  • Maximum length: 60
coc String Optional Chamber Of Commerce identifier, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Minimum length: 1
  • Maximum length: 32
saEmail String Optional Recipient for the Subscriber Agreement, see requiredFields/optionalFields in ssl product metadata for supported usage
  • Regular expression: (?=.{1,64}@)[a-z0-9_\-+]+(?:\.[a-z0-9_\-+]+)*@(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 6
  • Maximum length: 255
saLanguage Enum Optional Deprecated Us the new "language" field available on all request types, for backward compatibility we use this value if "language" is not supplied

Possible values:

  • EN: English
  • NL: Dutch
  • FR: French
  • CN: Simplified Chinese
  • DE: German
  • IT: Italian
  • JP: Japanese
  • KR: Korean
  • PT: Portugese
  • RU: Russian
  • ES: Spanish
  • DK: Danish
  • SE: Swedish
  • TR: Turkish
language Enum Optional Preferred for validations, if not supplied default is selected based on the country. Supported languages may differ per provider, if not supported defaults back to English

Possible values:

  • EN: English
  • NL: Dutch
  • FR: French
  • CN: Simplified Chinese
  • DE: German
  • IT: Italian
  • JP: Japanese
  • KR: Korean
  • PT: Portugese
  • RU: Russian
  • ES: Spanish
  • DK: Danish
  • SE: Swedish
  • TR: Turkish
uniqueValue String Optional An alphanumeric value of max 20 characters used for DCV validation, if not given a random string will be generated.
  • Regular expression: [a-zA-Z0-9]+
  • Minimum length: 1
  • Maximum length: 20
authKey Boolean Optional Use auth key validation for direct issuance, see requiredFields/optionalFields in ssl product metadata for supported usage
approver approver Optional Approver of the certificate, see requiredFields/optionalFields in ssl product metadata for usage.
dcv List < dcv > Optional List of DCVs for this certificate
approver
Name Type Required / Optional Description Restrictions
firstName String Required First name of the approver
  • Minimum length: 1
  • Maximum length: 40
lastName String Required Last name of the approver
  • Minimum length: 1
  • Maximum length: 40
jobTitle String Optional Job title of the approver
  • Minimum length: 1
  • Maximum length: 40
email String Required Email address of the approver
  • Regular expression: (?=.{1,64}@)[a-z0-9_\-+]+(?:\.[a-z0-9_\-+]+)*@(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 6
  • Maximum length: 255
voice String Required The voice telephone number of the approver
  • Regular expression: \+[0-9]{1,3}\.[0-9]{1,14}
  • Minimum length: 4
  • Maximum length: 17
dcv
Name Type Required / Optional Description Restrictions
commonName String Required The common name for this DCV entry
  • Regular expression: (?:\*\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 4
  • Maximum length: 255
type Enum Required The validation type used for this DCV entry

Possible values:

  • EMAIL: Email
  • FILE: File
  • DNS: DNS
email String Optional The email address for this DCV entry, required if 'type' is set to 'EMAIL'
  • Regular expression: (?=.{1,64}@)[a-z0-9_\-+]+(?:\.[a-z0-9_\-+]+)*@(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])
  • Minimum length: 6
  • Maximum length: 255

Successful request

Certificate has been issued immediately
  • 201 CreatedHTTP Status

Response is the same as info process

Request accepted, pending result
  • 202 AcceptedHTTP Status

Response is the same as info process

Failed requests

Generic errors can be expected.

Request parameters
If true, validate the request and request a quote for the action
Request parameters
The customer handle
The product defines the type of certificate to create
The validity period of the certificate in months, Multi year certificates are delivered as a subscription service.
A valid Certificate Signing Request
Overrides the common name in the CSR, see requiredFields/optionalFields in ssl product metadata for supported usage
List of SAN domains, overrides the alternative names in CSR, only applicible for multi domain certificates. Free www/non-www (when applicable) names are not automatically added for multi domain certificates, they must be specified. To exclude the free www/non-www name from your single-domain certificate, set this field to an empty list (`[]`).
The organization, overrides the Organization field in CSR
The department, overrides the Organisational Unit field in CSR
The country, will be taken from the CSR when not explicitly passed
The state, will be taken from the CSR when not explicitly passed
The address, see requiredFields/optionalFields in ssl product metadata for supported usage
The postal code, see requiredFields/optionalFields in ssl product metadata for supported usage
The city, overrides the City field in CSR
Chamber Of Commerce identifier, see requiredFields/optionalFields in ssl product metadata for supported usage
Recipient for the Subscriber Agreement, see requiredFields/optionalFields in ssl product metadata for supported usage
Us the new "language" field available on all request types, for backward compatibility we use this value if "language" is not supplied
Preferred for validations, if not supplied default is selected based on the country. Supported languages may differ per provider, if not supported defaults back to English
An alphanumeric value of max 20 characters used for DCV validation, if not given a random string will be generated.
Use auth key validation for direct issuance, see requiredFields/optionalFields in ssl product metadata for supported usage
approver
First name of the approver
Last name of the approver
Job title of the approver
Email address of the approver
The voice telephone number of the approver
dcv
The common name for this DCV entry
The validation type used for this DCV entry
The email address for this DCV entry, required if 'type' is set to 'EMAIL'
Request

POST /v2/ssl/certificates
Content-Type: application/json 

{}
Response