Digital Signatures

Refresh signatures on a document's layer

Use this endpoint to refresh LTV signatures for the given document layer.

Learn more about CAdES and LTV signatures here: https://www.nutrient.io/guides/web/signatures/digital-signatures/standards/#understanding-ltv-pades-b-lt

It will refresh the signatures with IDs provided in the signatureFQNs field. If signatureFQNs is not set, or empty, then all the signatures in the document layer will be refreshed.

post/api/documents/{documentId}/layers/{layerName}/refresh_ltv

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/layers/{layerName}/refresh_ltv
  • 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.

Request body

signatureFQNsstring[]

An optional list of signature IDs to refresh.

If this list is empty then all the signatures in the document will be refreshed.

Example request

{
  "signatureFQNs": [
    "Signature-9c58d27b-7ea1-4d7b-8e22-9ef3bcc46c85"
  ]
}

Response

The updated digital signatures for the document layer.

Example response

{
  "data": {
    "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.