Web SDKv1.0.0

SignaturesApi.list()

Every signature's metadata — reason, signing time, sub-filter, certification level (changesAllowed), whether it is signed (signed). Says whether a document is signed and what its certification allows. A signature field nested under a parent field (a dotted name) counts too, though the document's own list of signature fields does not include it. Without the extract feature each reason is ''. Needs no feature.
methodReadingsince 1.0.0

Signature

list(): Promise<SignatureInfo[]>

Returns

Promise<SignatureInfo[]> Each { index, reason, signedAt, subFilter, changesAllowed, signed }: reason ('' when absent), signedAt (when it was signed, as the signature says; null when it does not), subFilter (the signature's format as the file names it, 'adbe.pkcs7.detached' …, or ''), changesAllowed ('none' | 'forms' | 'annotations': what the signer allowed afterwards; null when unsaid) and signed (whether it holds signature bytes, or is a field still to be signed).

Throws

  • DOCUMENT_CLOSED — the document has been closed.

Example

TypeScript
const signed = (await doc.signatures.list()).some((s) => s.signed);
if (signed) showNotice('Changes are saved after the signed version');

More in SignaturesApi