eIDAS certificate
Endpoint: !AutoApplyOrder
https://secure.trust-provider.com/products/!AutoApplyOrder
Use the POST method for this endpoint.
Submit parameters in the x-www-form-urlencoded format.
Request parameters
| Parameter | Requirement | Type | Max.Length | Description | ||
|---|---|---|---|---|---|---|
|
required |
string |
64 chars |
Your account username. This value is case sensitive. |
||
|
required |
string |
128 chars |
Your account password. This value is case sensitive. |
||
|
required |
string |
64 chars |
Specifies a comma-separated string of integers for a product code. There must be exactly one of the following integers specified:
QSCD in the certificate type name indicates that the private key and the related certificate must reside on a QSCD, for example, on a token that is certified and approved for being used to generate Qualified Electronic Signatures. |
||
|
required |
integer |
The validity period, in days.
For QWAC eIDAS certificates the allowed values are:
For non-QWAC eIDAS certificates the allowed values are:
Sectigo allows purchase of a certificate bundle for multiple years.
Two, three, four, and five-year certificates bundle can be placed by setting the |
|||
|
required |
integer |
Specifies the server software code. The allowed values are:
This parameter does not directly affect the certificate content.
Use |
|||
|
optional |
string |
64 chars |
(QWAC certificates only) The primary domain name. One of the domain names listed in If this parameter is omitted for multi-domain certificates, no Common Names will be included in the resulting certificate. |
||
|
optional |
integer |
(QWAC certificates only) The number of Common Names (CN). It is optional for Multi-Domain certificates. It is ignored for all other certificate types. If omitted, the value defaults to If it is If it is All the Domain Names listed in |
|||
|
required |
string |
32767 chars |
The Base64-encoded certificate signing request (CSR), with or without the |
||
|
optional |
string |
20 chars |
An alphanumeric value used to ensure the Request Token is unique for The request tokens are as defined in the CA/B Forum Baseline requirements (version 1.4.1 or later) and used in the manner described in Sectigo’s Domain Control Validation. If the If the |
||
|
optional |
char |
1 char |
Specifies which values to use if there are duplicates. For example, if a postal code is specified in both the CSR and as a separate variable. The allowed values are:
If omitted, the value defaults to |
||
|
conditional |
string |
64 chars |
Specifies the organization name. If an organization name is specified here and This parameter is not required if there is an organization name in the CSR.
Otherwise, |
||
|
optional |
string |
40 chars |
The organization post office box. If a post office box is specified here and in the CSR, |
||
|
conditional |
string |
128 chars |
The street address where the organization operates. If a street address is specified here and in the CSR, If there is a street address in the CSR, |
||
|
optional |
string |
128 chars |
The second part of the company’s street address (if necessary). If the second part of the street address is specified here and in the CSR, |
||
|
optional |
string |
128 chars |
The third part of the company’s street address (if necessary). If the third part of the street address is specified here and in the CSR, |
||
|
conditional |
string |
128 chars |
The city in which the organization operates. Providing it in any product request that requires organization validation can help speed up the validation process.
If a locality name is specified here and in the CSR, If there is a locality name in the CSR, |
||
|
conditional |
string |
128 chars |
The state or province in which the organization operates. If a state or province name is specified here and in the CSR, If there is a state or province name in the CSR, |
||
|
conditional |
string |
40 chars |
The company’s postal code. If a postal code is specified here and in the CSR, If there is a postal code in the CSR, |
||
|
conditional |
string |
2 chars |
An ISO 3166 two-character country code. If a country name is specified here and If there is a country name in the CSR, |
||
|
optional |
string |
20 chars |
A unique nine-digit identifier for businesses, provided by the company Dun & Bradstreet. |
||
|
optional |
string |
64 chars |
The registration number of the organization provided for validation purposes. |
||
|
optional |
char |
1 char |
The legal classification of the organization. The allowed values are:
|
||
|
optional |
string |
255 chars |
The alternative issuance email address. If specified, the certificate will be emailed to this email address rather than the applicant’s admin email address. If the value specified is 'none', no certificate issuance email will be sent at all. |
||
|
optional |
string |
255 chars |
The validation email address. If specified, Sectigo will validate that this is the email address of the end customer. Sectigo will not send any emails to this email address. Instead Sectigo will trust you, the Partner, to forward emails to this end customer as appropriate. |
||
|
optional |
string |
255 chars |
The contact email address. If specified, this email address will be the only email address that Sectigo validation department will correspond with during the processing of this order. |
||
|
optional |
string |
32 chars |
(QWAC certificates only) The Domain Control Validation method. The allowed values are:
If omitted, the value defaults to If the length of the parameter’s value exceeds the maximum, the value will be truncated. For more information, see Domain Control Validation.
|
||
|
optional |
integer |
Specifies whether to override Sectigo’s default choice of DCV email template to be used to validate the called certificate. An account can contain multiple DCV email templates, for example, in different languages. Contact your account manager to arrange the creation of one or more custom DCV email templates that can be referenced through this parameter. |
|||
|
optional |
string |
2 chars |
The language name, specified using ISO639-1 two-character language code. If omitted, the default language is English. An account can contain multiple email templates in different languages for callback, Enterprise Authentication for the instant issuance, S/MIME request processing, or the missing shipping details request. You may specify exactly one of the following values:
If provided, the following parameters override
|
||
|
optional |
integer |
Specifies whether to override Sectigo’s default choice of callback email template to be used to validate this certificate. An account can contain multiple callback email templates. Contact Support for the callback template.
Contact your account manager if you would like to set up one or more of your own callback email templates that can be referenced by this parameter. |
|||
|
optional |
integer |
(QWAC Legal/Legal PSD2 only) If specified, this parameter overrides Sectigo’s default choice of email template for Enterprise Authentication for the instant issuance to be used to validate this certificate. An account can contain multiple email templates for Enterprise Authentication for the instant issuance. Contact Support for the templates for Enterprise Authentication for the instant issuance.
Contact your account manager if you would like to set up one or more of your own email templates of aforesaid type that can be referenced by this parameter. |
|||
|
optional |
integer |
Specifies the Subscriber Agreement email template ID to be used for the order.
|
|||
|
optional |
integer |
Specifies whether to override Sectigo’s default choice of shipping email template to be used to process the order. An account can contain multiple email templates. Contact Support for the shipping email templates.
Contact your account manager if you would like to set up one or more of your own shipping mail templates that can be referenced by this parameter. |
|||
|
required |
char |
1 char |
Specifies whether the customer will validate the customer’s documents. The allowed values are:
|
||
|
optional |
char |
1 char |
Specifies whether to include the certificate ID in the response. The allowed values are:
If omitted, the value defaults to |
||
|
optional |
char |
64 chars |
The external order number. This identifier can be returned by some of our other APIs to aid in integration with partner systems. |
||
|
optional |
char |
1 char |
Specifies whether to check that the The allowed values are:
|
||
|
optional |
char |
1 char |
Specifies the response format. The allowed values are:
If omitted, the value defaults to |
||
|
optional |
char |
1 char |
Specifies whether this is a test order. The allowed values are:
If omitted, the value defaults to |
||
|
required |
string |
255 chars |
The applicant representative’s email address which is used for the organizational callback by Sectigo. Used for critical customer communications:
|
||
|
optional |
char |
1 char |
The callback method for verification of the applicant representative’s identity. The allowed values are:
|
||
|
optional |
char |
1 char |
Specifies who will verify the applicant representative’s contact details before the callback is performed. The allowed values are:
|
||
|
optional |
char |
1 char |
Specifies who will perform the callback. The allowed values are:
|
||
|
optional |
char |
1 char |
Specifies whether to include the certificate state in the response. The allowed values are:
|
||
|
optional |
char |
1 char |
(QWAC certificates only) Specifies whether to omit additional fully qualified domain names (FQDN) from the certificate. The allowed values are:
If omitted, the value defaults to |
||
|
conditional |
string |
50 chars |
Specifies the applicant representative’s login name. Required for HackerGuardian, HackerProof and products with additional HackerGuardian license. |
||
|
optional |
integer |
(Token-based certificates where shipping is involved only) Specifies the type of shipping offer. The allowed values are:
|
|||
|
optional |
char |
1 char |
(non-QSCD eIDAS certificates only) Indicates whether you wish to get a certificate installed on a token. The allowed values are:
If omitted, the value defaults to
|
||
|
optional |
string |
64 chars |
(Token-based certificates only) The organization name for shipping purposes. If no parameters for shipping address are provided, the shipping address defaults to the organization address.
The parameters related to shipping details include this parameter and the following 14 ones starting with 'shipping'. If required shipping details are not provided before the token is ready for shipment, the token will be shipped to the verified organization address with the applicant representative being specified as a contact person. |
||
|
optional |
string |
64 chars |
(Token-based certificates only) The organizational department name for shipping purposes. If no parameters for shipping address are provided, the shipping address defaults to the organization address. |
||
|
optional |
string |
128 chars |
(Token-based certificates only) The street address where the organization operates for shipping purposes. If no parameters for shipping address are provided, the shipping address defaults to the organization address. |
||
|
optional |
string |
128 chars |
(Token-based certificates only) The second part of the company’s street address for shipping purposes (if necessary). If no parameters for shipping address are provided, the shipping address defaults to the organization address. |
||
|
optional |
string |
128 chars |
(Token-based certificates only) The third part of the company’s street address for shipping purposes (if necessary). If no parameters for shipping address are provided, the shipping address defaults to the organization address. |
||
|
optional |
string |
128 chars |
(Token-based certificates only) The city in which the organization operates for shipping purposes. Required for shipping. If no parameters for shipping address are provided, the shipping address defaults to the organization address. |
||
|
optional |
string |
128 chars |
(Token-based certificates only) The state or province in which the organization operates for shipping purposes. Required for shipping. If no parameters for shipping address are provided, the shipping address defaults to the organization address. |
||
|
optional |
string |
40 chars |
(Token-based certificates only) The organization’s postal code for shipping purposes. Required for shipping. If no parameters for shipping address are provided, the shipping address defaults to the organization address. |
||
|
optional |
string |
2 chars |
(Token-based certificates only) An ISO 3166 two-character country code. Required for shipping. If no parameters for shipping address are provided, the shipping address defaults to the organization address. |
||
|
optional |
string |
64 chars |
(Token-based certificates only) Title of a natural person who should be specified as a contact person in the courier shipping document. |
||
|
optional |
string |
64 chars |
(Token-based certificates only) The first name of a natural person who should be specified as a contact person in the courier shipping document. Required for shipping. |
||
|
optional |
string |
64 chars |
(Token-based certificates only) The surname of a natural person who should be specified as a contact person in the courier shipping document. Required for shipping. |
||
|
optional |
string |
255 chars |
(Token-based certificates only) The email address of a natural person who should be specified as a contact person in the courier shipping document. Required for shipping. |
||
|
optional |
string |
32 chars |
(Token-based certificates only) The contact phone number of a natural person who should be specified as a contact person in the courier shipping document. Required for shipping. |
||
|
optional |
string |
1024 chars |
The |
||
|
optional |
string |
255 chars |
The cryptographic service provider. If omitted, the value defaults to 'Microsoft Enhanced Cryptographic Provider v1.0'. |
||
|
optional |
char |
100 chars |
The organization identifier or the PSD2 authorization identifier recognized by the National Competent Authority. This parameter is relevant and optional for the following certificate products:
For more information, see |
||
|
conditional |
char |
100 chars |
The semantics information for attributes stored in the subject field related to the natural person. This parameter has a deprecated synonym — This parameter is required for Citizen, Employee and QWAC Natural Qualified certificate profiles with product IDs The information specified in the |
||
|
conditional |
char |
100 chars |
An abbreviated unique identifier of the National Competent Authority. Required for PSD2 Qualified certificate profiles with product IDs This parameter must contain information using the following structure in the presented order:
|
||
|
conditional |
char |
100 chars |
The name of National Competent Authority in English that registered the payment service provider. Required for PSD2 Qualified certificate profiles with product IDs If omitted, the value is defined automatically based on the |
||
|
conditional |
char |
1 char |
Specifies one of possible roles of the payment service provider. The allowed values are:
Required for PSD2 Qualified certificate profiles with product IDs At least one PSD role should be set to |
||
|
conditional |
char |
1 char |
Specifies one of possible roles of the payment service provider. The allowed values are:
Required for PSD2 Qualified certificate profiles with product IDs |
||
|
conditional |
char |
1 char |
Specifies one of possible roles of the payment service provider. The allowed values are:
Required for PSD2 Qualified certificate profiles with product IDs |
||
|
conditional |
char |
1 char |
Specifies one of possible roles of the payment service provider. The allowed values are:
Required for PSD2 Qualified certificate profiles with product IDs |
||
|
required |
string |
2 chars |
(QWAC Legal only) Jurisdiction country. |
||
|
optional |
string |
128 chars |
(QWAC Legal only) Jurisdiction state or province. |
||
|
optional |
string |
128 chars |
(QWAC Legal only) Jurisdiction city. |
||
|
optional |
string |
10 chars |
(QWAC Legal only) The date of incorporation ( |
||
|
optional |
string |
64 chars |
(QWAC Legal only) An optional name under which the organization operates that is different from its legal name. This is a so-called DBA (doing business as) name for the company (if any). |
Sample request
curl --location --request POST 'https://secure.trust-provider.com/products/!AutoApplyOrder' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'product=777' \
--data-urlencode 'days=365' \
--data-urlencode 'loginName=login_name' \
--data-urlencode 'loginPassword=login_password' \
--data-urlencode 'serverSoftware=2' \
--data-urlencode 'csr=-----BEGIN CERTIFICATE REQUEST-----
MIIDCzCCAfMCAQAwgcUxCzAJBgNVBAYTAkRFMQ8wDQYDVQQHDAZNdW5pY2gxHTAb
BgNVBAoMFG1hdXJ1cy5uZXR3b3JrcyBHbWJIMSIwIAYDVQQLDBlDQVNTRVJWRVIg
...
3MqcpjtP+hvqRXMUHBCohIvJLYF9i5xwLiyYQNxqFzr3qIuN48/HOnjoNVCFQLOE
dMHZl3k/9zp0py1AZ6HCjKKCmWHEajnHvcllW9+uQldEE8f3pIlBxq1bt+h5jORP
EONR3ey/VUm50nIwnNQ/
-----END CERTIFICATE REQUEST-----' \
--data-urlencode 'dunsNumber=060704780' \
--data-urlencode 'businessCategory=b' \
--data-urlencode 'isCustomerValidated=N' \
--data-urlencode 'personalIdentifier=1234567890' \
--data-urlencode 'SmartCardBased=Y' \
--data-urlencode 'offerType=22' \
--data-urlencode '[email protected]'
Response
The request is successful when the server returns a response with the error code 0.
Any error code less than 0 indicates an error condition, and the error message provides additional details.
Error responses are returned in application/x-www-form-urlencoded format.
Response format 0 (Plain text)
The MIME type will be text/plain for responseFormat=0 (by default).
The first line of the response contains a status code.
Whether 0 or 1 is returned for successful orders depends on how your account is configured with Sectigo.
Usually, you will take payment from your customer and Sectigo will debit your account funds when you place the order.
However, in special circumstances it can be arranged for Sectigo to take payment from your customer on your behalf.
|
If the status code is less than 0, the second line of the response contains an error message describing the error.
If the status code is greater than or equal to 0, the response can contain the following lines which provide:
| Line | Possible Value | Description |
|---|---|---|
Line 1 |
The status of the order. For more information, see Error codes. |
The status code. |
Line 2 |
An integer. |
The second line contains an order number. |
Line 3 |
|
The amount in your account’s native currency, without a currency symbol. |
Line 4 |
The expected delivery time. |
This value can be ignored and has been deprecated for Document Signing. |
Line 5 (if applicable) |
The internal certificate ID of the certificate purchased by this order. |
The certificate ID, up to 16 digits.
Returned if |
Line 5 or 6 (if applicable) |
A unique alphanumeric value up to 20 characters long. |
The certificate state.
Returned if |
Line 5, 6 or 7 (if applicable) |
A unique alphanumeric value up to 20 characters long. |
The unique value.
Returned if the |
Response format 1 (URL-encoded)
Most of Sectigo’s API endpoints use URL-encoded responses. AutoApplyOrder can return responses in the same format by specifying responseFormat=1 in the request.
The MIME type will be application/x-www-form-urlencoded for responseFormat=1.
The following table displays the various parameters that can appear for responseFormat=1.
| Parameter | Description |
|---|---|
|
A numeric code that identifies the type of error and is always present in the response. For more information, see Error codes. |
|
A description of the error.
|
|
An integer.
This parameter is only present when |
|
The amount in your account’s native currency, without a currency symbol.
This parameter is only present when |
|
The expected number of hours before this order will be completed. This value can be ignored and has been deprecated for eIDAS certificates. This parameter is only present when |
|
The internal certificate ID of the certificate purchased by this order.
This parameter is only present when |
|
The status of the certificate purchased by this order.
This parameter is only present when |
Error codes
| Error Code | Error Message | Description |
|---|---|---|
|
|
The request must use HTTPS protocol. |
|
|
The provided argument is not recognized. |
|
|
A required argument is missing from the request. |
|
|
The argument value does not meet validation requirements. |
|
|
The Common Name in the certificate signing request (CSR) must not include a wildcard character. |
|
|
The Common Name in the CSR must include exactly one wildcard character. |
|
|
The specified country code is not valid according to the ISO-3166 standard. |
|
|
The CSR does not include all required fields. |
|
|
The CSR must be encoded in valid Base-64 format. |
|
|
The CSR could not be decoded properly. |
|
|
The CSR’s algorithm is not supported. |
|
|
The signature on the CSR is invalid. |
|
|
The key size in the CSR is not supported. |
|
|
An unknown error occurred. |
|
|
The account does not have sufficient credit. |
|
|
The user does not have permission to access the |
|
|
The request method should be POST. |
|
|
Common Names must not be a fully qualified domain name (FQDN). |
|
|
Common Name must not be an Internet-accessible IP address. |
|
|
Common Name must not be an Internet-accessible IP address. |
|
|
The CSR’s key is on the compromised key list. |
|
|
The specified domain name has already been validated. |
|
|
The provided request token has already been used. |
|
|
The specified PlanID for the product could not be found. |
|
|
The specified parameter can only be used with license products. |
|
|
The provided email address is not valid. |
|
|
The previous order must include a license of the same type. |
|
|
The order must include a document signing certificate. |
|
|
The order can include only one Web Package product. |
|
|
The specified argument is not applicable for the current order. |
|
|
The order must include the specified item. |
|
|
The user does not have permission for the specified context. |
|
|
The user does not have permission for the specified context. |
|
|
An internal error occurred while decoding the CSR. |
|
|
The Tier1 credit/debit processing encountered an internal error. |
|
|
The Tier1 credit/debit processing encountered an internal error. |
|
|
The Tier1 credit/debit processing encountered an internal error. |
|
|
The specified |
|
|
No price information available for the specified item. |
|
|
The provided item cost is incorrect. |
|
|
The provided item cost is incorrect. |
|
|
The specified product identifier is incorrect. |
|
|
An internal error occurred. |
|
|
The required role arguments for PSD2 certificate type are missing. |
|
|
Semantic error. TAX is no longer a valid value. Use TIN instead. |
|
|
Semantic error. The format of the provided identifier is incorrect. |
|
|
Semantic error. The country code in the provided identifier is incorrect. |
|
|
An error occurred during key attestation verification for the specified context. |
|
|
The user does not have sufficient privileges to order the specified product type. |
|
|
The specified parameter is not valid for this product type. |
|
|
The CSR contains domain names not listed in the |