Section

The remote signature story Image Modified

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.

Use Case Description

The Customer (Charly) finds the company online
Charly calls the Hotline
Charly is answering the questions of the operator for preparing the travel insurance
The travel insurance contract is prepared and reviewed by an supervisor of the operator
The supervisor checks the data and conditions and the contract is automatically forwarded to Charly
Charly receives the contract via smartphone and authenticate himself via SMS-OTP
Charly reads and signs the contract via Click2Sign
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:

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

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

Image Removed

Section

Expand

title	Alternative: SOAP implementation (deprecated)

<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

/>

<recipientType>Signer</recipientType>

},

"SigningGroup": "secondSigner"

<eMail>##SUPERVISOREMAIL##</eMail>

      }
        },

<lastName>Supervisor</lastName>

</recipient>

 "Action": {

</recipients>

"SendCopy": {

</step>

<step>

"RecipientConfiguration": {

<recipientType>Signer</recipientType>

"ContactInformation": {

 "Email": "johndoe@sample.com",

<eMail>##Charly

Email##</eMail>

<firstName>Charly</firstName>

"GivenName": "John",

<lastName>Backpacker</lastName>

"Surname": "Doe",

          "LanguageCode": "EN"

},

<parameter>##Phonenumber##</parameter>

</authentication>

"PersonalMessage": "This is the copy of the document!"

</authentications>

</recipient>

</recipients>

</step>

</steps> </envelope><authentications> <authentication>

<parameter>##Phonenumber##</parameter>

</authentication> </authentications>

]

}

Code Block

language	java
theme	Eclipse

{
    "SspFileIdsDocuments": [{
    "##FileId##"
   ],
  "SendEnvelopeDescription": {
  "NameFileId": "test3c816859-1234-1234-b5ef-3b52a3af1c77",
     "EmailSubject": "Please sign the enclosed envelope",
  "EmailBodyDocumentNumber": "Dear1
 #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
  "DisplayedEmailSender      }
    ],
    "Name": "Test",
  "EnableReminders": true,
  "FirstReminderDayAmountActivities": 5,[{
  "RecurrentReminderDayAmount": 3,
    "BeforeExpirationDayAmount": 3,
  "DaysUntilExpire": 28,
  "CallbackUrlAction": "",{
  "StatusUpdateCallbackUrl": "",
  "Steps": [
    {
      "OrderIndexSign": 1,
      "Recipients": [
{
          {
          "EmailRecipientConfiguration": "##EMAIL##",
{
             "FirstName": "##NAME##",
          "LastNameContactInformation": "##NAME##",
{
               "LanguageCode": "en",
             "EmailBodyExtraEmail": "janedoe@sample.com",
          "DisableEmail": false,
            "AddAndroidAppLink": false,
          "AddIosAppLinkGivenName": false"Jane",
          "AddWindowsAppLink": false,
          "AllowDelegation": true,
          "SkipExternalDataValidationSurname": false"Doe",
          "AuthenticationMethods": []
        }
      ],
      "EmailBodyExtraLanguageCode": "EN",
      "RecipientType": "Signer",
        "WorkstepConfiguration": {
        "WorkstepLabel": "test",
 }
          "SmallTextZoomFactorPercent": 100,
        "FinishAction": {
  },
         "ServerActions": [],
          "ClientActionsElements": [{
            {
              "RemoveDocumentFromRecentDocumentListSignatures": false,
[{
                 "CallClientActionOnlyAfterSuccessfulSync": true,
              "ClientNameTaskConfiguration": "SIGNificant SignAnywhere",
 {
                     "CloseApp": false,
              "ActionOrderDefinition": "https://www.esignanywhere.net/"{
            }
            ]
        },
        "ReceiverInformationOrderIndex": {0
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",}
            "EMail": "##EMAIL##"
          },
          "TransactionCodePushPluginData": []
},
          },
        "SenderInformation": {
             "UserInformationId": {
 "sample sig click2sign",
                   "FirstName": "##NAME##",
            "LastNameRequired": "##NAME##"true,
            "EMail": "##EMAIL##"
             }
       "DocumentNumber": }1,
         "TransactionCodeConfigurations": [
          {
            "IdAllowedSignatureTypes": "smsAuthTransactionCodeId",{
            "HashAlgorithmIdentifier": "Sha256",
            "Texts": [
          "ClickToSign": {}
  
            ]
          }
        ]},
         "SignatureConfigurations": [],
            "ViewerPreferences": {
          "FinishWorkstepOnOpenFieldDefinition": false,{
          "VisibleAreaOptions": {
            "AllowedDomain": "*",
            "EnabledPosition": false{
             }
        },
        "ResourceUris": {
          "DelegationUriPageNumber": "https://demo.xyzmo.com/Resource/Delegate"1,
           "SignatureImagesUri": "https://demo.xyzmo.com/Resource/SignatureImages/?link=1Wwv8stkNJ7cRhjaTLcdiHTeoFPy4Ts81ZnRlUam7cfHQSVqTAN1HtFI~EYIPHCJm"
          },
        "AuditingToolsConfiguration": {
          "WriteAuditTrailX": false61,
           "NotificationConfiguration": {}
          },
        "Policy": {
          "GeneralPoliciesY": {598
             "AllowSaveDocument": true,
            "AllowSaveAuditTrail": true,
            "AllowRotatingPages": false},
            "AllowEmailDocument": true,
            "AllowPrintDocument": true,
            "AllowFinishWorkstepSize": true,{
              "AllowRejectWorkstep": true,
            "AllowRejectWorkstepDelegation": true,
            "AllowUndoLastActionWidth": true80,
             "AllowAdhocPdfAttachments": false,
            "AllowAdhocSignatures": false,
             "AllowAdhocStampingsHeight": false,
50
                 "AllowAdhocFreeHandAnnotations": false,
              "AllowAdhocTypewriterAnnotations": false,
    }
        "AllowAdhocPictureAnnotations": false,
            "AllowAdhocPdfPageAppending": false
          },
          "WorkstepTasks": {
               "PictureAnnotationMinResolution": 0,
  }
          "PictureAnnotationMaxResolution": 0,
            "PictureAnnotationColorDepth": "Color16M", ]
            "SequenceMode": "NoSequenceEnforced",
        },
       "PositionUnits": "PdfUnits",
            "ReferenceCornerSigningGroup": "Lower_LeftfirstSigner",
            "Tasks": [    }
            }
  {
      }, {
            "PositionPageAction": 1,{
                "PositionSign": {
                    "PositionXRecipientConfiguration": 61.0,
{
                        "PositionYContactInformation": 598.0{
                },
               "Email": "Size": {
janedoe@sample.com",
                   "Height": 80.0,
        "GivenName": "Jane",
         "Width": 190.0
                },
  "Surname": "Doe",
             "AdditionalParameters": [
              "LanguageCode": "EN"
   {
                    "Key": "enabled" },
                      "Value  "AuthenticationConfiguration": "1"
{

                       },
     "SmsOneTimePassword": {
            {
                    "KeyPhoneNumber": "positioningstring",
                    "Value": "onPage"
       }
           },
                  {}
                    "Key": "req"},
                    "ValueElements": "1"{
                  },
      "Signatures": [{
            {
                    "KeyTaskConfiguration": "fd",{
                    "Value": ""
               "OrderDefinition": {
  },
                  {
                    "KeyOrderIndex": "fd_dateformat",
1
                     "Value": "dd-MM-yyyy HH:mm:ss"
             }
     },
                  {
         },
           "Key": "fd_timezone",
                    "ValueId": "datetimeutc"
 second sample sig click2sign",
                 }
               "Required": ]true,
                     "AllowedSignatureTypes": [
          "DocumentNumber": 1,
       {
                    "AllowedCapturingMethod": "Click2Sign",
    "AllowedSignatureTypes": {
               "Id": "a0c2bebf-4e91-4992-8e35-4f9e495318f9",
                    "DiscriminatorTypeClickToSign": "SigTypeClick2Sign",
{}
                      "Preferred": false,
           },
         "StampImprintConfiguration": {
                      "DisplayExtraInformationFieldDefinition": true,
{
                          "DisplayEmail": true,
          "Position": {
             "DisplayIp": true,
                           "DisplayNamePageNumber": true1,
                      "DisplaySignatureDate": true,
                      "FontFamilyX": "Times New Roman"271,
                       "FontSize": 11.0
                "Y": 598
   }
                  }
                ]},
                 "UseTimestamp": false,
                   "IsRequiredSize": true,{
                 "Id": "1#XyzmoDuplicateIdSeperator#Signature_889831ac-c44c-909c-b8b9-e57379538617",
                       "DisplayNameWidth": ""80,
                "DocRefNumber": 1,
                  "DiscriminatorType": "Signature"
              }"Height": 50
            ]
          }
        }
      },
      "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": true,
          "SkipExternalDataValidation": false,
          "AuthenticationMethods": [
            {
              "Method": "Sms",
              "Parameter": "##NUMBER##"
            }
          ]
        }
      ],
      "EmailBodyExtra": "",
      "RecipientType": "Signer",
      "WorkstepConfiguration": {
        "WorkstepLabel": "test",
        "SmallTextZoomFactorPercent": 100,
        "FinishAction": {
          "ServerActions": [],
          "ClientActions": [
            {
              "RemoveDocumentFromRecentDocumentList": false,
              "CallClientActionOnlyAfterSuccessfulSync": true,
              "ClientName": "SIGNificant SignAnywhere",
              "CloseApp": false,
              "Action": "https://www.esignanywhere.net/"
            }
          ]
        },
        "ReceiverInformation": {
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",
            "EMail": "##EMAIL##"
          },
          "TransactionCodePushPluginData": []
        },
        "SenderInformation": {
          "UserInformation": {
            "FirstName": "##NAME##",
            "LastName": "##NAME##",
            "EMail": "##EMAIL##"
          }
        },
        "TransactionCodeConfigurations": [
          {
            "Id": "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

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

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

Code Block

language	java
theme	Eclipse

 "AuthenticationMethodsSmsOneTimePassword": [
            {
              "Method": "Sms",
              "Parameter"PhoneNumber": "##NUMBER##string"
            }
          ]
        }
      ],

Page tree

Versions Compared

Old Version 12

New Version 13

Key

The remote signature story Image Modified

Use Case Description

Integration

Page tree

Page History

Versions Compared

Old Version 12

New Version 13

Key

The remote signature story Image Modified

Use Case Description

Integration