...
XML-Element | webso | Type | description | ||||||
|---|---|---|---|---|---|---|---|---|---|
<Position> | x | Integer | The Position of the condition inside the document. Positions are defined for each condition and document in the envelope. | ||||||
<ConditionType> | x | String | only possible value is "download" | ||||||
<PDF> | x | base64 | A pdf file encoded in base64 to download. Alternativley <DocumentFromPosition> can be defined. | ||||||
<PDFName> | x | String | name of the document to download. | ||||||
<DocumentFromPosition> | x | Integer | Defines which document should be downloaded to fullfill the condition. Necessary if <PDF> is not defined. | ||||||
<DocumentNoBiodata>
| x | Integer 1/0 | Defines if the document should be downloaded with or without the biodata If 1 (true) the downloaded document just contains a pictures of the signatures with the text "copy"/"Kopie" but no certificate and no biodata (signature data).  | ||||||
<InfoText> | x | String | a text shown, when the download popup appears.   | ||||||
<ShowInViewer> | x | Integer 1/0 | If true (1) the download condition with a preview image of the pdf is shown in the viewer. 
| ||||||
<SignatureGroupName> | x | String | Defines which signatureGroup has to fullfill the download condition. | ||||||
<UserName> | x | String | Login name of a registered user or an email address. Defines which technical user has to fullfill the download condition. | ||||||
<AfterSigning> | |||||||||
(<finished> / <FinishedXmlDateTime>) | (x) | When a condition is finished and the method retrieveXML is called, <finished> and <FinishedXmlDateTime> will be added to the returned XML. Not applicable at upload time. | |||||||
...
XML-Element | webso | Type / example | description | ||||||
|---|---|---|---|---|---|---|---|---|---|
<PasswordRequired>
| x | Integer 1/0 | true or false, defines if the signer of the signature has to enter the password when opening the document. If a password is assigned to the document by default <PasswordRequired> is set to true. It must be explicitly set to false to prohibit the password prompt. The <DocumentPassword> is defined globally. Note: The first appearence of <PasswordRequired> in the signature fields of a distinct user defines whether the user has to enter a password. eg: A user has three signature fields.
| ||||||
(<Signed>) | When the method retrieveXML is called and the field is signed, the element is set to 1. <Signed> can't be set at upload time. | ||||||||
<Mandatory> | x | Integer 1/0 | Is an optional field indicating that signature field is mandatory. <Mandatory>1</Mandatory> means mandatory field <Mandatory>0</Mandatory> means optional field If no value is set, the field is optional. | ||||||
<Textblock> | |||||||||
<Zoom> | |||||||||
<Stamp> | x | Stamp can be:
If <SignatureType> value of the signature element is 0, a stamp creation without signature will be set, otherwise it's a combination of stamp and signature. A stamp can't be defined for digitalStamp (<SignatureType>1) because the stamp image including the email address or username of the signee is generated automatically. | |||||||
<Signer> | |||||||||
<UserName> | x | String | Login name of a registered user or an email address. Defines which technical user has to sign the field. If no <UserName> is defined, a self-sign field (for own/ xml-upload user) is set. If the email adress doesn't belong to a registered user a guest user will be created. | ||||||
<Reason> | x | String | Can be used to set the reason for the signature which will be visible in the pdf certificate. | ||||||
<SignatureType> | x | Integer | The available values are: The signer can choose between following types: StepOver signature pad OR one of our apps OR HTML-signer (with a pen or your finger on your mobile device) The behaviour of the document viewer after clicking "sign now" for the different <SignatureType>s are shown below:  Detailed Description: https://stepoverinfo.atlassian.net/wiki/spaces/WEBSO/pages/181960712/j+ESign+Input+XML#4.-Defining-the-%E2%80%9Csignature-type%E2%80%9D-%3CSignatureType%3E please note: If a SigatureGroup is defined, the signatureType will be ignored. | ||||||
<SignatureGroupName> | x | String | The name of the <SignatureGroup> | ||||||
|
|
| depricated
| ||||||
<SmsToken> | x | With this tag you can define if user have to enter a auto-generated SMS token before entering the document (two factor authentication). The SmsToken element has to be part of the <Signature> / <DigSig> / <Static> element and requires following parameters: <Number>: the mobile number excluding the phone code / country code <PhoneCode>: the international phone code of the mobile number according to iso 3166-1 alpha 2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ). ('DE' for Germany, 'US' for United States, 'GB' for Great Britain, etc.) You can only set one <SmsToken> element for each <Signature> / <DigSig> / <Static> element and only one <SmsToken> element for each signatory (defined via <UserName> for other user or self-sign fields). <Signature> | |||||||
<SelectionPhoneTabletDetails> | x | Defines what options are shown in the Phone/Tablet overlay: The child elements <OptionQRCode>, <OptionLink> and <OptionSMS> have the values 0 or 1. Note: If SignatureType is not 4 (handwritten), <SelectionPhoneTabletDetails> will be ignored. |
...
If OptionSMS is true, a phone number can be defined. A SMS will be send with a link to the document.
...
<SelectionPhoneTabletDetails>:
...
XML-Element | webso | Type | description |
|---|---|---|---|
<SignatureGroupName> | x | String | Defines the name of the signatureGroup. (mandatory) |
<ShowSignatureTypePopUp> | x | Integer 1/0 | defines if the signatureTypePopup is shown. If 1 (true), the signatureTypePopup will be shown. Note: If <ShowSignatureTypePopUp> is true, <ShowSignatureTypePopUpDetails> must be defined! (see below) |
<ShowSignatureTypePopUpDetails> | x | With the tag <ShowSignatureTypePopUpDetails> and it's child tags <SelectionPad>, <SelectionPhoneTablet>, <SelectionDisplay> (all int's with 1 or 0 values) the SignatureTypePopUp can be defined showing all or just some of the signature type selections. 
Note:
| |
<SignatureFieldColor> |
...