eSignature API > Integration & Use Cases
Integration & Use Cases
This page will show you how to integrate eSignAnyWhere into your own products and systems. Moreover some additional use cases are described:
- Basic Integration: Integrate eSignAnyWhere as middleware for remote signing
- Advanced Integration
- In-Person Signing with SIGNificant Apps/Products
- Integrate remote signing into your own (native) mobile Apps
- Integrate remote signing into your own web portal
- Integrate eSignAnyWhere document designer to define e-signing ceremonies in your own web application
- 1 Basic Integration
- 2 Advanced Integration
- 2.1 In-Person Signing with SIGNificant Apps/Products
- 2.2 Integrate remote signing into your own (native) mobile Apps
- 2.3 Integrate remote signing into your own web portal
- 2.4 Integrate eSignAnyWhere document designer to define e-signing ceremonies in your own web application
- 3 Example of a complex integration
- 4 Hybrid Integration (UI & API)
- 5 Advanced Guides
The basic integration is just using eSignAnyWhere as middleware for automating signing workflows and for the remote signing itself. Your integrating system configures envelopes, recipients and tasks via API (SOAP/REST) and uses callback functions to get the status of a finished (or rejected) envelope.
The callback function is calling the integrating system (basically a URL call with an envelope-id parameter). The integrated system gets the callback and can then check the status (signed or rejected) and init further actions, like downloading the documents and audit trail to store it in your archive system and delete the original documents from the eSignAnyWhere server.
In-Person Signing with SIGNificant Apps/Products
This is a typical point of sale scenario, where the customer signs the document via Signature-Pad or Touchscreen (Windows, Android, iOS). Therefore you can use the SIGNificant Products and Apps (www.xyzmo.com Solutions). So you can use in one step of the workflow the flexible SIGNificant Platform for signing. After signing the workflow continues automatically. You even can ask the customer at the point of sale if he wants to sign via eSignAnywhere remote on his mobile phone, via Signature-Pad or Tablet Computer.
It is also possible to integrate the SIGNificant Biometric Server for biometric verification in real-time into your use-case. This requires devices capable of recording a biometric signature (e.g. Signaturepads, Tablet PC with native pen, Smartphones with pen, etc.) and a SIGNificant biometric server. Because of the need of the biometric server, just a on-premise installation is supported.
How to Integrate SIGNificant Products and Apps
To connect eSignAnyWhere with one of the SIGNificant Products or App you have to suppress sending the email and catch the workstepId.
1) Suppress Sending Email
Envelope Config XML for suppressing sending email for one recipient/workflow-step:
... <recipient> <languageCode>en</languageCode> <eMail>firstname.lastname@example.org</eMail> <firstName>Firstname</firstName> <lastName>Lastname</lastName> ... <disableEmail>True</disableEmail> ... <!-- optional authentication methods for this recipient --> </recipient> ...
2) Links to SIGNificant Products or catch a WorkstepId
eSAW supports to send out links for the SIGNificant products automatically via notifications. Therefore you just have to add to the recipient configuration (XML) the following parameters:
<envelope> <steps> <step> <recipients> <recipient> <addAndroidAppLink>0</addAndroidAppLink> <!-- 0 or 1 --> <addIosAppLink>0</addIosAppLink> <!-- 0 or 1 --> <addWindowsAppLink>0</addWindowsAppLink> <!-- 0 or 1 --> </recipient> </recipients> </step> </steps> </envelope>
Otherwise you can connect one workstep of eSignAnyWhere with one of the SIGNificant Apps. First you call the
GetEnvelopeById_v1 with the
envelopeID you got in sendEnvelope_v1. In the result you will find the
workstepRedirectionURL. This URL forwards the SignAnywhere Viewer (Web-Client), but with the additional parameter
&responseType=returnWorkstepId it returns the workstepId. Example:
With this WorkstepId you can now connect the SIGNificant product to the document. If the document is finsihed the workflow continues automatically.
Other parameters are:
responseType=redirectToViewer– redirects to SAW Viewer (default)
responseType=redirectToAndroidApp– redirects to Android App
responseType=redirectToIOsApp– redirects to iOS App
responseType=redirectToWindowsApp– redirects to Windows App
responseType=returnWorkstepId– returns the WorkstepId for other integration types
3) Client Redirect
If you want, that the recipient is not redirected to the significant.com webpage after signing the document, you can use the finish action to redirect the recipient to your prefered webpage.
Therefore you have to use the FinishAction in the WorkstepConfiguration of the recipient.
<FinishAction> <ClientAction clientName="SIGNificant SignAnywhere" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">http://www.xyzmo.com</ClientAction> </FinishAction>
This example would forward the SignAnywhere Viewer, after the recipient has signed the document to www.xyzmo.com. You can replace the link with your own or even with parameter to recpient specific pages.
Integrate remote signing into your own (native) mobile Apps
If you want to integrate the document signing for customers into your own Apps, we offer mobile SDKs for you. We support iOS, Android and Windows. Moreover, we have a 100% native SDK and a Hybrid SDK (for a Webbased-Document-Viewer).
So you can integrate into your App a user document-inbox, where the user find documents he/she has to sign. If the user has finished the document, the workflow (e.g. for internal review) continues automatically.
With this integration you can use your notification-channel (no emails via eSignAnyWhere), extend your App and users read & sign documents directly in your App. The use will not see, that he/she is using eSignAnyWhere, because it is seamless integrated into your App.
If you are interested in our mobile SDKs for integrating into your Apps, please contact us. We will provide you information about the Terms & Conditions and the SDK.
Integrate remote signing into your own web portal
This use case surpress sending emails via eSignAnyWhere, because you are sending to your customer the notifications and direct them to your web portal. The customer has to login at your web portal and navigate to the “inbox” or a “document section” and gets a list of all documents he/she has to sign. The eSignAnyWhere Viewer is integrated into your web portal.
How to integrate
Basically it is the same as In-Person Signing with SIGNificant Apps/Products. You have to surpress sending the email for the recipient (via XML) and instead of catching the WorkstepID you just take the
workstepRedirectURL of the response of
GetEnvelopeById_v1. This link you can show the user in your web portal for signing the document.
Integrate eSignAnyWhere document designer to define e-signing ceremonies in your own web application
If you are integrating eSignAnyWhere to be used within your web portal, you can use the eSignAnyWhere WYSIWYG document designer for defining e-signing ceremonies.
How to integrate
1) Create Draft and embed designer
First you have to create a draft (
CreateDraft_v1) and configure the option to allow an external designer (
<draftOptions> ... <allowAgentRedirect>true</allowAgentRedirect> <iFrameWhiteList>http://172.16.17.256;http://foo.org</iFrameWhiteList> ... </draftOptions>
allowAgentRedirect enables an anonymous designer integration (without eSignAnyWhere Login) and
iFrameWhiteList extends the HTTP header with a list to integrate in your web application or portal (via
2) Integrate Designer
The designer can be embedded by modifing the following string:
If the draft is finished you can start the envelope.
Example of a complex integration
The following picture show you an example of a complex integration/use case.
- An agent designs in your web portal via integrated document designer the e-signing ceremony
- The first signer (customer) gets a notification via mobile app on his smartphone/tablet and gets an email that a document can be signed in the web portal. The customer is able to sign in the app or in the web-portal after login.
- An agent has to confirm the signed document. The agent gets an email from the eSignAnyWhere System and signs it in the browser.
Hybrid Integration (UI & API)
In some scenarios it makes sense to send the envelopes via UI by the user and have an automated post processing, when the envelope get finished. Therefore you can configure in the Organiatzion Settings a default callback, which is used by using the UI. You still can overwrite it via API.
Recommended is to use the envelope status change callback to get detailed information about the callbacks. See API Reference for details how to configure the callback.
So you can allow users to send envelopes via eSAW UI and integrate a post processing, e.g. for automated archiving.
Callbacks on Custom Events
You can define specific callbacks on specific events (e.g. if you want to get notified when a signer rejects the agreement text). A detailed description of this feature you can find here.