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.

...

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

Disposable certificate

...

Info
titleNeeds Rework

Requires an update regarding (minor) changes in the API - difference between traditional and lean disposable

...

titleAdditional Scenario

...

SMS-OTP

Code Block
languagejava
themeEclipse
{
  "SspFileIdsWorkstepTasks": [{
     "##FILE_ID##"
  ],
  "SendEnvelopeDescription": {
  "NamePictureAnnotationMinResolution": "test"0,
     "EmailSubject": "Please sign the enclosed envelope",
  "EmailBodyPictureAnnotationMaxResolution": "Dear0,
 #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
  "DisplayedEmailSenderPictureAnnotationColorDepth": "Color16M",
     "EnableReminders": true,
       "FirstReminderDayAmountSequenceMode": 5"NoSequenceEnforced",
  "RecurrentReminderDayAmount": 3,
    "BeforeExpirationDayAmount": 3,
  "DaysUntilExpire": 28,
  "CallbackUrlPositionUnits": "PdfUnits",
   "StatusUpdateCallbackUrl         "ReferenceCorner": "Lower_Left",
         "LockFormFieldsAtEnvelopeFinish": true,
  "StepsTasks": [
              {
        "OrderIndex": 1,
        "RecipientsTexts": [
        {
          "Email": "##EMAIL##",{
          "FirstName": "##NAME##",
          "LastNameLanguage": "##NAME##en",
          "LanguageCode": "en",
          "EmailBodyExtraValue": "Signature Disclosure Text",
            "DisableEmail": false,
      },
      "AddAndroidAppLink": false,
          "AddIosAppLink": false, {
          "AddWindowsAppLink": false,
          "AllowDelegationLanguage": false"*",
          "AllowAccessFinishedWorkstep": false,
          "SkipExternalDataValidationValue": false, "Signature Disclosure Text"
          "AuthenticationMethods": [],
       }
   "DisposableCertificateData": {
            "CountryResidence": "AT"],
                "IdentificationCountryHeadings": "AT",[
            "IdentificationType": "PASSPORT",
     {
       "PhoneMobile": "##PHONENUMBER##",
            "DocumentTypeLanguage": "PASSen",
                    "DocumentIssuedByValue": "NamirialSignature Disclosure Subject",
             "DocumentIssuedOn": "2020-07-07T00:00:00Z"     },
            "DocumentExpiryDate": "2020-07-29T00:00:00Z",
     {
       "SerialNumber": "1234",
            "DocumentNumberLanguage": "123*",
            "OverrideHolderInCaseOfMismatch": false
       "Value": "Signature Disclosure }
Subject"
                  }
                ],
      "EmailBodyExtra": "",
          "RecipientTypeIsRequired": "Signer"false,
       "WorkstepConfiguration": {
        "WorkstepLabelId": "testra",
        "SmallTextZoomFactorPercent": 100,
        "FinishActionDisplayName": {"ra",
          "ServerActions      "DocRefNumber": []1,
                "ClientActionsDiscriminatorType": ["Agreements"
              {},
              "RemoveDocumentFromRecentDocumentList": false,
{
                "CallClientActionOnlyAfterSuccessfulSyncPositionPage": true1,
                "ClientNamePosition": "SIGNificant SignAnywhere",
{
                  "CloseAppPositionX": false52.0,
                  "ActionPositionY": "https://www.esignanywhere.net/"586.0
            }
          ]},
        },
        "ReceiverInformationSize": {
          "UserInformation": {
            "FirstNameHeight": "##NAME##"80.0,
            "LastName": "##NAME##",
     "Width": 190.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",
            "HashAlgorithmIdentifier        "Value": "Sha2560",
            "Texts": [
      },
                  {
              }
      "Key": "req",
     ]
          }
     "Value": "1"
   ],
         "SignatureConfigurations": [],
     },
   "ViewerPreferences": {
          "FinishWorkstepOnOpen": false,
   {
       "VisibleAreaOptions": {
            "AllowedDomainKey": "*isPhoneNumberRequired",
                    "EnabledValue": false"0"
          }
        },
        "ResourceUris": {},
        "AuditingToolsConfiguration": {
          "WriteAuditTrail": false,
          "NotificationConfigurationKey": {}
"trValidityInSeconds",
         },
           "PolicyValue": {"60"
          "GeneralPolicies": {
            "AllowSaveDocument": true},
            "AllowSaveAuditTrail": true,
     {
       "AllowRotatingPages": false,
            "AllowEmailDocumentKey": true"fd",
            "AllowPrintDocument": true,
       "Value": ""
    "AllowFinishWorkstep": true,
            "AllowRejectWorkstep": true},
            "AllowRejectWorkstepDelegation": false,
     {
       "AllowUndoLastAction": true,
            "AllowAdhocPdfAttachmentsKey": false"fd_dateformat",
            "AllowAdhocSignatures": false,
        "Value": "dd-MM-yyyy HH:mm:ss"
    "AllowAdhocStampings": false,
            "AllowAdhocFreeHandAnnotations": false},
            "AllowAdhocTypewriterAnnotations": false,
     {
       "AllowAdhocPictureAnnotations": false,
            "AllowAdhocPdfPageAppendingKey": false"fd_timezone",
          },
          "WorkstepTasksValue": {"datetimeutc"
            "PictureAnnotationMinResolution": 0,
     }
       "PictureAnnotationMaxResolution": 0,
         ],
   "PictureAnnotationColorDepth": "Color16M",
            "SequenceModeAllowedSignatureTypes": "NoSequenceEnforced",[
             "PositionUnits": "PdfUnits",
    {
        "ReferenceCorner": "Lower_Left",
            "TasksTrModType": ["TransactionCodeSenderPlugin",
              {
                "PositionPage"TrValidityInSeconds": 1300,
                    "PositionTrConfId": {"otpSignatureSmsText",
                    "PositionXIsPhoneNumberRequired": 89.0false,
                    "PositionYLy": 575.0"simpleTransactionCodeSms",
                },
    "Id": "c787919a-b2fd-4849-8f97-98dee281da30",
                    "SizeDiscriminatorType": {"SigTypeTransactionCode",
                    "HeightPreferred": 80.0false,
                    "WidthStampImprintConfiguration": 190.0{
                },
      "DisplayExtraInformation": true,
         "AdditionalParameters": [
              "DisplayEmail": true,
    {
                    "KeyDisplayIp": "enabled"true,
                      "ValueDisplayName": "1"true,
                  },
                  {
"DisplaySignatureDate": true,
                      "KeyFontFamily": "positioningTimes New Roman",
                      "ValueFontSize": "onPage"11.0,
                  },
      "OverrideLegacyStampImprint": false,
            {
                    "Key"DisplayTransactionId": "req"true,
                      "ValueDisplayTransaktionToken": "1"true,
                  },
    "DisplayPhoneNumber": true
                   { },
                    "KeySignaturePluginConfigurationId": "fdltaLevelId",
                    "Value": ""}
                  }],
                  {"UseTimestamp": false,
                    "KeyIsRequired": "fd_dateformat"true,
                    "ValueId": "dd-MM-yyyy HH:mm:ss"1#XyzmoDuplicateIdSeperator#Signature_e7ca3f6a-33fa-cdba-d696-1377fcad51c9",
                  }"DisplayName": "",
                  {"DocRefNumber": 1,
                    "KeyDiscriminatorType": "fd_timezoneSignature",
              }
      "Value": "datetimeutc"
     ]
          },

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

<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>
[
                  {
                    "Language": "en",
            
<emailBodyExtra></emailBodyExtra>
      
<orderIndex>1</orderIndex>
  "Value": "Signature 
<recipientType>Signer</recipientType>
Disclosure Text"
      
<useDefaultAgreements>true</useDefaultAgreements>
      
<documentOptions>
      
<documentOption docRef="1">
},
          
<isHidden>false</isHidden>
        
</documentOption>
{
      
</documentOptions>
      
<workstepConfiguration
 
skipThirdPartyChecks="0">
       
<WorkstepLabel>test</WorkstepLabel>
"Language": "*",
        
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
        
<WorkstepTimeToLiveInMinutes>44650</WorkstepTimeToLiveInMinutes>
    "Value": "Signature 
<AbsoluteExpiryDate>2020-07-10T10:57:46.4243017Z</AbsoluteExpiryDate>
Disclosure Text"
        
<FinishAction>
          
<ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
}
             
</FinishAction>
   ],
     
<ViewerPreferences>
          
<SendVisibleArea
 
allowedDomain=
"
*">0</SendVisibleArea>
Headings": [
          
<FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
        
</ViewerPreferences>
{
        
<Policy version="1.1.0.0">
            
<AdhocPolicies>
"Language": "en",
            
<AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
        "Value": "Signature Disclosure 
</AdhocPolicies>
Subject"
          
<GeneralPolicies>
        },
   
<AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
            
<AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
   {
         
<AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
           
<AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
"Language": "*",
            
<AllowAdhocSignatures>0</AllowAdhocSignatures>
        "Value": "Signature 
<AllowAdhocStampings>0</AllowAdhocStampings>
Disclosure Subject"
            
<AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
      }
      
<AllowEmailDocument>1</AllowEmailDocument>
          ],
  
<AllowFinishWorkstep>1</AllowFinishWorkstep>
            
<AllowPrintDocument>1</AllowPrintDocument>
  "IsRequired": false,
         
<AllowRejectWorkstep>1</AllowRejectWorkstep>
       "Id": "ra",
    
<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
            
<AllowSaveDocument>1</AllowSaveDocument>
"DisplayName": "ra",
            
<AllowUndoLastAction>1</AllowUndoLastAction>
    "DocRefNumber": 1,
       
<AllowRotatingPages>0</AllowRotatingPages>
         "DiscriminatorType": "Agreements"
  
<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=
"PositionPage": 
required="1" />
1,
          
</WorkstepTasks>
      "Position": {
 
</Policy>
        
<Navigation
 
/>
        
<timeCreated>2020-07-10T10:47:46.3930488Z</timeCreated>
"PositionX": 52.0,
        
<TransactionCodeConfigurations>
    
<TransactionCodeConfiguration
 
trConfId="smsAuthTransactionCodeId">
    
</TransactionCodeConfiguration> </TransactionCodeConfigurations>
 "PositionY": 586.0
      
<receiverInformation>
          
<userInformation>
},
            
<firstName>##NAME##</firstName>
    "Size": {
       
<lastName>##NAME##</lastName>
           
<eMail>##EMAIL##</eMail>
"Height": 80.0,
          
</userInformation>
        
<showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
"Width": 190.0
        
<trRsDcNamHolderInformation
 
version="2">
       },
     
<recognitionType>PASS</recognitionType>
           
<documentIssuedOn>07/07/2020</documentIssuedOn>
"AdditionalParameters": [
            
<documentExpiryDate>29/07/2020</documentExpiryDate>
      {
      
<documentIssuedBy>Namirial</documentIssuedBy>
            
<documentNumber>123</documentNumber>
  "Key": "enabled",
         
<countryResidence>AT</countryResidence>
           
<firstName>##NAME##</firstName>
"Value": "1"
            
<lastName>##NAME##</lastName>
      },
      
<email>##EMAIL##</email>
            
<phoneMobile>##PHONENUMBER##</phoneMobile>
{
            
<identificationType>PASSPORT</identificationType>
        "Key": "completed",
   
<identificationCountry>AT</identificationCountry>
            
<passport>123</passport>
     "Value": "0"
    
</trRsDcNamHolderInformation>
        
</receiverInformation>
      
<senderInformation>
},
         
<userInformation>
         
<firstName>##NAME##</firstName>
{
            
<lastName>##NAME##</lastName>
        "Key": "req",
   
<eMail>##EMAIL##</eMail>
          
</userInformation>
       
</senderInformation>
"Value": "1"
        
<pdfForms
 
isEditingAllowed="0"
 
/>
        
<TypewriterAnnotationTaskInfo />
},
         
<attachmentFields
 
/>
        
<signatureTemplate>
{
          
<version>1.2.0.2</version>
          
<positionReferenceCorner>Lower_Left</positionReferenceCorner>
"Key": "isPhoneNumberRequired",
          
<positionUnits>PdfUnits</positionUnits>
          
<sig id="1#XyzmoDuplicateIdSeperator#Signature_a3d634d1-5b9e-8089-e77d-4888a9616fb2">
"Value": "0"
            
<TaskDisplayName
 
/>
     },
       
<param
 
name="enabled">1</param>
          
<positionPage>1</positionPage>
{
            
<positionX>78</positionX>
        "Key": "trValidityInSeconds",
   
<positionY>545</positionY>
            
<width>190</width>
     "Value": "60"
      
<height>80</height>
            
<param name="positioning">onPage</param>
},
            
<param
 
name="req">1</param>
     {
       
<param
 
name="fd"
 
/>
           
<param name=
"Key": "fd
_dateformat">dd-MM-yyyy HH:mm:ss</param>
",
              
<param
 
name="fd_timezone">datetimeutc</param>
     "Value": ""
      
<DocRefNumber>1</DocRefNumber>
            
<AllowedSignatureTypes>
},
                
<sigType
 
id="89f2876e-2149-4a88-b841-547a1b3478a5" type="TransactionCode">
 {
                
<trModType>RemoteSignatureDisposableCertificate</trModType>
    "Key": "fd_dateformat",
           
<trValidityInSeconds>300</trValidityInSeconds>
         "Value": "dd-MM-yyyy HH:mm:ss"
     
<ly>remoteCertificate</ly>
             },
  
<trConfIdIssueCertificate>disposableCertificateEnrolAndSignSmsText</trConfIdIssueCertificate>
                
<trConfId>remoteCertificateSignSmsText</trConfId>
{
                
<StampImprintConfiguration>
    "Key": "fd_timezone",
                  
<DisplayExtraInformation>1</DisplayExtraInformation>
  "Value": "datetimeutc"
                  
<DisplayEmail>1</DisplayEmail>
}
                
<DisplayIp>1</DisplayIp>
],
                
<DisplayName>1</DisplayName>
"AllowedSignatureTypes": [
                  
<DisplaySignatureDate>1</DisplaySignatureDate>
{
                  
<FontFamily>Times New Roman</FontFamily>
  "TrModType": "TransactionCodeSenderPlugin",
                   
<FontSize>11</FontSize>
 "TrValidityInSeconds": 300,
                
</StampImprintConfiguration>
    "TrConfId": "otpSignatureSmsText",
         
</sigType>
           
</AllowedSignatureTypes>
"IsPhoneNumberRequired": false,
            
<param name="spcId">padesSigningId</param>
        "Ly": "simpleTransactionCodeSms",
    
</sig>
        
</signatureTemplate>
        
<AuditingToolsConfiguration WriteAuditTrail="0">
"Id": "c787919a-b2fd-4849-8f97-98dee281da30",
          
<NotificationConfiguration
  
/>
        
</AuditingToolsConfiguration>
"DiscriminatorType": "SigTypeTransactionCode",
         
<resourceUris>
           
<delegationUri>https://demo.esignanywhere.net/Resource/Delegate</delegationUri>
"Preferred": false,
        
</resourceUris>
        
<LoggingMetaInformation>
    "StampImprintConfiguration": {
     
<envelopeId>##ENVELOPEID##</envelopeId>
          
<envelopeRecipientId>##RECIPIENTID##</envelopeRecipientId>
       
</LoggingMetaInformation>
"DisplayExtraInformation": true,
      
</workstepConfiguration>
         
<recipients>
       
<recipient>
"DisplayEmail": true,
          
<eMail>##EMAIL##</eMail>
          
<emailBodyExtra></emailBodyExtra>
  
"DisplayIp": true,
      
<firstName>##NAME##</firstName>
          
<lastName>##NAME##</lastName>
      "DisplayName": true,
   
<languageCode>en</languageCode>
          
<disableEmail>false</disableEmail>
         
<skipExternalDataValidation>false</skipExternalDataValidation>
"DisplaySignatureDate": true,
          
<addAndroidAppLink>false</addAndroidAppLink>
          
<addIosAppLink>false</addIosAppLink>
  "FontFamily": "Times New Roman",
     
<addWindowsAppLink>false</addWindowsAppLink>
          
<allowDelegation>true</allowDelegation>
       "FontSize": 11.0,
  
<allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
          
<authentications
 
/>
         
<disposableCertificateAdditionalInformation>
"OverrideLegacyStampImprint": false,
            
<countryResidence>AT</countryResidence>
          "DisplayTransactionId": true,
         
<phoneMobile>##PHONENUMBER##</phoneMobile>
            
<documentType>PASS</documentType>
 "DisplayTransaktionToken": true,
          
<documentIssuedBy>Namirial</documentIssuedBy>
            
<documentIssuedOn>2020-07-07T00:00:00Z</documentIssuedOn>
"DisplayPhoneNumber": true
            
<documentExpiryDate>2020-07-29T00:00:00Z</documentExpiryDate>
        },
           
<serialNumber>123</serialNumber>
         "SignaturePluginConfigurationId": "ltaLevelId"
                  
<identificationType>PASSPORT</identificationType>
}
            
<identificationCountry>AT</identificationCountry>
    ],
            
<documentNumber>123</documentNumber>
    "UseTimestamp": false,
       
<overrideOnHolderMismatch>false</overrideOnHolderMismatch>
         
</disposableCertificateAdditionalInformation>
"IsRequired": true,
        
</recipient>
        
</recipients>
"Id": "1#XyzmoDuplicateIdSeperator#Signature_e7ca3f6a-33fa-cdba-d696-1377fcad51c9",
       
</step>
    
<step>
     
<emailBodyExtra></emailBodyExtra>
"DisplayName": "",
          
<orderIndex>2</orderIndex>
      
<recipientType>Cc</recipientType>
"DocRefNumber": 1,
      
<useDefaultAgreements>false</useDefaultAgreements>
      
<recipients>
    "DiscriminatorType": "Signature"
   
<recipient>
           
<eMail>##EMAIL##</eMail>
}
          
<emailBodyExtra></emailBodyExtra>
  ]
          
<firstName>##NAME##</firstName>
},
         
<lastName>##NAME##</lastName>
 "FinalizeActions": {
          
<languageCode>en</languageCode>
  "FinalizeActionList": [
              
<disableEmail>false</disableEmail>
{
          
<skipExternalDataValidation>false</skipExternalDataValidation>
      "DocRefNumbers": "*",
       
<addAndroidAppLink>false</addAndroidAppLink>
         
<addIosAppLink>false</addIosAppLink>
"SpcId": "ltaLevelId",
          
<addWindowsAppLink>false</addWindowsAppLink>
      "DiscriminatorType": "Timestamp"
   
<allowDelegation>false</allowDelegation>
          
<authentications
 
/>
}
            
</recipient>
]
          
</recipients>
}
    
</step>
  
</steps>
  
<attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog> </envelope>
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,
  "KeyCallbackUrl": "spcId",
  "StatusUpdateCallbackUrl": "",
  "LockFormFieldsAtEnvelopeFinish": false,
  "Steps": [
    {
       "ValueOrderIndex": "padesSigningId"1,
      "Recipients": [
           }{
          "Email": "##email##",
     ],
     "FirstName": "##name##",
          "AllowedSignatureTypesLastName": ["##name##",
          "LanguageCode": "en",
       {
          "EmailBodyExtra": "",
          "TrModTypeDisableEmail": "RemoteSignatureDisposableCertificate"false,
          "AddAndroidAppLink": false,
          "TrValidityInSecondsAddIosAppLink": 300false,
          "AddWindowsAppLink": false,
          "LyAllowDelegation": "remoteCertificate"true,
          "AllowAccessFinishedWorkstep": false,
          "TrConfIdIssueCertificateSkipExternalDataValidation": "disposableCertificateEnrolAndSignSmsText"false,
          "AuthenticationMethods": [],
          "TrConfIdIdentificationMethods": "remoteCertificateSignSmsText"[],
          "OtpData": {
            "IsPhoneNumberRequiredPhoneMobile": false,"##phonenumber##"
          }
        }
  "Id    ],
      "EmailBodyExtra": "180c4201-4146-4161-baf8-cb5a607eec62",
      "RecipientType": "Signer",
      "WorkstepConfiguration": {
        "DiscriminatorTypeWorkstepLabel": "SigTypeTransactionCodeTest.pdf",
        "SmallTextZoomFactorPercent": 100,
           "PreferredFinishAction": false,{
          "ServerActions": [],
          "StampImprintConfigurationClientActions": {[]
              },
        "DisplayExtraInformationReceiverInformation": true,{
          "UserInformation": {
            "DisplayEmailFirstName": true"##name##",
            "LastName": "##name##",
            "DisplayIpEMail": true,"##email##"
          },
            "DisplayNameTransactionCodePushPluginData": true,[]
        },
              "DisplaySignatureDate"SenderInformation": true,{
          "UserInformation": {
            "FontFamilyFirstName": "Times New Roman##name##",
            "LastName": "##name##",
            "FontSizeEMail": 11.0"##email##"
           }
         },
        "TransactionCodeConfigurations": [],
         }"SignatureConfigurations": [],
                ],"ViewerPreferences": {
                "UseTimestamp"FinishWorkstepOnOpen": false,
                "IsRequiredVisibleAreaOptions": true,{
                "IdAllowedDomain": "1#XyzmoDuplicateIdSeperator#Signature_b58c192b-47c0-5339-cb18-4fe77c3d1812",
                "DisplayNameEnabled": "",false
          }
       "DocRefNumber": 1},
        "ResourceUris": {
          "DiscriminatorTypeDelegationUri": "Signature"
              },
        "AuditingToolsConfiguration": {
   ]
          }"WriteAuditTrail": true
        },
        "NavigationPolicy": {
          "HyperLinksGeneralPolicies": [],{
            "LinksAllowSaveDocument": []true,
            "LinkTargetsAllowSaveAuditTrail": []true,
        }
      }"AllowRotatingPages": false,
      "DocumentOptions      "AllowAppendFileToWorkstep": [
false,
            {"AllowAppendTaskToWorkstep": false,
            "DocumentReferenceAllowEmailDocument": "1"true,
            "IsHiddenAllowPrintDocument": falsetrue,
          }  "AllowFinishWorkstep": true,
      ],
      "UseDefaultAgreementsAllowRejectWorkstep": true,
    },
    {
      "OrderIndexAllowRejectWorkstepDelegation": 2true,
      "Recipients": [
     "AllowUndoLastAction": true,
  {
          "EmailAllowColorizePdfForms": "##EMAIL##"false,
            "FirstNameAllowAdhocPdfAttachments": "##NAME##"false,
            "LastNameAllowAdhocSignatures": "##NAME##"false,
            "LanguageCodeAllowAdhocStampings": "en"false,
            "EmailBodyExtraAllowAdhocFreeHandAnnotations": ""false,
            "DisableEmailAllowAdhocTypewriterAnnotations": false,
            "AddAndroidAppLinkAllowAdhocPictureAnnotations": false,
            "AddIosAppLinkAllowAdhocPdfPageAppending": false,
            "AddWindowsAppLinkAllowReloadOfFinishedWorkstep": falsetrue
          },
          "AllowDelegationWorkstepTasks": false,{
            "SkipExternalDataValidationPictureAnnotationMinResolution": false0,
            "AuthenticationMethodsPictureAnnotationMaxResolution": []
0,
            } "PictureAnnotationColorDepth": "Color16M",
      ],
      "EmailBodyExtraSequenceMode": "NoSequenceEnforced",
      "RecipientType      "PositionUnits": "CcPdfUnits",
      "DocumentOptions      "ReferenceCorner": []"Lower_Left",
      "UseDefaultAgreements      "Tasks": false[
    }
  ],
  "AddFormFields": {
    "Forms": {}
  },
    "OverrideFormFieldValues": {
    "Forms": {}
  },
  "AttachSignedDocumentsToEnvelopeLogTexts": false
}
}
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagexml
themeEclipse

P7M Signers Image Removed

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 Removed

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 Removed

},
        "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: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 XML with new recipient type “Automatic”

...

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"
              }
            ]

...