Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel45
stylecircle

Upload a file

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

...

For this call you need an authentication. For authentication, you’ll need an api token. You can find this information in Settings / Api Tokens and Apps. Note that all API methods require authentication. For more information about the authorization please have a look the  API Reference Guide for SOAP or the Postman Guide for REST

Expand
titleAlternative: 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
titleAlternative: SOAP implementation (deprecated)

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

Code Block
languagexml
themeEclipse
 <prepareSendEnvelopeStepsDescriptor>
  <clearFieldMarkupString>1</clearFieldMarkupString>
</prepareSendEnvelopeStepsDescriptor>

In REST you already have this configuration:

Code Block
languagejava
themeEclipse
 "PrepareSendEnvelopeStepsDescriptor": {
    "ClearFieldMarkupString": true
  }


AdditionalClientWorkstepInformation

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

Alternative: SOAP implementation (deprecated)
Info
title

Defining a MetaDataXML sets the value only if AdditionalClientWorkstepInformation is not already set via api. For example:

  1. Setting AdditionalClientWorkstepInformation AND MetaDataXml


    Code Block
    languagejava
    themeEclipse
    "SendEnvelopeDescription": {
        "MetaDataXml": "<Tagging doctype=\"INVOICE\"><InvoiceNr>123456</InvoiceNr></Tagging>",
    ...
    "Recipients": [
        {
            "Email": "##email##",
            ...
        }
    ],
    "RecipientType": "Signer",
    "WorkstepConfiguration": {
        "AdditionalClientWorkstepInformation": "<test id='test'
>Information<
  1. >Some Information</test>",
      
Expand
  1.   ...
    
    


    1. results in 

      Code Block
      languagexml
      themeEclipse
<AdditionalClientWorkstepInformation><test
    1. <AdditionalClientWorkstepInformation>
          <test id=
"test">Information<test></AdditionalClientWorkstepInformation>

Viewer preferences

...

Alternative: SOAP implementation (deprecated)
title
    1. 'test'>Some Information</test>
      </AdditionalClientWorkstepInformation>

  1. Setting AdditionalClientWorkstepInformation only

    Code Block
    languagejava
    themeEclipse
    "
ViewerPreferences
  1. SendEnvelopeDescription": {
"ShowPageNavigationButtons
  1. 
    ...
    "Recipients": 
true,
  1. [
       
"ShowThumbnails": true,
  1.  {
        
"SkipFinishConfirmDialog":
  1.  
true,
  1.    "
SkipDocumentDialog
  1. Email": 
true, "ShowImagesInFullWidth": true
  1. "##email##",
       
"DisableGeolocation":
  1.  
true,
  1.    
"ShowDocumentDownloadDialogAfterAutomaticFinish": true,
  1.  ...
       
"SkipPreviewImageOnDisposableCertificate": true
  1.  }
    ],
    
  1. "
LoadCustomJs
  1. RecipientType": 
true, "AllowCustomButtons": true, "ShowVersionNumber
  1. "Signer",
    "WorkstepConfiguration": 
true,
  1. {
        "
EnableWarningPopupOnLeave
  1. AdditionalClientWorkstepInformation": 
true, "FinishWorkstepOnOpen": true, "AutoFinishAfterRequiredTasksDone": true, "SkipThankYouDialog": true, "ShowTopBar": true, "DisplayRejectButtonInTopBar": true, "ShowStartGuidingHint": true, "ShowStatusBar": true, "ShowZoomButtons": true, "ShowNoGeolocationWarning": true, "AutoStartGuiding": true, "ShowPageGap": true, "ShowPageNavigationButtons": true, "ShowFinishPossibleHint": true, "SkipRejectConfirmDialog": true, "BatchSigningDisableNextButtonUntilDialogScrolledToBottom": true }
Expand
  1. "<test id='test'>Some Information</test>",
        ...
    
    

    1. results in


      Code Block
      languagexml
      themeEclipse
      <AdditionalClientWorkstepInformation>
          <test id='test'>Some Information</test>
      </AdditionalClientWorkstepInformation>


  2. Setting MetaDataXml only


    Code Block
    languagejava
    themeEclipse
    "SendEnvelopeDescription": {
        "MetaDataXml": "<Tagging doctype=\"INVOICE\"><InvoiceNr>123456</InvoiceNr></Tagging>",
    ...
    "Recipients": [
        {
            "Email": "##email##",
            ...
        }
    ],
    "RecipientType": "Signer",
    "WorkstepConfiguration": {
        ...
    
    


    1. results in

      Code Block
      languagexml
      themeEclipse
<ViewerPreferences>
    1. <AdditionalClientWorkstepInformation>
      
    1.  
<ShowThumbnails>1</ShowThumbnails>
    1.    
<ShowStatusBar>1</ShowStatusBar>
    1. <signature>
         
<ShowTopBar>1</ShowTopBar>
    1.    
<FinishWorkstepOnOpen>1</FinishWorkstepOnOpen>
    1.   
<BatchSigningDisableNextButtonUntilDialogScrolledToBottom>1</BatchSigningDisableNextButtonUntilDialogScrolledToBottom>
    1. <Tagging doctype="INVOICE">
         
<GuidingBehavior>GuideRequiredAndOptionalTasks</GuidingBehavior>
    1.    
<BatchSigningType>Basic</BatchSigningType>
    1.    
<FormFieldsGuidingBehavior>AllowSubmitAlways</FormFieldsGuidingBehavior>
    1.    
<GuidingBehaviorOnFinishedTask>MoveToNext<
    1. <InvoiceNr>123456</
GuidingBehaviorOnFinishedTask>
    1. InvoiceNr>
         
<SkipPreviewImageOnDisposableCertificate>1</SkipPreviewImageOnDisposableCertificate>
    1.    
<ShowPageNavigationButtons>1</ShowPageNavigationButtons>
    1.   
<ShowZoomButtons>1<
    1. </
ShowZoomButtons>
    1. Tagging>
         
<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:

...

    1.  </signature>
      </AdditionalClientWorkstepInformation>


Expiration date Image Added

Note: The following information is valid for envelopes as well as for drafts: Settings for the relative time:

  • Envelope expiry as relative time, provided in seconds (or milliseconds) after sending the envelope
  • Envelope expiry as relative time, in days after sending the envelope

Settings for the absolute time:

  • Envelope expiry as absolute time, as timestamp in GMT (with Z in the timestamp text) or optional with defined timezone

Please note the following: Defining no option will lead to usage of the default value of 28 days. Moreover, if you configure an absolute expiry time which is already in the past at time of sending the envelope, an error message will be returned. For the draft, it is required to have both options - store absolute or relative time. For the envelopes, only an absolute timestamp is required to be set and considered while being in progress. Please also see the next REST API configuration.

Absolute expiration date:

...

Image Removed

...

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

...

Code Block
languagejava
themeEclipse
"Policy": {
    "GeneralPolicies// works with envelope/send
// works with draft/create
"SendEnvelopeDescription": {
	...
	"AllowSaveDocumentExpirationDate": true,
		"AllowSaveAuditTrail": true,
		"AllowRotatingPages": true,
		"AllowAppendFileToWorkstep": true,
		"AllowAppendTaskToWorkstep": true,
		"AllowEmailDocument": true,
		"AllowPrintDocument": true,
		"AllowFinishWorkstep": true,
		"AllowRejectWorkstep": true,
		"AllowRejectWorkstepDelegation": true,
		"AllowUndoLastAction": true,
		"AllowColorizePdfForms": true,
		"AllowAdhocPdfAttachments": true,
		"AllowAdhocSignatures": true,
		"AllowAdhocStampings": true,
		"AllowAdhocFreeHandAnnotations": true,
		"AllowAdhocTypewriterAnnotations": true,
		"AllowAdhocPictureAnnotations": true,
		"AllowAdhocPdfPageAppending": true,
		"AllowReloadOfFinishedWorkstep": true,
	 }
 },
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagexml
themeEclipse
<GeneralPolicies>
	<AllowSaveDocument>1</AllowSaveDocument>
	<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
	<AllowRotatingPages>1</AllowRotatingPages>
	<AllowAppendFileToWorkstep>1</AllowAppendFileToWorkstep>
	<AllowAppendTasksToWorkstep>1</AllowAppendTasksToWorkstep>
	<AllowEmailDocument>1</AllowEmailDocument>
	<AllowPrintDocument>1</AllowPrintDocument>
	<AllowFinishWorkstep>1</AllowFinishWorkstep>
	<AllowRejectWorkstep>1</AllowRejectWorkstep>
	<AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
	<AllowUndoLastAction>1</AllowUndoLastAction>
	<AllowColorizePdfForms>1</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>

...

"2021-03-22T08:34:50.775Z",
	...
}
// works with draft/createFromTemplate
// works with envelope/sendFromTemplate
"EnvelopeOverrideOptions": {
	...
	"ExpirationDate": "2021-03-22T08:34:50.775Z",
	...
}
// works with draft/update
{
"ExpirationDate": "2021-03-22T08:34:50.775Z"
}

Relative expiration date:

Code Block
languagejava
themeEclipse
// works with envelope/send
// works with draft/create
"SendEnvelopeDescription": {
  ...
  "DaysUntilExpire": 1,
  // EXCLUSIVE OR!! (Only one is allowed - otherwise error)
  "ExpirationInSecondsAfterSending": 86400,
  ...
}
// works with draft/createFromTemplate
// works with envelope/sendFromTemplate
"EnvelopeOverrideOptions": {
  ...
  "DaysUntilExpire": 1,
  // EXCLUSIVE OR!! (Only one is allowed - otherwise error)
  "ExpirationInSecondsAfterSending": 86400,
...
}
// works with draft/update
{
"ExpirationInSecondsAfterSending": }


Info

Please note the following: An absolute expiration date is used in this example. Please

also note the date format (YYYY-MM-DD[T]HH:mm:ssZ).

For example:

  • 2022-12-24T18:21Z
  • 2022-01-01T12:00:00+01:00

Viewer preferences

Following lines of code show some viewer preferences configurations:

Code Block
languagejava
themeEclipse
"ClientActionsViewerPreferences": [{
   "ShowPageNavigationButtons": true,
   "ShowThumbnails": true,
    {"SkipFinishConfirmDialog": true,
   "SkipDocumentDialog": true,
   "ShowImagesInFullWidth": true,
      "RemoveDocumentFromRecentDocumentListDisableGeolocation": falsetrue,
   "ShowDocumentDownloadDialogAfterAutomaticFinish": true,
   "SkipPreviewImageOnDisposableCertificate": true,
   "LoadCustomJs": true,
   "CallClientActionOnlyAfterSuccessfulSyncAllowCustomButtons": true,
   "ShowVersionNumber": true,
   "EnableWarningPopupOnLeave": true,
   "FinishWorkstepOnOpen": true,
   "ClientNameAutoFinishAfterRequiredTasksDone": "SIGNificant SignAnywhere"true,
   "SkipThankYouDialog": true,
   "ShowTopBar": true,
   "DisplayRejectButtonInTopBar": true,
   "CloseAppShowStartGuidingHint": falsetrue,
   "ShowStatusBar": true,
   "ShowZoomButtons": true,
   "ShowNoGeolocationWarning": true,
   "ActionAutoStartGuiding": "https://www.esignanywhere.net/"true,
   "ShowPageGap": true,
   "ShowPageNavigationButtons": true,
    }"ShowFinishPossibleHint": true,
   "SkipRejectConfirmDialog": true,
      ]


 },"BatchSigningDisableNextButtonUntilDialogScrolledToBottom": true
}


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<FinishAction><ViewerPreferences>
   <ShowThumbnails>1</ShowThumbnails>
   <ShowStatusBar>1</ShowStatusBar>
   <ShowTopBar>1</ShowTopBar>
 <ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
</FinishAction>

Sender and receiver information

Sender information:

Code Block
languagejava
themeEclipse
"SenderInformation": {
       "UserInformation": {
       "FirstName": "##NAME##",
       "LastName": "##NAME##",
       "EMail": "##EMAIL##"
       }
},

 },

...

titleAlternative: SOAP implementation (deprecated)
Code Block
languagexml
themeEclipse
  <senderInformation>
          <userInformation>
            <firstName>FIRSTNAME</firstName>
            <lastName>LASTNAME</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
        </senderInformation>

...

 <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:

Note: With the value “1” you enable the policy and with the value “0” you disable the policy. In the following list all policies are enabled.

Code Block
languagejava
themeEclipse
"ReceiverInformationPolicy": {
          "UserInformationGeneralPolicies": {
		"AllowSaveDocument": true,
		"AllowSaveAuditTrail": true,
		"AllowRotatingPages": true,
		"AllowAppendFileToWorkstep": true,
		"AllowAppendTaskToWorkstep": true,
		"AllowEmailDocument":       "FirstNametrue,
		"AllowPrintDocument": true,
		"AllowFinishWorkstep": true,
		"##NAME##AllowRejectWorkstep": true,
            "LastName		"AllowRejectWorkstepDelegation": true,
		"##NAME##AllowUndoLastAction": true,
            "EMail		"AllowColorizePdfForms": true,
		"##EMAIL##AllowAdhocPdfAttachments": true,
	    }
}	"AllowAdhocSignatures": true,
		"AllowAdhocStampings": true,
		"AllowAdhocFreeHandAnnotations": true,
		"AllowAdhocTypewriterAnnotations": true,
		"AllowAdhocPictureAnnotations": true,
		"AllowAdhocPdfPageAppending": true,
		"AllowReloadOfFinishedWorkstep": true,
	 }
 },


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<GeneralPolicies>
	<AllowSaveDocument>1</AllowSaveDocument>
	<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
	<AllowRotatingPages>1</AllowRotatingPages>
	<AllowAppendFileToWorkstep>1</AllowAppendFileToWorkstep>
	<AllowAppendTasksToWorkstep>1</AllowAppendTasksToWorkstep>
	<AllowEmailDocument>1</AllowEmailDocument>
	<AllowPrintDocument>1</AllowPrintDocument>
	<AllowFinishWorkstep>1</AllowFinishWorkstep>
	<AllowRejectWorkstep>1</AllowRejectWorkstep>
	<AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
	<AllowUndoLastAction>1</AllowUndoLastAction>
	<AllowColorizePdfForms>1</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>



All policies disabledAll policies enabled

Image Added

Image Added



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.

Code Block
languagejava
themeEclipse
Code Block
languagejava
themeEclipse
"ClientActions": [
  
<receiverInformation>
          
<userInformation>
{
             
<firstName>FIRSTNAME</firstName>
 "RemoveDocumentFromRecentDocumentList": false,
           
<lastName>LASTNAME</lastName>
   "CallClientActionOnlyAfterSuccessfulSync": true,
            
<eMail>##EMAIL##</eMail>
  "ClientName": "SIGNificant SignAnywhere",
          
</userInformation>
    "CloseApp": false,
      
<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.

Info

This sample was carried out with an SMS-OTP signature. With such a signature type, in addition to the name, IP address etc., the transaction token and telephone number can be displayed or hidden too.

Note: If you want to hide all data just set the following variable false:
"DisplayExtraInformation”: false,

 "AllowedSignatureTypes": [
                  {
                    "TrModType": "TransactionCodeSenderPlugin",
        "Action": "https://www.esignanywhere.net/"
            }
          ]


 },


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<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
languagejava
themeEclipse
"SenderInformation": {
       "UserInformation": {
       "FirstName": "##NAME##",
       "LastName": "##NAME##",
       "EMail": "##EMAIL##"
       }
},

 },


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
  <senderInformation>
          <userInformation>
            <firstName>FIRSTNAME</firstName>
            <lastName>LASTNAME</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
        </senderInformation>


Receiver information:

