Version signatures

GET/v1/docs/{docId}/versions/signatures/{sha}v3.0.0-next.15

The signature snapshot of one base version (immutable).

Authentication#

Any one of these credentials is accepted.

API token

The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.

Document token

Doc-scoped JWT, valid only on the /v1/docs/{docId} subtree it names, gated by the capability scopes it carries (each operation's x-required-capability).

Document capabilitydoc.forms.read

Parameters#

docIdpathstringrequired

shapathstringrequired

X-Document-Passwordheaderstring

Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.

SDK examples#

The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
  baseUrl: "https://yourhost.com/path/to/api",
  token: "<token>",
});

await client.doc.versions.signatures({
  docId: "docId",
  sha: "sha"
});

Responses#

200OK

application/jsonDocVersionsSignatures200Response

chainValidboolean

revisionsobject[]

indexinteger

endinteger

xrefOffsetinteger

signatureIndexinteger

signaturesobject[]

indexinteger

fieldFormFieldRef

kind =

kind"objectNumber"

objectNumberinteger

fieldNamestring

widgetFormWidget

signedboolean

kind"signature" | "timestamp"

filterstring

subFilterstring

byteRange[integer, integer, integer, integer]

contentsSizeinteger

coverage"whole-revision" | "partial" | "malformed"

revisionIndexinteger

signerobject

namestring

reasonstring

locationstring

contactInfostring

signedAtstring<date-time>

docMdp1 | 2 | 3

catalogCertificationboolean

fieldMdpobject

action"all" | "include" | "exclude"

fieldsstring[]

permission1 | 2 | 3optional

lockobject

seedValueobject

requiredFlagsinteger

presentFlagsinteger

versioninteger

mdp0 | 1 | 2 | 3

filterstring

subFiltersstring[]

digestMethodsstring[]

reasonsstring[]

unsupportedRequiredboolean

protectionobject

enforced"none" | "lta" | "fill" | "annotate"

judged"none" | "lta" | "fill" | "annotate"

certificationobject

signatureIndexinteger

permission1 | 2 | 3

fieldLocksobject[]

signatureIndexinteger

source"fieldmdp" | "lock"

specobject

action"all" | "include" | "exclude"

fieldsstring[]

permission1 | 2 | 3optional

policyVersioninteger

404Not found

application/jsonDocVersionsSignatures404Response

defaultError

application/jsonEngineErrorPayload

name"EngineError"

messagestring

detailsobjectoptional