Versions Compared

Old Version 3

changes.mady.by.user Unknown User (gierlinger)

Saved on

compared with

New Version Current

changes.mady.by.user Christoph Bimminger

Saved on

Key

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


Alternative: SOAP implementation (deprecated)

Section

The

Story

remote signature story Image Added

Charly goes on a backpacker adventure for some weeks. At the Airport he realizes that he does not have a travel insurance, therefore he is looking for travel insurance online. You find a list of available stories here.

Please also see the developer mode for this tutorial here: Visit the developer mode.

Travel Insurance ComicImage RemovedRemote Signature StoryImage Added


Use Case Description

  1. The Customer (Charly) finds the company online
  2. Charly calls the Hotline
  3. Charly is answering the questions of the operator for preparing the travel insurance
  4. The travel insurance contract is prepared and reviewed by an supervisor of the operator
  5. The supervisor checks the data and conditions and the contract is automatically forwarded to Charly
  6. Charly receives the contract via smartphone and authenticate himself via SMS-OTP
  7. Charly reads and signs the contract via Click2Sign
  8. Charly receives a copy of the finally signed travel insurance contract

Integration

The contract is prepared by the insurance customer relation management system and the signing transaction started with eSignAnyWhere. Therefore the workflow for integration is quite simple:

  1. Upload the contract as PDF document
  2. Send envelope with Workstep Configuration
  3. Wait on callback to download and archive the final contract

Basic URI for REST: https://demo.esignanywhere.net/Api

Image Removed

Expand
title

workflow travel insuranceImage Removed


Section



Code Block
languagejava
themeEclipse
{
    "
SspFileIds
Documents": [{
"##FileId##"
],
"SendEnvelopeDescription":
{ 
  "
Name
FileId": "
test
3c816859-1234-1234-b5ef-3b52a3af1c77",
"EmailSubject": "Please sign the enclosed envelope", 
        "
EmailBody
DocumentNumber":
"Dear
1
#RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#", "DisplayedEmailSender
      }
    ],
    "Name": "Test",
    "