Code Block
languagejava
themeEclipse
"ReceiverInformation": {
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",
            "EMail": "##EMAIL##"
	    }
},


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
   <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.

Info

This sample was carried out with an SMS-OTP signature. With such a signature type, in addition to the name, IP address etc., the transaction token and telephone number can be displayed or hidden too.

Note: If you want to hide all data just set the following variable false:
"DisplayExtraInformation”: false,


Code Block
languagejava
themeEclipse
 "AllowedSignatureTypes": [
                  {
                    "TrModType": "TransactionCodeSenderPlugin",
                    "TrValidityInSeconds": 300,
                    "Ly": "simpleTransactionCodeSms",
                    "TrConfId": "otpSignatureSmsText",
                    "IsPhoneNumberRequired": false,
                    "Id": "cee105ae-f407-42f9-993c-6b664055f5fb",
                    "DiscriminatorType": "SigTypeTransactionCode",
                    "Preferred": false,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "OverrideLegacyStampImprint": true,
                      "DisplayTransactionId":true,
                      "DisplayTransaktionToken":true,
                      "DisplayPhoneNumber":true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0
                    }
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_0d123383-e054-81ec-0b17-96c4e7b955b3",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        },


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
  <AllowedSignatureTypes>
              <sigType id="3dd00265-9101-4b90-b2ac-330fa8f2180a" type="TransactionCode">
                <trModType>TransactionCodeSenderPlugin</trModType>
                <trConfId>otpSignatureSmsText</trConfId>
                <trValidityInSeconds>300</trValidityInSeconds>
                <ly>simpleTransactionCodeSms</ly>
                <phonenumber>##phonenumber##</phonenumber>
                <StampImprintConfiguration>
                  	<DisplayExtraInformation>1</DisplayExtraInformation>
<OverrideLegacyStampImprint>1</OverrideLegacyStampImprint>				<DisplayTransactionId>1</DisplayTransactionId>
		<DisplayTransaktionToken>1</DisplayTransaktionToken>
		<DisplayPhoneNumber>1</DisplayPhoneNumber>
                  	<DisplayEmail>1</DisplayEmail>
                  	<DisplayIp>1</DisplayIp>
                  	<DisplayName>1</DisplayName>
                  	<DisplaySignatureDate>1</DisplaySignatureDate>
                  	<FontFamily>Times New Roman</FontFamily>
                  	<FontSize>11</FontSize>
                </StampImprintConfiguration>
              </sigType>
            </AllowedSignatureTypes>  


Result (All data shown):

Image Added

Code Block
languagejava
themeEclipse
  "AllowedSignatureTypes": [
                  {
                    "TrModType": "TransactionCodeSenderPlugin",
                    "TrValidityInSeconds": 300,
                    "Ly": "simpleTransactionCodeSms",
                    "TrConfId": "otpSignatureSmsText",
                    "IsPhoneNumberRequired": false,
                    "Id": "cee105ae-f407-42f9-993c-6b664055f5fb",
                    "DiscriminatorType": "SigTypeTransactionCode",
                    "Preferred": false,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": false,
                      "OverrideLegacyStampImprint": false,
                      "DisplayTransactionId":true,
                      "DisplayTransaktionToken":true,
                      "DisplayPhoneNumber":false,
                      "DisplayIp": false,
                      "DisplayName": false,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0
                    }
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_0d123383-e054-81ec-0b17-96c4e7b955b3",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        },


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
  <AllowedSignatureTypes>
              <sigType id="3dd00265-9101-4b90-b2ac-330fa8f2180a" type="TransactionCode">
                <trModType>TransactionCodeSenderPlugin</trModType>
                <trConfId>otpSignatureSmsText</trConfId>
                <trValidityInSeconds>300</trValidityInSeconds>
                <ly>simpleTransactionCodeSms</ly>
                <phonenumber>##phonenumber##</phonenumber>
                <StampImprintConfiguration>
                  	<DisplayExtraInformation>1</DisplayExtraInformation>
				<OverrideLegacyStampImprint>0</OverrideLegacyStampImprint>
				<DisplayTransactionId>1</DisplayTransactionId>
				<DisplayTransaktionToken>1</DisplayTransaktionToken>
				<DisplayPhoneNumber>0</DisplayPhoneNumber>
                  	<DisplayEmail>0</DisplayEmail>
                  	<DisplayIp>0</DisplayIp>
                  	<DisplayName>0</DisplayName>
                  	<DisplaySignatureDate>1</DisplaySignatureDate>
                  	<FontFamily>Times New Roman</FontFamily>
                  	<FontSize>11</FontSize>
                </StampImprintConfiguration>
              </sigType>
            </AllowedSignatureTypes>


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

Image Added

Click2Sign

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

Code Block
languagejava
themeEclipse
 "WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 69.0,
                  "PositionY": 529.92
                },
                "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"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "AllowedCapturingMethod": "Click2Sign",
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0
                    },
                    "Id": "d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4ea",
                    "DiscriminatorType": "SigTypeClick2Sign",
                    "Preferred": true
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aef",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        }
      },


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
 <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.

Code Block
languagejava
themeEclipse
"WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 69.0,
                  "PositionY": 529.92
                },
                "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"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "AllowedCapturingMethod": "Draw2Sign",
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0
                    },
                    "Id": "d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4ea",
                    "DiscriminatorType": "SigTypeDraw2Sign",
                    "Preferred": true
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aef",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        }
      },


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<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.

Code Block
languagejava
themeEclipse
"WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 69.0,
                  "PositionY": 529.92
                },
                "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"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "AllowedCapturingMethod": "Type2Sign",
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0
                    },
                    "Id": "d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4ea",
                    "DiscriminatorType": "SigTypeType2Sign",
                    "Preferred": true
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aef",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        }
      },
      },


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<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
languagejava
themeEclipse
"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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
 <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="positioning">onPage</param>
        <AllowedSignatureTypes>
              <sigType id="672d210e-9aa1-41b5-bb24-2e1b4b079f61" type="BiometricSignature">
                <bio>0</bio>
              </sigType>
        </AllowedSignatureTypes>
  </sig>



Expand
titleAlternative: 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
languagexml
themeEclipse
<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

SMS-OTP

