developers.esigngenie.comAPI Documentation eSign Genie

-- Toggle navigation Getting Started About eSign Genie Creating a developer account General guidelines Authentication Generating access token Folders API Getting template info Getting all templates list for your account -- Creating a new folder from templates -- Creating a new folder from PDFs Creating embedded signing session Creating embedded sending session Sending Draft Folder by Folder Id Update Envelope Fields Update Envelope Custom Fields -- Get folder details Download folder files Download single document pdf Delete folder(s) Templates API Creating a new template from PDF Creating a new folder from templates Getting all templates list for your account Get template details Parties API Get email group details Creating a new email group Webhooks Webhook Events Webhook Security Webhook Channels Create Webhook Channel Get Webhook Channel Details Get all Webhook Channel Details Update Webhook Channel Activate Webhook Channel Deactivate Webhook Channel Delete Webhook Channel Users API Create New User Update User Delete User List All Users Account API Create New Account Cancel Account Reactivate Account Change Licences Change Plan Error Handling FAQ -- Change History Getting Started About eSign Genie eSign Genie is the #1 easiest and most collaborative contract management and esignature software with the most robust functionality amongst its peers. Key features include: Collaborative contracts and agreement building; template contract creation; esignature workflow to obtain esignature(s) from single, or multiple users; advanced bulk esignature solution with dashboard; notification receiving control; API for esignature integration with other software or websites and a lot more... For more information on eSign Genie Software, please contact us at info@esigngenie.com Create a Developer Account Activate the developer account with eSign Genie under the API tab in the settings menu. (This menu will only be visible after you have purchased the API service from eSign Genie). Fill in the form to obtain your API Key and API Secret under your API settings. This is how your API information will display: General Guidelines eSign Genie is an oAuth2 provider. Security implementation is based on the final version of "The OAuth 2.0 Authorization Framework". All requests must be made via HTTPS. Authentication Generating Access Token Client Credentials Access your eSign Genie account from your application Your website/application can generate an access token of grant_type: client_credentials as follows: POST https://www.esigngenie.com/esign/api/oauth2/access_token CONTENT TYPE application/x-www-form-URLencoded REQUEST Parameter Description grant_type This value should be client_credentials client_id Your API Key from the API menu under the Settings Tab client_secret Your API Secret from the API menu under the Settings Tab scope Please use read-write , in order to send documents RESPONSE { "access_token":"ACCESS_TOKEN", "token_type":"bearer", "expires_in":31536000 } Sample Code CURL PHP CURL C# Java curl https://www.esigngenie.com/esign/api/oauth2/access_token \ > -d "grant_type=client_credentials" \ > -d "client_id=CLIENT_ID" \ > -d "client_secret=CLIENT_SECRET" \ > -d "scope=read-write" \ > -H "Content-Type: application/x-www-form-urlencoded" \ > -X POST <?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://www.esigngenie.com/esign/api/oauth2/access_token", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "grant_type=client_credentials&client_id=CLIENT_ID&client_secret=CLIENT_SECRET&scope=read-write", CURLOPT_HTTPHEADER => array( "cache-control: no-cache", "content-type: application/x-www-form-urlencoded" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } var request = (HttpWebRequest)WebRequest.Create("https://www.esigngenie.com/esign/api/oauth2/access_token"); var postData = "grant_type=client_credentials" + "&client_id=" + CLIENT_ID + "&client_secret=" + CLIENT_SECRET + "&scope=read-write"; var data = Encoding.ASCII.GetBytes(postData); request.Method = "POST"; request.ContentType = "application/x-www-form-urlencoded"; request.ContentLength = data.Length; using (var stream = request.GetRequestStream()) { stream.Write(data, 0, data.Length); } var response = (HttpWebResponse)request.GetResponse(); using (var streamReader = new StreamReader(response.GetResponseStream())) { var responseString = streamReader.ReadToEnd(); } URL url= new URL("https://www.esigngenie.com/esign/api/oauth2/access_token"); HttpURLConnection con= (HttpURLConnection) url.openConnection(); con.setDoOutput(true); con.setUseCaches(false); con.setRequestProperty("Content-Type","application/x-www-form-urlencoded"); String urlParameters = "grant_type=client_credentials&client_id= CLIENT_ID &client_secret= CLIENT_SECRET &scope=read-write"; DataOutputStream wr = new DataOutputStream(con.getOutputStream()); wr.writeBytes(urlParameters); if (con.getResponseCode() != HttpURLConnection.HTTP_OK) { throw new RuntimeException("Failed : HTTP error code : "+ con.getResponseCode()); } BufferedReader br = new BufferedReader(new InputStreamReader((con.getInputStream()))); String output; System.out.println("Output from Server .... \n"); while ((output = br.readLine()) != null) { System.out.println(output); } con.disconnect(); Now you can make calls to the eSign Genie API with this ACCESS_TOKEN. Please include ACCESS_TOKEN to request headers with every request as indicated. Authorization: Bearer ACCESS_TOKEN CURL curl https://www.esigngenie.com/esign/api/folders/createfolder \ > -i \ > -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ > -H "Content-Type: application/json" ... Document(s) Folder API All API requests start with https://www.esigngenie.com/esign/api/ . Get Template Info You can get information about a template with the following endpoint -- Create folder of documents from PDF files With eSign Genie API you can create a folder of documents and send them for signature right from your own application. To create a folder of documents from PDF files you can either provide publicly accessible URLs to PDF documents or pass PDF documents as multipart form data and other parameters about the recipient parties, etc. While creating the documents from PDF files you can define various fields like text field or signature field within the document using simple Text Tags . You can assign various properties for these fields like party responsible for filling the data etc. These Text Tags will then be converted to eSign Genie document fields. Or if you don't want to use Text Fields within the document, then you can also request to create an embedded document preparing session where you can manually drag and drop each field on the document itself without leaving your application. Preparing PDF documents with text tags To send a PDF document from your application for signature, you need to define the signature and other eSign Genie fields in the documents, and who is allowed to fill in the data. eSign Genie supports simple Text Tags. A Text Tag is a simple text block within your PDF document which defines the field type, the party who is responsible for it, and other field specific options. Quick Tip : When you apply Text Tags to the document, eSign Genie does not remove or replace the Text Tags text. You can hide codified Text Tags by using the same font color as the background of the document. So the Text Tags can be used by eSign Genie processes and it will not be visible on the document. Field Type: One of 'textfield', 'signfield', 'initialfield', 'datefield', 'checkboxfield' or short notations. Party Number (optional): the sequence number of the reci...