Qualified Electronic Signatures (QES)

Overview

A Qualified Electronic Signature (QES) uses a qualified digital certificate issued by a Trusted Service Provider. Enable QES when adding a package by configuring options.digitalSignatures.signatureTypes.

Digital signatures and the selected QES provider must be enabled for your subscription and organization before you can use them in a signing package.

Providers

The following QES providers are supported:

Value	Provider
`digidentity`	Digidentity

Use the serialized provider values shown in the table when configuring the request.

Add a package with QES

Set options.digitalSignatures.signatureTypes.qes to an ordered array of enabled providers. QES also requires signing consent, cac set to none, and formFlattening set to none or omitted.

QES is currently supported only for packages using the Sequential signing workflow.

The final signature completed by each signer on a document is automatically converted to a digital signature.

Request

POST /packages/add
{
  "name": "New Package with QES",
  "type": "Sequential",
  "state": "open",
  "options": {
    "cac": "none",
    "formFlattening": "none",
    "consentOptions": {
      "required": true,
      "requiredSigning": true
    },
    "digitalSignatures": {
      "signatureTypes": {
        "qes": ["digidentity"]
      }
    }
  },
  "signers": [
    {
      "firstName": "Signer",
      "lastName": "One",
      "email": "signer.one@example.com"
    }
  ],
  "documents": [
    {
      "fileName": "document.pdf",
      "fileId": "682f1158-e3f5-4329-8f88-c52cb5447d8c"
    }
  ]
}

See the Packages add API and digital signature options reference for the complete request contract.

Signer experience

After the signer completes all documents in the package, they are prompted to authorize the QES through the selected provider. QES authorization is the final step in the signing session.

Check signing status

Call /packages/{packageId}/status to monitor the package. A revision’s isSigned property becomes true after that signer completes the revision. The document and package isExecuted properties become true after all required signers complete the signing workflow.

Request

GET /packages/{packageId}/status

Response

{
  "packageId": "08aba360-4466-4463-8b4b-9585d3de4b33",
  "isExecuted": true,
  "documents": [
    {
      "documentId": "d3386e4e-d5db-41f0-82ad-d3427fe57495",
      "isExecuted": true,
      "revisions": [
        {
          "revisionId": "6fcf36b4-ce54-45b9-8892-ce2d92a7e669",
          "signerId": "dff8f8cc-fe2d-428e-9a8c-bcf1a2b187ce",
          "isSigned": true
        }
      ]
    }
  ]
}

See the Packages status API for the complete response.

View the QES result

After the document is executed, download its executed PDF. The PDF contains the applied QES and certificate information for validation in a compatible PDF viewer.

Request

GET /packages/{packageId}/documents/{documentId}/pdf/executed/download

See the Packages download API for more information.

Getting started

Guides

API

Webhooks

Reference

Qualified Electronic Signatures (QES)

Overview

Providers

Add a package with QES

Signer experience

Check signing status

View the QES result

​Overview

​Providers

​Add a package with QES

​Signer experience

​Check signing status

​View the QES result

Overview

Providers

Add a package with QES

Signer experience

Check signing status

View the QES result