Code Block
languagejava
themeEclipse
  "WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "Texts": [
                  {
                    "Language": "en",
                    "Value": "Signature Disclosure Text"
                  },
                  {
                    "Language": "*",
                    "Value": "Signature Disclosure Text"
                  }
                ],
                "Headings": [
                  {
                    "Language": "en",
                    "Value": "Signature Disclosure Subject"
                  },
                  {
                    "Language": "*",
                    "Value": "Signature Disclosure Subject"
                  }
                ],
                "IsRequired": false,
                "Id": "ra",
                "DisplayName": "ra",
                "DocRefNumber": 1,
                "DiscriminatorType": "Agreements"
              },
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 52.0,
                  "PositionY": 586.0
                },
                "Size": {
                  "Height": 80.0,
                  "Width": 190.0
                },
                "AdditionalParameters": [
                  {
                    "Key": "enabled",
                    "Value": "1"
                  },
                  {
                    "Key": "completed",
                    "Value": "0"
                  },
                  {
                    "Key": "req",
                    "Value": "1"
                  },
                  {
                    "Key": "isPhoneNumberRequired",
                    "Value": "0"
                  },
                  {
                    "Key": "trValidityInSeconds",
                    "Value": "60"
                  },
                  {
                    "Key": "fd",
                    "Value": ""
                  },
                  {
                    "Key": "fd_dateformat",
                    "Value": "dd-MM-yyyy HH:mm:ss"
                  },
                  {
                    "Key": "fd_timezone",
                    "Value": "datetimeutc"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "TrModType": "TransactionCodeSenderPlugin",
                    "TrValidityInSeconds": 300,
                    "TrConfId": "otpSignatureSmsText",
                    "IsPhoneNumberRequired": false,
                    "Ly": "simpleTransactionCodeSms",
                    "Id": "c787919a-b2fd-4849-8f97-98dee281da30",
                    "DiscriminatorType": "SigTypeTransactionCode",
                    "Preferred": false,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0,
                      "OverrideLegacyStampImprint": false,
                      "DisplayTransactionId": true,
                      "DisplayTransaktionToken": true,
                      "DisplayPhoneNumber": true
                    },
                    "SignaturePluginConfigurationId": "ltaLevelId"
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_e7ca3f6a-33fa-cdba-d696-1377fcad51c9",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          },

Please also see a complete configuration below. Note that the phone number for the otp is in the recipient section!

Code Block
languagejava
themeEclipse
{
  "Name": "Test.pdf",
  "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,
  "ExpirationInSecondsAfterSending": 2419200,
  "CallbackUrl": "",
  "StatusUpdateCallbackUrl": "",
  "LockFormFieldsAtEnvelopeFinish": false,
  "Steps": [
    {
      "OrderIndex": 1,
      "Recipients": [
        {
          "Email": "##email##",
          "FirstName": "##name##",
          "LastName": "##name##",
          "LanguageCode": "en",
          "EmailBodyExtra": "",
          "DisableEmail": false,
          "AddAndroidAppLink": false,
          "AddIosAppLink": false,
          "AddWindowsAppLink": false,
          "AllowDelegation": true,
          "AllowAccessFinishedWorkstep": false,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": [],
          "IdentificationMethods": [],
          "OtpData": {
            "PhoneMobile": "##phonenumber##"
          }
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Signer",
      "WorkstepConfiguration": {
        "WorkstepLabel": "Test.pdf",
        "SmallTextZoomFactorPercent": 100,
        "FinishAction": {
          "ServerActions": [],
          "ClientActions": []
        },
        "ReceiverInformation": {
          "UserInformation": {
            "FirstName": "##name##",
            "LastName": "##name##",
            "EMail": "##email##"
          },
          "TransactionCodePushPluginData": []
        },
        "SenderInformation": {
          "UserInformation": {
            "FirstName": "##name##",
            "LastName": "##name##",
            "EMail": "##email##"
          }
        },
        "TransactionCodeConfigurations": [],
        "SignatureConfigurations": [],
        "ViewerPreferences": {
          "FinishWorkstepOnOpen": false,
          "VisibleAreaOptions": {
            "AllowedDomain": "",
            "Enabled": false
          }
        },
        "ResourceUris": {
          "DelegationUri": ""
        },
        "AuditingToolsConfiguration": {
          "WriteAuditTrail": true
        },
        "Policy": {
          "GeneralPolicies": {
            "AllowSaveDocument": true,
            "AllowSaveAuditTrail": true,
            "AllowRotatingPages": false,
            "AllowAppendFileToWorkstep": false,
            "AllowAppendTaskToWorkstep": false,
            "AllowEmailDocument": true,
            "AllowPrintDocument": true,
            "AllowFinishWorkstep": true,
            "AllowRejectWorkstep": true,
            "AllowRejectWorkstepDelegation": true,
            "AllowUndoLastAction": true,
            "AllowColorizePdfForms": false,
            "AllowAdhocPdfAttachments": false,
            "AllowAdhocSignatures": false,
            "AllowAdhocStampings": false,
            "AllowAdhocFreeHandAnnotations": false,
            "AllowAdhocTypewriterAnnotations": false,
            "AllowAdhocPictureAnnotations": false,
            "AllowAdhocPdfPageAppending": false,
            "AllowReloadOfFinishedWorkstep": true
          },
          "WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "Texts": [
                  {
                    "Language": "en",
                    "Value": "Signature Disclosure Text"
                  },
                  {
                    "Language": "*",
                    "Value": "Signature Disclosure Text"
                  }
                ],
                "Headings": [
                  {
                    "Language": "en",
                    "Value": "Signature Disclosure Subject"
                  },
                  {
                    "Language": "*",
                    "Value": "Signature Disclosure Subject"
                  }
                ],
                "IsRequired": false,
                "Id": "ra",
                "DisplayName": "ra",
                "DocRefNumber": 1,
                "DiscriminatorType": "Agreements"
              },
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 52.0,
                  "PositionY": 586.0
                },
                "Size": {
                  "Height": 80.0,
                  "Width": 190.0
                },
                "AdditionalParameters": [
                  {
                    "Key": "enabled",
                    "Value": "1"
                  },
                  {
                    "Key": "completed",
                    "Value": "0"
                  },
                  {
                    "Key": "req",
                    "Value": "1"
                  },
                  {
                    "Key": "isPhoneNumberRequired",
                    "Value": "0"
                  },
                  {
                    "Key": "trValidityInSeconds",
                    "Value": "60"
                  },
                  {
                    "Key": "fd",
                    "Value": ""
                  },
                  {
                    "Key": "fd_dateformat",
                    "Value": "dd-MM-yyyy HH:mm:ss"
                  },
                  {
                    "Key": "fd_timezone",
                    "Value": "datetimeutc"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "TrModType": "TransactionCodeSenderPlugin",
                    "TrValidityInSeconds": 300,
                    "TrConfId": "otpSignatureSmsText",
                    "IsPhoneNumberRequired": false,
                    "Ly": "simpleTransactionCodeSms",
                    "Id": "c787919a-b2fd-4849-8f97-98dee281da30",
                    "DiscriminatorType": "SigTypeTransactionCode",
                    "Preferred": false,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0,
                      "OverrideLegacyStampImprint": false,
                      "DisplayTransactionId": true,
                      "DisplayTransaktionToken": true,
                      "DisplayPhoneNumber": true
                    },
                    "SignaturePluginConfigurationId": "ltaLevelId"
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_e7ca3f6a-33fa-cdba-d696-1377fcad51c9",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          },
          "FinalizeActions": {
            "FinalizeActionList": [
              {
                "DocRefNumbers": "*",
                "SpcId": "ltaLevelId",
                "DiscriminatorType": "Timestamp"
              }
            ]
          }
        },
        "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": [],
          "IdentificationMethods": []
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Cc",
      "DocumentOptions": [],
      "UseDefaultAgreements": false
    }
  ],
  "AddFormFields": {
    "Forms": {}
  },
  "OverrideFormFieldValues": {
    "Forms": {}
  },
  "AttachSignedDocumentsToEnvelopeLog": false
}


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<envelope>
  <name>Test.pdf</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></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.pdf</WorkstepLabel>
        <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
        <AbsoluteExpiryDate>2022-02-24T11:42:06.9452877Z</AbsoluteExpiryDate>
        <WorkstepTimeToLiveInMinutes>43210</WorkstepTimeToLiveInMinutes>
        <FinishAction />
        <signatureTemplate>
          <version>1.2.0.2</version>
          <positionUnits>PdfUnits</positionUnits>
          <positionReferenceCorner>Lower_Left</positionReferenceCorner>
          <sig useTimestamp="false" id="1#XyzmoDuplicateIdSeperator#Signature_e7ca3f6a-33fa-cdba-d696-1377fcad51c9">
            <positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>
            <positionX>52</positionX>
            <positionY>586</positionY>
            <width>190</width>
            <height>80</height>
            <param name="enabled">1</param>
            <param name="completed">0</param>
            <param name="req">1</param>
            <param name="isPhoneNumberRequired">0</param>
            <param name="trValidityInSeconds">60</param>
            <param name="fd" />
            <param name="fd_dateformat">dd-MM-yyyy HH:mm:ss</param>
            <param name="fd_timezone">datetimeutc</param>
            <AllowedSignatureTypes>
              <sigType id="00ea98dd-5bc3-4ab6-93f7-f87f5277f7d2" type="TransactionCode" preferred="false">
                <spcId>ltaLevelId</spcId>
                <trModType>TransactionCodeSenderPlugin</trModType>
                <trValidityInSeconds>300</trValidityInSeconds>
                <trConfId>otpSignatureSmsText</trConfId>
                <phonenumber>##phonenumber##</phonenumber>
                <ly>simpleTransactionCodeSms</ly>
                <isPhoneNumberRequired>0</isPhoneNumberRequired>
                <StampImprintConfiguration>
                  <DisplayExtraInformation>1</DisplayExtraInformation>
                  <OverrideLegacyStampImprint>0</OverrideLegacyStampImprint>
                  <DisplayTransactionId>1</DisplayTransactionId>
                  <DisplayTransactionToken>1</DisplayTransactionToken>
                  <DisplayPhoneNumber>1</DisplayPhoneNumber>
                  <DisplayEmail>1</DisplayEmail>
                  <DisplayIp>1</DisplayIp>
                  <DisplayName>1</DisplayName>
                  <DisplaySignatureDate>1</DisplaySignatureDate>
                  <FontFamily>Times New Roman</FontFamily>
                  <FontSize>11</FontSize>
                </StampImprintConfiguration>
              </sigType>
            </AllowedSignatureTypes>
          </sig>
        </signatureTemplate>
        <senderInformation>
          <userInformation>
            <firstName>##NAME##</firstName>
            <lastName>##NAME##</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
        </senderInformation>
        <receiverInformation>
          <userInformation>
            <firstName>##NAME##</firstName>
            <lastName>##NAME##</lastName>
            <eMail>##EMAIL##</eMail>
          </userInformation>
          <showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
        </receiverInformation>
        <Agreements>
          <text language="en">Signature Disclosure Text</text>
          <text language="*">Signature Disclosure Text</text>
          <heading language="en">Signature Disclosure Subject</heading>
          <heading language="*">Signature Disclosure Subject</heading>
        </Agreements>
        <pdfForms isEditingAllowed="1" />
        <attachmentFields />
        <TypewriterAnnotationTaskInfo />
        <ViewerPreferences>
          <FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
          <SendVisibleArea allowedDomain="">0</SendVisibleArea>
        </ViewerPreferences>
        <Policy version="1.2.0.0">
          <GeneralPolicies>
            <AllowSaveDocument>1</AllowSaveDocument>
            <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
            <AllowDownloadOfSignedP7MFiles>0</AllowDownloadOfSignedP7MFiles>
            <AllowRotatingPages>0</AllowRotatingPages>
            <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep>
            <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep>
            <AllowEmailDocument>1</AllowEmailDocument>
            <AllowPrintDocument>1</AllowPrintDocument>
            <AllowFinishWorkstep>1</AllowFinishWorkstep>
            <AllowRejectWorkstep>1</AllowRejectWorkstep>
            <AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
            <AllowUndoLastAction>1</AllowUndoLastAction>
            <AllowColorizePdfForms>0</AllowColorizePdfForms>
            <AllowReloadOfFinishedWorkstep>1</AllowReloadOfFinishedWorkstep>
            <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="1" completed="0" required="0" id="ra" displayName="ra" DocRefNumber="1" type="ReadAgreement" finishPercentage="0" />
            <Task enabled="1" completed="0" required="1" id="1#XyzmoDuplicateIdSeperator#Signature_e7ca3f6a-33fa-cdba-d696-1377fcad51c9" displayName="" DocRefNumber="1" type="SignField" finishPercentage="0" />
          </WorkstepTasks>
          <AdhocPolicies>
            <AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
          </AdhocPolicies>
          <FinalizeActions>
            <Timestamp DocRefNumbers="*" spcId="ltaLevelId" />
          </FinalizeActions>
          <completedActions />
          <TaskTransactionIds />
          <FeaturePolicies>
            <UseCustomStampImprintConfiguration>1</UseCustomStampImprintConfiguration>
          </FeaturePolicies>
        </Policy>
        <resourceUris>
          <delegationUri></delegationUri>
        </resourceUris>
        <LoggingMetaInformation>
          <envelopeId>##envelopeId##</envelopeId>
          <envelopeRecipientId>##recipientId##</envelopeRecipientId>
        </LoggingMetaInformation>
        <Navigation />
        <timeCreated>2022-02-24T11:32:06.9572846Z</timeCreated>
        <AuditingToolsConfiguration WriteAuditTrail="1" />
      </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 />
          <identifications />
          <smsOtpAdditionalInformation>
            <phoneMobile>##phonenumber##</phoneMobile>
          </smsOtpAdditionalInformation>
        </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 />
          <identifications />
        </recipient>
      </recipients>
    </step>
  </steps>
  <attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope>


Disposable certificate

The disposable certificate signature is a signature variant using the Namirial Trust Service Provider services to issue a (typically qualified) electronic signing certificate on the fly during signing, on explicit request of the signer.
The implementation distinguishes between "traditional" (depracated) and "lean" (recommended) disposable certificate procedure based on the configuration in Settings - Organization.

Registration as Local Registration Authority (LRA) at Namirial is mandatory to perform the necessary identification steps in order to issue disposable certificates. The LRA ID, service password and service username need to be configured in Settings - Organization.
To issue a disposable certificate, the (future) certificate holder must be identified according to the regulations of the LRA contract upfront. The LRA Contract may contain clauses about how consent for issuing a certificate has to be requested, or delivered to the signer.

Please see the following sample configuration for a disposable certificate signature:

Code Block
languagejava
themeEclipse
{
  "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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<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> 


Disposable certitifacate (Long-lived)
Info
titleAdditional Scenario

Beside the disposable certificate, the solution can use a specific procedure called "Long-Lived Disposable" for scenarios where the signature becomes a valid qualified signature after signing. This can be useful where the identification is confirmed/approved after signing of the document. When using this special type of Disposable Certificates, the procedure of the Opative Manual has to be followed; which is different for the case of Long-Lived Disposable. See Long-Lived Disposable in SSP documentation for more information.

General description

The Long-Lived Disposable Certificate (LLD) is a special variant of a Disposable certificate.

The main difference to the disposable certificate is, that it is not being activated immediately, but after the signatures have been applied. LLD are always active, no need to activate them.

Please see the following sample configuration for LLD:

Code Block
languagejava
themeEclipse
{
  
  "SspFileIds": [
    "b4d753d1-1234-1234-ada4-b7a7975324c3"
  ],
   "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,
  "ExpirationInSecondsAfterSending": 2419200,
  "CallbackUrl": "",
  "StatusUpdateCallbackUrl": "",
  "LockFormFieldsAtEnvelopeFinish": false,
  "Steps": [
    {
      "OrderIndex": 1,
      "Recipients": [
        {
          "Email": "johndoe@sample.com",
          "FirstName": "John",
          "LastName": "Doe",
          "LanguageCode": "en",
          "EmailBodyExtra": "",
          "DisableEmail": false,
          "AddAndroidAppLink": false,
          "AddIosAppLink": false,
          "AddWindowsAppLink": false,
          "AllowDelegation": true,
          "AllowAccessFinishedWorkstep": false,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": [],
          "IdentificationMethods": [],
          "DisposableCertificateData": {
            "CountryResidence": "AT",
            "DocumentIssuingCountry": "",
            "IdentificationCountry": "AT",
            "IdentificationType": "PASSPORT",
            "PhoneMobile": "##PhoneNumber##",
            "DocumentType": "PASS",
            "DocumentIssuedBy": "Namirial",
            "DocumentIssuedOn": "2022-05-24T00:00:00Z",
            "DocumentExpiryDate": "2022-06-07T00:00:00Z",
            "SerialNumber": "##SerialNumber##",
            "DocumentNumber": "##DocumentNumber##",
            "OverrideHolderInCaseOfMismatch": false
          }
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Signer",
      "WorkstepConfiguration": {
        "WorkstepLabel": "test",
        "SmallTextZoomFactorPercent": 100,
        "FinishAction": {
          "ServerActions": [],
          "ClientActions": []
        },
        "ReceiverInformation": {
          "UserInformation": {
            "FirstName": "Jane",
            "LastName": "Doe",
            "EMail": "janedoe@sample.com"
          },
          "HolderInformation": "<recognitionType>PASS</recognitionType><documentIssuedOn>24/05/2022</documentIssuedOn><documentExpiryDate>07/06/2022</documentExpiryDate><documentIssuedBy>Namirial</documentIssuedBy><documentNumber>##DocumentNumber##</documentNumber><countryResidence>AT</countryResidence><firstName>John</firstName><lastName>Doe</lastName><email>johndoe@sample.com</email><phoneMobile>##PhoneNumber##</phoneMobile><identificationType>PASSPORT</identificationType><identificationCountry>AT</identificationCountry><passport>##Passport##</passport>",
          "TransactionCodePushPluginData": []
        },
        "SenderInformation": {
          "UserInformation": {
            "FirstName": "John",
            "LastName": "Doe",
            "EMail": "johndoe@sample.com"
          }
        },
        "TransactionCodeConfigurations": [],
        "SignatureConfigurations": [],
        "ViewerPreferences": {
          "FinishWorkstepOnOpen": false,
          "VisibleAreaOptions": {
            "AllowedDomain": "",
            "Enabled": false
          }
        },
        "ResourceUris": {
          "DelegationUri": "https://demo.esignanywhere.net/Resource/Delegate"
        },
        "AuditingToolsConfiguration": {
          "WriteAuditTrail": true
        },
        "Policy": {
          "GeneralPolicies": {
            "AllowSaveDocument": false,
            "AllowSaveAuditTrail": false,
            "AllowRotatingPages": false,
            "AllowAppendFileToWorkstep": false,
            "AllowAppendTaskToWorkstep": false,
            "AllowEmailDocument": true,
            "AllowPrintDocument": true,
            "AllowFinishWorkstep": true,
            "AllowRejectWorkstep": true,
            "AllowRejectWorkstepDelegation": true,
            "AllowUndoLastAction": true,
            "AllowColorizePdfForms": false,
            "AllowAdhocPdfAttachments": false,
            "AllowAdhocSignatures": false,
            "AllowAdhocStampings": false,
            "AllowAdhocFreeHandAnnotations": false,
            "AllowAdhocTypewriterAnnotations": false,
            "AllowAdhocPictureAnnotations": false,
            "AllowAdhocPdfPageAppending": false,
            "AllowReloadOfFinishedWorkstep": true
          },
          "WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "Texts": [
                  {
                    "Language": "en",
                    "Value": "Agreement text"
                  },
                  {
                    "Language": "*",
                    "Value": "Agreement text"
                  }
                ],
                "Headings": [
                  {
                    "Language": "en",
                    "Value": "Agreement Subject"
                  },
                  {
                    "Language": "*",
                    "Value": "Agreement Subject"
                  }
                ],
                "IsRequired": false,
                "Id": "ra",
                "DisplayName": "ra",
                "DocRefNumber": 1,
                "DiscriminatorType": "Agreements"
              },
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 72.0,
                  "PositionY": 594.0
                },
                "Size": {
                  "Height": 80.0,
                  "Width": 190.0
                },
                "AdditionalParameters": [
                  {
                    "Key": "enabled",
                    "Value": "1"
                  },
                  {
                    "Key": "completed",
                    "Value": "0"
                  },
                  {
                    "Key": "req",
                    "Value": "1"
                  },
                  {
                    "Key": "isPhoneNumberRequired",
                    "Value": "0"
                  },
                  {
                    "Key": "trValidityInSeconds",
                    "Value": "60"
                  },
                  {
                    "Key": "fd",
                    "Value": ""
                  },
                  {
                    "Key": "fd_dateformat",
                    "Value": "dd-MM-yyyy HH:mm:ss"
                  },
                  {
                    "Key": "fd_timezone",
                    "Value": "datetimeutc"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "TrModType": "RemoteSignatureLongLivedDisposableCertificate",
                    "TrValidityInSeconds": 300,
                    "TrConfIdIssueCertificate": "disposableCertificateEnrolAndSignSmsText",
                    "TrConfId": "remoteCertificateSignSmsText",
                    "IsPhoneNumberRequired": false,
                    "Ly": "remoteCertificate",
                    "Id": "7392f37f-32f5-4f53-bade-d830ddb51fa2",
                    "DiscriminatorType": "SigTypeTransactionCode",
                    "Preferred": false,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0,
                      "OverrideLegacyStampImprint": false,
                      "DisplayTransactionId": true,
                      "DisplayTransaktionToken": true,
                      "DisplayPhoneNumber": true
                    },
                    "SignaturePluginConfigurationId": "padesSigningId"
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_4385a5b6-4615-2f23-3a1e-49e31af38dba",
                "DisplayName": "",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          }
        },
        "Navigation": {
          "HyperLinks": [],
          "Links": [],
          "LinkTargets": []
        }
      },
      "DocumentOptions": [
        {
          "DocumentReference": "1",
          "IsHidden": false
        }
      ],
      "UseDefaultAgreements": true
    },
    {
      "OrderIndex": 2,
      "Recipients": [
        {
          "Email": "johndoe@sample",
          "FirstName": "John",
          "LastName": "Doe",
          "LanguageCode": "en",
          "EmailBodyExtra": "",
          "DisableEmail": false,
          "AddAndroidAppLink": false,
          "AddIosAppLink": false,
          "AddWindowsAppLink": false,
          "AllowDelegation": false,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": [],
          "IdentificationMethods": []
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Cc",
      "DocumentOptions": [],
      "UseDefaultAgreements": false
    }
  ],
  "AddFormFields": {
    "Forms": {}
  },
  "OverrideFormFieldValues": {
    "Forms": {}
  },
  "AttachSignedDocumentsToEnvelopeLog": false
}
}

After sending the envelope the receiver get the following after clicking the signature field to accept the general terms and conditions.:

Image Added

The information about the LLD is also shown in the audit trail:

Image Added

Please also note the following difference:

Difference in the certificate issued

A main difference is in the "certification policies" documented in the certificate:

"Normal" Disposable Certificate (Sample)Long-Lived Disposable Certificate (Sample)

Image Added

Image Added

* Refers to Policy OID: 1.3.6.1.4.1.36203.1.1.6* Refers to Policy OID 1.3.6.1.4.1.36203.1.1.7 (Long-Lived Disposable)

P7M Signers Image Added

Info

It is possible to define P7M signers in eSignAnyWhere. 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

The P7M signer can be defined in the recipient list (P7M Signer Type). The P7M signer has no assigned signature fields in the document, so you will not be able to assign signature fields, form fields or predefined fields for him or her.

When a workflow with a P7M signer is finished you will not receive a PDF document, but a signed P7M container with the PDF. Please see the next figure:


Image Added

The workstepconfig must be extended with a invisibleSignature, Task and a document information:

Code Block
languagexml
themeEclipse
<signatureTemplate>
	<InvisibleSig>
		<id>pkcs1</id>
		<TargetDocument>
			<DocRefNumber>1</DocRefNumber>
			<completed>0</completed>
		</TargetDocument>
		<TargetDocument>
			<DocRefNumber>2</DocRefNumber>
			<completed>0</completed>
		</TargetDocument>
		<TargetDocument>
			<DocRefNumber>3</DocRefNumber>
			<completed>0</completed>
		</TargetDocument>
	</InvisibleSig>
</signatureTemplate>

Taskdefinition:

Code Block
languagexml
themeEclipse
<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 Image Added

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!

1) Envelope JSON with new recipient type “Automatic”

Code Block
languagejava
themeEclipse
"EmailBodyExtra": "",
"RecipientType": "Automatic",
"WorkstepConfiguration": {

2) Workstep Configuration

2.1) Define Signature Field in WorkstepConfiguration

Code Block
languagejava
themeEclipse
 "AllowedSignatureTypes": [
                  {
                    "TrModType": "RemoteSignature",
                    "SealingProfileId": "SEALING_PROFILE_IDENTIFIER_FROM_ORGANIZATION_SETTINGS",
                    "RenderingLanguage": "en",
                    "Ly": "test",
                    "Id": "##Id##",
                    "DiscriminatorType": "SigTypeAutomaticSignature",
                    "Preferred": false,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0,
                      "OverrideLegacyStampImprint": false,
                      "DisplayTransactionId": true,
                      "DisplayTransaktionToken": true,
                      "DisplayPhoneNumber": true
                    },

2.3) Finalize Action in WorkstepConfiguration Policy

Code Block
languagejava
themeEclipse
 "FinalizeActions": {
            "FinalizeActionList": [
              {
                "SigId": "##SignatureId##",
                "DiscriminatorType": "AutomaticSignature"
              },
              {
                "DocRefNumbers": "*",
                "SpcId": "ltaLevelId",
                "DiscriminatorType": "Timestamp"
              }
            ]
          }
        },

