Digital Signatures

Get Digital Signatures

Returns a document's digital signatures.

A document's digital signature status is computed by looking at all the digital signatures included in the document. Digital signature status is automatically updated after each change (e.g. adding a new annotation).

The validity of a signature is determined by the signing certificate used to create it: If you're using a custom certificate, you need to set up Document Engine to use a corresponding certificate store in order to identify the signature as valid. Please check our guide article on how to set up custom certificates for digital signature validation.

By default, the signature certificates are validated against the current time. This means that valid signatures with expired certificates validate as expired. You can modify the DIGITAL_SIGNATURE_CERTIFICATE_CHECK_TIME configuration option to signing_time if you wish to instead validate certificates against the signing time.

⚠ Warning: If you're validating digital signature certificates against the signing time, special care should be taken: By default, there's no way of knowing whether the creation time stored with the signature itself can be trusted. To solve this issue, digital signatures need to use a Time Stamping Authority to provide a signed timestamp to embed. Note that we don't validate the timestamp token's certificates — we always assume a valid proof of existence if it's present. Thus, it's expected that the timestamps will be validated independently by your client code.

get/api/documents/{documentId}/signatures

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/signatures
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

Headers

pspdfkit-pdf-passwordstring

The PDF document password.

The value can be either a plain-text password or a base64 encoded password in a form base64:<encoded-password>. Use the Base64 encoding if your password contains characters that are not allowed in HTTP header or would be otherwise mangled (e.g. trailing or leading spaces)

If the document is password protected, any operations performed on it require supplying a password.

Response

The document's digital signatures

Example response

{
  "data": {
    "signatures": [
      {
        "signerName": "John Appleseed",
        "creationDate": "2013-12-19 14:45:26",
        "signatureReason": "accepted",
        "signatureLocation": "Vienna",
        "validFrom": "2023-12-01T15:34:15Z",
        "validUntil": "2025-11-30T15:34:14Z",
        "signatureFormFQN": "Signature-a9c0376e-15cd-416f-9b8f-bbf341fae0ca",
        "signingCertificateChain": [
          {
            "issuerCommonName": "Example CA",
            "serialNumberHex": "1234567890ABCDEF",
            "subjectCommonName": "John Appleseed",
            "validFrom": "2023-12-01T15:34:15Z",
            "validUntil": "2025-11-30T15:34:14Z"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.