EnableReminders
Activities":
true,
[{
"FirstReminderDayAmount": 5,
"RecurrentReminderDayAmount":
3,
"BeforeExpirationDayAmount":
3, 
  "
DaysUntilExpire
Action":
28,
{
"CallbackUrl":
"",
"StatusUpdateCallbackUrl": "", 
          "
Steps
Sign":
[
{
{
"OrderIndex":
1, 
      "
Recipients
RecipientConfiguration":
[ 
{
{ 
          "
Email
ContactInformation":
"##EMAIL##", 
{
"FirstName": "##NAME##", 
            "
LastName
Email": "
##NAME##
janedoe@sample.com",
"LanguageCode": "en",
"EmailBodyExtra
     "GivenName": "Jane",
"DisableEmail":
false, 
          "
AddAndroidAppLink
Surname":
false
"Doe",
"AddIosAppLink":
false, 
          "
AddWindowsAppLink
LanguageCode":
false,
"EN"
"AllowDelegation": true,
"SkipExternalDataValidation": false,
 }
"AuthenticationMethods": [] 
          },
],
"EmailBodyExtra":
"", 
      "
RecipientType
Elements":
"Signer",
{
"WorkstepConfiguration":
{
"WorkstepLabel":
"test", 
        "
SmallTextZoomFactorPercent
Signatures":
100,
[{
"FinishAction": {
"ServerActions":
[], 
          "
ClientActions
TaskConfiguration":
[
{
{
"RemoveDocumentFromRecentDocumentList":
false, 
         "OrderDefinition": {
"CallClientActionOnlyAfterSuccessfulSync":
true,
"ClientName": "SIGNificant SignAnywhere", 
                     "
CloseApp
OrderIndex":
false,
0
"Action":
"https://www.esignanywhere.net/"
}
]
}
},
"ReceiverInformation":
{
"UserInformation":
{ 
    },
"FirstName":
"##NAME##",
"LastName":
"##NAME##", 
          
"
EMail
ElementId": "
##EMAIL##
sample sig click2sign",
},
"TransactionCodePushPluginData":
[] 
       "Required":
}
true,
"SenderInformation":
{
"UserInformation":
{ 
            "
FirstName
DocumentNumber":
"##NAME##"
1,
"LastName": "##NAME##", 
                "
EMail
AllowedSignatureTypes":
"##EMAIL##"
{
}
},
"TransactionCodeConfigurations":
[ 
        "ClickToSign": 
{}
"Id":
"smsAuthTransactionCodeId",
"HashAlgorithmIdentifier":
"Sha256", 
      },
"Texts":
[
]
"FieldDefinition": {
}
],
"SignatureConfigurations":
[], 
        "
ViewerPreferences
Position": {
"FinishWorkstepOnOpen": false,
"VisibleAreaOptions":
{
"AllowedDomain":
   "
*
PageNumber": 1,
"Enabled": false
}
}, 
        "
ResourceUris
X":
{
61,
"DelegationUri":
"https://demo.xyzmo.com/Resource/Delegate",
"SignatureImagesUri":
"https://demo.xyzmo.com/Resource/SignatureImages/?link=1Wwv8stkNJ7cRhjaTLcdiHTeoFPy4Ts81ZnRlUam7cfHQSVqTAN1HtFI~EYIPHCJm"
}, 
        "
AuditingToolsConfiguration
Y":
{
598
"WriteAuditTrail": false,
"NotificationConfiguration":
{}
},
"Policy": {
},
"GeneralPolicies":
{
"AllowSaveDocument":
true, 
            "
AllowSaveAuditTrail
Size":
true,
{
"AllowRotatingPages": false,
"AllowEmailDocument":
true, 
            "
AllowPrintDocument
Width":
true
80,
"AllowFinishWorkstep":
true,
"AllowRejectWorkstep":
true, 
              "
AllowRejectWorkstepDelegation
Height":
true,
50
"AllowUndoLastAction":
true,
"AllowAdhocPdfAttachments":
false, 
       }
"AllowAdhocSignatures":
false,
"AllowAdhocStampings":
false,
"AllowAdhocFreeHandAnnotations": false,
 }
"AllowAdhocTypewriterAnnotations": false,
"AllowAdhocPictureAnnotations": false,
 }
"AllowAdhocPdfPageAppending": false
},
]
"WorkstepTasks":
{
"PictureAnnotationMinResolution": 0
},
"PictureAnnotationMaxResolution":
0, 
            "
PictureAnnotationColorDepth
SigningGroup": "
Color16M
firstSigner"
,
"SequenceMode":
"NoSequenceEnforced", 
   }
"PositionUnits":
"PdfUnits", 
  }
"ReferenceCorner": "Lower_Left",
}, {
            "
Tasks
Action":
[
{
                "Sign": {
                    "
PositionPage
RecipientConfiguration":
1,
{
"Position":
{ 
        "ContactInformation": {
"PositionX":
61.0, 
                  "
PositionY
Email":
598.0
"janedoe@sample.com",
}, 
            
"
Size
GivenName":
{
"Jane",
"Height":
80.0, 
         "Surname": "Doe",
"Width":
190.0
}, 
   
"LanguageCode": "EN"
"AdditionalParameters":
[ 
              },
{ 
                    "
Key
AuthenticationConfiguration":
"enabled", 
{

                            "
Value
SmsOneTimePassword":
"1"
{
}, 
             "PhoneNumber": "string"
{
"Key":
"positioning", 
   }
"Value":
"onPage" 
      }
                    },
                    "Elements": {
                        "
Key
Signatures":
"req", 
[{
                                "
Value
TaskConfiguration":
"1"
{
}, 
                 "OrderDefinition": {
"Key":
"fd", 
                   
"
Value
OrderIndex":
""
1
},
{
}
"Key": "fd_dateformat", 
            },
"Value":
"dd-MM-yyyy
HH:mm:ss"
}, 
  "ElementId": "second sample sig click2sign",
{ 
                    "
Key
Required":
"fd_timezone"
true,
"Value":
"datetimeutc"
}
"DocumentNumber": 1,
], 
                "AllowedSignatureTypes":
[
{
{ 
                  
"
AllowedCapturingMethod
ClickToSign":
"Click2Sign", 
{}
"Id": "a0c2bebf-4e91-4992-8e35-4f9e495318f9", 
           },
"DiscriminatorType":
"SigTypeClick2Sign", 
                    "
Preferred
FieldDefinition":
false,
{
"StampImprintConfiguration":
{ 
               "Position": {
"DisplayExtraInformation":
true,
"DisplayEmail":
true, 
          "PageNumber": 1,
"DisplayIp": true, 
                             "
DisplayName
X":
true
271,
"DisplaySignatureDate":
true, 
                      "
FontFamily
Y":
"Times
598
New
Roman",
"FontSize":
11.0 
          },
}
} 
        "Size": {
],
"UseTimestamp":
false, 
                "
IsRequired
Width":
true
80,
"Id": "1#XyzmoDuplicateIdSeperator#Signature_889831ac-c44c-909c-b8b9-e57379538617", 
                      "
DisplayName
Height":
"",
50
"DocRefNumber":
1,
"DiscriminatorType":
"Signature" 
  }
}
] 
          }
}
},
"DocumentOptions":
[
{
}
"DocumentReference":
"1",
"IsHidden": false 
   ]
}
]
},
"UseDefaultAgreements":
true
},
{ 
      "
OrderIndex
SigningGroup":
2,
"secondSigner"
"Recipients": [
{
}
"Email": "##EMAIL##",
  }
        }, {
"FirstName":
"##NAME##", 
          "
LastName
Action":
"##NAME##",
{
"LanguageCode": "en", "EmailBodyExtra": "", 
      "SendCopy": {
"DisableEmail":
false, 
          "
AddAndroidAppLink
RecipientConfiguration":
false,
{
"AddIosAppLink":
false, 
          "
AddWindowsAppLink
ContactInformation":
false,
{
"AllowDelegation":
true,
"SkipExternalDataValidation":
false, 
      "
AuthenticationMethods
Email":
[
"johndoe@sample.com",
{ 
                "
Method
GivenName": "
Sms
John",
"Parameter":
"##NUMBER##"
} 
 "Surname": "Doe",
]
}
], 
      "
EmailBodyExtra
LanguageCode": "EN"
,
"RecipientType": "Signer",
"WorkstepConfiguration":
{
"WorkstepLabel": "test"
 },
"SmallTextZoomFactorPercent":
100,
"FinishAction":
{ 
      
"
ServerActions
PersonalMessage":
[], "ClientActions": [
 "This is the copy of the document!"
{
"RemoveDocumentFromRecentDocumentList": false, 
}
"CallClientActionOnlyAfterSuccessfulSync": true,
}
"ClientName": "SIGNificant SignAnywhere",
}
        }
"CloseApp": false, "Action": "https://www.esignanywhere.net/" } ] }, "ReceiverInformation": { "UserInformation": { "FirstName": "##NAME##", "LastName": "##NAME##", "EMail": "##EMAIL##" }, "TransactionCodePushPluginData": [] }, "SenderInformation": { "UserInformation": { "FirstName": "##NAME##", "LastName": "##NAME##", "EMail": "##EMAIL##" } }, "TransactionCodeConfigurations": [ { "Id": "smsAuthTransactionCodeId", "HashAlgorithmIdentifier": "Sha256", "Texts": [ ] } ], "SignatureConfigurations": [], "ViewerPreferences": { "FinishWorkstepOnOpen": false, "VisibleAreaOptions": { "AllowedDomain": "*", "Enabled": false } }, "ResourceUris": { "DelegationUri": "https://demo.xyzmo.com/Resource/Delegate", "SignatureImagesUri": "https://demo.xyzmo.com/Resource/SignatureImages/?link=1J8yV09X5V3F6Gtvv2xIg47q9fmrJr~qVVGq8h4nLDVPeGgZ4oDXtmRGZV3v1GUSP" }, "AuditingToolsConfiguration": { "WriteAuditTrail": false, "NotificationConfiguration": {} }, "Policy": { "GeneralPolicies": { "AllowSaveDocument": true, "AllowSaveAuditTrail": true, "AllowRotatingPages": false, "AllowEmailDocument": true, "AllowPrintDocument": true, "AllowFinishWorkstep": true, "AllowRejectWorkstep": true, "AllowRejectWorkstepDelegation": true, "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": 271.0, "PositionY": 598.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" } ], "AllowedSignatureTypes": [ { "AllowedCapturingMethod": "Click2Sign", "Id": "d570e91e-29df-474e-b946-2bcfb83ce24d", "DiscriminatorType": "SigTypeClick2Sign", "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_e811b1f2-67f8-f127-e1db-36eaad8af393", "DisplayName": "", "DocRefNumber": 1, "DiscriminatorType": "Signature" } ] } } }, "DocumentOptions": [ { "DocumentReference": "1", "IsHidden": false } ], "UseDefaultAgreements": true }, { "OrderIndex": 3, "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>Travel Insurance for Charly</name>
   <eMailSubject>Travel Insurance for Charly</eMailSubject>
   <eMailBody>Dear #RecipientFirstName#! Please sign this insurance contract.</eMailBody>
   <enableReminders>True</enableReminders>
   <firstReminderDayAmount>1</firstReminderDayAmount>
   <recurrentReminderDayAmount>1</recurrentReminderDayAmount>
   <beforeExpirationReminderDayAmount>1</beforeExpirationReminderDayAmount>
   <daysUntilExpire>2</daysUntilExpire>
   <!-- callback to your backend system on a completed envelope 
   <callbackUrl>http://172.16.17.78:57550/default.aspx?EnvelopeId=##EnvelopeId##&myParamForMe=1234</callbackUrl> 
   -->
   <callbackUrl />
   <steps>
      <step>
         <emailBodyExtra />
         <orderIndex>1</orderIndex>
         <recipientType>Signer</recipientType>
         <recipients>
            <recipient>
               <languageCode>en-us</languageCode>
               <eMail>##SUPERVISOREMAIL##</eMail>
               <firstName>Bob</firstName>
               <lastName>Supervisor</lastName>
            </recipient>
         </recipients>
         <workstepConfiguration>...</workstepConfiguration>
      </step>
      <step>
         <emailBodyExtra />
         <orderIndex>2</orderIndex>
         <recipientType>Signer</recipientType>
         <recipients>
            <recipient>
               <languageCode>en-us</languageCode>
               <eMail>##Charly Email##</eMail>
               <firstName>Charly</firstName>
               <lastName>Backpacker</lastName>
               <authentications>
                  <authentication>
                     <method>SMS</method>
                     <parameter>##Phonenumber##</parameter>
                  </authentication>
               </authentications>
            </recipient>
         </recipients>
         <workstepConfiguration>...</workstepConfiguration>
      </step>
   </steps>
</envelope>
]

}


You can see the first recipient is the supervisor (without authentication) and then followed by Charly with SMS-OTP authentication.

<authentications> <authentication> <method>SMS</method> <parameter>##Phonenumber##</parameter> </authentication> </authentications>
},
Code Block
languagejava
themeEclipse
 "AuthenticationMethods": [
            {
              "Method": "Sms",
              "Parameter": "##NUMBER##" "SmsOneTimePassword": {
            }
          ]"PhoneNumber": "string"
        }
      ],
Expand
titleAlternative: SOAP implementation (deprecated)
Code Block
languagexml
themeEclipse