Please also see the following sample configuration:

Code Block
languagejava
themeEclipse
{
  "Name": "Test.pdf",
  "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,
  "ExpirationInSecondsAfterSending": 2419200,
  "CallbackUrl": "",
  "StatusUpdateCallbackUrl": "",
  "LockFormFieldsAtEnvelopeFinish": false,
  "Steps": [
    {
      "OrderIndex": 1,
      "Recipients": [
        {
          "Email": "##Email##",
          "FirstName": "##Name##",
          "LastName": "##Name##",
          "LanguageCode": "en",
          "EmailBodyExtra": "",
          "DisableEmail": false,
          "AddAndroidAppLink": false,
          "AddIosAppLink": false,
          "AddWindowsAppLink": false,
          "AllowDelegation": true,
          "AllowAccessFinishedWorkstep": false,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": [],
          "IdentificationMethods": []
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Automatic",
      "WorkstepConfiguration": {
        "WorkstepLabel": "Test.pdf",
        "SmallTextZoomFactorPercent": 100,
        "FinishAction": {
          "ServerActions": [],
          "ClientActions": []
        },
        "ReceiverInformation": {
          "UserInformation": {
            "FirstName": "##Name##",
            "LastName": "##Name##",
            "EMail": "##Email##"
          },
          "TransactionCodePushPluginData": []
        },
        "SenderInformation": {
          "UserInformation": {
            "FirstName": "##Name##",
            "LastName": "##Name##",
            "EMail": "##Email##"
          }
        },
        "TransactionCodeConfigurations": [],
        "SignatureConfigurations": [],
        "ViewerPreferences": {
          "FinishWorkstepOnOpen": false,
          "VisibleAreaOptions": {
            "AllowedDomain": "",
            "Enabled": false
          }
        },
        "AuditingToolsConfiguration": {
          "WriteAuditTrail": true
        },
        "Policy": {
          "GeneralPolicies": {
            "AllowSaveDocument": true,
            "AllowSaveAuditTrail": true,
            "AllowRotatingPages": false,
            "AllowAppendFileToWorkstep": false,
            "AllowAppendTaskToWorkstep": false,
            "AllowEmailDocument": true,
            "AllowPrintDocument": true,
            "AllowFinishWorkstep": true,
            "AllowRejectWorkstep": false,
            "AllowRejectWorkstepDelegation": false,
            "AllowUndoLastAction": true,
            "AllowColorizePdfForms": false,
            "AllowAdhocPdfAttachments": false,
            "AllowAdhocSignatures": false,
            "AllowAdhocStampings": false,
            "AllowAdhocFreeHandAnnotations": false,
            "AllowAdhocTypewriterAnnotations": false,
            "AllowAdhocPictureAnnotations": false,
            "AllowAdhocPdfPageAppending": false,
            "AllowReloadOfFinishedWorkstep": true
          },
          "WorkstepTasks": {
            "PictureAnnotationMinResolution": 0,
            "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M",
            "SequenceMode": "NoSequenceEnforced",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 56.0,
                  "PositionY": 589.0
                },
                "Size": {
                  "Height": 80.0,
                  "Width": 190.0
                },
                "AdditionalParameters": [
                  {
                    "Key": "enabled",
                    "Value": "1"
                  },
                  {
                    "Key": "completed",
                    "Value": "0"
                  },
                  {
                    "Key": "req",
                    "Value": "0"
                  },
                  {
                    "Key": "fd",
                    "Value": ""
                  },
                  {
                    "Key": "fd_dateformat",
                    "Value": "dd-MM-yyyy HH:mm:ss"
                  },
                  {
                    "Key": "fd_timezone",
                    "Value": "datetimeutc"
                  }
                ],
                "AllowedSignatureTypes": [
                  {
                    "TrModType": "RemoteSignature",
                    "SealingProfileId": "##SealingProfileId##",
                    "RenderingLanguage": "en",
                    "Ly": "test",
                    "Id": "##Id##",
                    "DiscriminatorType": "SigTypeAutomaticSignature",
                    "Preferred": false,
                    "StampImprintConfiguration": {
                      "DisplayExtraInformation": true,
                      "DisplayEmail": true,
                      "DisplayIp": true,
                      "DisplayName": true,
                      "DisplaySignatureDate": true,
                      "FontFamily": "Times New Roman",
                      "FontSize": 11.0,
                      "OverrideLegacyStampImprint": false,
                      "DisplayTransactionId": true,
                      "DisplayTransaktionToken": true,
                      "DisplayPhoneNumber": true
                    },
                    "SignaturePluginConfigurationId": "ltaLevelId"
                  }
                ],
                "UseTimestamp": false,
                "IsRequired": false,
                "Id": "##Id##",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]
          },
          "FinalizeActions": {
            "FinalizeActionList": [
              {
                "SigId": "##SignatureId##",
                "DiscriminatorType": "AutomaticSignature"
              },
              {
                "DocRefNumbers": "*",
                "SpcId": "ltaLevelId",
                "DiscriminatorType": "Timestamp"
              }
            ]
          }
        },
        "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": [],
          "IdentificationMethods": []
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Cc",
      "DocumentOptions": [],
      "UseDefaultAgreements": false
    }
  ],
  "AddFormFields": {
    "Forms": {}
  },
  "OverrideFormFieldValues": {
    "Forms": {}
  },
  "AttachSignedDocumentsToEnvelopeLog": false
}

You can also find the same samples but for SOAP below:

1) Envelope XML with new recipient type “Automatic”

Code Block
languagexml
themeEclipse
<envelope>
  ...
  <steps>
    <step>
      <emailBodyExtra></emailBodyExtra>
      <orderIndex>1</orderIndex>
      <recipientType>Automatic</recipientType>
      <workstepConfiguration skipThirdPartyChecks="0">
      ...
      </workstepConfiguration>
      </step>
  </steps>
</envelope>

2) Workstep Configuration

2.1) Define Signature Field in WorkstepConfiguration

Code Block
languagexml
themeEclipse
<sig id="GENERIC_SIG_IDENTIFIER">
  <DocRefNumber>1</DocRefNumber>
  <param name="enabled">1</param>
  <AllowedSignatureTypes>
    <sigType id="automatic" type="AutomaticSignature" preferred="0">
	  <trModType>RemoteSignature</trModType>
	  <ImageRenderingLanguage>en</ImageRenderingLanguage>
	  <SealingProfileId>SEALING_PROFILE_IDENTIFIER_FROM_ORGANIZATION_SETTINGS</SealingProfileId>
    </sigType>
  </AllowedSignatureTypes>
</sig>

The sealing profile identifier can be found in the organization settings page at the automatic remote signature settings (Identifier).

2.3) Finalize Action in WorkstepConfiguration Policy

Code Block
languagexml
themeEclipse
<Policy version="1.1.0.0">
  <FinalizeActions>
	<AutomaticSignature sigId="GENERIC_SIG_IDENTIFIER" />
  </FinalizeActions>
</Policy>

A-Trust Image Added

Info

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

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

Code Block
languagexml
themeEclipse
<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="1">
            <positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>          
            <positionX>10</positionX>           
            <positionY>10</positionY>           
            <width>200</width>         
            <height>50</height>           
            <param name="enabled">1</param>          
            <param name="completed">0</param>           
            <param name="sigType">ExternalSigningProcess</param>            
            <param name="positioning">onPage</param>            
            <param name="trModType">ATrustHandySignatur</param>       
            <param name="aTrustTemplateId">4246</param>
        </sig>
    </signatureTemplate>
  <receiverInformation>
        <userInformation>
            <firstName>FirstName</firstName>
            <lastName>LastName</lastName>
            <eMail />
        </userInformation>
        <aTrustCertificateData>
            <!--Used to prefill the phone number for A-Trust Handysignatur-->
            <phonenumber>##phone number##</phonenumber>
        </aTrustCertificateData>
        <!--Defines, if the disclaimer for Namirial disposable certificates should be shown.-->
        <showNamirialDisposableDisclaimer>0</showNamirialDisposableDisclaimer>
    </receiverInformation>   
   <Policy version="1.1.0.0">
      <GeneralPolicies>
      </GeneralPolicies>       
	<TypewriterAnnotationTaskInfo />
      <WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">      
 <Task enabled="1" completed="0" required="1" id="1" 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>
</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>

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 Image Added

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:

Code Block
languagejava
themeEclipse
{   "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": "##SENDER##",
  "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": []
        }
      ],
      "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##"
          },
          "TransactionCodePushPluginData": []
        },
        "SenderInformation": {
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",
            "EMail": "##EMAIL##"
          }
        },
        "TransactionCodeConfigurations": [
          {
            "Id": "",
            "HashAlgorithmIdentifier": "Sha1",
            "Texts": [
              {
                "Value": "Please sign the document"
              }
            ]
          },
          {
            "Id": "otpSignatureSmsText",
            "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": "SequenceOnlyRequiredTasks",
            "PositionUnits": "PdfUnits",
            "ReferenceCorner": "Lower_Left",
            "Tasks": [
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 10.0,
                  "PositionY": 10.0
                },
                "Size": {
                  "Height": 50.0,
                  "Width": 200.0
                },
                "AdditionalParameters": [
                  {
                    "Key": "sigType",
                    "Value": "TransactionCode"
                  },
                  {
                    "Key": "trModType",
                    "Value": "BankIdSignature"
                  },
                  {
                    "Key": "trValidityInSeconds",
                    "Value": "60"
                  },
                  {
                    "Key": "ly",
                    "Value": "bankId"
                  }
                ],
                "AllowedSignatureTypes": [],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "1",
                "DisplayName": "SignField 1",
                "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,
          "AllowAccessFinishedWorkstep": false,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": []
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Cc",
      "DocumentOptions": [
        {
          "DocumentReference": "1",
          "IsHidden": false
        }
      ],
      "UseDefaultAgreements": false
    }
  ],
  "AddFormFields": {
    "Forms": {}
  },
  "OverrideFormFieldValues": {
    "Forms": {}
  },
  "AttachSignedDocumentsToEnvelopeLog": false
}


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
 <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-13T09:11:44.7415636Z</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 SequenceMode="SequenceOnlyRequiredTasks" originalSequenceMode="SequenceOnlyRequiredTasks">
            <Task enabled="1" completed="0" required="1" id="1" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" />
        </WorkstepTasks>
</Policy>
        <Navigation />
        <timeCreated>2020-07-13T09:01:44.7103136Z</timeCreated>
        <TransactionCodeConfigurations>       
        <TransactionCodeConfiguration trConfId="">          
            <Message>Please sign the document</Message>
            <hashAlgorithmIdentifier>Sha1</hashAlgorithmIdentifier>
        </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" />
        <TypewriterAnnotationTaskInfo />
        <attachmentFields />
         <signatureTemplate>
        <version>1.2.0.2</version>
        <positionUnits>PdfUnits</positionUnits>
        <positionReferenceCorner>Lower_Left</positionReferenceCorner>
        <sig id="1">
            <positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>
            <positionX>10</positionX>
            <positionY>10</positionY>
            <width>200</width>
            <height>50</height>
            <param name="sigType">TransactionCode</param>
            <param name="trModType">BankIdSignature</param>
            <param name="trValidityInSeconds">60</param>
            <param name="ly">bankId</param>
        </sig>
    </signatureTemplate>
        <AuditingToolsConfiguration WriteAuditTrail="0">
          <NotificationConfiguration />
        </AuditingToolsConfiguration>
        <resourceUris />
        <LoggingMetaInformation>
          <envelopeId>##ENVELOPE##</envelopeId>
          <envelopeRecipientId>##RECIPIENT##</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>false</allowDelegation>
          <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
        </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> 


In this section you can find the bankID authentication method:

Code Block
languagejava
themeEclipse
"AuthenticationMethods": [
            {
              "Method": "BankId",
              "Parameter": "##Parameter##"
            }
          ]


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
 <authentications>
          <authentication>
                <method>BankId</method>
                <parameter>##parameter##</parameter>
          </authentication>
 </authentications> 


Generic Signing Plugin Image Added

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:

