...
If the recipient opens the envelope it should look like the following screenshot:
Image Modified
With this empty workstep configuration we can now add the settings which are mentioned above. First, let us start with the viewer preferences.
...
Info |
---|
Defining a MetaDataXML sets the value only if AdditionalClientWorkstepInformation is not already set via api. For example:
- Setting AdditionalClientWorkstepInformation AND MetaDataXml
Code Block |
---|
| "SendEnvelopeDescription": {
"MetaDataXml": "<Tagging doctype=\"INVOICE\"><InvoiceNr>123456</InvoiceNr></Tagging>",
...
"Recipients": [
{
"Email": "##email##",
...
}
],
"RecipientType": "Signer",
"WorkstepConfiguration": {
"AdditionalClientWorkstepInformation": "<test id='test'>Some Information</test>",
...
|
results in Code Block |
---|
| <AdditionalClientWorkstepInformation>
<test id='test'>Some Information</test>
</AdditionalClientWorkstepInformation> |
Setting AdditionalClientWorkstepInformation only Code Block |
---|
| "SendEnvelopeDescription": {
...
"Recipients": [
{
"Email": "##email##",
...
}
],
"RecipientType": "Signer",
"WorkstepConfiguration": {
"AdditionalClientWorkstepInformation": "<test id='test'>Some Information</test>",
...
|
- results in
Code Block |
---|
| <AdditionalClientWorkstepInformation>
<test id='test'>Some Information</test>
</AdditionalClientWorkstepInformation> |
- Setting MetaDataXml only
Code Block |
---|
| "SendEnvelopeDescription": {
"MetaDataXml": "<Tagging doctype=\"INVOICE\"><InvoiceNr>123456</InvoiceNr></Tagging>",
...
"Recipients": [
{
"Email": "##email##",
...
}
],
"RecipientType": "Signer",
"WorkstepConfiguration": {
...
|
results in Code Block |
---|
| <AdditionalClientWorkstepInformation>
<signature>
<Tagging doctype="INVOICE">
<InvoiceNr>123456</InvoiceNr>
</Tagging>
</signature>
</AdditionalClientWorkstepInformation> |
|
Expiration date
Image Modified
Note: The following information is valid for envelopes as well as for drafts: Settings for the relative time:
...
All policies disabled | All policies enabled |
Image Modified
| Image Modified |
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.
...
Expand |
---|
title | Alternative: SOAP implementation (deprecated) |
---|
|
Code Block |
---|
| <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 Modified
Code Block |
---|
|
"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"
}
]
}
}, |
...
Result (Transaction token, Transaction ID, Signing time):
Image Modified
Click2Sign
This is the simplest signature type, the signer has just to click on the signature field to sing it.
...
Expand |
---|
title | Alternative: SOAP implementation (deprecated) |
---|
|
Code Block |
---|
| <envelope>
<name>test</name>
<eMailSubject>Please sign the enclosed envelope</eMailSubject>
<eMailBody>Dear #RecipientFirstName# #RecipientLastName#
#PersonalMessage#
Please sign the envelope #EnvelopeName#
Envelope will expire at #ExpirationDate#</eMailBody>
<enableReminders>true</enableReminders>
<firstReminderDayAmount>5</firstReminderDayAmount>
<recurrentReminderDayAmount>3</recurrentReminderDayAmount>
<beforeExpirationReminderDayAmount>3</beforeExpirationReminderDayAmount>
<daysUntilExpire>28</daysUntilExpire>
<callbackUrl></callbackUrl>
<statusUpdateCallbackUrl></statusUpdateCallbackUrl>
<lockFormFieldsAtEnvelopeFinish>true</lockFormFieldsAtEnvelopeFinish>
<displayedEmailSender></displayedEmailSender>
<steps>
<step>
<emailBodyExtra></emailBodyExtra>
<orderIndex>1</orderIndex>
<recipientType>Signer</recipientType>
<useDefaultAgreements>true</useDefaultAgreements>
<documentOptions>
<documentOption docRef="1">
<isHidden>false</isHidden>
</documentOption>
</documentOptions>
<workstepConfiguration skipThirdPartyChecks="0">
<WorkstepLabel>test</WorkstepLabel>
<SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
<WorkstepTimeToLiveInMinutes>44650</WorkstepTimeToLiveInMinutes>
<AbsoluteExpiryDate>2020-07-10T10:57:46.4243017Z</AbsoluteExpiryDate>
<FinishAction>
<ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">https://www.esignanywhere.net/</ClientAction>
</FinishAction>
<ViewerPreferences>
<SendVisibleArea allowedDomain="*">0</SendVisibleArea>
<FinishWorkstepOnOpen>0</FinishWorkstepOnOpen>
</ViewerPreferences>
<Policy version="1.1.0.0">
<AdhocPolicies>
<AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
</AdhocPolicies>
<GeneralPolicies>
<AllowAdhocFreeHandAnnotations>0</AllowAdhocFreeHandAnnotations>
<AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
<AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
<AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
<AllowAdhocSignatures>0</AllowAdhocSignatures>
<AllowAdhocStampings>0</AllowAdhocStampings>
<AllowAdhocTypewriterAnnotations>0</AllowAdhocTypewriterAnnotations>
<AllowEmailDocument>1</AllowEmailDocument>
<AllowFinishWorkstep>1</AllowFinishWorkstep>
<AllowPrintDocument>1</AllowPrintDocument>
<AllowRejectWorkstep>1</AllowRejectWorkstep>
<AllowSaveAuditTrail>1</AllowSaveAuditTrail>
<AllowSaveDocument>1</AllowSaveDocument>
<AllowUndoLastAction>1</AllowUndoLastAction>
<AllowRotatingPages>0</AllowRotatingPages>
<AllowRejectWorkstepDelegation>1</AllowRejectWorkstepDelegation>
</GeneralPolicies>
<WorkstepTasks originalSequenceMode="NoSequenceEnforced" SequenceMode="NoSequenceEnforced">
<Task type="SignField" DocRefNumber="1" id="1#XyzmoDuplicateIdSeperator#Signature_a3d634d1-5b9e-8089-e77d-4888a9616fb2" internalCompleted="0" finishPercentage="0" completed="0" enabled="1" displayName="" required="1" />
</WorkstepTasks>
</Policy>
<Navigation />
<timeCreated>2020-07-10T10:47:46.3930488Z</timeCreated>
<TransactionCodeConfigurations>
<TransactionCodeConfiguration trConfId="smsAuthTransactionCodeId">
</TransactionCodeConfiguration>
</TransactionCodeConfigurations>
<receiverInformation>
<userInformation>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<eMail>##EMAIL##</eMail>
</userInformation>
<showNamirialDisposableDisclaimer>1</showNamirialDisposableDisclaimer>
<trRsDcNamHolderInformation version="2">
<recognitionType>PASS</recognitionType>
<documentIssuedOn>07/07/2020</documentIssuedOn>
<documentExpiryDate>29/07/2020</documentExpiryDate>
<documentIssuedBy>Namirial</documentIssuedBy>
<documentNumber>123</documentNumber>
<countryResidence>AT</countryResidence>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<email>##EMAIL##</email>
<phoneMobile>##PHONENUMBER##</phoneMobile>
<identificationType>PASSPORT</identificationType>
<identificationCountry>AT</identificationCountry>
<passport>123</passport>
</trRsDcNamHolderInformation>
</receiverInformation>
<senderInformation>
<userInformation>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<eMail>##EMAIL##</eMail>
</userInformation>
</senderInformation>
<pdfForms isEditingAllowed="0" />
<TypewriterAnnotationTaskInfo />
<attachmentFields />
<signatureTemplate>
<version>1.2.0.2</version>
<positionReferenceCorner>Lower_Left</positionReferenceCorner>
<positionUnits>PdfUnits</positionUnits>
<sig id="1#XyzmoDuplicateIdSeperator#Signature_a3d634d1-5b9e-8089-e77d-4888a9616fb2">
<TaskDisplayName />
<param name="enabled">1</param>
<positionPage>1</positionPage>
<positionX>78</positionX>
<positionY>545</positionY>
<width>190</width>
<height>80</height>
<param name="positioning">onPage</param>
<param name="req">1</param>
<param name="fd" />
<param name="fd_dateformat">dd-MM-yyyy HH:mm:ss</param>
<param name="fd_timezone">datetimeutc</param>
<DocRefNumber>1</DocRefNumber>
<AllowedSignatureTypes>
<sigType id="89f2876e-2149-4a88-b841-547a1b3478a5" type="TransactionCode">
<trModType>RemoteSignatureDisposableCertificate</trModType>
<trValidityInSeconds>300</trValidityInSeconds>
<ly>remoteCertificate</ly>
<trConfIdIssueCertificate>disposableCertificateEnrolAndSignSmsText</trConfIdIssueCertificate>
<trConfId>remoteCertificateSignSmsText</trConfId>
<StampImprintConfiguration>
<DisplayExtraInformation>1</DisplayExtraInformation>
<DisplayEmail>1</DisplayEmail>
<DisplayIp>1</DisplayIp>
<DisplayName>1</DisplayName>
<DisplaySignatureDate>1</DisplaySignatureDate>
<FontFamily>Times New Roman</FontFamily>
<FontSize>11</FontSize>
</StampImprintConfiguration>
</sigType>
</AllowedSignatureTypes>
<param name="spcId">padesSigningId</param>
</sig>
</signatureTemplate>
<AuditingToolsConfiguration WriteAuditTrail="0">
<NotificationConfiguration />
</AuditingToolsConfiguration>
<resourceUris>
<delegationUri>https://demo.esignanywhere.net/Resource/Delegate</delegationUri>
</resourceUris>
<LoggingMetaInformation>
<envelopeId>##ENVELOPEID##</envelopeId>
<envelopeRecipientId>##RECIPIENTID##</envelopeRecipientId>
</LoggingMetaInformation>
</workstepConfiguration>
<recipients>
<recipient>
<eMail>##EMAIL##</eMail>
<emailBodyExtra></emailBodyExtra>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<languageCode>en</languageCode>
<disableEmail>false</disableEmail>
<skipExternalDataValidation>false</skipExternalDataValidation>
<addAndroidAppLink>false</addAndroidAppLink>
<addIosAppLink>false</addIosAppLink>
<addWindowsAppLink>false</addWindowsAppLink>
<allowDelegation>true</allowDelegation>
<allowAccessFinishedWorkstep>false</allowAccessFinishedWorkstep>
<authentications />
<disposableCertificateAdditionalInformation>
<countryResidence>AT</countryResidence>
<phoneMobile>##PHONENUMBER##</phoneMobile>
<documentType>PASS</documentType>
<documentIssuedBy>Namirial</documentIssuedBy>
<documentIssuedOn>2020-07-07T00:00:00Z</documentIssuedOn>
<documentExpiryDate>2020-07-29T00:00:00Z</documentExpiryDate>
<serialNumber>123</serialNumber>
<identificationType>PASSPORT</identificationType>
<identificationCountry>AT</identificationCountry>
<documentNumber>123</documentNumber>
<overrideOnHolderMismatch>false</overrideOnHolderMismatch>
</disposableCertificateAdditionalInformation>
</recipient>
</recipients>
</step>
<step>
<emailBodyExtra></emailBodyExtra>
<orderIndex>2</orderIndex>
<recipientType>Cc</recipientType>
<useDefaultAgreements>false</useDefaultAgreements>
<recipients>
<recipient>
<eMail>##EMAIL##</eMail>
<emailBodyExtra></emailBodyExtra>
<firstName>##NAME##</firstName>
<lastName>##NAME##</lastName>
<languageCode>en</languageCode>
<disableEmail>false</disableEmail>
<skipExternalDataValidation>false</skipExternalDataValidation>
<addAndroidAppLink>false</addAndroidAppLink>
<addIosAppLink>false</addIosAppLink>
<addWindowsAppLink>false</addWindowsAppLink>
<allowDelegation>false</allowDelegation>
<authentications />
</recipient>
</recipients>
</step>
</steps>
<attachSignedDocumentsToEnvelopeLog>false</attachSignedDocumentsToEnvelopeLog>
</envelope> |
|
P7M Signers
Image Modified
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 |
...
Automatic Remote Signature Recipient via API
Image Modified
Via API you have to use a new recipient type (“Automatic”). Moreover the workstepConfiguration must contain information about the automatic remote signature. As additional option, you can use more than one profile for the workstep configuration at once via API. Note: this leads to a missing information in eSAW UI!
...
Code Block |
---|
|
<Policy version="1.1.0.0">
<FinalizeActions>
<AutomaticSignature sigId="GENERIC_SIG_IDENTIFIER" />
</FinalizeActions>
</Policy> |
A-Trust
Image Modified
Info |
---|
Note: For the A-Trust signature configuration you need an A-Trust Signaturbox first. For more information please contact us. |
...
If you enter the phone number then the recipient can not enter another number. However, if you do not define a phone number then the recipient is free to choose a phone number of their choice.
BankID
Image Modified
In this section you can find the configuration for the bankID signature. First we have to upload a PDF. After uploading the document we can now send the document with the following workstep configuration to define the bankID signature:
...
Expand |
---|
title | Alternative: SOAP implementation (deprecated) |
---|
|
Code Block |
---|
| <authentications>
<authentication>
<method>BankId</method>
<parameter>##parameter##</parameter>
</authentication>
</authentications> |
|
Generic Signing Plugin
Image Modified
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:
...
Generic Signing Plugin (automatic)
Image Modified
In this section you can find the configuration for an automatic generic signing plugin signature. Please see the following workstep configuration for more information:
...
Generic Signing Plugin (Batch-Signature)
Image Modified
In this section you can find the configuration for a batch generic signing plugin signature. Please see the following workstep configuration for more information:
...
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 Modified
...
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:
...