Easy Sign API Template Integration

DocVerify Easy Sign System API Template Integration

API Integration Using a DocVerify Library Template Document

The DocVerify Easy Sign API System will allow you to easily integrate the DocVerify e-Signature platform inside an IFrame directly within your own web site giving you full control, and allowing the first signer to sign the document directly from your own desired web pages.

The system works by allowing you to use a template from from DocVerify Library, and allowing you to display that document from within an IFrame through the e-signature platform. The system is also fully integrated with our Smart Tags, which will allow you to designate special fields, and locations where you want signature elements to appear within the document. The Smart Tags will also allow you the flexibility of creating any type of text field within your PDF for DocVerify to populate. In addition to the Smart Tags, you can also create signature elements on the fly using our XML system. Please refer to both the Smart Tags and XML documentation for more information about the two systems.

The Easy Sign System also works with the DocVerify URL Push or Web Hook system. If both are activated, DocVerify will update your system in real time when new signature documents are created and their status as signers do things such as view or sign documents. The system allows up to three signers per document. The first signer signs through the Easy Sign System, but all others will sign through the normal workflow.

This feature may require special activation, and API access is also required.

For more information visit www.docverify.com or contact DocVerify sales at sales@docverify.com.

To use the system, you must first activate it after the feature has been enabled for you.

IMPORTANT: When testing, make sure you are not signed in to DocVerify.

To activate:

  1. Sign in to DocVerify
  2. Go to "My Account"
  3. Click on the API tab
  4. Click on API Activation.
  5. Click on Active Easy Sign.

After activation, you will receive an "API Key" and "API Signature" needed for the API, and an "IKey" needed for the Easy Sign System, which you will use to access the Easy Sign system from within your own web site.

Note: By using the DocVerify Easy Sign System you agree to the DocVerify Terms of Use. It is also the responsibility of the originator to authenticate the signer when using the Easy Sign System.

Precautions: Although not required, it is highly recommended to utilize javascript in order to hide certain aspects of the url when submitting to DocVerify such as creating the src link for the iframe.

Creating a new document signature request is a two step process. Step 1, you must upload the document through the API. Step 2, after a successful upload you will take the DocVerify ID and use that ID to access the document through an IFrame. The steps are fully explained below.

Step 1:

Requirements

Access to the Internet over port 443. Support for XML Web Services. Such support is available through a wide range of tools, such as:

  • Microsoft .NET languages (VB.net, C#, ASPX)
  • Java
  • PHP
  • SOAP toolkits
  • etc.

Document MUST be a PDF, and cannot exceed 300K in size.

Programmers Guide

Accessing the DocVerify API Web Service

DocVerify Easy Sign API Web Service WSDL may be accessed at https://api.docverify.com/easysign/v2/?wsdl.

The DocVerify Easy Sign API Web Service may be accessed at https://api.docverify.com/easysign/v2/.

Method Reference

All properties or variables are required unless they are specifically stated as being optional.

Method Name: AddNewEasySignTemplate

Return Value: string. In case of successful submission - the value contains the DocVerifyID. In case of a failure, a negative value is returned.

0 < Error - See Appendix A

Step 2:

After you have successfully received a DocVerify ID, you will be able to access that document through an IFrame.

Note: After receiving the DocVerifyID you may have to wait a couple of seconds before invoking the IFrame.

IMPORTANT: The Easy Sign system should be in a secure authenticated area of your website in order to maintain the highest levels of authenticity.

Basic Integration:

<iframe id="dviframe" src="http://www.docverify.com?ikey={YOUR IKEY HERE}&dvs={DOCVERIFY ID AFTER SUCCESSFUL SUBMISSION}" width="840" height="1150" frameborder="0">

Simply copy and paste the above HTML IFrame code into your existing web site, replace the ikey with your DocVerify IKey, replace the email with the signer's email, and replace the templateid with the Template ID from your DocVerify library.

For example, if our ikey is "1234567890", and the DocVerify ID is "ABCD1234-0000-0000-0000-ABCD1234ABCD". The Iframe HTML would look like the one below.

<iframe id="dviframe" src="http://www.docverify.com?ikey=1234567890&dvs=ABCD1234-0000-0000-0000-ABCD1234ABCD" width="840" height="1150" frameborder="0">

And that's it.... every time the IFrame loads a new document is created on the fly for the signer to sign right within your own web site

Important: All IFrame source MUST be URL Encoded.

IFrame Testing:

You can easily test the IFrame from within your own web site without incurring any charges until the functionality is achieved on your web site If the testmode parameter is included, and testmode=true, the IFrame will load with a test document that will have a similar layout as the actual live documents. Simply use the code below as a reference, and replace ikey with your own DocVerify IKey.

<iframe id="dviframe" src="http://www.docverify.com?ikey={YOUR IKEY HERE}&testmode=true" width="840" height="1150" frameborder="0">

Javascript or Server Side:

In some cases you will have to either use javascript for client side source manipulation of the Iframe src or use server side applications to manipulate or change the IFrame src. We will not be discussing any of the server side methods because any number of technologies such as .Net, PHP, Java, Ruby, etc., can be used. For most Javascript will do the job.

For this example we will use Javascript, and the only assumption we will make is that the page will have a textbox with the id of "txtemail" where the signer can enter their email address; however, this email address can be derived from any number of places, but for this example the signer will enter it.

<script type="text/javascript">

//set IKey

var ikey = "1234567890";

//Set DocVerify ID

var docverifyid = "ABCD1234-0000-0000-0000-ABCD1234ABCD";

//create the source string for the IFrame

var src = "http://www.docverify.com?" + "ikey=" + ikey + "&dvs=" + docverifyid

// set the iframe src

window.frames['dviframe'].src = src;

</script>

There is lots of information out there on the web on how to do all of the above, we also recommend taking a look at jquery as well for simplifying Javascripting.

Javascript Tools:

Javascript Obfuscator

Javascript JQuery

Appendix A - Return Codes

Results of DocVerify API Web Service