Code Block
languagejava
themeEclipse
{
  "SspFileIds": [
    "##FileId##"
  ],
  "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": "",
    "Steps": [
      {
        "OrderIndex": 1,
        "Recipients": [
          {
            "Email": "##Email##",
            "FirstName": "##name##",
            "LastName": "##name##",
            "LanguageCode": "en",
            "EmailBodyExtra": "",
            "DisableEmail": false,
            "AddAndroidAppLink": false,
            "AddIosAppLink": false,
            "AddWindowsAppLink": false,
            "AllowDelegation": false,
            "SkipExternalDataValidation": false,
            "AuthenticationMethods": [],
						"BankIdPluginData" : {
							"TrBiPersonalNumber": "##PersonalNumber##",
							"TrBiAllowAnyPersonalNumber": false
						}
          }
        ],
        "EmailBodyExtra": "",
        "RecipientType": "Signer",
        "WorkstepConfiguration": {
          "WorkstepLabel": "test",
					"ReceiverInformation": {
						"GenericSigningPluginDataList": [{
							"PluginId": "GenericSigningPluginForTests",
							"SenderDataFields": {
								"Fields": [{
									"Key": "customEmail",
									"Value": "##customEmail##"
								},{
									"Key": "userId",
									"Value": "##UserId##"
								},{
									"Key": "email",
									"Value": "##Email##"
								},{
									"Key": "password",
									"Value": "##Password##"
								},{
									"Key": "number",
									"Value": "##Number##"
								},{
									"Key": "phoneNumber",
									"Value": "##Number##"
								},{
									"Key": "list",
									"Value": "app"
								}]
							}
						}]
					},
          "SmallTextZoomFactorPercent": 100,
          "FinishAction": {
            "TrValidityInSecondsServerActions": 300[],
                    "LyClientActions": "simpleTransactionCodeSms",[
                    "TrConfId": "otpSignatureSmsText",
    {
                "IsPhoneNumberRequiredRemoveDocumentFromRecentDocumentList": false,
                    "IdCallClientActionOnlyAfterSuccessfulSync": "cee105ae-f407-42f9-993c-6b664055f5fb",
   true,
                 "DiscriminatorTypeClientName": "SigTypeTransactionCodeSIGNificant SignAnywhere",
                    "PreferredCloseApp": false,
                    "StampImprintConfigurationAction": {"https://www.esignanywhere.net/"
              }
         "DisplayExtraInformation": true,
  ]
          },
          "DisplayEmailPolicy": true,{
            "GeneralPolicies": {
              "OverrideLegacyStampImprintAllowSaveDocument": true,
              "AllowSaveAuditTrail": true,
       "DisplayTransactionId":true,
       "AllowRotatingPages": false,
              "DisplayTransaktionTokenAllowEmailDocument": true,
              "AllowPrintDocument": true,
       "DisplayPhoneNumber":true,
       "AllowFinishWorkstep": true,
              "DisplayIpAllowRejectWorkstep": true,
              "AllowRejectWorkstepDelegation": false,
       "DisplayName       "AllowUndoLastAction": true,
              "AllowAdhocPdfAttachments": false,
              "DisplaySignatureDateAllowAdhocSignatures": truefalse,
              "AllowAdhocStampings": false,
              "FontFamilyAllowAdhocFreeHandAnnotations": "Times New Roman",
 false,
              "AllowAdhocTypewriterAnnotations": false,
              "FontSizeAllowAdhocPictureAnnotations": 11.0
false,
              "AllowAdhocPdfPageAppending": false
       }
     },
            "WorkstepTasks": }{
                ]"PictureAnnotationMinResolution": 0,
                "UseTimestampPictureAnnotationMaxResolution": false0,
                "IsRequiredPictureAnnotationColorDepth": true"Color16M",
                "IdSequenceMode": "1#XyzmoDuplicateIdSeperator#Signature_0d123383-e054-81ec-0b17-96c4e7b955b3NoSequenceEnforced",
                "DisplayNamePositionUnits": "PdfUnits",
                "DocRefNumberReferenceCorner": 1"Lower_Left",
                "DiscriminatorTypeTasks": "Signature"[
              }  {
            ]      "PositionPage": 1,
          }
        },
Expand
titleAlternative: SOAP implementation (deprecated)

Image Removed

 <AllowedSignatureTypes>
"Position": {
              
<sigType
 
id="3dd00265-9101-4b90-b2ac-330fa8f2180a"
 
type="TransactionCode">
    "PositionX": 70.0,
           
<trModType>TransactionCodeSenderPlugin</trModType>
         "PositionY": 606.0
      
<trConfId>otpSignatureSmsText</trConfId>
            },
    
<trValidityInSeconds>300</trValidityInSeconds>
              
<ly>simpleTransactionCodeSms</ly>
"Size": {
                
<phonenumber>##phonenumber##</phonenumber>
    "Height": 80.0,
           
<StampImprintConfiguration>
         "Width": 191.0
        
<DisplayExtraInformation>1</DisplayExtraInformation> <OverrideLegacyStampImprint>1</OverrideLegacyStampImprint> <DisplayTransactionId>1</DisplayTransactionId> <DisplayTransaktionToken>1</DisplayTransaktionToken> <DisplayPhoneNumber>1</DisplayPhoneNumber>
          },
        
<DisplayEmail>1</DisplayEmail>
          "AdditionalParameters": [
       
<DisplayIp>1</DisplayIp>
             {
     
<DisplayName>1</DisplayName>
                 
<DisplaySignatureDate>1</DisplaySignatureDate>
"Key": "enabled",
                  
<FontFamily>Times
  
New
 
Roman</FontFamily>
 "Value": "1"
                
<FontSize>11</FontSize>
    },
            
</StampImprintConfiguration>
        {
      
</sigType>
            
</AllowedSignatureTypes>
  
Code Block
languagejava
themeEclipse
Code Block
languagexml
themeEclipse

...

 <AllowedSignatureTypes>
"DisplayName": "",
              
<sigType
    
id="3dd00265-9101-4b90-b2ac-330fa8f2180a" type="TransactionCode">
"DocRefNumber": 1,
                
<trModType>TransactionCodeSenderPlugin</trModType>
  "DiscriminatorType": "Signature"
             
<trConfId>otpSignatureSmsText</trConfId>
   }
              
<trValidityInSeconds>300</trValidityInSeconds>
]
            }
    
<ly>simpleTransactionCodeSms</ly>
      }
        },
   
<phonenumber>##phonenumber##</phonenumber>
     "DocumentOptions": [
          
<StampImprintConfiguration>
{
            "DocumentReference": "1",
     
<DisplayExtraInformation>1</DisplayExtraInformation> <OverrideLegacyStampImprint>0</OverrideLegacyStampImprint> <DisplayTransactionId>1</DisplayTransactionId> <DisplayTransaktionToken>1</DisplayTransaktionToken> <DisplayPhoneNumber>0</DisplayPhoneNumber>
       "IsHidden": false
          
<DisplayEmail>0</DisplayEmail>
}
        ],
        
<DisplayIp>0</DisplayIp>
"UseDefaultAgreements": true
      }
    ]
  }
}
  "AllowedSignatureTypesKey": [
"positioning",
                       {"Value": "onPage"
                    "TrModType": "TransactionCodeSenderPlugin"},
                    "TrValidityInSeconds": 300,
 {
                      "LyKey": "simpleTransactionCodeSmsreq",
                      "TrConfIdValue": "otpSignatureSmsText1",
                    "IsPhoneNumberRequired": false},
                    "Id": "cee105ae-f407-42f9-993c-6b664055f5fb",
{
                      "DiscriminatorTypeKey": "SigTypeTransactionCodefd",
                      "PreferredValue": false,""
                    "StampImprintConfiguration": {},
                      "DisplayExtraInformation": true,{
                      "DisplayEmailKey": false"fd_dateformat",
                      "OverrideLegacyStampImprintValue": false, "dd-MM-yyyy HH:mm:ss"
                      "DisplayTransactionId":true},
                      "DisplayTransaktionToken":true,{
                      "DisplayPhoneNumberKey":false "fd_timezone",
                      "DisplayIpValue": false,"datetimeutc"
                      "DisplayName": false},
                      "DisplaySignatureDate": true,{
                      "FontFamilyKey": "Times New RomanspcId",
                      "FontSizeValue": 11.0"padesSigningId"
                    }
                  }],
                   ],
"AllowedSignatureTypes": [
                   "UseTimestamp": false, {
                "IsRequired      "Id": true"8e4ce7e9-b70b-464b-861e-8429239ef474",
                "Id      "DiscriminatorType": "1#XyzmoDuplicateIdSeperator#Signature_0d123383-e054-81ec-0b17-96c4e7b955b3",
SigTypeGenericSigningPlugin",
											"PluginId": "GenericSigningPluginForTests"
                  "DisplayName": "",
  }
                 "DocRefNumber": 1],
                  "DiscriminatorTypeUseTimestamp": "Signature"
false,
                   }
"IsRequired": true,
                   ]"Id": "1#XyzmoDuplicateIdSeperator#Signature_a48a82a2-0bd3-1e9e-c223-64ad308bf715",
          }
        },
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagexml
themeEclipse


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<envelope>
  <name>test</name>
  <eMailSubject>Please sign the 	<DisplayName>0</DisplayName>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>
  	<DisplaySignatureDate>1<<recurrentReminderDayAmount>3</DisplaySignatureDate>recurrentReminderDayAmount>
  <beforeExpirationReminderDayAmount>3</beforeExpirationReminderDayAmount>
  <daysUntilExpire>28</daysUntilExpire>
  <callbackUrl></callbackUrl>
  <statusUpdateCallbackUrl></statusUpdateCallbackUrl>
  <lockFormFieldsAtEnvelopeFinish>false</lockFormFieldsAtEnvelopeFinish>
  <displayedEmailSender>##Email##</displayedEmailSender>
  <steps>
    	<FontFamily>Times New Roman</FontFamily><step>
      <emailBodyExtra></emailBodyExtra>
      <orderIndex>1</orderIndex>
      	<FontSize>11<<recipientType>Signer</FontSize>recipientType>
      <useDefaultAgreements>true</useDefaultAgreements>
      <documentOptions>
     </StampImprintConfiguration>
   <documentOption docRef="1">
          <<isHidden>false</sigType>isHidden>
        </documentOption>
      </AllowedSignatureTypes>

...

Image Removed

Click2Sign

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

Alternative: SOAP implementation (deprecated)
Code Block
languagejava
themeEclipse
title "WorkstepTasks": {
documentOptions>
      <workstepConfiguration skipThirdPartyChecks="0">
       
"PictureAnnotationMinResolution": 0,
 <WorkstepLabel>test</WorkstepLabel>
        <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
    
"PictureAnnotationMaxResolution":
 
0,
   <WorkstepTimeToLiveInMinutes>43200</WorkstepTimeToLiveInMinutes>
        <FinishAction>
 
"PictureAnnotationColorDepth":
 
"Color16M",
        <ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="
SequenceMode
0"
:
 CallClientActionOnlyAfterSuccessfulSync="
NoSequenceEnforced",
1">https://www.esignanywhere.net/</ClientAction>
        </FinishAction>
       
"PositionUnits": "PdfUnits",
 <signatureTemplate>
          <sig 
"ReferenceCorner": "Lower_Left",
id="1#XyzmoDuplicateIdSeperator#Signature_a48a82a2-0bd3-1e9e-c223-64ad308bf715" useTimestamp="false">
            
"Tasks": [
<positionPage>1</positionPage>
            <DocRefNumber>1</DocRefNumber>
  
{
          <positionX>70</positionX>
      
"PositionPage":
 
1,
     <positionY>606</positionY>
           
"Position": {
 <width>191</width>
            <height>80</height>
       
"PositionX":
 
69.0,
    <param name="enabled">1</param>
            <param name="
PositionY": 529.92
positioning">onPage</param>
            
},
<param name="req">1</param>
            <param 
"Size": {
name="fd"></param>
            
"Height": 80.0,
<param name="fd_dateformat">dd-MM-yyyy HH:mm:ss</param>
            
"Width": 190.0
<param name="fd_timezone">datetimeutc</param>
            <AllowedSignatureTypes>
    
},
          <sigType id="8e4ce7e9-b70b-464b-861e-8429239ef474" type="GenericSigningPlugin" preferred="0">
   
"AdditionalParameters":
 
[
            <genericSigningPluginId>GenericSigningPluginForTests</genericSigningPluginId>
      
{
        </sigType>
            
"Key": "enabled",
</AllowedSignatureTypes>
          </sig>
          
"Value": "1"
<positionUnits>PdfUnits</positionUnits>
          <positionReferenceCorner>Lower_Left</positionReferenceCorner>
        
},
</signatureTemplate>
        <PictureAnnotationTaskInfo>
          
{
<MinResolution>0</MinResolution>
          <MaxResolution>0</MaxResolution>
          
"Key": "positioning",
<ColorDepth>Color16M</ColorDepth>
        </PictureAnnotationTaskInfo>
        <Policy version="1.1.0.0">
   
"Value":
 
"onPage"
      <GeneralPolicies>
            
},
<AllowSaveDocument>1</AllowSaveDocument>
            <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
      
{
      <AllowRotatingPages>0</AllowRotatingPages>
            <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep>
  
"Key":
 
"req",
         <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep>
           
"Value": "1"
 <AllowEmailDocument>1</AllowEmailDocument>
            <AllowPrintDocument>1</AllowPrintDocument>
      
},
      <AllowFinishWorkstep>1</AllowFinishWorkstep>
            
{
<AllowRejectWorkstep>1</AllowRejectWorkstep>
            <AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation>
        
"Key":
 
"fd",
   <AllowUndoLastAction>1</AllowUndoLastAction>
            <AllowColorizePdfForms>0</AllowColorizePdfForms>
     
"Value":
 
""
      <AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
            
},
<AllowAdhocSignatures>0</AllowAdhocSignatures>
            <AllowAdhocStampings>0</AllowAdhocStampings>
     
{
       <AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
            
"Key": "fd_dateformat",
<AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
            <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
          
"Value":
 
"dd-MM-yyyy HH:mm:ss"
 <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>
     
"Key":
 
"fd_timezone",
  
</Policy>
        <timeCreated />
       
"Value": "datetimeutc"
 <TransactionCodeConfigurations>
          <TransactionCodeConfiguration trConfId="smsAuthTransactionCodeId" language="">
      
}
     
          
],
</TransactionCodeConfiguration>
        </TransactionCodeConfigurations>
        
"AllowedSignatureTypes": [
<ViewerPreferences />
        <receiverInformation>
          
{
<userInformation>
            <firstName>##FirstName##</firstName>
           
"AllowedCapturingMethod": "Click2Sign",
 <lastName>##LastName##</lastName>
            <eMail>##Email##</eMail>
         
"StampImprintConfiguration": {
 </userInformation>
          <showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
          <genericSigningPluginData 
pluginId="
DisplayExtraInformation": true,
GenericSigningPluginForTests">
            <senderDataFields>
             
"DisplayEmail": true,
 <recipientemail>##Email##</recipientemail>
              <recipientfirstname>##FirstName##</recipientfirstname>
         
"DisplayIp":
 
true,
    <customEmail>##Email##</customEmail>
              <userId>##UserId##</userId>
    
"DisplayName":
 
true,
         <email>##Email##</email>
             
"DisplaySignatureDate": true,
 <password>##Password##</password>
              <number>##Number##</number>
        
"FontFamily": "Times New Roman",
      <phoneNumber>+##PhoneNumber##</phoneNumber>
              <list>app</list>
         
"FontSize":
 
11.0
  </senderDataFields>
          </genericSigningPluginData>
        
},
</receiverInformation>
        <senderInformation>
          <userInformation>
  
"Id":
 
"d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4ea",
         <firstName>##FirstName##</firstName>
           
"DiscriminatorType": "SigTypeClick2Sign",
 <lastName>##LastName##</lastName>
            <eMail>##Email##</eMail>
         
"Preferred": true
 </userInformation>
        </senderInformation>
      </workstepConfiguration>
    
}
  <recipients>
        <recipient>
      
],
    <eMail>##Email##</eMail>
          <emailBodyExtra></emailBodyExtra>
  
"UseTimestamp":
 
false,
       <firstName>##FirstName##</firstName>
         
"IsRequired": true,
 <lastName>##LastName##</lastName>
          <languageCode>en</languageCode>
       
"Id":
 
"1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aef",
  <disableEmail>false</disableEmail>
          <skipExternalDataValidation>false</skipExternalDataValidation>
    
"DisplayName":
 
"",
     <addAndroidAppLink>false</addAndroidAppLink>
          
"DocRefNumber": 1,
<addIosAppLink>false</addIosAppLink>
          <addWindowsAppLink>false</addWindowsAppLink>
     
"DiscriminatorType":
 
"Signature"
    <allowDelegation>false</allowDelegation>
          
}
<allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
          <authentications 
]
/>
        </recipient>
  
}
    </recipients>
    
}
</step>
  </steps>
  
},
Expand
<attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope> 


Generic Signing Plugin (automatic) Image Added

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

