Echos

EchoSign API Guide
This document provides an overview of how to use the EchoSign API in common integration scenarios.

Table of Contents
Sending a document for Signature ........................................................................................................... 2 Checking the status of a document...................................................................................................... 2 Retrieving the final signed document................................................................................................... 3 Signing Widgets ....................................................................................................................................... 4 Checking the status of a document signed through awidget................................................................ 4

1 EchoSign API Guide (rev1 - October 11, 2010) Copyright © EchoSign Inc. 2005-2010

Sending a document for Signature
To send a document out for signature through the EchoSign API, call the sendDocument method. This method has 3 parameters that you will need to pass, apiKey, senderInfo and documentCreationInfo. For more information on EchoSign APImethods, please refer to the API documentation. After you send a document, you can retrieve up-to-date status of the document either by polling, or when EchoSign notifies you the status of the document has changed.

Checking the status of a document
There are two ways you can retrieve up-to-date status of the document: by polling, or by calling the getDocumentInfo method when EchoSign notifies youthe status of the document has changed.

1. Polling
You can call the getDocumentInfo method periodically to check the status of your documents. The upside of polling is that it is more reliable in the event that callback fails since your system is down, scheduled maintenance, lack of connectivity, etc. The downside is that you have to create a scheduling mechanism to query the status of alldocuments that were not yet signed, waste time and resources checking to see if a document status has changed instead of only retrieving the updated status when you know it has changed. If you choose to use polling, we recommend you will have different policies based on document “age” ie. reducing the frequency of polling if the document was not signed after X days.

2. Ping Notifications
Pingnotifications allow your application to retrieve up-to-date status after EchoSign notifies you the status of a document had changed. In the CallbackInfo object used in DocumentCreationInfo, you can set the signedDocumentUrl parameter. This is the URL to which EchoSign will call your system using HTTP GET every time the status of the document has changed. You can then use getDocumentInfo to get thelatest status of the 2 EchoSign API Guide (rev1 - October 11, 2010) Copyright © EchoSign Inc. 2005-2010

document. You probably have a unique identifier on your end for each document, and some sort of table that maps that to the documentKey you get as an output from sendDocument. Pass your unique identifier as a parameter in the URL, so that when EchoSign pings you to notify the document statushas changed, you will know which document ID on your end we are talking about, and subsequently which documentKey. Then, call the getDocumentInfo method and provide that documentKey, and EchoSign will return the updated status of the document. In most cases, when the document status is “Signed”, you would like to retrieve the signed document PDF using the getLatestDocument method and store it inyour system. The HTTP GET method of retrieving up-to-date document status is not configured by default. Please contact EchoSign if you wish to use this option.

Retrieving the final signed document
There are two ways you can retrieve the final signed document: calling getLastestDocument after the document has been signed, or by setting the signedDocumentUrl where EchoSign will do a HTTP PUT...