Digital Signatures

Get Digital Signatures in a Layer

Returns a layer's digital signatures.

You can fetch the digital signature status of an individual layer using the parent document ID and the layer name.

If you use a layer name that maps to a non-existing layer, Document Engine will report the status of the document base layer without creating a new one:

get/api/documents/{documentId}/layers/{layerName}/signatures

Request

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

Path parameters

documentIdstring required

The document ID

layerNamestring required

The layer name

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.