xml
Code Block
language
java
themeEclipse
Code Block
languagejava
themeEclipse
<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
{
    "SspFileIds": ["##SspFileId##"],      "SendEnvelopeDescription": {
        "Name": "GenericSigningPluginForTests",
      
<positionPage>1</positionPage>
  "EmailSubject": "*GenericSigningPluginForTests*",
        
<DocRefNumber>1</DocRefNumber>
"EmailBody": "*Please sign the document*",
        
<positionX>80.22857</positionX>
"Steps": [{
            
<positionY>158.8629</positionY>
"OrderIndex": 1,
           
<width>171.4286</width>
 "Recipients": [{
             
<height>68.57143</height>
   "Email": "##PlaceholderEmail##",
                
<param name="enabled">1</param>
"FirstName": "_PlaceHolderFirstName",
            
<param name="completed">0</param>
    "LastName": "_PlaceHolderLastName",
            
<param name="sigType">Picture</param>
    "LanguageCode": "en",
               
<param
 
name=
"
positioning">onPage</param>
DisableEmail": true,
               
<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.

<sig
 
id="93cce567-ae5c-4e98-ac99-9f56ac034250">
            
<positionPage>1</positionPage>
    "DiscriminatorType": "AutomaticSignature",
       
<DocRefNumber>1</DocRefNumber>
            
<positionX>80.22857</positionX>
         
<positionY>158.8629</positionY>
"SigId": "c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75"
            
<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>
"WorkstepTasks"AddAndroidAppLink": {false,
                "PictureAnnotationMinResolutionAddIosAppLink": 0false,
                "PictureAnnotationMaxResolutionAddWindowsAppLink": 0false,
                "PictureAnnotationColorDepthAllowDelegation": "Color16M"false,
                "SequenceModeSkipExternalDataValidation": "NoSequenceEnforced",true
            "PositionUnits": "PdfUnits"}],
            "ReferenceCornerRecipientType": "Lower_LeftAutomatic",
            "TasksWorkstepConfiguration": [{
               { "WorkstepLabel": "Automatic",
                "PositionPageSkipThirdPartyChecks": 1false,
                "PositionSmallTextZoomFactorPercent": {100,
                  "PositionXWorkstepTimeToLiveInMinutes": 69.044650,
                  "PositionYViewerPreferences": 529.92{
                  },
  "FinishWorkstepOnOpen": false
             "Size": {
  },
                "HeightPolicy": 80.0,{
                    "WidthWorkstepTasks": 190.0
{
                   },
     "SequenceMode": "NoSequenceEnforced",
          "AdditionalParameters": [
             "PositionUnits": "PdfUnits",
    {
                    "KeyReferenceCorner": "enabledLower_Left",
                        "ValueTasks": "1"[{
                  },
          "DiscriminatorType": "Signature",
        {
                    "KeyId": "positioningc5d2b3a5-afd1-4794-b8c8-c3f9c0755b75",
                            "ValueDocRefNumber": "onPage"1,
                  },
          "PositionPage": 1,
                    {
        "Position": {
           "Key": "req",
                    "ValuePositionX": "1"0.0,
                  },
              "PositionY": 0.0
   {
                    "Key": "fd",
    },
                "Value": ""
           "Size": {
      },
                  {
        "Height": 80.0,
           "Key": "fd_dateformat",
                    "ValueWidth": "dd-MM-yyyy HH:mm:ss"190.0
                  },
          },
        {
                    "KeyAdditionalParameters": "fd_timezone",[{
                    "Value": "datetimeutc"
                  }"Key": "req",
                ],
                "AllowedSignatureTypesValue": ["1"
                    {
        }, {
           "AllowedCapturingMethod": "Draw2Sign",
                    "StampImprintConfigurationKey": {
"positioning",
                         "DisplayExtraInformation": true,
      "Value": "onPage"
               "DisplayEmail": true,
            }, {
         "DisplayIp": true,
                      "DisplayNameKey": true"enabled",
                                "DisplaySignatureDateValue": true,
"1"
                         "FontFamily": "Times New Roman"}],
                      "FontSize": 11.0
       "AllowedSignatureTypes": [{
            },
                    "IdDiscriminatorType": "d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4eaSigTypeAutomaticSignature",
                                "DiscriminatorTypeId": "SigTypeDraw2Sign",
   SignFor_c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75",
                 "Preferred": true
                  }"GenericSigningPluginId": "GenericSigningPluginForTests",
                ],
                "UseTimestampSealingProfileId": false,"##SealingProfileId##"
                "IsRequired": true,
                "Id": "1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aef",}]
                "DisplayName": "",
       }]
         "DocRefNumber": 1,
          },
      "DiscriminatorType": "Signature"
             "FinalizeActions": }{
            ]
          }
  "FinalizeActionList": [{
     }
      },
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagexml
themeEclipse

Type2Sign

...

}
}


java
Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
language
xml
themeEclipse
"WorkstepTasks": {
 <envelope>
  <name>GenericSigningPluginForTests</name>
  <eMailSubject>*GenericSigningPluginForTests*</eMailSubject>
  <eMailBody>*Please sign the document*</eMailBody>
  <enableReminders>true</enableReminders>
  
"PictureAnnotationMinResolution": 0,
<firstReminderDayAmount>5</firstReminderDayAmount>
  <recurrentReminderDayAmount>3</recurrentReminderDayAmount>
  <beforeExpirationReminderDayAmount>3</beforeExpirationReminderDayAmount>
  <daysUntilExpire>28</daysUntilExpire>
  <callbackUrl></callbackUrl>
  <statusUpdateCallbackUrl></statusUpdateCallbackUrl>
  <lockFormFieldsAtEnvelopeFinish>false</lockFormFieldsAtEnvelopeFinish>
  
"PictureAnnotationMaxResolution": 0,
<displayedEmailSender>##Email##</displayedEmailSender>
  <steps>
    <step>
      
"PictureAnnotationColorDepth": "Color16M",
<emailBodyExtra></emailBodyExtra>
      <orderIndex>1</orderIndex>
      
"SequenceMode": "NoSequenceEnforced",
<recipientType>Automatic</recipientType>
      <useDefaultAgreements>true</useDefaultAgreements>
      
"PositionUnits": "PdfUnits",
<documentOptions>
        <documentOption 
"ReferenceCorner": "Lower_Left",
docRef="1">
          
"Tasks": [
<isHidden>false</isHidden>
        </documentOption>
      
{
</documentOptions>
      <workstepConfiguration skipThirdPartyChecks="0">
        <WorkstepLabel>Generic 
"PositionPage": 1,
Signing Plugin</WorkstepLabel>
        <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
        
"Position": {
<WorkstepTimeToLiveInMinutes>43200</WorkstepTimeToLiveInMinutes>
        <signatureTemplate>
          <sig 
"PositionX": 69.0,
id="c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75">
            <positionPage>1</positionPage>
       
"PositionY":
 
529.92
    <DocRefNumber>1</DocRefNumber>
            
},
<positionX>0</positionX>
            <positionY>0</positionY>
    
"Size":
 
{
       <width>190</width>
           
"Height": 80.0,
 <height>80</height>
            <param name="req">1</param>
     
"Width":
 
190.0
      <param name="positioning">onPage</param>
            
},
<param name="enabled">1</param>
            <AllowedSignatureTypes>
    
"AdditionalParameters":
 
[
         <sigType id="SignFor_c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75" 
{
type="AutomaticSignature" preferred="0">
                
"Key": "enabled",
<trModType />
                
"Value": "1"
<SealingProfileId>##SealingProfileId##</SealingProfileId>
                
},
<genericSigningPluginId>GenericSigningPluginForTests</genericSigningPluginId>
              </sigType>
    
{
        </AllowedSignatureTypes>
            
"Key": "positioning",
<param name="spcId">automaticSigningId</param>
          </sig>
          
"Value": "onPage"
<positionUnits>PdfUnits</positionUnits>
          <positionReferenceCorner>Lower_Left</positionReferenceCorner>
        
},
</signatureTemplate>
        <PictureAnnotationTaskInfo>
          
{
<MinResolution>-1</MinResolution>
          <MaxResolution>-1</MaxResolution>
          
"Key": "req",
<ColorDepth>Color16M</ColorDepth>
        </PictureAnnotationTaskInfo>
        <Policy 
"Value": "1"
version="1.1.0.0">
          <GeneralPolicies>
        
},
    <AllowSaveDocument>1</AllowSaveDocument>
            
{
<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
            <AllowRotatingPages>1</AllowRotatingPages>
        
"Key":
 
"fd",
   <AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep>
            <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep>
     
"Value":
 
""
      <AllowEmailDocument>1</AllowEmailDocument>
            
},
<AllowFinishWorkstep>1</AllowFinishWorkstep>
            <AllowRejectWorkstep>1</AllowRejectWorkstep>
      
{
      <AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
            <AllowUndoLastAction>1</AllowUndoLastAction>
  
"Key":
 
"fd_dateformat",
         <AllowColorizePdfForms>0</AllowColorizePdfForms>
           
"Value": "dd-MM-yyyy HH:mm:ss"
 <AllowAdhocPdfAttachments>1</AllowAdhocPdfAttachments>
            <AllowAdhocSignatures>0</AllowAdhocSignatures>
      
},
      <AllowAdhocStampings>0</AllowAdhocStampings>
            
{
<AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
            <AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
        
"Key":
 
"fd_timezone",
   <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
            <AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
     
"Value":
 
"datetimeutc"
    </GeneralPolicies>
          <WorkstepTasks SequenceMode="NoSequenceEnforced" />
  
}
        
<FinalizeActions>
       
],
     <AutomaticSignature sigId="c5d2b3a5-afd1-4794-b8c8-c3f9c0755b75" />
         
"AllowedSignatureTypes": [
 </FinalizeActions>
        </Policy>
        <timeCreated 
{
/>
        <TransactionCodeConfigurations>
          <TransactionCodeConfiguration 
trConfId="
AllowedCapturingMethod
smsAuthTransactionCodeId"
:
 language="
Type2Sign
"
,
>
          </TransactionCodeConfiguration>
        </TransactionCodeConfigurations>
  
"StampImprintConfiguration":
 
{
     <ViewerPreferences>
          <FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
       
"DisplayExtraInformation": true,
 </ViewerPreferences>
        <senderInformation>
          <userInformation>
     
"DisplayEmail":
 
true,
      <firstName>##FirstName##</firstName>
            <lastName>##LastName##</lastName>
    
"DisplayIp":
 
true,
       <eMail>##Email##</eMail>
          </userInformation>
     
"DisplayName":
 
true,
  </senderInformation>
        <FinishAction />
      </workstepConfiguration>
     
"DisplaySignatureDate": true,
 <recipients>
        <recipient>
          <eMail>#PlaceholderEmail##</eMail>
    
"FontFamily":
 
"Times
 
New
 
Roman",
   <emailBodyExtra></emailBodyExtra>
          <firstName>_PlaceHolderFirstName</firstName>
         
"FontSize": 11.0
 <lastName>_PlaceHolderFirstName</lastName>
          <languageCode>en</languageCode>
          
},
<disableEmail>true</disableEmail>
          <skipExternalDataValidation>false</skipExternalDataValidation>
          
"Id": "d63ec0d5-a2ca-46d9-9c73-7bd8d91aa4ea",
<addAndroidAppLink>false</addAndroidAppLink>
          <addIosAppLink>false</addIosAppLink>
          
"DiscriminatorType": "SigTypeType2Sign",
<addWindowsAppLink>false</addWindowsAppLink>
          <allowDelegation>false</allowDelegation>
          
"Preferred": true
<allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
          <authentications />
        
}
</recipient>
      </recipients>
    </step>
  </steps>
  
],
<attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope> 


Generic Signing Plugin (Batch-Signature) Image Added

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

<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">
"Email": "##Email##",
          
<positionPage>1</positionPage>
"FirstName": "##FirstName##",
          
<DocRefNumber>1</DocRefNumber>
"LastName": "##LastName##",
          
<positionX>80.22857</positionX>
"LanguageCode": "en",
          
<positionY>158.8629</positionY> <width>171.4286</width>
"EmailBodyExtra": "",
          
<height>68.57143</height>
"DisableEmail": false,
         
<param
 
name=
"
enabled">1</param>
AddAndroidAppLink": false,
         
<param
 
name=
"
completed">0</param>
AddIosAppLink": false,
         
<param
 
name=
"
sigType">Picture</param>
AddWindowsAppLink": false,
         
<param
 
name=
"
positioning">onPage</param>
AllowDelegation": false,
         
<param
 
name=
"
allowedCapturingMethods">Type2Sign</param> </sig>
Code Block
languagejava
themeEclipse
{
    "UseTimestampSspFileIds": false["##SspFileId##"],
                "IsRequiredSendEnvelopeDescription": true,{
    
         
   "IdName": "1#XyzmoDuplicateIdSeperator#Signature_94816166-6b59-1cc1-de9b-285633162aefeSignAnyWhere Tutorial",
  "EmailSubject": "Document of eSignAnyWhere Tutorial",
  "EmailBody": "Dear #RecipientFirstName#! Please sign this tutorial document.",
  "DisplayNameDisplayedEmailSender": "",
  "EnableReminders": true,
  "FirstReminderDayAmount": 1,
        "RecurrentReminderDayAmount": 1,
  "DocRefNumberBeforeExpirationDayAmount": 1,
  "DaysUntilExpire": 2,
  "CallbackUrl": "",
          "DiscriminatorType"StatusUpdateCallbackUrl": "Signature",
  "LockFormFieldsAtEnvelopeFinish": false,
  "Steps": [
        }{
            ]"OrderIndex": 1,
          }"Recipients": [
        }{
      },
      },
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagejava
themeEclipse
Code Block
languagexml
themeEclipse

Biometric

<sig id="93cce567-ae5c-4e98-ac99-9f56ac034250">

          
<positionPage>1</positionPage>
{
            
<DocRefNumber>1</DocRefNumber> <positionX>80.22857</positionX>
"Id": "Trans1",
            
<positionY>158.8629</positionY>
"HashAlgorithmIdentifier": "Sha256",
           
<width>171.4286</width>
 "Texts": [
              
<height>68.57143</height>
{
               
<param
 
name="enabled">1</param>
"Value": "Please accept the transactionId {tId} with the code: {Token}"
    
<param
 
name="completed">0</param>
         }
   
<param
 
name="positioning">onPage</param>
        
<AllowedSignatureTypes>
]
          },
    
<sigType
 
id="672d210e-9aa1-41b5-bb24-2e1b4b079f61"
 
type="BiometricSignature">
    {
            
<bio>0</bio>
"Id": "IdentityServerMail",
            "HashAlgorithmIdentifier": 
</sigType>
"Sha256",
         
</AllowedSignatureTypes>
  
</sig><WorkstepTasks
 
SequenceMode=
"
SequenceOnlyRequiredTasks
Texts"
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

"WorkstepTasks": {AllowAccessFinishedWorkstep": false,
            "PictureAnnotationMinResolutionSkipExternalDataValidation": 0false,
            "PictureAnnotationMaxResolutionAuthenticationMethods": 0,[]
        }
    "PictureAnnotationColorDepth": "Color16M",
       ],
       "SequenceModeEmailBodyExtra": "NoSequenceEnforced",
            "PositionUnits"RecipientType": "PdfUnitsSigner",
      "WorkstepConfiguration": {
        "ReferenceCornerWorkstepLabel": "Lower_Left",
             "TasksSmallTextZoomFactorPercent": [100,
        "FinishAction": {
     {
     "ServerActions": [],
          "PositionPageClientActions": 1,[]
        },
        "PositionReceiverInformation": {
          "UserInformation": {
            "PositionXFirstName": 67.0"##FirstName##",
            "LastName": "##LastName##",
            "PositionYEMail": 521.92"##Email##"
          },
      },
     "TransactionCodePushPluginData": [],
          "SizeGenericSigningPluginDataList": {
[
            {
              "HeightPluginId": 80.0"GenericSigningPluginForTests",
                  "WidthSenderDataFields": 190.0{
                }, "Fields": [
                "AdditionalParameters": [
                  {
                    "Key": "enabledcustomEmail",
                    "Value": "1##Email##"
                  },
                  {
                    "Key": "positioninguserId",
                    "Value": "intersectsWithField##UserId##"
                  },
                  {
                    "Key": "reqemail",
                    "Value": "1##Email##"
                  },
                  {
                    "Key": "fdpassword",
                    "Value": "##Password##"
                  },
                  {
                    "Key": "fd_dateformatnumber",
                    "Value": "dd-MM-yyyy HH:mm:ss##Number##"
                  },
                  {
                    "Key": "fd_timezonephoneNumber",
                    "Value": "datetimeutc+##PhoneNumber##"
                  },
                 ], {
                    "AllowedSignatureTypesKey": ["list",
                  {
  "Value": "app"
                 "IsBio": false, }
                ]
    "AllowSkipBiometricVerification": false,
         }
           "AllowBiometricStoringOnly": false, }
          ]
          "SignedResponseWithoutBioData": false},
        "SenderInformation": {
           "IdUserInformation": "6fa90b47-847f-47b1-b73a-9c3802aa077d",
       {
             "DiscriminatorTypeFirstName": "SigTypeBiometricSignature##FirstName##",
                    "PreferredLastName": true"##LastName##",
              "EMail": "##Email##"
    }
      }
          ]},
          "TransactionCodeConfigurations": [
      "UseTimestamp": false,
    {
            "IsRequiredId": true"",
                "IdHashAlgorithmIdentifier": "1#XyzmoDuplicateIdSeperator#Signature_532f40e1-0583-8285-fc50-c2a76dc2fa44Sha256",
                "DisplayNameTexts": "",[
                "DocRefNumber": 1,{
                "DiscriminatorTypeValue": "Signature"
Please sign the document with the transactionId {tId} with the     }code: {Token}"
            ]
  }
        }
    ]
    }
      },
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagexml
themeEclipse
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagejava
themeEclipse

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
languagexml
themeEclipse

Disposable certificate

<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>
"Key": "fd",
  
<steps>
    
<step>
      
<emailBodyExtra></emailBodyExtra>
      
<orderIndex>1</orderIndex>
  "Value": "My Field Description 
<recipientType>Signer</recipientType>
Text"
    
<useDefaultAgreements>true</useDefaultAgreements>
      
<documentOptions>
        
<documentOption docRef="1">
}
           
<isHidden>false</isHidden>
     ],
   
</documentOption>
      
</documentOptions>
      
<workstepConfiguration
 
skipThirdPartyChecks=
"
0">
AllowedSignatureTypes": [],
        
<WorkstepLabel>test</WorkstepLabel>
        
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
"UseTimestamp": false,
        
<WorkstepTimeToLiveInMinutes>44650</WorkstepTimeToLiveInMinutes>
        
<AbsoluteExpiryDate>2020-07-10T10:57:46.4243017Z</AbsoluteExpiryDate>
"IsRequired": false,
     
<FinishAction>
          
<ClientAction
 
clientName=
"
SIGNificant SignAnywhere
Id": 
closeApp=
"
0
Sig1c",
 
RemoveDocumentFromRecentDocumentList="0"
 
CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
        
</FinishAction>
      "DisplayName": "SignField 
<ViewerPreferences>
1",
          
<SendVisibleArea
 
allowedDomain="*">0</SendVisibleArea>
     
<FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
"DocRefNumber": 1,
        
</ViewerPreferences>
        
<Policy version="1.1.0.0">
"BatchId": "batch",
           
<AdhocPolicies>
     "DiscriminatorType": "Signature"
      
<AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
        }
  
</AdhocPolicies>
          
<GeneralPolicies>
]
          }
     
<AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
   },
        
<AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
"Navigation": {
          
<AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
"HyperLinks": [],
          
<AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
"Links": [],
          
<AllowAdhocSignatures>0</AllowAdhocSignatures>
"LinkTargets": []
        }
    
<AllowAdhocStampings>0</AllowAdhocStampings>
  },
      "DocumentOptions": [
   
<AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
     {
       
<AllowEmailDocument>1</AllowEmailDocument>
   
"DocumentReference": "1",
       
<AllowFinishWorkstep>1</AllowFinishWorkstep>
   "IsHidden": false
        
<AllowPrintDocument>1</AllowPrintDocument>
}
      ],
      
<AllowRejectWorkstep>1</AllowRejectWorkstep>
"UseDefaultAgreements": true
    },
    {
    
<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
  "OrderIndex": 2,
      
<AllowSaveDocument>1</AllowSaveDocument>
"Recipients": [
        
<AllowUndoLastAction>1</AllowUndoLastAction>
{
          
<AllowRotatingPages>0</AllowRotatingPages>
"Email": "##Email##",
          "FirstName": 
<AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
"##FirstName##",
          
</GeneralPolicies>
"LastName": "##LastName##",
          
<WorkstepTasks originalSequenceMode=
"
NoSequenceEnforced
LanguageCode": 
SequenceMode=
"
NoSequenceEnforced
en"
>
,
          
<Task type=
"
SignField
EmailBodyExtra": 
DocRefNumber=
"
1
"
id="1#XyzmoDuplicateIdSeperator#Signature_a3d634d1-5b9e-8089-e77d-4888a9616fb2" internalCompleted="0" finishPercentage="0" completed="0" enabled="1" displayName="" required="1" />
,
          "DisableEmail": false,
          
</WorkstepTasks>
"AddAndroidAppLink": false,
        
</Policy>
  "AddIosAppLink": false,
     
<Navigation
 
/>
    "AddWindowsAppLink": false,
   
<timeCreated>2020-07-10T10:47:46.3930488Z</timeCreated>
       
<TransactionCodeConfigurations>
"AllowDelegation": false,
    
<TransactionCodeConfiguration
 
trConfId="smsAuthTransactionCodeId">
    
</TransactionCodeConfiguration> </TransactionCodeConfigurations>
 "AllowAccessFinishedWorkstep": false,
        
<receiverInformation>
  "SkipExternalDataValidation": false,
       
<userInformation>
   "AuthenticationMethods": []
        
<firstName>##NAME##</firstName>
}
      ],
      
<lastName>##NAME##</lastName>
"EmailBodyExtra": "",
      "RecipientType": "Cc",
     
<eMail>##EMAIL##</eMail>
 "DocumentOptions": [
        
</userInformation>
{
          
<showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
"DocumentReference": "1",
          
<trRsDcNamHolderInformation version=
"
2
IsHidden"
>
: false
        }
      
<recognitionType>PASS</recognitionType>
],
      "UseDefaultAgreements": true
    
<documentIssuedOn>07/07/2020</documentIssuedOn>
}
  ],
  "AddFormFields": {
    "Forms": {}
  
<documentExpiryDate>29/07/2020</documentExpiryDate>
},
  "OverrideFormFieldValues": {
    "Forms": {}
  
<documentIssuedBy>Namirial</documentIssuedBy>
},
  "AttachSignedDocumentsToEnvelopeLog": false
}
}
{
  "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: [
              {}
            ]
          },
          {
            "Id": "otpSignatureSmsText",
            "HashAlgorithmIdentifier": "Sha256",
            "Texts": [
              
            ]
          }
        ],
        "SignatureConfigurations": [],
        "RecipientsViewerPreferences": [{},
        "AuditingToolsConfiguration": {
          "EmailWriteAuditTrail": "##EMAIL##"true,
          "FirstNameNotificationConfiguration": "##NAME##",
{
          }
       "LastName": "##NAME##" },
          "LanguageCodePolicy": "en",{
          "EmailBodyExtraGeneralPolicies": "",{
            "DisableEmailAllowSaveDocument": falsetrue,
            "AddAndroidAppLinkAllowSaveAuditTrail": falsetrue,
            "AddIosAppLinkAllowRotatingPages": falsetrue,
            "AddWindowsAppLinkAllowAppendFileToWorkstep": false,
            "AllowDelegationAllowAppendTaskToWorkstep": false,
            "AllowAccessFinishedWorkstepAllowEmailDocument": falsetrue,
            "SkipExternalDataValidationAllowPrintDocument": falsetrue,
            "AuthenticationMethodsAllowFinishWorkstep": []true,
            "DisposableCertificateDataAllowRejectWorkstep": {true,
            "CountryResidenceAllowRejectWorkstepDelegation": "AT"false,
            "IdentificationCountryAllowUndoLastAction": "AT"true,
            "IdentificationTypeAllowColorizePdfForms": "PASSPORT"false,
            "PhoneMobileAllowAdhocPdfAttachments": "##PHONENUMBER##"true,
            "DocumentTypeAllowAdhocSignatures": "PASS"true,
            "DocumentIssuedByAllowAdhocStampings": "Namirial"true,
            "DocumentIssuedOnAllowAdhocFreeHandAnnotations": "2020-07-07T00:00:00Z"true,
            "DocumentExpiryDateAllowAdhocTypewriterAnnotations": "2020-07-29T00:00:00Z"true,
            "SerialNumberAllowAdhocPictureAnnotations": "1234"true,
            "DocumentNumberAllowAdhocPdfPageAppending": "123"true,
            "OverrideHolderInCaseOfMismatchAllowReloadOfFinishedWorkstep": falsetrue
          },
          "WorkstepTasks": }{
      ],
      "EmailBodyExtraPictureAnnotationMinResolution": ""96,
      "RecipientType": "Signer",
      "WorkstepConfigurationPictureAnnotationMaxResolution": {
300,
            "WorkstepLabelPictureAnnotationColorDepth": "testColor16M",
            "SmallTextZoomFactorPercentSequenceMode": 100"SequenceOnlyRequiredTasks",
            "FinishActionPositionUnits": {"PdfUnits",
            "ServerActionsReferenceCorner": []"Lower_Left",
            "ClientActionsTasks": [
              {
                "RemoveDocumentFromRecentDocumentListPositionPage": false1,
                "CallClientActionOnlyAfterSuccessfulSyncPosition": true,
{
                  "ClientNamePositionX": "SIGNificant SignAnywhere",
           50.0,
   "CloseApp": false,
              "ActionPositionY": "https://www.esignanywhere.net/"
  700.0
          }
          ]},
        },
        "ReceiverInformationSize": {
          "UserInformation": {
            "FirstNameHeight": "##NAME##"54.85714,
            "LastName": "##NAME##",
       "Width": 240.0
     "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>",
          "TransactionCodePushPluginDataAdditionalParameters": []
        },
         "SenderInformation": {
          "UserInformation": {
            "FirstNameKey": "##NAME##enabled",
            "LastName": "##NAME##",
            "EMailValue": "##EMAIL##1"
          }
        },
        "TransactionCodeConfigurations": [
          {
                    "IdKey": "smsAuthTransactionCodeIdcompleted",
                    "HashAlgorithmIdentifierValue": "Sha2560",
            "Texts": [
     },
         {
         {
     }
            ]
   "Key": "sigType",
      }
        ],
        "SignatureConfigurationsValue": [],
"GenericSigningPlugin"
         "ViewerPreferences": {
         },
      "FinishWorkstepOnOpen": false,
          "VisibleAreaOptions": {
            "AllowedDomain        "Key": "*genericSigningPluginId",
                    "EnabledValue": false"GenericSigningPluginForTests"
          }
        },
        "ResourceUris": {},
        "AuditingToolsConfiguration": {
          "WriteAuditTrail": false,
          "NotificationConfigurationKey": {}
"positioning",
            },
        "PolicyValue": {"onPage"
          "GeneralPolicies": {
            "AllowSaveDocument": true},
            "AllowSaveAuditTrail": true,
     {
       "AllowRotatingPages": false,
            "AllowEmailDocumentKey": true"ly",
            "AllowPrintDocument": true,
       "Value": "remoteCertificate"
    "AllowFinishWorkstep": true,
            "AllowRejectWorkstep": true},
            "AllowRejectWorkstepDelegation": false,
     {
       "AllowUndoLastAction": true,
            "AllowAdhocPdfAttachmentsKey": false"fd",
            "AllowAdhocSignatures": false,
       "Value": "My    "AllowAdhocStampings": false,Field Description Text"
            "AllowAdhocFreeHandAnnotations": false,
      }
      "AllowAdhocTypewriterAnnotations": false,
         ],
   "AllowAdhocPictureAnnotations": false,
            "AllowAdhocPdfPageAppendingAllowedSignatureTypes": false[],
          },
          "WorkstepTasksUseTimestamp": {
false,
                "PictureAnnotationMinResolutionIsRequired": 0false,
                "PictureAnnotationMaxResolutionId": 0"Sig1a",
                "PictureAnnotationColorDepthDisplayName": "Color16MSignField 1",
                "SequenceModeDocRefNumber": "NoSequenceEnforced"1,
                "PositionUnitsBatchId": "PdfUnitsbatch",
                "ReferenceCornerDiscriminatorType": "Lower_LeftSignature",
            "Tasks": [  },
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 8950.0,
                  "PositionY": 575600.0
                },
                "Size": {
                  "Height": 8054.085714,
                  "Width": 190240.0
                },
                "AdditionalParameters": [
                  {
                    "Key": "enabled",
                    "Value": "1"
                  },
                  {
                    "Key": "positioningcompleted",
                    "Value": "onPage0"
                  },
                  {
                    "Key": "reqsigType",
                    "Value": "1GenericSigningPlugin"
                  },
                  {
                    "Key": "fdgenericSigningPluginId",
                    "Value": "GenericSigningPluginForTests"
                  },
                  {
                    "Key": "fd_dateformatpositioning",
                    "Value": "dd-MM-yyyy HH:mm:ssonPage"
                  },
                  {
                    "Key": "fd_timezonely",
                    "Value": "datetimeutcremoteCertificate"
                  },
                  {
                    "Key": "spcIdfd",
                    "Value": "padesSigningId"
My Field                 }
                ],
                "AllowedSignatureTypes": [
          Description Text"
        {
                    "TrModType": "RemoteSignatureDisposableCertificate",
                    "TrValidityInSeconds": 300,
                    "Ly": "remoteCertificate",
           }
           "TrConfIdIssueCertificate": "disposableCertificateEnrolAndSignSmsText",
    ],
                "TrConfIdAllowedSignatureTypes": "remoteCertificateSignSmsText"[],
                    "IsPhoneNumberRequiredUseTimestamp": false,
                    "IdIsRequired": "180c4201-4146-4161-baf8-cb5a607eec62"false,
                    "DiscriminatorTypeId": "SigTypeTransactionCodeSig1b",
                    "PreferredDisplayName": "SignField false1",
                    "StampImprintConfigurationDocRefNumber": {
    1,
                  "DisplayExtraInformationBatchId": true"batch",
                      "DisplayEmailDiscriminatorType": true,"Signature"
               },
       "DisplayIp": true,
      {
                "DisplayNamePositionPage": true1,
                      "DisplaySignatureDatePosition": true,{
                      "FontFamilyPositionX": "Times New Roman"50.0,
                      "FontSizePositionY": 11500.0
                },
    }
            "Size": {
     }
             "Height": 54.85714,
  ],
                "UseTimestampWidth": false,240.0
                "IsRequired": true},
                "IdAdditionalParameters": "1#XyzmoDuplicateIdSeperator#Signature_b58c192b-47c0-5339-cb18-4fe77c3d1812",[
                "DisplayName": "",
  {
                    "DocRefNumberKey": 1"enabled",
                    "DiscriminatorTypeValue": "Signature1"
                  },
            ]
      {
    }
        },
        "NavigationKey": {"completed",
          "HyperLinks": [],
          "LinksValue": [],"0"
          "LinkTargets": []
        },
           },
      "DocumentOptions": [{
          {
          "DocumentReferenceKey": "1sigType",
          "IsHidden": false
           }
"Value": "GenericSigningPlugin"
       ],
      "UseDefaultAgreements": true
    },
    {
      "OrderIndex": 2,
      "Recipients": [{
          {
          "EmailKey": "##EMAIL##genericSigningPluginId",
          "FirstName": "##NAME##",
          "LastNameValue": "##NAME##GenericSigningPluginForTests",
             "LanguageCode": "en",
    },
      "EmailBodyExtra": "",
          "DisableEmail": false, {
          "AddAndroidAppLink": false,
          "AddIosAppLinkKey": false"positioning",
          "AddWindowsAppLink": false,
          "AllowDelegationValue": false,"onPage"
          "SkipExternalDataValidation": false        },
          "AuthenticationMethods": []
        }{
      ],
       "EmailBodyExtra": "",
      "RecipientTypeKey": "Ccly",
      "DocumentOptions": [],
      "UseDefaultAgreements": false
    }
  ],
  "AddFormFieldsValue": {"remoteCertificate"
    "Forms": {}
    },
  "OverrideFormFieldValues": {
    "Forms": {}
  },
  "AttachSignedDocumentsToEnvelopeLog": false
}
}
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagexml
themeEclipse


Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<envelope>
   <name>eSignAnyWhere Tutorial</name>
   <eMailSubject>Document of eSignAnyWhere   <documentNumber>123<Tutorial</documentNumber>eMailSubject>
   <eMailBody>Dear #RecipientFirstName#! Please sign this tutorial document.</eMailBody>
   <countryResidence>AT<<enableReminders>True</countryResidence>enableReminders>
   <firstReminderDayAmount>1</firstReminderDayAmount>
   <recurrentReminderDayAmount>1</recurrentReminderDayAmount>
   <beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
   <firstName>##NAME##<<daysUntilExpire>2</firstName>daysUntilExpire>
   <callbackUrl />
   <steps>
      <lastName>##NAME##</lastName><step>
           <emailBodyExtra <email>##EMAIL##</email>>
            <phoneMobile>##PHONENUMBER##</phoneMobile><orderIndex>1</orderIndex>
            <identificationType>PASSPORT</identificationType><recipientType>Signer</recipientType>
            <identificationCountry>AT</identificationCountry><recipients>
            <passport>123</passport><recipient>
          </trRsDcNamHolderInformation>
        <<languageCode>en</receiverInformation>languageCode>
        <senderInformation>
       <eMail>##Email##</eMail>
   <userInformation>
            <firstName>##NAME##<<firstName>##FirstName##</firstName>
              <lastName>##NAME##< <lastName>##LastName##</lastName>
              <eMail>##EMAIL##</eMail>
            </userInformation>recipient>
         </senderInformation>recipients>
       <workstepConfiguration <pdfForms isEditingAllowedskipThirdPartyChecks="0">
  <WorkstepLabel />
  <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
  <WorkstepTimeToLiveInMinutes>900</WorkstepTimeToLiveInMinutes>
  <FinishAction>
  <TypewriterAnnotationTaskInfo </>FinishAction>
  <signatureTemplate>
      <attachmentFields /><version>1.2.0.2</version>
    <positionUnits>PdfUnits</positionUnits>
    <signatureTemplate><positionReferenceCorner>Lower_Left</positionReferenceCorner>
    <sig id="Sig1a">
      <version>1.2.0.2</version><positionPage>1</positionPage>
      <DocRefNumber>1</DocRefNumber>
    <positionReferenceCorner>Lower_Left</positionReferenceCorner>
  <positionX>50</positionX>
      <positionY>700</positionY>
      <positionUnits>PdfUnits<<width>240</positionUnits>width>
      <height>54.85714</height>
      <sig<param idname="1#XyzmoDuplicateIdSeperator#Signature_a3d634d1-5b9e-8089-e77d-4888a9616fb2">enabled">1</param>
      <param name="completed">0</param>
      <TaskDisplayName /><param name="sigType">GenericSigningPlugin</param>
      <param name="genericSigningPluginId">GenericSigningPluginForTests</param>
      <param name="enabledpositioning">1<>onPage</param>
      <param name="ly">remoteCertificate</param>
     <positionPage>1</positionPage>
 <param name="fd">My Field Description Text</param>
       <positionX>78</positionX></sig>
    <sig id="Sig1b">
       <positionY>545<<positionPage>1</positionY>positionPage>
      <DocRefNumber>1</DocRefNumber>
      <width>190<<positionX>50</width>positionX>
      <positionY>600</positionY>
      <height>80<<width>240</height>width>
      <height>54.85714</height>
      <param name="positioningenabled">onPage<>1</param>
            <param name="reqcompleted">1<>0</param>
            <param name="fdsigType" >GenericSigningPlugin</>param>
            <param name="fd_dateformat">dd-MM-yyyy HH:mm:ss<genericSigningPluginId">GenericSigningPluginForTests</param>
            <param name="fd_timezonepositioning">datetimeutc<>onPage</param>
            <DocRefNumber>1</DocRefNumber><param name="ly">remoteCertificate</param>
      <param name="fd">My Field    <AllowedSignatureTypes>Description Text</param>
    </sig>
          <sigType <sig id="89f2876e-2149-4a88-b841-547a1b3478a5" type="TransactionCodeSig1c">
      <positionPage>1</positionPage>
      <DocRefNumber>1</DocRefNumber>
      <trModType>RemoteSignatureDisposableCertificate<<positionX>50</trModType>positionX>
      <positionY>500</positionY>
      <width>240</width>
      <trValidityInSeconds>300<<height>54.85714</trValidityInSeconds>height>
      <param name="enabled">1</param>
         <ly>remoteCertificate</ly>
  <param name="completed">0</param>
      <param name="sigType">GenericSigningPlugin</param>
       <trConfIdIssueCertificate>disposableCertificateEnrolAndSignSmsText</trConfIdIssueCertificate><param name="genericSigningPluginId">GenericSigningPluginForTests</param>
      <param name="positioning">onPage</param>
         <trConfId>remoteCertificateSignSmsText</trConfId><param name="ly">remoteCertificate</param>
      <param name="fd">My Field Description Text</param>
    </sig>
  <StampImprintConfiguration></signatureTemplate>
  <receiverInformation>
    <userInformation>
      <firstName>##FirstName##</firstName>
      <DisplayExtraInformation>1<<lastName>##LastName##</DisplayExtraInformation>lastName>
      <eMail>##Email##</eMail>
    </userInformation>
    <genericSigningPluginData pluginId="GenericSigningPluginForTests">
    <DisplayEmail>1</DisplayEmail>
  <senderDataFields>
      </senderDataFields>
    </genericSigningPluginData>
  </receiverInformation>
  <pdfForms isEditingAllowed="1" <DisplayIp>1</DisplayIp>>
  <attachmentFields />
  <PictureAnnotationTaskInfo>
    <MinResolution>96</MinResolution>
    <MaxResolution>300</MaxResolution>
     <DisplayName>1<<ColorDepth>Color16M</DisplayName>ColorDepth>
  </PictureAnnotationTaskInfo>
  <TypewriterAnnotationTaskInfo />
  <Policy version="1.1.0.0">
    <GeneralPolicies>
      <DisplaySignatureDate>1<<AllowSaveDocument>1</DisplaySignatureDate>AllowSaveDocument>
      <AllowSaveAuditTrail>1</AllowSaveAuditTrail>
      <AllowRotatingPages>1</AllowRotatingPages>
      <FontFamily>Times New Roman</FontFamily><AllowAppendFileToWorkstep>0</AllowAppendFileToWorkstep>
      <AllowAppendTasksToWorkstep>0</AllowAppendTasksToWorkstep>
      <AllowEmailDocument>1</AllowEmailDocument>
      <FontSize>11<<AllowPrintDocument>1</FontSize>AllowPrintDocument>
      <AllowFinishWorkstep>1</AllowFinishWorkstep>
          </StampImprintConfiguration><AllowRejectWorkstep>1</AllowRejectWorkstep>
      <AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation>
        <<AllowUndoLastAction>1</sigType>AllowUndoLastAction>
      <AllowColorizePdfForms>0</AllowColorizePdfForms>
      <<AllowReloadOfFinishedWorkstep>1</AllowedSignatureTypes>AllowReloadOfFinishedWorkstep>
      <AllowAdhocPdfAttachments>1</AllowAdhocPdfAttachments>
      <param name="spcId">padesSigningId</param><AllowAdhocSignatures>1</AllowAdhocSignatures>
          </sig><AllowAdhocStampings>1</AllowAdhocStampings>
        <<AllowAdhocFreeHandAnnotations>1</signatureTemplate>AllowAdhocFreeHandAnnotations>
        <AuditingToolsConfiguration WriteAuditTrail="0">
