Page Comparison

<Window>

<Signatures>

x

<Signatures>

Contains the signature-field definitions. Possible Signature Types are

<Signature>: The field is defined with a search item (<Placeholder>) within the pdf-file

<DigSig>: The field is defined with a signature-filed within the pdf-file

<Static>: The field is defined with coordinates

<FillInfo>

x

<FillInfo>

Contains a List of Name-Value Pairs to fill formfields within the pdf-document

<GUIMode>

<SCSPath>

<ReadBeforeSign>

<DeviceKind>

<BlindPadSearch>

<PublicKey1Emulation>

<SCS>

<CorpCode>

<Overlapped>

<AfterSigning>

<AfterCancel>

<PDF>

x

base64

base64 encoded PDF-file

<PDFName>

x

String

name of the pdf shown in GUI. If no name is set, the name will be set dynamically:

upload_2022-07-21_46669.pdf

<TapToSign>

x

Integer

1/0

"true" or "false" / "1" or "0" (false by default or if tag isn't defined). If TapToSign is "true" the signature fields can be activated/signed via clicking into the individual field within the iSignatureOffice or aSignatureOffice App (instead of clicking the start-signing button).

<TapToSignOnly>

x

Integer

1/0

If "1"/ "true" the pen icon (start signing button) in the Apps will be disabled and you need to click into the signature field to sign.

<PdfNoBiodata>

x

If present, the method retrieveXml will fill the field with the base64 encoded pdf without biometric data.

The document doesn't contain the certificates but pictures of the signatures.

The <PDF> tag will still be filled with the signed document.

See Condition.DocumentNoBiodata

At upload time the field must be empty.

<DisableHelpButton>

<DisableInfoButton>

<ShowDialogPrintButton>

<ShowFormFillButton>

<HideSignControllButtons>

<HideLcdSignButton>

<DeviceKeys>

<OpenResult>

<LastMacroNumber>

<MacroButtonHistory>

<Macro1Upload>

<Zoom>

<ScrollInSignMode>

<HashDialog>

<Found>

<Signed>

<Output>

<DeviceDetails>

tbd: not applicable at upload time

<DueDate>

x

DateTime

2019-07-21

This tag defines the expiration date of the signature request / envelope.

Example: <DueDate>2019-07-21</DueDate>

If <DueDate> is defined, <DueDays> <DueWeeks> and <DueMonths> will be ignored.

If neither <DueDate> <DueDays> <DueWeeks> and <DueMonths> are defined, the expiration time is unlimited.

If <DueDate> is in the past, the expiration time is one day.

<DueDays>,

<DueWeeks>,

<DueMonths>

x

Integer

Tags are defining the expiration of the signature request / envelope.

With setting a value in one of the three tags, the due date will be the date x days / weeks or months after the time of upload.

The relevant value is always the next expected date. For example <DueDays> is set with the value 9 and <DueWeeks> is set with the value 1, the due date will be 7 days later (one week)

If <DueDate> is defined, <DueDays> <DueWeeks> and <DueMonths> will be ignored.

If neither <DueDate> <DueDays> <DueWeeks> and <DueMonths> are defined, the expiration time is unlimited.

<MandatorySkippable>

x

Integer

1/0

If set to 1 (true) mandatory fields can be skipped.

This optional tag defines, if mandatory signature fields are skippable (value 1) or not (value 0).

If no value is set or tag is not defined, mandatory signature fields are not skippable.todo: test

<Observer>

x

String

userName /

email-adress

Sets an observer for a document. The observer can view the document, but has no signature-fields.

If email notification is active, the user will receive an email with the document-link.

Possible values are a valid email adress or the userName (login) of an active user.

(If the xml defines an envelope and Document.Observer is not defined, ESign.Observer will be used)

<CallbackUrl>

x

String (URL)

www.example.com/event

Defines a callbackURL for the document. If not present, the default callbackURL (server settings) will be used. See e) Callback-API

<DocumentPassword>

x

String

Defines a document password.

If a user has to enter the password is defined in the <Signatures> Element. see <PasswordRequired>

NOTE: Document passwords are stored in plain text in visible for the document creator.

<SignatureGroups>

x

<SignatureGroups>

Contains a list of SignatureGroups. 

(If the xml is an envelope, signature groups can also be defined in ESign.SignatureRequestEnvelope.SignatureGroups.)

<ExecutionOrder>

x

Integer

deprecated ExecutionOrder – specifies field execution order. Possible values: 0 – ABC   ABC ABC, 1 – AAA BBB CCC, 2 – as sorted.

<SignatureRequestEnvelope>

x

<SignatureRequestEnvelope>

defines an Envelope which can contain several documents and download-conditions.

<AppAvailability>

x

Defines how long the signatureRequest / document is available in the app.

<ActiveFrom>: Date from which the document is visible in the app

<ActiveUntil>: Date until the document is visible in the app.

(<DeleteOnServer> : deprecated)

<AppAvailability>
  <ActiveFrom>2022-07-22</ActiveFrom>
  <ActiveUntil>2022-07-25</ActiveUntil>
</AppAvailability>

Document will be visible in app from 22/7/2022 till 25/7/2022

<CryptoIDSelection>

<SignatureOrder>

x

<SignatureOrder>

Defines in which order the users of the document/envelope have to sign.

Contains a list of <SignaturePosition>.