List signatures
The layer view of digital signatures: revisions, every signature field with its signed state, and the protection in force.
Describes the bytes the layer is over: the base version's signatures plus the layer's own edits as the last revision. Signed bytes (contents, digests, revision prefixes) are served per base version under /versions.
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#
docIdpathstringrequiredlayerNamepathstringrequiredX-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.list({
docId: "docId",
layerName: "layerName"
});Responses#
application/jsonDocSignaturesList200ResponsechainValidbooleanrevisionsobject[]indexintegerendintegerxrefOffsetintegersignatureIndexintegersignaturesobject[]indexintegerfieldFormFieldRefkind"objectNumber"objectNumberintegerfieldNamestringwidgetFormWidgetsignedbooleankind"signature" | "timestamp"filterstringsubFilterstringbyteRange[integer, integer, integer, integer]contentsSizeintegercoverage"whole-revision" | "partial" | "malformed"revisionIndexintegersignerobjectnamestringreasonstringlocationstringcontactInfostringsignedAtstring<date-time>docMdp1 | 2 | 3catalogCertificationbooleanfieldMdpobjectaction"all" | "include" | "exclude"fieldsstring[]permission1 | 2 | 3optionallockobjectseedValueobjectrequiredFlagsintegerpresentFlagsintegerversionintegermdp0 | 1 | 2 | 3filterstringsubFiltersstring[]digestMethodsstring[]reasonsstring[]unsupportedRequiredbooleanprotectionobjectenforced"none" | "lta" | "fill" | "annotate"judged"none" | "lta" | "fill" | "annotate"certificationobjectsignatureIndexintegerpermission1 | 2 | 3fieldLocksobject[]signatureIndexintegersource"fieldmdp" | "lock"specobjectaction"all" | "include" | "exclude"fieldsstring[]permission1 | 2 | 3optionalpolicyVersionintegerapplication/jsonDocSignaturesList404Responseapplication/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