<AllowAdhocTypewriterAnnotations>1</AllowAdhocTypewriterAnnotations>
      <AllowAdhocPictureAnnotations>1</AllowAdhocPictureAnnotations>
     <NotificationConfiguration <AllowAdhocPdfPageAppending>1</>AllowAdhocPdfPageAppending>
        </AuditingToolsConfiguration>GeneralPolicies>
        <resourceUris><WorkstepTasks SequenceMode="SequenceOnlyRequiredTasks">
      <Task enabled="1" completed="0"  <delegationUri>https://demo.esignanywhere.net/Resource/Delegate</delegationUri>
        </resourceUris>required="0" id="Sig1a" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" batchId="batch" />
      <Task  <LoggingMetaInformation>
          <envelopeId>##ENVELOPEID##</envelopeId>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"  <envelopeRecipientId>##RECIPIENTID##</envelopeRecipientId>
        </LoggingMetaInformation>required="0" id="Sig1c" displayName="SignField 1" DocRefNumber="1" type="SignField" internalAllConcernedDocRefNumbersList="1" allRequiredFieldsFilledOnWorkstepCreation="0" batchId="batch" />
      </workstepConfiguration>WorkstepTasks>
      <recipients><AdhocPolicies>
        <recipient><AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
    </AdhocPolicies>
  </Policy>
   <Navigation <eMail>##EMAIL##</eMail>>
  <timeCreated>2020-07-08T08:17:01.0948544Z</timeCreated>
  <signaturePluginConfiguration>
      <emailBodyExtra></emailBodyExtra><PdfSignatureProperties_V1>
          <firstName>##NAME##</firstName><PdfAConformant>0</PdfAConformant>
      <ValidateSigningCertificateName    <lastName>##NAME##</lastName>regex="(?<LastName>.*) (?<FirstName>.*)">0</ValidateSigningCertificateName>
          <languageCode>en</languageCode><ValidateSigningCertificateViaEutl>0</ValidateSigningCertificateViaEutl>
          <disableEmail>false</disableEmail><PAdESPart4Compliant>0</PAdESPart4Compliant>
          <skipExternalDataValidation>false</skipExternalDataValidation><IncludeSigningCertificateChain>0</IncludeSigningCertificateChain>
          <addAndroidAppLink>false</addAndroidAppLink><SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
          <addIosAppLink>false</addIosAppLink><SignatureTimestampData>
         <Password <addWindowsAppLink>false</addWindowsAppLink>>
          <allowDelegation>true<<SignatureHashAlgorithm>SHA1</allowDelegation>SignatureHashAlgorithm>
        <Uri  <allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>>
        <UserName  <authentications />
      </SignatureTimestampData>
    <disposableCertificateAdditionalInformation></PdfSignatureProperties_V1>
     <PdfSignatureCryptographicData_V1>
       <countryResidence>AT<<SignatureHashAlgorithm>Sha256</countryResidence>SignatureHashAlgorithm>
      <SigningCertificateDescriptor>
      <phoneMobile>##PHONENUMBER##<  <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</phoneMobile>Identifier>
            <documentType>PASS</documentType><Type>Sha1Thumbprint</Type>
            <documentIssuedBy>Namirial</documentIssuedBy><Csp>Default</Csp>
      </SigningCertificateDescriptor>
    </PdfSignatureCryptographicData_V1>
  <documentIssuedOn>2020-07-07T00:00:00Z</documentIssuedOn></signaturePluginConfiguration>
  <AuditingToolsConfiguration WriteAuditTrail="1">
    <NotificationConfiguration>
    </NotificationConfiguration>
  <documentExpiryDate>2020-07-29T00:00:00Z</documentExpiryDate></AuditingToolsConfiguration>
  <TransactionCodeConfigurations>
    <TransactionCodeConfiguration trConfId="">
     <serialNumber>123</serialNumber>
 <Message>Please sign the document with the transactionId {tId} with the  <identificationType>PASSPORT</identificationType>code: {Token}</Message>
      <hashAlgorithmIdentifier>Sha256</hashAlgorithmIdentifier>
      <identificationCountry>AT<</identificationCountry>TransactionCodeConfiguration>
    <TransactionCodeConfiguration trConfId="Trans1">
      <Message>Please <documentNumber>123</documentNumber>
accept the transactionId {tId} with the code: {Token}</Message>
     <overrideOnHolderMismatch>false< <hashAlgorithmIdentifier>Sha256</overrideOnHolderMismatch>hashAlgorithmIdentifier>
    </TransactionCodeConfiguration>
      </disposableCertificateAdditionalInformation><TransactionCodeConfiguration trConfId="IdentityServerMail">
      <Subject>Message for <TransactionCode</recipient>Subject>
      <<FromAddress>##Email##</recipients>FromAddress>
    </step>
  <TextBody>Please accept <step>
the transactionId {tId} with the  <emailBodyExtra></emailBodyExtra>code: {Token}</TextBody>
      <orderIndex>2</orderIndex>
      <recipientType>Cc<<hashAlgorithmIdentifier>Sha256</recipientType>hashAlgorithmIdentifier>
    </TransactionCodeConfiguration>
  <useDefaultAgreements>false</useDefaultAgreements></TransactionCodeConfigurations>
</workstepConfiguration>
      <recipients></step>
        <recipient><step>
         <emailBodyExtra <eMail>##EMAIL##</eMail>>
          <emailBodyExtra><<orderIndex>2</emailBodyExtra>orderIndex>
          <firstName>##NAME##<<recipientType>CC</firstName>recipientType>
          <lastName>##NAME##</lastName><recipients>
          <languageCode>en</languageCode>
  <recipient>
        <disableEmail>false</disableEmail>
          <skipExternalDataValidation>false<<languageCode>en</skipExternalDataValidation>languageCode>
          <addAndroidAppLink>false</addAndroidAppLink>
     <eMail>##Email##</eMail>
     <addIosAppLink>false</addIosAppLink>
          <addWindowsAppLink>false<<firstName>##FirstName##</addWindowsAppLink>firstName>
          <allowDelegation>false</allowDelegation>
     <lastName>##LastName##</lastName>
     <authentications />
        </recipient>
         </recipients>
      </step>
   </steps>
  <attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</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
languagejava
themeEclipse
{
              "Method": "Pin",
              "Parameter": "1234"
}

...

Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<authentications>
<authentication>
<method>Pin</method>
<parameter>1234</parameter>
</authentication>
</authentications>


SMS-authentication

Code Block
languagejava
themeEclipse
{
              "Method": "Sms",
              "Parameter": "+0123456789"
}

...

Expand
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
 <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
languagejava
themeEclipse
 "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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<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
languagejava
themeEclipse
{
                    "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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
 <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
languagejava
themeEclipse
{
                    "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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<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
languagejava
themeEclipse
{
                    "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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
 <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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
<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
languagejava
themeEclipse
{
                    "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
languagejava
themeEclipse
{
          "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
titleAlternative: 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 Image Added

...

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:

Code Block
languagejava
themeEclipse
 "Tasks": [
              {
                "PositionPage": 1,
                "AllPages": falsetrue,
                "AllDocuments": truefalse,
                "Position": {                   "PositionX": 50.0,
                  "PositionY": 100.0
                },
                "Size": {
                  "Height": 40.0,
                  "Width": 400.0
                },
                "IsRequired": true,
                "Id": "847a3d4a-da2c-46f4-8c8c-a9edaa06c29b",
                "DisplayName": "your text for this task",
                "DocRefNumber": 1,
                "DiscriminatorType": "ReadingTask"
              },
              {
                "PositionPage": 1,
                "Position": {
                  "PositionX": 80.22857,
                  "PositionY": 158.8629
                },
                "Size": {
                  "Height": 68.57143,
                  "Width": 171.4286
                },
                
                "AllowedSignatureTypes": [],
                "UseTimestamp": false,
                "IsRequired": true,
                "Id": "93cce567-ae5c-4e98-ac99-9f56ac034250",
                "DisplayName": "SignField 1",
                "DocRefNumber": 1,
                "DiscriminatorType": "Signature"
              }
            ]

...

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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
 <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
titleAlternative: SOAP implementation (deprecated)


Code Block
languagexml
themeEclipse
  <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.

...