Analyze layer changes
What the layer changed after a signature (or after any revision), judged against the restrictions in force.
Exactly one of `since.signature=<index>` or `since.revision=<index>`; the layer's pending edits are the end. `level=fill|annotate|lta|none` evaluates exploratorily and never becomes a verdict. For history between two base revisions use the version analysis.
Authentication#
Any one of these credentials is accepted.
The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.
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).
Parameters#
docIdpathstringrequiredlayerNamepathstringrequiredsince.signaturequeryintegersince.revisionqueryintegerlevelquery"none" | "lta" | "fill" | "annotate"X-Document-PasswordheaderstringBase64-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.signatures.analysis({
docId: "docId",
layerName: "layerName"
});Responses#
application/jsonDocSignaturesAnalysis200Responsemode"authoritative" | "exploratory"policyVersionintegerbasisobjectversionobjectsha256stringbyteLengthintegereditsVersionintegersource"persisted" | "working-copy"sinceobjectrevisionIndexintegersignatureIndexintegeruntilobjectrevisionIndexintegerrestrictionsobject[]signatureIndexintegerrevisionIndexintegersource"docmdp" | "fieldmdp" | "lock"ownbooleanpermission1 | 2 | 3optionalfieldsunknownoptionalcurrentobjectverdict"unchanged" | "permitted" | "forbidden" | "indeterminate"completebooleanprimaryobjectoptionalrulestringverdict"permitted" | "forbidden" | "incomplete"objectNumberintegeredgestringoptionaldetailstringoptionalfindingsobject[]rulestringverdict"permitted" | "forbidden" | "incomplete"objectNumberintegeredgestringoptionaldetailstringoptionalmethod"net-state" | "net-state+replay"laterobjectrevisionCountintegerundoneObjectNumbersinteger[]verdict"unchanged" | "permitted" | "forbidden" | "indeterminate"stepsunknown[]application/jsonDocSignaturesAnalysis400Responseapplication/jsonDocSignaturesAnalysis404Responseapplication/jsonEngineErrorPayloadname"EngineError"code"Unknown" | "InvalidArg" | "DocNotOpen" | "DocOpenFailed" | "DocPasswordRequired" | "DocPasswordIncorrect" | "SharePasswordRequired" | "Aborted" | "Network" | "Unauthenticated" | "Forbidden" | "NotFound" | "WireFormat" | "RuntimeUnavailable" | "LayerVersionConflict" | "NotImplemented" | "MalformedPdf" | "SigningPending" | "SigningExpired" | "SigningVersionMismatch" | "SignatureRefused" | "ProtectedDocument" | "StaleBase" | "PayloadTooLarge" | "ObjectNumberUnavailable" | "LayerFull" | "ChangeConflict" | "UndoUnavailable" | "IdempotencyKeyReused"messagestringdetailsobjectoptional