Page History

...

Table of Contents

maxLevel	4
style	circle

Upload a file

First, you will need a PDF document which you want to upload.

...

Expand

title	Alternative: SOAP implementation (deprecated)

After the authorization you need to BASE64 the PDF which you want to upload. If the call was successful you get a file Id which we will need for sending an envelope.

Workstep configuration

The workstep configuration is the core of the envelope. Within the workstep configuration you can define following settings:

AdditionalClientWorkstepInformation
Viewer preferences
Policy
Sender and receiver information
Workstep tasks
Signature template
Authentication
PdfForms

Empty workstep

Lets start with an empty workstep first and then fill it step by step with the settings above. In the next collapse you can find an empty workstep (change ##EMAIL## to the email-address and ”NAME## to the name of the recipient you want to send the envelope):

...

With this empty workstep configuration we can now add the settings which are mentioned above. First, let us start with the viewer preferences.

Prepare envelope

With the api call: basicURL/envelope/prepare in REST and PrepareSendEnvelopeSteps_v1 in SOAP you can also create a workstep configuration. For this api call you need the FileId and a prepare configuration. You can find a sample configuration in the next section:

...

Expand

title	Alternative: SOAP implementation (deprecated)

For the api call in SOAP you also need the following configuration:

Code Block

language	xml
theme	Eclipse

 <prepareSendEnvelopeStepsDescriptor>
  <clearFieldMarkupString>1</clearFieldMarkupString>
</prepareSendEnvelopeStepsDescriptor>

In REST you already have this configuration:

Code Block

language	java
theme	Eclipse

 "PrepareSendEnvelopeStepsDescriptor": {
    "ClearFieldMarkupString": true
  }

AdditionalClientWorkstepInformation

This field is used to provide additional information. Note: Must be written in XML form. See the code below:

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<AdditionalClientWorkstepInformation><test id="test">Information<test></AdditionalClientWorkstepInformation>

Viewer preferences

Following lines of code show some viewer preferences configurations:

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<ViewerPreferences>
   <ShowThumbnails>1</ShowThumbnails>
   <ShowStatusBar>1</ShowStatusBar>
   <ShowTopBar>1</ShowTopBar>
   <FinishWorkstepOnOpen>1</FinishWorkstepOnOpen>
   <BatchSigningDisableNextButtonUntilDialogScrolledToBottom>1</BatchSigningDisableNextButtonUntilDialogScrolledToBottom>
   <GuidingBehavior>GuideRequiredAndOptionalTasks</GuidingBehavior>
   <BatchSigningType>Basic</BatchSigningType>
   <FormFieldsGuidingBehavior>AllowSubmitAlways</FormFieldsGuidingBehavior>
   <GuidingBehaviorOnFinishedTask>MoveToNext</GuidingBehaviorOnFinishedTask>
   <SkipPreviewImageOnDisposableCertificate>1</SkipPreviewImageOnDisposableCertificate>
   <ShowPageNavigationButtons>1</ShowPageNavigationButtons>
   <ShowZoomButtons>1</ShowZoomButtons>
   <ShowPageGap>1</ShowPageGap>
   <SkipFinishConfirmDialog>1</SkipFinishConfirmDialog>
   <SkipRejectConfirmDialog>1</SkipRejectConfirmDialog>
   <SkipDocumentDialog>1</SkipDocumentDialog>
   <ShowImagesInFullWidth>1</ShowImagesInFullWidth>
   <DisableGeolocation>1</DisableGeolocation>
   <ShowNoGeolocationWarning>1</ShowNoGeolocationWarning>
   <ShowDocumentDownloadDialogAfterAutomaticFinish>1</ShowDocumentDownloadDialogAfterAutomaticFinish>
   <AllowCustomButtons>1</AllowCustomButtons>
   <AutoFinishAfterRequiredTasksDone>1</AutoFinishAfterRequiredTasksDone>
   <DisplayRejectButtonInTopBar>1</DisplayRejectButtonInTopBar>
   <TriggerBankIdDesktopApp>1</TriggerBankIdDesktopApp>
   <AutoStartGuiding>1</AutoStartGuiding>
   <EnableWarningPopupOnLeave>1</EnableWarningPopupOnLeave>
   <WarningPopupDisplayAfter>FillOrSignField</WarningPopupDisplayAfter>
   <DocumentViewingMode>EndlessPaperAllDocuments</DocumentViewingMode>
   <SendVisibleArea allowedDomain="*">1</SendVisibleArea>
</ViewerPreferences>

Policy

The following list shows the policy configurations:

...

As you can see on the right screenshot the recipient of the envelope can now print the document as well as reject the envelope and more.

Client Actions

In this section you can define client actions. For detailed information please have a look at the configuration below.

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<FinishAction>
          <ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
</FinishAction>

Sender and receiver information

Sender information:

Code Block

language	java
theme	Eclipse

"SenderInformation": {
       "UserInformation": {
       "FirstName": "##NAME##",
       "LastName": "##NAME##",
       "EMail": "##EMAIL##"
       }
},

 },

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

  <senderInformation>
          <userInformation>
            <firstName>FIRSTNAME</firstName>
            <lastName>LASTNAME</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
        </senderInformation>

Receiver information:

Code Block

language	java
theme	Eclipse

"ReceiverInformation": {
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",
            "EMail": "##EMAIL##"
	    }
},

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

   <receiverInformation>
          <userInformation>
            <firstName>FIRSTNAME</firstName>
            <lastName>LASTNAME</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
          <showNamirialDisposableDisclaimer>0</showNamirialDisposableDisclaimer>
        </receiverInformation>

Workstep task

Every task you add to the envelope you have to add also in the section Tasks in REST and in the following section if you create the envelope with SOAP: <WorkstepTasks>##TASK##</WorkstepTasks>. Furthermore you have to define the signature in the section signature template (only in SOAP):

Signatures

Note: In the StampImprintConfiguration you can define which data should be displayed after signing. So you could set, for example, that the IP address and the name should not be displayed after signing. Please see the next sample for a configuration in which all data is displayed. This is followed by a configuration in which only the date, the transaction token and the transaction id should be displayed.

...

Result (Transaction token, Transaction ID, Signing time):

Click2Sign

This is the simplest signature type, the signer has just to click on the signature field to sing it.

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

 <sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
            <positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>
            <positionX>80.22857</positionX>
            <positionY>158.8629</positionY>
            <width>171.4286</width>
            <height>68.57143</height>
            <param name="enabled">1</param>
            <param name="completed">0</param>
            <param name="sigType">Picture</param>
            <param name="positioning">onPage</param>
            <param name="allowedCapturingMethods">Click2Sign</param>
</sig>

Draw2Sign

This type allows the signer to draw a signature by mouse, finger or pen. Just an image of the signature is created and embedded into the document.

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
            <positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>
            <positionX>80.22857</positionX>
            <positionY>158.8629</positionY>
            <width>171.4286</width>
            <height>68.57143</height>
            <param name="enabled">1</param>
            <param name="completed">0</param>
            <param name="sigType">Picture</param>
            <param name="positioning">onPage</param>
            <param name="allowedCapturingMethods">Draw2Sign</param>
</sig>

Type2Sign

With this type of signature the signer has to type in his/her name to sign the signature field.

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
            <positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>
            <positionX>80.22857</positionX>
            <positionY>158.8629</positionY>
            <width>171.4286</width>
            <height>68.57143</height>
            <param name="enabled">1</param>
            <param name="completed">0</param>
            <param name="sigType">Picture</param>
            <param name="positioning">onPage</param>
            <param name="allowedCapturingMethods">Type2Sign</param>
</sig>

Biometric

Code Block

language	java
theme	Eclipse

"WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
             "Tasks": [
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 67.0,
                  "PositionY": 521.92
                },
                "Size": {
                  "Height": 80.0,
                  "Width": 190.0
                },
                "AdditionalParameters": [
                  {
                    "Key": "enabled",
                    "Value": "1"
                  },
                  {
                    "Key": "positioning",
                    "Value": "intersectsWithField"
                  },
                  {
                    "Key": "req",
                    "Value": "1"
                  },
                  {
                    "Key": "fd",
                    "Value": ""
                  },
                  {
                    "Key": "fd_dateformat",
                    "Value": "dd-MM-yyyy HH:mm:ss"
                  },
                  {
                    "Key": "fd_timezone",
                    "Value": "datetimeutc"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "IsBio": false,
                    "AllowSkipBiometricVerification": false,
                    "AllowBiometricStoringOnly": false,
                    "SignedResponseWithoutBioData": false,
                    "Id": "6fa90b47-847f-47b1-b73a-9c3802aa077d",
                    "DiscriminatorType": "SigTypeBiometricSignature",
                    "Preferred": true
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_532f40e1-0583-8285-fc50-c2a76dc2fa44",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        }
      },

...

Expand

title	Alternative: SOAP implementation (deprecated)

After adding the signature fields in the signature template you have to add these signatures in the workstep task section. Following lines of code shows an example configuration of a workstep task.

Code Block

language	xml
theme	Eclipse

<WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">
<Task enabled="1" completed="0" required="1" id="93cce567-ae5c-4e98-ac99-9f56ac034250" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" />
</WorkstepTasks>

The Id in the code within the workstep Id must be the same as the Id of the signature field

Disposable certificate

Code Block

language	java
theme	Eclipse

{
  "SspFileIds": [
    "##FILE_ID##"
  ],
  "SendEnvelopeDescription": {
  "Name": "test",
  "EmailSubject": "Please sign the enclosed envelope",
  "EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
  "DisplayedEmailSender": "",
  "EnableReminders": true,
  "FirstReminderDayAmount": 5,
  "RecurrentReminderDayAmount": 3,
  "BeforeExpirationDayAmount": 3,
  "DaysUntilExpire": 28,
  "CallbackUrl": "",
  "StatusUpdateCallbackUrl": "",
  "LockFormFieldsAtEnvelopeFinish": true,
  "Steps": [
    {
      "OrderIndex": 1,
      "Recipients": [
        {
          "Email": "##EMAIL##",
          "FirstName": "##NAME##",
          "LastName": "##NAME##",
          "LanguageCode": "en",
          "EmailBodyExtra": "",
          "DisableEmail": false,
          "AddAndroidAppLink": false,
          "AddIosAppLink": false,
          "AddWindowsAppLink": false,
          "AllowDelegation": false,
          "AllowAccessFinishedWorkstep": false,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": [],
          "DisposableCertificateData": {
            "CountryResidence": "AT",
            "IdentificationCountry": "AT",
            "IdentificationType": "PASSPORT",
            "PhoneMobile": "##PHONENUMBER##",
            "DocumentType": "PASS",
            "DocumentIssuedBy": "Namirial",
            "DocumentIssuedOn": "2020-07-07T00:00:00Z",
            "DocumentExpiryDate": "2020-07-29T00:00:00Z",
            "SerialNumber": "1234",
            "DocumentNumber": "123",
            "OverrideHolderInCaseOfMismatch": false
          }
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Signer",
      "WorkstepConfiguration": {
        "WorkstepLabel": "test",
        "SmallTextZoomFactorPercent": 100,
        "FinishAction": {
          "ServerActions": [],
          "ClientActions": [
            {
              "RemoveDocumentFromRecentDocumentList": false,
              "CallClientActionOnlyAfterSuccessfulSync": true,
              "ClientName": "SIGNificant SignAnywhere",
              "CloseApp": false,
              "Action": "https://www.esignanywhere.net/"
            }
          ]
        },
        "ReceiverInformation": {
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",
            "EMail": "##EMAIL##"
          },
          "HolderInformation": "<recognitionType>PASS</recognitionType><documentIssuedOn>07/07/2020</documentIssuedOn><documentExpiryDate>29/07/2020</documentExpiryDate><documentIssuedBy>Namirial</documentIssuedBy><documentNumber>123</documentNumber><countryResidence>AT</countryResidence><firstName>##NAME##</firstName><lastName>##NAME##</lastName><email>##EMAIL##</email><phoneMobile>##PHONENUMBER##</phoneMobile><identificationType>PASSPORT</identificationType><identificationCountry>AT</identificationCountry><passport>1234</passport>",
          "TransactionCodePushPluginData": []
        },
        "SenderInformation": {
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",
            "EMail": "##EMAIL##"
          }
        },
        "TransactionCodeConfigurations": [
          {
            "Id": "smsAuthTransactionCodeId",
            "HashAlgorithmIdentifier": "Sha256",
            "Texts": [
              {
              }
            ]
          }
        ],
        "SignatureConfigurations": [],
        "ViewerPreferences": {
          "FinishWorkstepOnOpen": false,
          "VisibleAreaOptions": {
            "AllowedDomain": "*",
            "Enabled": false
          }
        },
        "ResourceUris": {},
        "AuditingToolsConfiguration": {
          "WriteAuditTrail": false,
          "NotificationConfiguration": {}
        },
        "Policy": {
          "GeneralPolicies": {
            "AllowSaveDocument": true,
            "AllowSaveAuditTrail": true,
            "AllowRotatingPages": false,
            "AllowEmailDocument": true,
            "AllowPrintDocument": true,
            "AllowFinishWorkstep": true,
            "AllowRejectWorkstep": true,
            "AllowRejectWorkstepDelegation": false,
            "AllowUndoLastAction": true,
            "AllowAdhocPdfAttachments": false,
            "AllowAdhocSignatures": false,
            "AllowAdhocStampings": false,
            "AllowAdhocFreeHandAnnotations": false,
            "AllowAdhocTypewriterAnnotations": false,
            "AllowAdhocPictureAnnotations": false,
            "AllowAdhocPdfPageAppending": false
          },
          "WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 89.0,
                  "PositionY": 575.0
                },
                "Size": {
                  "Height": 80.0,
                  "Width": 190.0
                },
                "AdditionalParameters": [
                  {
                    "Key": "enabled",
                    "Value": "1"
                  },
                  {
                    "Key": "positioning",
                    "Value": "onPage"
                  },
                  {
                    "Key": "req",
                    "Value": "1"
                  },
                  {
                    "Key": "fd",
                    "Value": ""
                  },
                  {
                    "Key": "fd_dateformat",
                    "Value": "dd-MM-yyyy HH:mm:ss"
                  },
                  {
                    "Key": "fd_timezone",
                    "Value": "datetimeutc"
                  },
                  {
                    "Key": "spcId",
                    "Value": "padesSigningId"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "TrModType": "RemoteSignatureDisposableCertificate",
                    "TrValidityInSeconds": 300,
                    "Ly": "remoteCertificate",
                    "TrConfIdIssueCertificate": "disposableCertificateEnrolAndSignSmsText",
                    "TrConfId": "remoteCertificateSignSmsText",
                    "IsPhoneNumberRequired": false,
                    "Id": "180c4201-4146-4161-baf8-cb5a607eec62",
                    "DiscriminatorType": "SigTypeTransactionCode",
                    "Preferred": false,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0
                    }
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_b58c192b-47c0-5339-cb18-4fe77c3d1812",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        },
        "Navigation": {
          "HyperLinks": [],
          "Links": [],
          "LinkTargets": []
        }
      },
      "DocumentOptions": [
        {
          "DocumentReference": "1",
          "IsHidden": false
        }
      ],
      "UseDefaultAgreements": true
    },
    {
      "OrderIndex": 2,
      "Recipients": [
        {
          "Email": "##EMAIL##",
          "FirstName": "##NAME##",
          "LastName": "##NAME##",
          "LanguageCode": "en",
          "EmailBodyExtra": "",
          "DisableEmail": false,
          "AddAndroidAppLink": false,
          "AddIosAppLink": false,
          "AddWindowsAppLink": false,
          "AllowDelegation": false,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": []
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Cc",
      "DocumentOptions": [],
      "UseDefaultAgreements": false
    }
  ],
  "AddFormFields": {
    "Forms": {}
  },
  "OverrideFormFieldValues": {
    "Forms": {}
  },
  "AttachSignedDocumentsToEnvelopeLog": false
}
}

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<envelope>
  <name>test</name>
  <eMailSubject>Please sign the enclosed envelope</eMailSubject>
  <eMailBody>Dear #RecipientFirstName# #RecipientLastName#

#PersonalMessage#

Please sign the envelope #EnvelopeName#

Envelope will expire at #ExpirationDate#</eMailBody>
  <enableReminders>true</enableReminders>
  <firstReminderDayAmount>5</firstReminderDayAmount>
  <recurrentReminderDayAmount>3</recurrentReminderDayAmount>
  <beforeExpirationReminderDayAmount>3</beforeExpirationReminderDayAmount>
  <daysUntilExpire>28</daysUntilExpire>
  <callbackUrl></callbackUrl>
  <statusUpdateCallbackUrl></statusUpdateCallbackUrl>
  <lockFormFieldsAtEnvelopeFinish>true</lockFormFieldsAtEnvelopeFinish>
  <displayedEmailSender></displayedEmailSender>
  <steps>
    <step>
      <emailBodyExtra></emailBodyExtra>
      <orderIndex>1</orderIndex>
      <recipientType>Signer</recipientType>
      <useDefaultAgreements>true</useDefaultAgreements>
      <documentOptions>
        <documentOption docRef="1">
          <isHidden>false</isHidden>
        </documentOption>
      </documentOptions>
      <workstepConfiguration skipThirdPartyChecks="0">
        <WorkstepLabel>test</WorkstepLabel>
        <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
        <WorkstepTimeToLiveInMinutes>44650</WorkstepTimeToLiveInMinutes>
        <AbsoluteExpiryDate>2020-07-10T10:57:46.4243017Z</AbsoluteExpiryDate>
        <FinishAction>
          <ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
        </FinishAction>
        <ViewerPreferences>
          <SendVisibleArea allowedDomain="*">0</SendVisibleArea>
          <FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
        </ViewerPreferences>
        <Policy version="1.1.0.0">
          <AdhocPolicies>
            <AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
          </AdhocPolicies>
          <GeneralPolicies>
            <AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
            <AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
            <AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
            <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
            <AllowAdhocSignatures>0</AllowAdhocSignatures>
            <AllowAdhocStampings>0</AllowAdhocStampings>
            <AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
            <AllowEmailDocument>1</AllowEmailDocument>
            <AllowFinishWorkstep>1</AllowFinishWorkstep>
            <AllowPrintDocument>1</AllowPrintDocument>
            <AllowRejectWorkstep>1</AllowRejectWorkstep>
            <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
            <AllowSaveDocument>1</AllowSaveDocument>
            <AllowUndoLastAction>1</AllowUndoLastAction>
            <AllowRotatingPages>0</AllowRotatingPages>
            <AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
          </GeneralPolicies>
          <WorkstepTasks originalSequenceMode="NoSequenceEnforced" SequenceMode="NoSequenceEnforced">
            <Task type="SignField" DocRefNumber="1" id="1#XyzmoDuplicateIdSeperator#Signature_a3d634d1-5b9e-8089-e77d-4888a9616fb2" internalCompleted="0" finishPercentage="0" completed="0" enabled="1" displayName="" required="1" />
          </WorkstepTasks>
        </Policy>
        <Navigation />
        <timeCreated>2020-07-10T10:47:46.3930488Z</timeCreated>
        <TransactionCodeConfigurations>
    <TransactionCodeConfiguration trConfId="smsAuthTransactionCodeId">
    </TransactionCodeConfiguration>
  </TransactionCodeConfigurations>
        <receiverInformation>
          <userInformation>
            <firstName>##NAME##</firstName>
            <lastName>##NAME##</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
          <showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
          <trRsDcNamHolderInformation version="2">
            <recognitionType>PASS</recognitionType>
            <documentIssuedOn>07/07/2020</documentIssuedOn>
            <documentExpiryDate>29/07/2020</documentExpiryDate>
            <documentIssuedBy>Namirial</documentIssuedBy>
            <documentNumber>123</documentNumber>
            <countryResidence>AT</countryResidence>
            <firstName>##NAME##</firstName>
            <lastName>##NAME##</lastName>
            <email>##EMAIL##</email>
            <phoneMobile>##PHONENUMBER##</phoneMobile>
            <identificationType>PASSPORT</identificationType>
            <identificationCountry>AT</identificationCountry>
            <passport>123</passport>
          </trRsDcNamHolderInformation>
        </receiverInformation>
        <senderInformation>
          <userInformation>
            <firstName>##NAME##</firstName>
            <lastName>##NAME##</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
        </senderInformation>
        <pdfForms isEditingAllowed="0" />
        <TypewriterAnnotationTaskInfo />
        <attachmentFields />
        <signatureTemplate>
          <version>1.2.0.2</version>
          <positionReferenceCorner>Lower_Left</positionReferenceCorner>
          <positionUnits>PdfUnits</positionUnits>
          <sig id="1#XyzmoDuplicateIdSeperator#Signature_a3d634d1-5b9e-8089-e77d-4888a9616fb2">
            <TaskDisplayName />
            <param name="enabled">1</param>
            <positionPage>1</positionPage>
            <positionX>78</positionX>
            <positionY>545</positionY>
            <width>190</width>
            <height>80</height>
            <param name="positioning">onPage</param>
            <param name="req">1</param>
            <param name="fd" />
            <param name="fd_dateformat">dd-MM-yyyy HH:mm:ss</param>
            <param name="fd_timezone">datetimeutc</param>
            <DocRefNumber>1</DocRefNumber>
            <AllowedSignatureTypes>
              <sigType id="89f2876e-2149-4a88-b841-547a1b3478a5" type="TransactionCode">
                <trModType>RemoteSignatureDisposableCertificate</trModType>
                <trValidityInSeconds>300</trValidityInSeconds>
                <ly>remoteCertificate</ly>
                <trConfIdIssueCertificate>disposableCertificateEnrolAndSignSmsText</trConfIdIssueCertificate>
                <trConfId>remoteCertificateSignSmsText</trConfId>
                <StampImprintConfiguration>
                  <DisplayExtraInformation>1</DisplayExtraInformation>
                  <DisplayEmail>1</DisplayEmail>
                  <DisplayIp>1</DisplayIp>
                  <DisplayName>1</DisplayName>
                  <DisplaySignatureDate>1</DisplaySignatureDate>
                  <FontFamily>Times New Roman</FontFamily>
                  <FontSize>11</FontSize>
                </StampImprintConfiguration>
              </sigType>
            </AllowedSignatureTypes>
            <param name="spcId">padesSigningId</param>
          </sig>
        </signatureTemplate>
        <AuditingToolsConfiguration WriteAuditTrail="0">
          <NotificationConfiguration />
        </AuditingToolsConfiguration>
        <resourceUris>
          <delegationUri>https://demo.esignanywhere.net/Resource/Delegate</delegationUri>
        </resourceUris>
        <LoggingMetaInformation>
          <envelopeId>##ENVELOPEID##</envelopeId>
          <envelopeRecipientId>##RECIPIENTID##</envelopeRecipientId>
        </LoggingMetaInformation>
      </workstepConfiguration>
      <recipients>
        <recipient>
          <eMail>##EMAIL##</eMail>
          <emailBodyExtra></emailBodyExtra>
          <firstName>##NAME##</firstName>
          <lastName>##NAME##</lastName>
          <languageCode>en</languageCode>
          <disableEmail>false</disableEmail>
          <skipExternalDataValidation>false</skipExternalDataValidation>
          <addAndroidAppLink>false</addAndroidAppLink>
          <addIosAppLink>false</addIosAppLink>
          <addWindowsAppLink>false</addWindowsAppLink>
          <allowDelegation>true</allowDelegation>
          <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
          <authentications />
          <disposableCertificateAdditionalInformation>
            <countryResidence>AT</countryResidence>
            <phoneMobile>##PHONENUMBER##</phoneMobile>
            <documentType>PASS</documentType>
            <documentIssuedBy>Namirial</documentIssuedBy>
            <documentIssuedOn>2020-07-07T00:00:00Z</documentIssuedOn>
            <documentExpiryDate>2020-07-29T00:00:00Z</documentExpiryDate>
            <serialNumber>123</serialNumber>
            <identificationType>PASSPORT</identificationType>
            <identificationCountry>AT</identificationCountry>
            <documentNumber>123</documentNumber>
            <overrideOnHolderMismatch>false</overrideOnHolderMismatch>
          </disposableCertificateAdditionalInformation>
        </recipient>
      </recipients>
    </step>
    <step>
      <emailBodyExtra></emailBodyExtra>
      <orderIndex>2</orderIndex>
      <recipientType>Cc</recipientType>
      <useDefaultAgreements>false</useDefaultAgreements>
      <recipients>
        <recipient>
          <eMail>##EMAIL##</eMail>
          <emailBodyExtra></emailBodyExtra>
          <firstName>##NAME##</firstName>
          <lastName>##NAME##</lastName>
          <languageCode>en</languageCode>
          <disableEmail>false</disableEmail>
          <skipExternalDataValidation>false</skipExternalDataValidation>
          <addAndroidAppLink>false</addAndroidAppLink>
          <addIosAppLink>false</addIosAppLink>
          <addWindowsAppLink>false</addWindowsAppLink>
          <allowDelegation>false</allowDelegation>
          <authentications />
        </recipient>
      </recipients>
    </step>
  </steps>
  <attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope>

P7M Signers

Info
It is possible to define P7M signers in eSignAnyWhere (version 3.1+). This allows you to define at the end of a signing workflow to define signers with P7M. Due technical reasons it is not possible to add non-P7M signers after the first P7M signer. P7M is an advanced feature and must be enabled for you, so please contact your Namirial Sales

...

Code Block

language	xml
theme	Eclipse

<WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks">
	<Task enabled="1" completed="0" required="0" id="pkcs1" displayName="" DocRefNumber="1" type="SignPkcs7" finishPercentage="0" />
</WorkstepTasks>

EnvelopeDocumentInforamtion

<WorkStepInformation>
    ...
    <EnvelopeInformation>
        <EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="1" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
        <EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="2" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
        <EnvelopeDocumentInformation numberOfPages="1" DocRefNumber="3" name="" isOptionalDocument="0" isPkcs7="0" enabled="1" />
    </EnvelopeInformation>
	...
</WorkStepInformation>

Automatic Remote Signature Recipient via API

Via API you have to use a new recipient type (“Automatic”). Moreover the workstepConfiguration must contain information about the automatic remote signature. As additional option, you can use more than one profile for the workstep configuration at once via API. Note: this leads to a missing information in eSAW UI!

...

Code Block

language	xml
theme	Eclipse

<Policy version="1.1.0.0">
  <FinalizeActions>
	<AutomaticSignature sigId="GENERIC_SIG_IDENTIFIER" />
  </FinalizeActions>
</Policy>

A-Trust

Info
Note: For the A-Trust signature configuration you need an A-Trust Signaturbox first. For more information please contact us.

...

If you enter the phone number then the recipient can not enter another number. However, if you do not define a phone number then the recipient is free to choose a phone number of their choice.

BankID

In this section you can find the configuration for the bankID signature. First we have to upload a PDF. After uploading the document we can now send the document with the following workstep configuration to define the bankID signature:

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

 <authentications>
          <authentication>
                <method>BankId</method>
                <parameter>##parameter##</parameter>
          </authentication>
 </authentications>

Generic Signing Plugin

In this section you can find the configuration for the generic signing plugin signature. First we have to upload a PDF. After uploading the document we can now send the document with the following workstep configuration to define the plugin signature:

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<envelope>
  <name>test</name>
  <eMailSubject>Please sign the enclosed envelope</eMailSubject>
  <eMailBody>Dear #RecipientFirstName# #RecipientLastName#

#PersonalMessage#

Please sign the envelope #EnvelopeName#

Envelope will expire at #ExpirationDate#</eMailBody>
  <enableReminders>true</enableReminders>
  <firstReminderDayAmount>5</firstReminderDayAmount>
  <recurrentReminderDayAmount>3</recurrentReminderDayAmount>
  <beforeExpirationReminderDayAmount>3</beforeExpirationReminderDayAmount>
  <daysUntilExpire>28</daysUntilExpire>
  <callbackUrl></callbackUrl>
  <statusUpdateCallbackUrl></statusUpdateCallbackUrl>
  <lockFormFieldsAtEnvelopeFinish>false</lockFormFieldsAtEnvelopeFinish>
  <displayedEmailSender>##Email##</displayedEmailSender>
  <steps>
    <step>
      <emailBodyExtra></emailBodyExtra>
      <orderIndex>1</orderIndex>
      <recipientType>Signer</recipientType>
      <useDefaultAgreements>true</useDefaultAgreements>
      <documentOptions>
        <documentOption docRef="1">
          <isHidden>false</isHidden>
        </documentOption>
      </documentOptions>
      <workstepConfiguration skipThirdPartyChecks="0">
        <WorkstepLabel>test</WorkstepLabel>
        <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
        <WorkstepTimeToLiveInMinutes>43200</WorkstepTimeToLiveInMinutes>
        <FinishAction>
          <ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
        </FinishAction>
        <signatureTemplate>
          <sig id="1#XyzmoDuplicateIdSeperator#Signature_a48a82a2-0bd3-1e9e-c223-64ad308bf715" useTimestamp="false">
            <positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>
            <positionX>70</positionX>
            <positionY>606</positionY>
            <width>191</width>
            <height>80</height>
            <param name="enabled">1</param>
            <param name="positioning">onPage</param>
            <param name="req">1</param>
            <param name="fd"></param>
            <param name="fd_dateformat">dd-MM-yyyy HH:mm:ss</param>
            <param name="fd_timezone">datetimeutc</param>
            <AllowedSignatureTypes>
              <sigType id="8e4ce7e9-b70b-464b-861e-8429239ef474" type="GenericSigningPlugin" preferred="0">
                <genericSigningPluginId>GenericSigningPluginForTests</genericSigningPluginId>
              </sigType>
            </AllowedSignatureTypes>
          </sig>
          <positionUnits>PdfUnits</positionUnits>
          <positionReferenceCorner>Lower_Left</positionReferenceCorner>
        </signatureTemplate>
        <PictureAnnotationTaskInfo>
          <MinResolution>0</MinResolution>
          <MaxResolution>0</MaxResolution>
          <ColorDepth>Color16M</ColorDepth>
        </PictureAnnotationTaskInfo>
        <Policy version="1.1.0.0">
          <GeneralPolicies>
            <AllowSaveDocument>1</AllowSaveDocument>
            <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
            <AllowRotatingPages>0</AllowRotatingPages>
            <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep>
            <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep>
            <AllowEmailDocument>1</AllowEmailDocument>
            <AllowPrintDocument>1</AllowPrintDocument>
            <AllowFinishWorkstep>1</AllowFinishWorkstep>
            <AllowRejectWorkstep>1</AllowRejectWorkstep>
            <AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation>
            <AllowUndoLastAction>1</AllowUndoLastAction>
            <AllowColorizePdfForms>0</AllowColorizePdfForms>
            <AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
            <AllowAdhocSignatures>0</AllowAdhocSignatures>
            <AllowAdhocStampings>0</AllowAdhocStampings>
            <AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
            <AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
            <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
            <AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
          </GeneralPolicies>
          <WorkstepTasks SequenceMode="NoSequenceEnforced">
            <Task enabled="0" completed="0" required="1" id="1#XyzmoDuplicateIdSeperator#Signature_a48a82a2-0bd3-1e9e-c223-64ad308bf715" displayName="" DocRefNumber="1" type="SignField" />
          </WorkstepTasks>
        </Policy>
        <timeCreated />
        <TransactionCodeConfigurations>
          <TransactionCodeConfiguration trConfId="smsAuthTransactionCodeId" language="">
           
          </TransactionCodeConfiguration>
        </TransactionCodeConfigurations>
        <ViewerPreferences />
        <receiverInformation>
          <userInformation>
            <firstName>##FirstName##</firstName>
            <lastName>##LastName##</lastName>
            <eMail>##Email##</eMail>
          </userInformation>
          <showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
          <genericSigningPluginData pluginId="GenericSigningPluginForTests">
            <senderDataFields>
              <recipientemail>##Email##</recipientemail>
              <recipientfirstname>##FirstName##</recipientfirstname>
              <customEmail>##Email##</customEmail>
              <userId>##UserId##</userId>
              <email>##Email##</email>
              <password>##Password##</password>
              <number>##Number##</number>
              <phoneNumber>+##PhoneNumber##</phoneNumber>
              <list>app</list>
            </senderDataFields>
          </genericSigningPluginData>
        </receiverInformation>
        <senderInformation>
          <userInformation>
            <firstName>##FirstName##</firstName>
            <lastName>##LastName##</lastName>
            <eMail>##Email##</eMail>
          </userInformation>
        </senderInformation>
      </workstepConfiguration>
      <recipients>
        <recipient>
          <eMail>##Email##</eMail>
          <emailBodyExtra></emailBodyExtra>
          <firstName>##FirstName##</firstName>
          <lastName>##LastName##</lastName>
          <languageCode>en</languageCode>
          <disableEmail>false</disableEmail>
          <skipExternalDataValidation>false</skipExternalDataValidation>
          <addAndroidAppLink>false</addAndroidAppLink>
          <addIosAppLink>false</addIosAppLink>
          <addWindowsAppLink>false</addWindowsAppLink>
          <allowDelegation>false</allowDelegation>
          <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
          <authentications />
        </recipient>
      </recipients>
    </step>
  </steps>
  <attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope>

Generic Signing Plugin (automatic)

In this section you can find the configuration for an automatic generic signing plugin signature. Please see the following workstep configuration for more information:

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

 <envelope>
  <name>GenericSigningPluginForTests</name>
  <eMailSubject>*GenericSigningPluginForTests*</eMailSubject>
  <eMailBody>*Please sign the document*</eMailBody>
  <enableReminders>true</enableReminders>
  <firstReminderDayAmount>5</firstReminderDayAmount>
  <recurrentReminderDayAmount>3</recurrentReminderDayAmount>
  <beforeExpirationReminderDayAmount>3</beforeExpirationReminderDayAmount>
  <daysUntilExpire>28</daysUntilExpire>
  <callbackUrl></callbackUrl>
  <statusUpdateCallbackUrl></statusUpdateCallbackUrl>
  <lockFormFieldsAtEnvelopeFinish>false</lockFormFieldsAtEnvelopeFinish>
  <displayedEmailSender>##Email##</displayedEmailSender>
  <steps>
    <step>
      <emailBodyExtra></emailBodyExtra>
      <orderIndex>1</orderIndex>
      <recipientType>Automatic</recipientType>
      <useDefaultAgreements>true</useDefaultAgreements>
      <documentOptions>
        <documentOption docRef="1">
          <isHidden>false</isHidden>
        </documentOption>
      </documentOptions>
      <workstepConfiguration skipThirdPartyChecks="0">
        <WorkstepLabel>Generic Signing Plugin</WorkstepLabel>
        <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
        <WorkstepTimeToLiveInMinutes>43200</WorkstepTimeToLiveInMinutes>
        <signatureTemplate>
          <sig id="c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75">
            <positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>
            <positionX>0</positionX>
            <positionY>0</positionY>
            <width>190</width>
            <height>80</height>
            <param name="req">1</param>
            <param name="positioning">onPage</param>
            <param name="enabled">1</param>
            <AllowedSignatureTypes>
              <sigType id="SignFor_c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75" type="AutomaticSignature" preferred="0">
                <trModType />
                <SealingProfileId>##SealingProfileId##</SealingProfileId>
                <genericSigningPluginId>GenericSigningPluginForTests</genericSigningPluginId>
              </sigType>
            </AllowedSignatureTypes>
            <param name="spcId">automaticSigningId</param>
          </sig>
          <positionUnits>PdfUnits</positionUnits>
          <positionReferenceCorner>Lower_Left</positionReferenceCorner>
        </signatureTemplate>
        <PictureAnnotationTaskInfo>
          <MinResolution>-1</MinResolution>
          <MaxResolution>-1</MaxResolution>
          <ColorDepth>Color16M</ColorDepth>
        </PictureAnnotationTaskInfo>
        <Policy version="1.1.0.0">
          <GeneralPolicies>
            <AllowSaveDocument>1</AllowSaveDocument>
            <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
            <AllowRotatingPages>1</AllowRotatingPages>
            <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep>
            <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep>
            <AllowEmailDocument>1</AllowEmailDocument>
            <AllowFinishWorkstep>1</AllowFinishWorkstep>
            <AllowRejectWorkstep>1</AllowRejectWorkstep>
            <AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
            <AllowUndoLastAction>1</AllowUndoLastAction>
            <AllowColorizePdfForms>0</AllowColorizePdfForms>
            <AllowAdhocPdfAttachments>1</AllowAdhocPdfAttachments>
            <AllowAdhocSignatures>0</AllowAdhocSignatures>
            <AllowAdhocStampings>0</AllowAdhocStampings>
            <AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
            <AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
            <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
            <AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
          </GeneralPolicies>
          <WorkstepTasks SequenceMode="NoSequenceEnforced" />
          <FinalizeActions>
            <AutomaticSignature sigId="c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75" />
          </FinalizeActions>
        </Policy>
        <timeCreated />
        <TransactionCodeConfigurations>
          <TransactionCodeConfiguration trConfId="smsAuthTransactionCodeId" language="">
          </TransactionCodeConfiguration>
        </TransactionCodeConfigurations>
        <ViewerPreferences>
          <FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
        </ViewerPreferences>
        <senderInformation>
          <userInformation>
            <firstName>##FirstName##</firstName>
            <lastName>##LastName##</lastName>
            <eMail>##Email##</eMail>
          </userInformation>
        </senderInformation>
        <FinishAction />
      </workstepConfiguration>
      <recipients>
        <recipient>
          <eMail>#PlaceholderEmail##</eMail>
          <emailBodyExtra></emailBodyExtra>
          <firstName>_PlaceHolderFirstName</firstName>
          <lastName>_PlaceHolderFirstName</lastName>
          <languageCode>en</languageCode>
          <disableEmail>true</disableEmail>
          <skipExternalDataValidation>false</skipExternalDataValidation>
          <addAndroidAppLink>false</addAndroidAppLink>
          <addIosAppLink>false</addIosAppLink>
          <addWindowsAppLink>false</addWindowsAppLink>
          <allowDelegation>false</allowDelegation>
          <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
          <authentications />
        </recipient>
      </recipients>
    </step>
  </steps>
  <attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope>

Generic Signing Plugin (Batch-Signature)

In this section you can find the configuration for a batch generic signing plugin signature. Please see the following workstep configuration for more information:

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<envelope>
   <name>eSignAnyWhere Tutorial</name>
   <eMailSubject>Document of eSignAnyWhere Tutorial</eMailSubject>
   <eMailBody>Dear #RecipientFirstName#! Please sign this tutorial document.</eMailBody>
   <enableReminders>True</enableReminders>
   <firstReminderDayAmount>1</firstReminderDayAmount>
   <recurrentReminderDayAmount>1</recurrentReminderDayAmount>
   <beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
   <daysUntilExpire>2</daysUntilExpire>
   <callbackUrl />
   <steps>
      <step>
         <emailBodyExtra />
         <orderIndex>1</orderIndex>
         <recipientType>Signer</recipientType>
         <recipients>
            <recipient>
               <languageCode>en</languageCode>
               <eMail>##Email##</eMail>
               <firstName>##FirstName##</firstName>
               <lastName>##LastName##</lastName>
              
            </recipient>
         </recipients>
       <workstepConfiguration skipThirdPartyChecks="0">
  <WorkstepLabel />
  <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
  <WorkstepTimeToLiveInMinutes>900</WorkstepTimeToLiveInMinutes>
  <FinishAction>
  </FinishAction>
  <signatureTemplate>
    <version>1.2.0.2</version>
    <positionUnits>PdfUnits</positionUnits>
    <positionReferenceCorner>Lower_Left</positionReferenceCorner>
    <sig id="Sig1a">
      <positionPage>1</positionPage>
      <DocRefNumber>1</DocRefNumber>
      <positionX>50</positionX>
      <positionY>700</positionY>
      <width>240</width>
      <height>54.85714</height>
      <param name="enabled">1</param>
      <param name="completed">0</param>
      <param name="sigType">GenericSigningPlugin</param>
      <param name="genericSigningPluginId">GenericSigningPluginForTests</param>
      <param name="positioning">onPage</param>
      <param name="ly">remoteCertificate</param>
      <param name="fd">My Field Description Text</param>
    </sig>
    <sig id="Sig1b">
      <positionPage>1</positionPage>
      <DocRefNumber>1</DocRefNumber>
      <positionX>50</positionX>
      <positionY>600</positionY>
      <width>240</width>
      <height>54.85714</height>
      <param name="enabled">1</param>
      <param name="completed">0</param>
      <param name="sigType">GenericSigningPlugin</param>
      <param name="genericSigningPluginId">GenericSigningPluginForTests</param>
      <param name="positioning">onPage</param>
      <param name="ly">remoteCertificate</param>
      <param name="fd">My Field Description Text</param>
    </sig>
    <sig id="Sig1c">
      <positionPage>1</positionPage>
      <DocRefNumber>1</DocRefNumber>
      <positionX>50</positionX>
      <positionY>500</positionY>
      <width>240</width>
      <height>54.85714</height>
      <param name="enabled">1</param>
      <param name="completed">0</param>
      <param name="sigType">GenericSigningPlugin</param>
      <param name="genericSigningPluginId">GenericSigningPluginForTests</param>
      <param name="positioning">onPage</param>
      <param name="ly">remoteCertificate</param>
      <param name="fd">My Field Description Text</param>
    </sig>
  </signatureTemplate>
  <receiverInformation>
    <userInformation>
      <firstName>##FirstName##</firstName>
      <lastName>##LastName##</lastName>
      <eMail>##Email##</eMail>
    </userInformation>
    <genericSigningPluginData pluginId="GenericSigningPluginForTests">
      <senderDataFields>
      </senderDataFields>
    </genericSigningPluginData>
  </receiverInformation>
  <pdfForms isEditingAllowed="1" />
  <attachmentFields />
  <PictureAnnotationTaskInfo>
    <MinResolution>96</MinResolution>
    <MaxResolution>300</MaxResolution>
    <ColorDepth>Color16M</ColorDepth>
  </PictureAnnotationTaskInfo>
  <TypewriterAnnotationTaskInfo />
  <Policy version="1.1.0.0">
    <GeneralPolicies>
      <AllowSaveDocument>1</AllowSaveDocument>
      <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
      <AllowRotatingPages>1</AllowRotatingPages>
      <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep>
      <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep>
      <AllowEmailDocument>1</AllowEmailDocument>
      <AllowPrintDocument>1</AllowPrintDocument>
      <AllowFinishWorkstep>1</AllowFinishWorkstep>
      <AllowRejectWorkstep>1</AllowRejectWorkstep>
      <AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation>
      <AllowUndoLastAction>1</AllowUndoLastAction>
      <AllowColorizePdfForms>0</AllowColorizePdfForms>
      <AllowReloadOfFinishedWorkstep>1</AllowReloadOfFinishedWorkstep>
      <AllowAdhocPdfAttachments>1</AllowAdhocPdfAttachments>
      <AllowAdhocSignatures>1</AllowAdhocSignatures>
      <AllowAdhocStampings>1</AllowAdhocStampings>
      <AllowAdhocFreeHandAnnotations>1</AllowAdhocFreeHandAnnotations>
      <AllowAdhocTypewriterAnnotations>1</AllowAdhocTypewriterAnnotations>
      <AllowAdhocPictureAnnotations>1</AllowAdhocPictureAnnotations>
      <AllowAdhocPdfPageAppending>1</AllowAdhocPdfPageAppending>
    </GeneralPolicies>
    <WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks">
      <Task enabled="1" completed="0" required="0" id="Sig1a" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" batchId="batch" />
      <Task enabled="1" completed="0" required="0" id="Sig1b" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" batchId="batch" />
      <Task enabled="1" completed="0" required="0" id="Sig1c" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" batchId="batch" />
    </WorkstepTasks>
    <AdhocPolicies>
      <AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
    </AdhocPolicies>
  </Policy>
  <Navigation />
  <timeCreated>2020-07-08T08:17:01.0948544Z</timeCreated>
  <signaturePluginConfiguration>
    <PdfSignatureProperties_V1>
      <PdfAConformant>0</PdfAConformant>
      <ValidateSigningCertificateName regex="(?<LastName>.*) (?<FirstName>.*)">0</ValidateSigningCertificateName>
      <ValidateSigningCertificateViaEutl>0</ValidateSigningCertificateViaEutl>
      <PAdESPart4Compliant>0</PAdESPart4Compliant>
      <IncludeSigningCertificateChain>0</IncludeSigningCertificateChain>
      <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
      <SignatureTimestampData>
        <Password />
        <SignatureHashAlgorithm>SHA1</SignatureHashAlgorithm>
        <Uri />
        <UserName />
      </SignatureTimestampData>
    </PdfSignatureProperties_V1>
    <PdfSignatureCryptographicData_V1>
      <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
      <SigningCertificateDescriptor>
        <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
        <Type>Sha1Thumbprint</Type>
        <Csp>Default</Csp>
      </SigningCertificateDescriptor>
    </PdfSignatureCryptographicData_V1>
  </signaturePluginConfiguration>
  <AuditingToolsConfiguration WriteAuditTrail="1">
    <NotificationConfiguration>
    </NotificationConfiguration>
  </AuditingToolsConfiguration>
  <TransactionCodeConfigurations>
    <TransactionCodeConfiguration trConfId="">
      <Message>Please sign the document with the transactionId {tId} with the code: {Token}</Message>
      <hashAlgorithmIdentifier>Sha256</hashAlgorithmIdentifier>
    </TransactionCodeConfiguration>
    <TransactionCodeConfiguration trConfId="Trans1">
      <Message>Please accept the transactionId {tId} with the code: {Token}</Message>
      <hashAlgorithmIdentifier>Sha256</hashAlgorithmIdentifier>
    </TransactionCodeConfiguration>
    <TransactionCodeConfiguration trConfId="IdentityServerMail">
      <Subject>Message for TransactionCode</Subject>
      <FromAddress>##Email##</FromAddress>
      <TextBody>Please accept the transactionId {tId} with the code: {Token}</TextBody>
    
      <hashAlgorithmIdentifier>Sha256</hashAlgorithmIdentifier>
    </TransactionCodeConfiguration>
  </TransactionCodeConfigurations>
</workstepConfiguration>
      </step>
      <step>
         <emailBodyExtra />
         <orderIndex>2</orderIndex>
         <recipientType>CC</recipientType>
         <recipients>
            <recipient>
               <languageCode>en</languageCode>
               <eMail>##Email##</eMail>
               <firstName>##FirstName##</firstName>
               <lastName>##LastName##</lastName>
            </recipient>
         </recipients>
      </step>
   </steps>
</envelope>

Authentication

You can add different authentications for the recipient to ensure that only the one who has the code/phone number can open the envelope. Following list shows the different authentications:

...

In the next two collapses you can find the configuration for the Pin-authentication and for the SMS-authentication:

Pin-authentication

Code Block

language	java
theme	Eclipse

{
              "Method": "Pin",
              "Parameter": "1234"
}

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<authentications>
<authentication>
<method>Pin</method>
<parameter>1234</parameter>
</authentication>
</authentications>

SMS-authentication

Code Block

language	java
theme	Eclipse

{
              "Method": "Sms",
              "Parameter": "+0123456789"
}

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

 <envelope>
<name>eSignAnyWhere Tutorial</name>
<eMailSubject>Document of eSignAnyWhere Tutorial</eMailSubject>
<eMailBody>Dear #RecipientFirstName#! Please sign this tutorial document.</eMailBody>
<enableReminders>True</enableReminders>
<firstReminderDayAmount>1</firstReminderDayAmount>
<recurrentReminderDayAmount>1</recurrentReminderDayAmount>
<beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
<daysUntilExpire>2</daysUntilExpire>
<!-- callback to your backend system on a completed envelope 
<callbackUrl>http://172.16.17.78:57550/default.aspx?EnvelopeId=##EnvelopeId##&myParamForMe=1234</callbackUrl> 
-->
<callbackUrl />
<steps>
<step>
<emailBodyExtra />
<orderIndex>1</orderIndex>
<recipientType>Signer</recipientType>
<recipients>
<recipient>
<languageCode>en</languageCode>
<eMail>##EMAIL##</eMail>
<firstName>Alice</firstName>
<lastName>Somename</lastName>
<authentications>
<authentication>
<method>Pin</method>
<parameter>1234</parameter>
</authentication>
</authentications>
</recipient>
</recipients>
<workstepConfiguration>
<WorkstepLabel />
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
<WorkstepTimeToLiveInMinutes>11520</WorkstepTimeToLiveInMinutes>
<FinishAction />
<ViewerPreferences>
</ViewerPreferences>
<signatureTemplate>
</signatureTemplate>
<Policy version="1.1.0.0">
<GeneralPolicies> 
</GeneralPolicies>
<WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks"> 
</WorkstepTasks>
</Policy>
<TransactionCodeConfigurations>
<TransactionCodeConfiguration trConfId=""> 
</TransactionCodeConfiguration>
</TransactionCodeConfigurations>
</workstepConfiguration> 
</step>
</steps>
</envelope>

PdfForms

The following list shows you all different form fields which can be placed on the document:

...

Info

There are two configurations to do:

PdfForms
AddFormFields

This applies to all form fields.

Textfield

Code Block

language	java
theme	Eclipse

 "Forms": [
                  {
                    "Id": "TextBox_3daf9a88-bf45-70af-99d0-c077bcb48245",
                    "PositionPage": 1,
                    "DocRefNumber": 1,
                    "Position": {
                      "PositionX": 77.0,
                      "PositionY": 590.0
                    },
                    "Size": {
                      "Height": 20.0,
                      "Width": 124.0
                    },
                    "DiscriminatorType": "TextBox"
                  }
                ],
                "IsRequired": false,
                "Id": "f390ebd3-4b9c-4554-ab61-4d1234bad681",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "FormGroup"
      },

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<textBox id="TextBox_044431e0-c75b-ea8a-0a6b-b2a82a3b7a67">
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>70</positionX>
<positionY>579</positionY>
<width>124</width>
<height>20</height>
</textBox>

Radiobutton

Code Block

language	java
theme	Eclipse

{
                    "RadioButtonGroupId": "RadioButton_942fca6a-5e0e-7694-b858-b5ded711ed0b",
                    "Id": "0",
                    "PositionPage": 1,
                    "DocRefNumber": 1,
                    "Position": {
                      "PositionX": 77.0,
                      "PositionY": 553.0
                    },
                    "Size": {
                      "Height": 20.0,
                      "Width": 20.0
                    },
                    "DiscriminatorType": "RadioButton"
                  },

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

 <radioButton id="RadioButton_2b853f33-ed5c-7e39-7865-41056a90ca13#XyzmoIndexSeparator#0">
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>66</positionX>
<positionY>544</positionY>
<width>20</width>
<height>20</height>
</radioButton>

Checkbox

Code Block

language	java
theme	Eclipse

{
                    "IsRequired": false,
                    "RequiredEvalPolicy": "None",
                    "Id": "CheckBox_41371eaf-6e1a-0d9a-58a9-0705fd8d08d1",
                    "PositionPage": 1,
                    "DocRefNumber": 1,
                    "Position": {
                      "PositionX": 77.0,
                      "PositionY": 520.0
                    },
                    "Size": {
                      "Height": 20.0,
                      "Width": 20.0
                    },
                    "DiscriminatorType": "CheckBox"
                  },

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<checkBox id="CheckBox_6f1fde0e-9338-f34b-6fe2-05d27ff632b9">
<requiredEvalPolicy>None</requiredEvalPolicy>
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>69</positionX>
<positionY>511</positionY>
<width>20</width>
<height>20</height>
</checkBox>

Listbox

Code Block

language	java
theme	Eclipse

{
                    "Items": [],
                    "Id": "ListBox_d51c4e55-2497-8ab4-f2c8-6f60ac6a2cfd",
                    "PositionPage": 1,
                    "DocRefNumber": 1,
                    "Position": {
                      "PositionX": 79.0,
                      "PositionY": 475.0
                    },
                    "Size": {
                      "Height": 30.0,
                      "Width": 150.0
                    },
                    "DiscriminatorType": "ListBox"
                  },

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

 <listBox id="ListBox_1c2a2627-5262-2fb0-d937-5e0f947031a4">
<DocRefNumber>1</DocRefNumber>
<isRequired>0</isRequired>
<positionPage>1</positionPage>
<positionX>69</positionX>
<positionY>464</positionY>
<width>150</width>
<height>30</height>
</listBox>

Listbox (Multiselect)

In the workstep configuration you can also define to select multiple items in the listbox. To define a multiselect of items you have to have at least two items in the listbox and you have to activate multiselect for this listbox. Please see the configurations below for more information:

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

<envelope>
  <name>test</name>
  <eMailSubject>Please sign the enclosed envelope</eMailSubject>
  <eMailBody>Dear #RecipientFirstName# #RecipientLastName#

#PersonalMessage#

Please sign the envelope #EnvelopeName#

Envelope will expire at #ExpirationDate#</eMailBody>
  <enableReminders>true</enableReminders>
  <firstReminderDayAmount>5</firstReminderDayAmount>
  <recurrentReminderDayAmount>3</recurrentReminderDayAmount>
  <beforeExpirationReminderDayAmount>3</beforeExpirationReminderDayAmount>
  <daysUntilExpire>28</daysUntilExpire>
  <callbackUrl></callbackUrl>
  <statusUpdateCallbackUrl></statusUpdateCallbackUrl>
  <lockFormFieldsAtEnvelopeFinish>true</lockFormFieldsAtEnvelopeFinish>
  <displayedEmailSender></displayedEmailSender>
  <steps>
    <step>
      <emailBodyExtra></emailBodyExtra>
      <orderIndex>1</orderIndex>
      <recipientType>Signer</recipientType>
      <useDefaultAgreements>true</useDefaultAgreements>
      <documentOptions>
        <documentOption docRef="1">
          <isHidden>false</isHidden>
        </documentOption>
      </documentOptions>
      <workstepConfiguration skipThirdPartyChecks="0">
        <WorkstepLabel>test</WorkstepLabel>
        <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
        <WorkstepTimeToLiveInMinutes>44650</WorkstepTimeToLiveInMinutes>
        <AbsoluteExpiryDate>2020-07-17T07:15:28.9549326Z</AbsoluteExpiryDate>
        <FinishAction>
          <ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
        </FinishAction>
        <ViewerPreferences>
          <SendVisibleArea allowedDomain="*">0</SendVisibleArea>
          <FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
        </ViewerPreferences>
        <Policy version="1.1.0.0">
          <AdhocPolicies>
            <AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
          </AdhocPolicies>
          <GeneralPolicies>
            <AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
            <AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
            <AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
            <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
            <AllowAdhocSignatures>0</AllowAdhocSignatures>
            <AllowAdhocStampings>0</AllowAdhocStampings>
            <AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
            <AllowEmailDocument>1</AllowEmailDocument>
            <AllowFinishWorkstep>1</AllowFinishWorkstep>
            <AllowPrintDocument>1</AllowPrintDocument>
            <AllowRejectWorkstep>1</AllowRejectWorkstep>
            <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
            <AllowSaveDocument>1</AllowSaveDocument>
            <AllowUndoLastAction>1</AllowUndoLastAction>
            <AllowRotatingPages>0</AllowRotatingPages>
            <AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation>
          </GeneralPolicies>
          <WorkstepTasks originalSequenceMode="NoSequenceEnforced" SequenceMode="NoSequenceEnforced">
            <Task id="411581f7-5d5b-4443-8aec-43027d1f703c" DocRefNumber="1" enabled="1" completed="0" type="FillFormsGroup" required="0" displayName="" />
          </WorkstepTasks>
        </Policy>
        <Navigation />
        <timeCreated>2020-07-17T07:05:28.9236813Z</timeCreated>
        <TransactionCodeConfigurations>
    <TransactionCodeConfiguration trConfId="smsAuthTransactionCodeId">
    </TransactionCodeConfiguration>
  </TransactionCodeConfigurations>
        <receiverInformation>
          <userInformation>
            <firstName>##NAME##</firstName>
            <lastName>##NAME##</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
          <showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
        </receiverInformation>
        <senderInformation>
          <userInformation>
            <firstName>##NAME##</firstName>
            <lastName>##NAME##</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
        </senderInformation>
        <pdfForms isEditingAllowed="0">
          <pdfFormsGroup id="411581f7-5d5b-4443-8aec-43027d1f703c">
            <listBox id="ListBox_ef1ae2c5-8c83-2aab-b9eb-56624e33bcb8">
              <DocRefNumber>1</DocRefNumber>
              <isRequired>0</isRequired>
              <positionPage>1</positionPage>
              <positionX>60</positionX>
              <positionY>655</positionY>
              <width>150</width>
              <height>30</height>
            </listBox>
          </pdfFormsGroup>
        </pdfForms>
        <TypewriterAnnotationTaskInfo />
        <attachmentFields />
        <signatureTemplate>
          <version>1.2.0.2</version>
          <positionReferenceCorner>Lower_Left</positionReferenceCorner>
          <positionUnits>PdfUnits</positionUnits>
        </signatureTemplate>
        <AuditingToolsConfiguration WriteAuditTrail="0">
          <NotificationConfiguration />
        </AuditingToolsConfiguration>
        <resourceUris />
      </workstepConfiguration>
      <recipients>
        <recipient>
          <eMail>##EMAIL##</eMail>
          <emailBodyExtra></emailBodyExtra>
          <firstName>##NAME##</firstName>
          <lastName>##NAME##</lastName>
          <languageCode>en</languageCode>
          <disableEmail>false</disableEmail>
          <skipExternalDataValidation>false</skipExternalDataValidation>
          <addAndroidAppLink>false</addAndroidAppLink>
          <addIosAppLink>false</addIosAppLink>
          <addWindowsAppLink>false</addWindowsAppLink>
          <allowDelegation>false</allowDelegation>
          <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
          <authentications />
        </recipient>
      </recipients>
    </step>
    <step>
      <emailBodyExtra></emailBodyExtra>
      <orderIndex>2</orderIndex>
      <recipientType>Cc</recipientType>
      <useDefaultAgreements>false</useDefaultAgreements>
      <recipients>
        <recipient>
          <eMail>##EMAIL##</eMail>
          <emailBodyExtra></emailBodyExtra>
          <firstName>##NAME##</firstName>
          <lastName>##NAME##</lastName>
          <languageCode>en</languageCode>
          <disableEmail>false</disableEmail>
          <skipExternalDataValidation>false</skipExternalDataValidation>
          <addAndroidAppLink>false</addAndroidAppLink>
          <addIosAppLink>false</addIosAppLink>
          <addWindowsAppLink>false</addWindowsAppLink>
          <allowDelegation>false</allowDelegation>
          <authentications />
        </recipient>
      </recipients>
    </step>
  </steps>
  <addFormFields>
    <document docRef="1">
      <listBox name="ListBox_ef1ae2c5-8c83-2aab-b9eb-56624e33bcb8" readOnly="false" required="false" x="60" y="655" width="150" height="30" page="1">
         <isMultiSelect>1</isMultiSelect>
        <fontSettings>
          <textColor></textColor>
          <fontName>Times New Roman</fontName>
          <fontSize>11</fontSize>
          <fontStyleBold>false</fontStyleBold>
          <fontStyleItalic>false</fontStyleItalic>
          <textAlign>Left</textAlign>
        </fontSettings>
        <item>
          <item exportValue="option1" displayValue="option1" isSelected="true" />
          <item exportValue="option2" displayValue="option2" isSelected="true" />
          <item exportValue="option3" displayValue="option3" isSelected="false" />
        </item>
      </listBox>
    </document>
  </addFormFields>
  <attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope>

Combobox

Code Block

language	java
theme	Eclipse

{
                    "IsRequired": false,
                    "Items": [],
                    "Id": "ComboBox_67a8d39f-3a49-65e0-0d5d-88ac97b387ea",
                    "PositionPage": 1,
                    "DocRefNumber": 1,
                    "Position": {
                      "PositionX": 79.0,
                      "PositionY": 424.0
                    },
                    "Size": {
                      "Height": 30.0,
                      "Width": 150.0
                    },
                    "DiscriminatorType": "ComboBox"
                  }

...

After the configuration of the section “PdfForms” you can add these form fields in the section “addFormFields”.

AddFormFields

Textfield:

Code Block

language	java
theme	Eclipse

{
          "Value": "",
          "MaxLength": -1,
          "IsMultiline": false,
          "IsPassword": false,
          "IsComb": false,
          "TextColor": "0, 0, 0",
          "FontSize": 11.0,
          "FontName": "Times New Roman",
          "Bold": false,
          "Italic": false,
          "TextAlign": "Left",
          "Name": "TextBox_3daf9a88-bf45-70af-99d0-c077bcb48245",
          "ReadOnly": false,
          "Required": false,
          "X": 77.0,
          "Y": 590.92,
          "Width": 124.0,
          "Height": 20.0,
          "Page": 1,
          "DiscriminatorType": "AddTextBoxFormFieldDescriptor"
        },

...

Expand

title	Alternative: SOAP implementation (deprecated)

Please do not forget to add a workstep task for the form fields.

TypeWriterAnnotation

The following lines of code show you how to write the configuration. First, you have to define the task:

...

For all placeholder with the additional “*” you need either the sender information or the receiver information which are both explained in the section “sender and receiver information”.

Reading Tasks

...

With the reading task a recipient must confirm reading the document to have the evidence that he/she was reading it.
Generally there are 3 basic ways concerning the range of the reading task:

Reading task for one page
Reading task for all pages
Reading task for a section

Reading task for one page

Note: The reading task must be the first task and it must be required!)

...

As you can see, just the first page needs a reading confirmation.

Reading task for all pages

The following lines of code shows you the reading task configuration for all pages:

...

The result should look like the following screenshot:

Reading task for a section

The following lines of code shows you how to configure the reading task for a section:

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

 <envelope>
   <name>eSignAnyWhere Tutorial</name>
   <eMailSubject>Document of eSignAnyWhere Tutorial</eMailSubject>
   <eMailBody>Dear #RecipientFirstName#! Please sign this tutorial document.</eMailBody>
   <enableReminders>True</enableReminders>
   <firstReminderDayAmount>1</firstReminderDayAmount>
   <recurrentReminderDayAmount>1</recurrentReminderDayAmount>
   <beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
   <daysUntilExpire>2</daysUntilExpire>
   <!-- callback to your backend system on a completed envelope 
   <callbackUrl>http://172.16.17.78:57550/default.aspx?EnvelopeId=##EnvelopeId##&myParamForMe=1234</callbackUrl> 
   -->
   <callbackUrl />
   <steps>
      <step>
         <emailBodyExtra />
         <orderIndex>1</orderIndex>
         <recipientType>Signer</recipientType>
         <recipients>
            <recipient>
               <languageCode>en</languageCode>
               <eMail>##EMAIL##</eMail>
               <firstName>Alice</firstName>
               <lastName>Somename</lastName>
            </recipient>
         </recipients>
         <workstepConfiguration>
   <WorkstepLabel />
   <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
   <WorkstepTimeToLiveInMinutes>11520</WorkstepTimeToLiveInMinutes>
   <FinishAction />
   <signatureTemplate>
      <version>1.2.0.2</version>
      <positionUnits>PdfUnits</positionUnits>
      <positionReferenceCorner>Lower_Left</positionReferenceCorner>
      <sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
         <positionPage>1</positionPage>
         <DocRefNumber>1</DocRefNumber>
         <positionX>80.22857</positionX>
         <positionY>158.8629</positionY>
         <width>171.4286</width>
         <height>68.57143</height>
         <param name="enabled">1</param>
         <param name="completed">0</param>
         <param name="sigType">Picture</param>
         <param name="positioning">onPage</param>
         <param name="allowedCapturingMethods">Click2Sign</param>
      </sig>
   </signatureTemplate>
   <Policy version="1.1.0.0">
      <GeneralPolicies>
         <AllowSaveDocument>1</AllowSaveDocument>
         <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
      </GeneralPolicies>
      <WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">
         <Task enabled="1" completed="0" required="1" id="847a3d4a-da2c-46f4-8c8c-a9edaa06c29b" displayName="your text for this task" DocRefNumber="1" type="ConfirmReading" />
         <Task enabled="1" completed="0" required="1" id="93cce567-ae5c-4e98-ac99-9f56ac034250" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" />
      </WorkstepTasks>
   </Policy>
   <TransactionCodeConfigurations>
      <TransactionCodeConfiguration trConfId="">
         <Message>Please sign the document with the transactionId {tId} with the code: {Token}</Message>
         <hashAlgorithmIdentifier>Sha256</hashAlgorithmIdentifier>
      </TransactionCodeConfiguration>
      <TransactionCodeConfiguration trConfId="Trans1">
         <Message>Please accept the transactionId {tId} with the code: {Token}</Message>
         <hashAlgorithmIdentifier>Sha256</hashAlgorithmIdentifier>
      </TransactionCodeConfiguration>
   </TransactionCodeConfigurations>
  <ReadingTaskInfo positionUnit="PdfUnits" positionReferenceCorner="Upper_Left">
	 <ReadingTask id="847a3d4a-da2c-46f4-8c8c-a9edaa06c29b" pageNumber="1" DocRefNumber="1" AllPages="0" AllDocuments="0">
  <Position positionX="50" positionY="100" width="400" height="40" />
  </ReadingTask>
</ReadingTaskInfo>
</workstepConfiguration>
      </step>
      <step>
         <emailBodyExtra />
         <orderIndex>2</orderIndex>
         <recipientType>CC</recipientType>
         <recipients>
            <recipient>
               <languageCode>en</languageCode>
               <eMail>##EMAIL##</eMail>
               <firstName>Charly</firstName>
               <lastName>Randomname</lastName>
            </recipient>
         </recipients>
      </step>
   </steps>
</envelope>

Sending envelope

After you have added all form fields and signatures you can send the envelope to recipients. Therefore, add the file Id and the workstep configuration to the REST call basicURL/envelope/send or in SOAP to the API call SendEnvelope_v1 and send the envelope to the recipients.

Get the envelope

After sending the envelope you can call the api call (basicURL/envelope{envelopeId}) in REST and GetEnvelopeById_v1 in SOAP.

...

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

  <baseResult>ok</baseResult>
  <okInfo>
    <envelopeStatus>
      <name>eSignAnyWhere Tutorial</name>
      <eMailSubject>Document of eSignAnyWhere Tutorial</eMailSubject>
      <eMailBody>Dear #RecipientFirstName#! Please sign this tutorial document.</eMailBody>
      <enableReminders>true</enableReminders>
      <firstReminderDayAmount>1</firstReminderDayAmount>
      <recurrentReminderDayAmount>1</recurrentReminderDayAmount>
      <beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
      <id>3385b0cd-29d0-4849-b6a5-06b7c39abc1f</id>
      <bulk></bulk>
      <status>InProgress</status>
      <sendDate>2020-04-10T11:31:55.967Z</sendDate>
      <expirationDate>2020-04-12T11:31:55.967Z</expirationDate>
      <daysUntilExpire />
      <bulkRecipients>
        <bulkRecipient eMail="" id="">
          <status>InProgress</status>
          <recipients>
            <recipient>
              <id>08b584bf-2c61-44a2-90e4-b62527d7542b</id>
              <orderIndex>1</orderIndex>
              <firstName>Alice</firstName>
              <lastName>Somename</lastName>
              <eMail>##EMAIL##</eMail>
              <languageCode>en</languageCode>
              <status>NotSigned</status>
              <signedDate></signedDate>
              <openedDate></openedDate>
              <recipientType>Signer</recipientType>
              <isParallel>false</isParallel>
              <workstepRedirectionUrl>https://demo.xyzmo.com/workstepredirector/sign?identifier=##WorkstepRedirection##</workstepRedirectionUrl>
              <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
              <authentication>
                <method>Pin</method>
                <parameter>1234</parameter>
              </authentication>
              <workstepConfiguration>
                <WorkstepLabel />
                <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
                <WorkstepTimeToLiveInMinutes>11520</WorkstepTimeToLiveInMinutes>
                <FinishAction>
                  <ServerAction callSynchronous="0">https://demo.xyzmo.com/workstepredirector/setfinishaction?wid=##WorkstepId##</ServerAction>
                </FinishAction>
                <signatureTemplate>
                  <version>1.2.0.2</version>
                  <positionUnits>PdfUnits</positionUnits>
                  <positionReferenceCorner>Lower_Left</positionReferenceCorner>
                  <sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
                    <positionPage>1</positionPage>
                    <DocRefNumber>1</DocRefNumber>
                    <positionX>80.22857</positionX>
                    <positionY>158.8629</positionY>
                    <width>171.4286</width>
                    <height>68.57143</height>
                    <param name="enabled">1</param>
                    <param name="completed">0</param>
                    <param name="sigType">Picture</param>
                    <param name="positioning">onPage</param>
                    <param name="allowedCapturingMethods">Click2Sign</param>
                  </sig>
                </signatureTemplate>
                <Policy version="1.1.0.0">
                  <GeneralPolicies>
                    <AllowSaveDocument>1</AllowSaveDocument>
                    <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
                  </GeneralPolicies>
                  <WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">
                    <Task enabled="1" completed="0" required="1" id="93cce567-ae5c-4e98-ac99-9f56ac034250" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" />
                  </WorkstepTasks>
                </Policy>
                <TransactionCodeConfigurations>
                  <TransactionCodeConfiguration trConfId="">
                    
                  </TransactionCodeConfiguration>
                </TransactionCodeConfigurations>
                <receiverInformation>
                  <userInformation>
                    <firstName>Alice</firstName>
                    <lastName>Somename</lastName>
                    <eMail>##EMAIL##</eMail>
                  </userInformation>
                  <showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
                </receiverInformation>
                <senderInformation>
                  <userInformation>
                    <firstName>##NAME##</firstName>
                    <lastName>##NAME##</lastName>
                    <eMail>##EMAIL##</eMail>
                  </userInformation>
                </senderInformation>
                <signaturePluginConfiguration>
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>false</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <signaturePluginConfiguration spcId="timestampSigningId">
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>false</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
                    <SignatureTimestampData>
                      <Password>xyzmo</Password>
                      <SignatureHashAlgorithm>SHA256</SignatureHashAlgorithm>
                      <Uri>https://timestamp.test.namirialtsp.com</Uri>
                      <UserName>xyzmo</UserName>
                    </SignatureTimestampData>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <signaturePluginConfiguration spcId="padesSigningId">
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>true</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <signaturePluginConfiguration spcId="padesTimestampSigningId">
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>true</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>
                    <SignatureTimestampData>
                      <Password>xyzmo</Password>
                      <SignatureHashAlgorithm>SHA256</SignatureHashAlgorithm>
                      <Uri>https://timestamp.test.namirialtsp.com</Uri>
                      <UserName>xyzmo</UserName>
                    </SignatureTimestampData>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <signaturePluginConfiguration spcId="padesRemoteCertificateSigningId">
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>true</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <signaturePluginConfiguration spcId="padesRemoteCertificateTimestampSigningId">
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>true</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>
                    <SignatureTimestampData>
                      <Password>xyzmo</Password>
                      <SignatureHashAlgorithm>SHA256</SignatureHashAlgorithm>
                      <Uri>https://timestamp.test.namirialtsp.com</Uri>
                      <UserName>xyzmo</UserName>
                    </SignatureTimestampData>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <signaturePluginConfiguration spcId="automaticSigningId">
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>false</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <signaturePluginConfiguration spcId="automaticTimestampSigningId">
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>false</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
                    <SignatureTimestampData>
                      <Password>xyzmo</Password>
                      <SignatureHashAlgorithm>SHA256</SignatureHashAlgorithm>
                      <Uri>https://timestamp.test.namirialtsp.com</Uri>
                      <UserName>xyzmo</UserName>
                    </SignatureTimestampData>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <signaturePluginConfiguration spcId="swissComSigningId">
                  <PdfSignatureProperties_V1>
                    <PdfAConformant>false</PdfAConformant>
                    <PAdESPart4Compliant>true</PAdESPart4Compliant>
                    <IncludeSigningCertificateChain>false</IncludeSigningCertificateChain>
                    <SigningCertificateRevocationInformationIncludeMode>IncludeDss</SigningCertificateRevocationInformationIncludeMode>
                  </PdfSignatureProperties_V1>
                  <PdfSignatureCryptographicData_V1>
                    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
                    <SigningCertificateDescriptor>
                      <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
                      <Type>Sha1Thumbprint</Type>
                      <Csp>Default</Csp>
                    </SigningCertificateDescriptor>
                  </PdfSignatureCryptographicData_V1>
                </signaturePluginConfiguration>
                <resourceUris>
                  <signatureImagesUri>https://demo.xyzmo.com/Resource/SignatureImages/?link=1bc6ZS1MTOv~59DsLiDB/0fnb410yo661GUEpJ~NEDVSuJB1fjy~09vjn6TBfRpOe</signatureImagesUri>
                </resourceUris>
              </workstepConfiguration>
            </recipient>
            <recipient>
              <id>55cabc5f-8138-46f9-8b7e-3018d8838e2f</id>
              <orderIndex>2</orderIndex>
              <firstName>Charly</firstName>
              <lastName>Randomname</lastName>
              <eMail>##EMAIL##</eMail>
              <languageCode>en</languageCode>
              <status>NotSigned</status>
              <signedDate></signedDate>
              <openedDate></openedDate>
              <recipientType>Cc</recipientType>
              <isParallel>false</isParallel>
              <workstepRedirectionUrl></workstepRedirectionUrl>
              <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
              <workstepConfiguration skipThirdPartyChecks="0">
                <WorkstepLabel />
                <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
                <WorkstepTimeToLiveInMinutes>43200</WorkstepTimeToLiveInMinutes>
                <PictureAnnotationTaskInfo>
                  <MinResolution>0</MinResolution>
                  <MaxResolution>0</MaxResolution>
                  <ColorDepth>Color16M</ColorDepth>
                </PictureAnnotationTaskInfo>
                <Policy version="1.1.0.0">
                  <GeneralPolicies>
                    <AllowRotatingPages>1</AllowRotatingPages>
                    <AllowFinishWorkstep>1</AllowFinishWorkstep>
                    <AllowUndoLastAction>1</AllowUndoLastAction>
                  </GeneralPolicies>
                  <WorkstepTasks SequenceMode="NoSequenceEnforced" />
                </Policy>
                <timeCreated />
                <TransactionCodeConfigurations />
                <ViewerPreferences />
              </workstepConfiguration>
            </recipient>
          </recipients>
          <completedDocuments>
            <logDocumentId></logDocumentId>
            <logXmlDocumentId></logXmlDocumentId>
          </completedDocuments>
        </bulkRecipient>
      </bulkRecipients>
      <documents>
        <document>
          <fileName>eSignAnyWhere_Tutorial.pdf</fileName>
          <docRefNumber>1</docRefNumber>
          <fields />
          <pages>
            <page>
              <width>612</width>
              <height>792</height>
            </page>
          </pages>
        </document>
      </documents>
    </envelopeStatus>
  </okInfo>

Download the document(s)

With the following URI you can download the documents: basicURL/envelope/downloadCompletedDocument/{documentId} in REST and DownloadCompletedDocument_v1 in SOAP.

...

Page tree

Page History

Versions Compared

Old Version 10

New Version 11

Key

Upload a file

Workstep configuration

Empty workstep

Prepare envelope

AdditionalClientWorkstepInformation

Viewer preferences

Policy

Client Actions

Sender and receiver information

Sender information:

Receiver information:

Workstep task

Signatures

Click2Sign

Draw2Sign

Type2Sign

Biometric

Disposable certificate

P7M Signers

Automatic Remote Signature Recipient via API

A-Trust

BankID

Generic Signing Plugin

Generic Signing Plugin (automatic)

Generic Signing Plugin (Batch-Signature)

Authentication

Pin-authentication

SMS-authentication

PdfForms

Textfield

Radiobutton

Checkbox

Listbox

Listbox (Multiselect)

Combobox

AddFormFields

TypeWriterAnnotation

Reading Tasks

Reading task for one page

Reading task for all pages

Reading task for a section

Sending envelope

Get the envelope

Download the document(s)