Getting Started

About Foxit eSign

Foxit eSign 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 Foxit eSign Software, please contact us at info@esigngenie.com

Create a Developer Account

Activate the developer account with Foxit eSign under the API tab in the settings menu.
(This menu will only be visible after you have purchased the API service from Foxit eSign).
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

Foxit eSign 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.

Parameter	Description
{{Host_Name}} for US Region	na1.foxitesign.foxit.com
{{Host_Name}} for EU Region	eu1.foxitesign.foxit.com

Pass the respective {{Host_Name}} as per the desired region. Old eSign Genie API customers can replace 'esigngenie.com/esign' with 'na1.foxitesign.foxit.com'

Authentication

Generating Access Token

Client Credentials Access your Foxit eSign account from your application

Your website/application can generate an access token of grant_type: client_credentials as follows:

POST https://{{HOST_NAME}}/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.
emailId (Optional)	Email-id of one of the Super-Admin Users from your account, whom you want to make API Owner. Note: This is mandatory only when the account owner of the company is Setup Admin.

RESPONSE

{
	"access_token":"ACCESS_TOKEN",
	"token_type":"bearer",
	"expires_in":31536000
}

Sample Code

curl https://{{HOST_NAME}}/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://{{HOST_NAME}}/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://{{HOST_NAME}}/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://{{HOST_NAME}}/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 Foxit eSign API with this ACCESS_TOKEN. Please include ACCESS_TOKEN to request headers with every request as indicated.

Authorization: Bearer ACCESS_TOKEN

CURL

curl https://{{HOST_NAME}}/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://{{HOST_NAME}}/api/.

Create folder of documents from PDF files

With Foxit eSign 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 Foxit eSign 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 Foxit eSign fields in the documents, and who is allowed to fill in the data. Foxit eSign 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, Foxit eSign 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 Foxit eSign processes and it will not be visible on the document.

Field Type: One of 'textfield', 'formulafield', 'signfield', 'initialfield', 'datefield', 'checkboxfield', 'attachmentfield', 'imagefield', 'accept', 'decline' or short notations.
Party Number (optional): the sequence number of the recipient party from the parties list which will be responsible for filling this field.
Required/Optional Field: 'y' makes the field mandatory to be filled before signing while 'n' makes it optional.
Field Name: Optional. Assign a name to this field. Assigning names to fields is a good practice for better productivity as named fields are downloaded in the document from data report and all same named fields in a document will automatically take up the value typed once in any one of those fields. Please note not to include any space character for the name of the field (or anywhere else in the Text Tag) as it will then not recognize that word as a proper Text Tag syntax, instead you can use underscore which will then be replaced with space character in the final Foxit eSign field.
Underscores: Optional. A way to increase the field's width.

There are other options that you can add before underscores for various other properties as follows:

Sizing

By default, the new field has the same width and height as the original text tag, however it can be overridden by adding custom width as 90 and height as 20 (in pixels):

${textfield:1:y:field_name:90:20}

Validation

You also can validation information for text fields inside the tags. For example, the max number of characters required are 12 and only Numbers:

${textfield:1:y:field_name:90:20:12:Numbers}

And if you want to stick to the default height and width for the new field (which is the height and width of the text tag)

${textfield:1:y:field_name:::12:Numbers}

NOTE: validation inputs are currently only available for textfields

Font Style

You can also control the font style for each new field via their text tags. For example, the following tag creates a textfield with 14 font size and gray as font color

${textfield:1:y:field_name:90:20:12:Numbers:14:gray}

Pre-Filled Value

You can pass pre-filled value to the textfields via its text tags as shown below. Please make to replace any space character with '_' (underscore) else the system may not recognize that text tag.

${textfield:1:y:field_name:90:20:12:Numbers:14:gray:default_value}

NOTE: pre-filled values are currently only available for textfields

Mark as Dependent Field

You can make a field dependent on any other field value. To set a field dependent on another field, select the values of the independent field that will enable the signer to see the dependent field.

${t:1:y:field_name:90:20:12:Numbers:14:gray:default_value:parent_field_name:value_of_parent_field:options}

Column	Description
parent_field_name	Name of the parent field. NOTE: Only the following type of fields are allowed as the parent or independent field: `textfields\|textbox\|checkbox\|radiobutton\|dropdown`
value_of_parent_field	Value of the parent field. NOTE: In the case of the radio button and checkbox, the value can be either `checked` or `unchecked`
options (optional)	In the case of textfield, the value can be either `isblank` or `allowNull` or `contains`

The full list of Field Types is:

TextField - textfield or t (short notation)
TextBox - textboxfield or tb (short notation)
Signature - signfield or s
FormulaField - formulafield or ff
Initial - initialfield or i
Date - datefield or d
Checkbox - checkboxfield or c (recommended)
Radio Button - radiobuttonfield or rb (recommended)
Secured Field - securedfield or sc
Attachment Field - attachmentfield or a
Image Field - imagefield or img
Signer Name Field - textfield or t
Date Signed - datefield or d
Accept Button - accept or ab
Decline Button - decline or db
PayField - payfield or pf

Examples

${textfield:1:y:client_name:________} - A mandatory textfield which is assigned to party number 1 with field name as 'client name'.
${tb:1:n:________________} - An optional textbox assinged to party 1.
${signfield:1:y:____} - A mandatory signature field assigned to party number 1.
${i:2:n} - An optional initial field assigned to party number 2.
${datefield:2:n::____} - An optional date field assigned to party number 2 with empty field name.
${c:2:y:male:gender:::multicheck} - A checkbox assigned to party number 2 with initial value as checked with name 'male' and group 'gender' with multiple check option enable to same group checkbox.
${c:1:y:yes:group-y} - A checkbox assigned to party number 1 with initial value as checked with name 'yes' and group 'group'. 'group-y' means group mandatory.
${rb:1:n:yes:grp1} - An un-selected radio button assigned to party 1 with the name yes and grp 'grp1'.
${rb:1:y:no:group2-y} - A radio button assigned to party number 1 with initial value as checked with the name 'no' and group 'group2'. 'group2-y' means group mandatory.
${sc:2:n:Credit_Card_Number:4:____} - A secured field assigned to party 2, which is optional with the name 'Credit Card Number' and only last 4 characters to remain unmasked.
${attachmentfield:1:y:____} - A mandatory attachment field assigned to party number 1.
${img:1:n:stamp_image:120:50:__} - An optional image field is a field name 'stamp image' with 120-pixel width and 50-pixels height which is assigned to party number 1.
${textfield:1:y:Signer_Name:________} - A mandatory signer name field which is assigned to party number 1 with field name as 'Signer_Name'. This field is auto-populated once the document is opened by the signer.
${datefield:1:y:Date_Signed:_______} - A mandatory date signed field assigned to party number 1 with field name as 'Date_Signed'. This field will auto populate once the document is opened by the signer.
${accept:1:90:20} - A accept button field with 90-pixel width and 20-pixel height assigned to party number 1.
${decline:1:90:20} - A decline button field with 90-pixel width and 20-pixel height assigned to party number 1.
${payfield:1:paymentType:payeeOptions:productAndService:paymentDescription:paymentAmount} - Tag consolidates Payment Type, Product/Service, Payment Description, and Payment Amount to utilize the payment field.

Personalized Fields:We can use the personalized field tag while sending it via API in place of process tags. Personalized field creation instructions can be seen in the help center.

Examples

${field_7:1}Using this format, you can simply use the existing personalized field name and properties assigned to party #1.
${field_15:1:y:field_name:90:20} Using this format, you can simply use the existing personalized field name

Here is a PDF file with some other Text Tag samples: Sample Document.

Preparing PDF documents with Recipient Party Tags

To send a PDF document from your application for signature, you can either define the recipient parties in the documents itself or send the recipients information via API call. Foxit eSign supports simple Text Tags for recipient party information. In case both API call and Tags on the PDF are provided with Recipient Party information, Foxit eSign will use API call values.

A Recipient Party Tag is a simple text block within your PDF document that defines the party, who is responsible for filling the fields.
Quick Tip: When you apply Recipient Party tags to the document, Foxit eSign does not remove or replace the Recipient Party Tags text. You can hide codified Recipient Party Tags by using the same font color as the background of the document, so the Recipient Party tags will be used by Foxit eSign to derive signers. Still, the tags will not be visible on the document.

Tag Type: Accepts only value as rp, which is an identifier of recipient party tags.
Party First Name: First name of the recipient party.
Party Last Name: Last name of the recipient party.
Party email: Email of the recipient party.
Party permission: Use this field to assign folder permissions to a recipient. It can be any one of the following values: FILL_FIELDS_AND_SIGN, FILL_FIELDS_ONLY, SIGN_ONLY, VIEW_ONLY
Party workflow sequence: If the document is signed in sequence, the recipient party will receive the notification as per the workflow sequence number. It should be starting with 1 like 1,2,3,4, etc.
Party sequence: Assign a sequence number to a recipient in the list of recipient parties. Use unique sequence numbers or party numbers for each party, starting with 1 like 1,2,3,4, etc.

Adding Fields in Document(s) via API

Fields can also be added to the documents via an array of JSON objects in the input data for the API request. This way of adding fields gives you more control over the size of fields, their font color and font size, etc.

While adding the fields on each document page, the position of the fields is relative to the top left corner of that page.

Each field object must contain the following values:
NOTE: If one of these values is missing field may disappear.

type - (string) the type of field to be added at this place. Can be one of these values: text|signature|initial|textbox|date|secure|checkbox|radiobutton|dropdown|attachment|image|accept|decline
x - (int) the x location coordinate of the top left corner of the field in pixels
y - (int) the y location coordinate of the top left corner of the field in pixels
width - (int) the width of the field in the pixel
height - (int) the height of the field in pixel
documentNumber - (int) the document index in the document files array starting from 1
pageNumber - (int) page in the document where the field needs to be added

There are other parameters which can be optional and different for different field types.

text or textbox type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
value - (string)
required - (boolean) value: either true or false
textAlignment - (string) value: left, center, or right
characterLimit - (int)
fontSize - (int)
fontColor (string) example: #0000FF for blue
validation (string) value: anyone from None(default) or Numbers or Letters or RegexValidation(in case of text type) or CanadianSin(Canadian SIN Number)
hideFieldNameForRecipients - (boolean) value: either true or false

formulafield type

party - (int) party index from the parties submitted in this request starting from 1
formulafieldName - (string)
formula - (string)
fontFamily - (string)
documentNumber - (int)
fontSize - (int)
fontColor (string) example: #0000FF for blue
x - (int) the x location coordinate of the top left corner of the field in pixels
y - (int) the y location coordinate of the top left corner of the field in pixels
width - (int) the width of the field in pixel
height - (int) the height of the field in pixel
pageNumber - (int) page in the document where field needs to be added
tabOrder - (int)
decimalPlaces - (int)

payfield type

payeeOptions - (string) Specify payment methods for the payee to choose from any of the following options:["CardPayment"] or ["AchBankPayment"] or ["CardPayment", "AchBankPayment"]
paymentType - (string) Determines payment amount type: "Fixed" or "Payee decides". Note: "Payee_decides" in case of text tag.
paymentAmount - (string) Required for 'Fixed' payment type, must be an integer or have up to two decimal places
paymentDescription - (string) Description of the payment (Character limit: 250)
productAndService (string) Name of the product or service (Character limit: 75)
documentNumber - (int)
pageNumber - (int) page in the document where field needs to be added
x - (int) the x location coordinate of the top left corner of the field in pixels
y - (int) the y location coordinate of the top left corner of the field in pixels
tabOrder - (int)
width - (int) the width of the field in pixel
height - (int) the height of the field in pixel
party - (int) party index from the parties submitted in this request starting from 1

Note:

signature or initial type

party - (int)
required - (boolean) value: either true or false

date type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
value - (string)
required - (boolean) value: either true or false
textAlignment - (string) value: left, center, or right
fontSize - (int)
fontColor (string) example: #0000FF for blue
dateFormat (string) example: MM-DD-YYYY for 04-30-2019
hideFieldNameForRecipients - (boolean) value: either true or false

secure type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
value - (string)
required - (boolean) value: either true or false
fontSize - (int)
fontColor (string) example: #0000FF for blue
charToDisplay (int)
hideFieldNameForRecipients - (boolean) value: either true or false

checkbox type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
group - (string)
required - (boolean) value: either true or false
multicheck - (boolean) value: either true or false
hideCheckboxBorder - (boolean) value: either true or false

dropdown type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
value - (string)
required - (boolean) value: either true or false
fontSize - (int)
fontColor (string) example: #0000FF for blue
options (array of strings)
hideFieldNameForRecipients - (boolean) value: either true or false

attachment type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
required - (boolean) value: either true or false
hideFieldNameForRecipients - (boolean) value: either true or false

image type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
required - (boolean) value: either true or false
inputType - (string) value: either url or base64
imageName - (string) image name with extension(png, jpg or jpeg)
source - (string) value: either url or base64 value

signer name type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
required - (boolean) value: either true or false
fontSize - (int)
fontColor (string) example: #0000FF for blue
readOnly - (boolean) value: either true or false
systemField - (boolean) value: either true or false

date signed type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
required - (boolean) value: either true or false
textAlignment - (string) value: left, center, or right
fontSize - (int)
fontColor (string) example: #0000FF for blue
dateFormat (string) example: MM-DD-YYYY for 04-30-2019
readOnly - (boolean) value: either true or false
systemField - (boolean) value: either true or false

accept or decline type

party - (int)

Apply Template while uploading the documents

You can copy template fields to the document via API while using the call: /folders/createfolder
To copy template fields while uploading the document, add the following to your document folder creation API call:

Parameter	Description
applyTemplate Default `false`	Value can be either `true` or `false` If `true`, It will process the copy template fields.
templateIds	An array of template IDs you want to use to copy template fields into the documents for this folder. You can determine the template ID from the template URL.(https://{{HOST_NAME}}/templates/prepareimmutabletemplate?template.templateId={TEMPLATE_ID})
templateFieldsValues (optional)	You may pass of the field values used in the templates to prefill them in the documents created from the template. FIELD_NAME is the name of the field used in the template. FIELD_VALUE is the document field value.

Sending the documents

To create a document from PDF files you need to make a call to /folders/createfolder with the given parameters.

You can either store the document as 'Draft' in your Foxit eSign account and send it later.
Or you can directly send the document via Foxit eSign API.
Or you can embed the document directly inside your application.

1. When using file URLs

POST /folders/createfolder
Content-Type application/json

REQUEST

{
	"folderName":"Sample Documents",
	"fileUrls":[
		"URL_TO_DOCUMENT_1","URL_TO_DOCUMENT_2",...
	],
	"fileNames":[
		"document_1.pdf","document_2.pdf",...
	],
	"processTextTags":true,
	"processAcroFields":true,
	"signInSequence":false,
	"inPersonEnable":false,
	"custom_field1":{
  	"name":"NAME",
  	"value":"VALUE"
         },
    
      	"custom_field2":{
  	"name":"NAME",
  	"value":"VALUE"
         },    
	"sendNow":false,
	"signSuccessUrlAllParties":false,
	"emailTemplateId":2,
	"signerInstructionId":1,
	"confirmationInstructionId":2,
	"emailTemplateCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_1",
  		"type":"plain",
  		"value":"Please click on the View Document(s) link below to review and esign the documents as required."
  	},
  	{
  		"tag":"CUSTOM_TAGS_2",
  		"type":"hyperlink",
  		"value":"click here's",
  		"url":"HYPERTEXT_REFERENCE"
  	}
  	
  	
  	],
  	"signerInstructionCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_1",
  		"type":"plain",
  		"value":"Please review the document."
  	}
  	],
  	"confirmationInstructionCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_2",
  		"type":"plain",
  		"value":"Click here to confirm signing."
  	}
  	],
	"createEmbeddedSendingSession":false,
	"fixRecipientParties":true,
	"fixDocuments":true,	
	"hideSignerSelectOption":false,
	"enableStepByStep":false,
	"hideAddMeButton":false,
	"hideAddNewButton":true,
	"hideAddGroupButton":false,
	"hideSignerActions": false,
	"hideSenderName": true,
	"hideFolderName": false,
	"hideDocumentsName": true,
	"sendSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"sendErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"createEmbeddedSigningSession":true,
	"createEmbeddedSigningSessionForAllParties":false,
	"embeddedSignersEmailIds":["FIRST_EMBEDDED_SIGNER_EMAIL","SECOND_EMBEDDED_SIGNER_EMAIL"],
	"signSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signDeclineUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signLaterUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"themeColor":"ANY_CSS_COLOR_TO_MATCH_YOUR_APPLICATION",
	"sessionExpire":false,
	"expiry":300000,
	"allowSendNowAndEmbeddedSigningSession":false,
	"allowAdvancedEmailValidation":true,
	"metadata":{
	"DATA_KEY1":"DATA_VALUE1",
	"DATA_KEY2":"DATA_VALUE2",
	"DATA_KEY3":"DATA_VALUE3",
	"DATA_KEY4":"DATA_VALUE4",
	    ........
	}
	"hideFieldNameForRecipients":false,
        "hideCheckboxBorder":false,	
        "selfSign":false,
        "selfSignerSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SELF_SIGN_SESSION",
	"parties":[
		{
			"firstName":"FIRST_NAME_OF_RECIPIENT_PARTY",
			"lastName":"LAST_NAME_OF_RECIPIENT_PARTY",
			"emailId":"EMAIL_ID_OF_RECIPIENT_PARTY",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"hostEmailId":"EMAIL_ID_OF_INPERSON_ADMINISTRATOR",
			"allowNameChange":true,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			"signerAuthLevel":"Email Access Code"
		},
		{
			"firstName":"FIRST_NAME_OF_RECIPIENT_PARTY",
			"lastName":"LAST_NAME_OF_RECIPIENT_PARTY",
			"emailId":"EMAIL_ID_OF_RECIPIENT_PARTY",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"hostEmailId":"EMAIL_ID_OF_INPERSON_ADMINISTRATOR",
			"allowNameChange":true,
			"signerAuthLevel":"User-defined Access Code",
			"userDefinedAccessCode":"123Test@"
		},
		....
	],
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":50,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"optional name",
			"tooltip":"",
			"value":"optional value",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters",
			"hideFieldNameForRecipients":false

		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1,
			"inputType":"url or base64",
			"imageName":"logo.png",
			"source": "URL or BASE64 String"		   
		},
		{
			"type":"text",
			"x":552,
			"y":150,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers"
		},
		{
                       "type":"formulafield",
                       "formulafieldName":"Formula_Field_Name",
                       "formula":"[n1] + [n2]",
                       "fontSize":8,
                       "fontFamily":"default",
                       "fontColor":"#000000",
                       "documentNumber":1,
                       "pageNumber":1,
                       "x":100,
                       "y":280,
                       "tabOrder":1,
                       "width":50,
                       "height":100,
                       "party": 1,
                       "decimalPlaces": 2
                },
        
		{
			"type":"signature",
			"x":200,
			"y":150,
			"width":100,
			"height":50,
			"documentNumber":1,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"dropdown",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"party":1,
			"value":"US",
			"options":["UK","Canada","Australia","US","France"]
		},
		{
			"type":"accept",
			"party":1,
			"documentNumber":1,
			"pageNumber":1,
			"x":350,
			"y":505,
			"width":90,
			"height":15
		},
		{
			"type":"decline",
			"party":1,
			"documentNumber":1,
			"pageNumber":1,
			"x":450,
			"y":505,
			"width":90,
			"height":15
		},
		{
			"type":"attachment",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"party":1,
			"required":true,
			"name":"optional name"
			
		},
		{
			"type":"text",
			"textfieldName": "Signer Name",
			"x":300,
			"y":250,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"Signer Name",
			"characterLimit":100,
		 	"partyResponsible": 1,
			"required": true,
			"fontSize": 12,
			"fontFamily": "default",
			"fontColor": "#000000",
			"readOnly": true,
			"systemField": true
		},		
		{
			"type": "date",
			"x":220,
			"y":150,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"Date Signed",
			"required":true,
			"fontSize":12,
			"dateFormat": "MM-DD-YYYY",
			"readOnly": true,
			"systemField": true			
		},
		{
			"type":"hyperlink",
			"x":50,
			"y":350,
			"width":150,
			"height":15,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"HLFN1P1",
			"value":"click hear only party 1",
			"url":"https://developers.esigngenie.com/#createfolderfrompdfs",
			"tooltip":"Allow clickable for party 1 HFD_1_P1",
			"required":true,
			"fontSize":10,
			"fontColor":"#0000ff"
		}
		],
	"dependentFields":[
		{ 
			"dependentFieldName":"DEPENDENT_FIELD_NAME",
			"parentFieldName":"PARENT_FIELD_NAME",
			"parentFieldValue":"VALUE_OF_PARENT_FIELD",
			"options":"contains"
		},
		{ 
			"dependentFieldName":"DEPENDENT_FIELD_NAME",
			"parentFieldName":"PARENT_FIELD_NAME",
			"parentFieldValue":"VALUE_OF_PARENT_FIELD",
			"options":"contains"
		}....
		],
	"applyTemplate":true,
	"templateIds":[ID_OF_TEMPLATE_A,ID_OF_TEMPLATE_B],
	"templateFieldsValues": 
		{
    		"TEMPLATE_FIELD1_NAME":"FIELD1_VALUE",
          	"TEMPLATE_FIELD2_NAME":"FIELD2_VALUE"
            	....
    	},	
		
	"senderEmail":"user2@example.com"
	
}

Parameter Description

folderName (required) Name of the document(s) folder

inputType (optional)
Default url Value can be either url or base64

fileUrls
(required if inputType is url) An array of URLs to PDF documents you are sending. It should be publicly accessible when you are creating the document.

base64FileString
(required if inputType is base64) An array of BASE64 to PDF documents you are sending. It should be publicly accessible when you are creating the document.

fileNames (required) An array of the file names whose URLs are given in the previous parameter

Custom Fields (optional)
Two custom fields custom_field1 and custom_field2

Parameter	Description
name	Name of the custom field
value	Value of the custom field

Custom fields can be used for many purposes such as identifying the application and module where the signed document belongs. You can use the custom fields as per your requirements. Maximum of two custom fields can be passed to Foxit eSign via API that is stored at the folder level. The webhook response includes these custom fields.

metadata (optional) This should be in the key value pair. Maximum 1000 key value pairs are allowed.

processTextTags (optional) Value can be either true or false
Use this field to determine whether Foxit eSign should parse your documents for Text Tags to convert them into Foxit eSign fields.

processAcroFields (optional) Value can be either true or false
Use this field to determine whether Foxit eSign should parse your documents for AcroFields to convert them into Foxit eSign fields.

signInSequence
Default false Value can be either true or false
Use this field to determine whether recipients will sign the folder in a sequence.
If false, then all the recipients receive the invitation email simultaneously. When true, then each recipient receives an invitation email successively after the previous recipient completes the required task, like signing the documents or filling fields, etc.

inPersonEnable
Default false Value can be either true or false
Use this field to initiate the in-person signing process which can be easily completed on any device in a matter of minutes and avoids email based signatures where required.
If false, then all the recipients receive the invitation email simultaneously. When true, then in-person administrator receives an invitation email to initiate the signing process for the signer.

requiredBothEmbeddedSession
Default false Value can be either true or false
If true, It will generate the embedded sending and signing URLs together.

folderPassword (Optional) This password will be required by the signer/author in order to open the digitally signed document. If the parameter is kept blank then no password will be required to open the digitally signed document.

sendNow
Default false Value can be either true or false
Use this field to send the folder to the recipient parties. Each party will then receive a unique link in their email to sign the document. The invitation mail and subject in this case will be the same as the default invitation mail setup in your account.

signSuccessUrlAllParties
Default false Value can be either true or false
If true then folder will be redirected to after successfully signing the document on the absolute URL which URL is provided by the signSuccessUrl parameter
Note: This parameter is only applicable when the sendNow parameter is true and sent a folder invitation email.

createEmbeddedSendingSession
Default false Value can be either true or false
If true then an embedded token will be generated in the response, for an embedded sending session, where you can directly open the Foxit eSign document preparing view in your application for dragging and dropping various fields on your document. And also give a custom invitation message.

fixRecipientParties (required if createEmbeddedSendingSession is true) Value can be either true or false
If true then in the embedded sending view you won't be able to change the parties for the folder which are already added as a part of this API request.

fixDocuments (required if createEmbeddedSendingSession is true) Value can be either true or false
If true then in the embedded sending view you won't be able to change the documents for the folder which are already added as a part of this API request.

sendSuccessUrl (required if createEmbeddedSendingSession is true) Enter the absolute URL for the landing page on your website/application, which the user will be redirected to after successfully sending the folder in the embedded sending view.

sendErrorUrl (optional) Enter the absolute URL for the landing page on your website/application, which the user will be redirected to if error comes during sending the folder in the embedded sending view.

hideSendButton (optional, default=false) Value can be either true or false
If true, it will hide the Send button in the embedded sending session.
Else if false, you will be able to send the folder.

enableStepByStep (optional, default=false) To enable step by step action in the embedded sending session.

createEmbeddedSigningSession
Default false Value can be either true or false
If true then an embedded token will be generated in the response, for an embedded signing session for the recipient whose email will be given in the emailIdOfEmbeddedSigner, and that party will not receive any invitation email.

createEmbeddedSigningSessionForAllParties
(optional, default=false) Value can be either true or false
If true, then an embedded signing session is created for all the recipients in the folder.
Else if false, then the embedded signing session is only created for those recipients whose email ids are given in embeddedSignersEmailIds.

embeddedSignersEmailIds
(optional) An array of email ids of recipients for whom an embedded signing session needs to be created. The values must be email ids from the recipient parties added in the parties list.

signSuccessUrl
(optional,append ?parent=false if you want to redirect within the same iframe) Enter the absolute URL for the landing page on your website/application, which the user will be redirected to after successfully signing the folder in the embedded signing view.

signDeclineUrl
(optional,append ?parent=false if you want to redirect within the same iframe) Enter the absolute URL for the landing page on your website/application, which the user will be redirected to if he declines to sign the folder in the embedded signing view.

signLaterUrl (optional) Enter the absolute URL for the landing page your website/application, which the user will be redirected to if he chooses to sign the folder later in the embedded signing view.

signErrorUrl (optional) Enter the absolute URL for the landing page your website/application, which the user will be redirected to if error comes during signing the folder in the embedded signing view.

hideNextRequiredFieldBtn (optional, default=false) Value can be either true or false
If true, it will hide the Next Required Field button(top on the right side of the user interface) in an embedded signing session.

allowSendNowAndEmbeddedSigningSession (optional, default=false) Value can be either true or false
If true, then the Foxit eSign will send the invitation email to each recipient to sign the document with the unique embedded signing session link for the recipient whose email is included in emailIdOfEmbeddedSigner.
Note: This parameter is ONLY applicable when both parameters sendNow and createEmbeddedSigningSession is true

emailTemplateId (optional) If you want to use the email template other than the default email template, then pass that particular email template id.

signerInstructionId (optional) If you want to use the signer instructions other than the default signer instructions, then pass that particular signer instruction id like "signerInstructionId":1.

confirmationInstructionId (optional) If you want to use the confirmation text other than the default confirmation text, then pass that particular confirmation instruction id like "confirmationInstructionId":2.

signerInstructionCustomFields
(required if signerInstructionId is not 0)

A list of signer instruction fields details you're sending the folder to. Every field must contain tag, type, and value fields.

Parameter	Description
tag (required)	Signer Instruction custom field name
type (required)	type can be `plain`
value (required)	Signer Instruction custom field value (Note:- use HTML tag `<br>` for line break)

confirmationInstructionCustomFields
(required if confirmationInstructionId is not 0)

A list of confirmation instruction fields details you're sending the folder to. Every field must contain tag, type, and value fields.

Parameter	Description
tag (required)	Confirmation Text custom field name
type (required)	type can be `plain`
value (required)	Confirmation Text custom field value (Note:- use HTML tag `<br>` for line break)

allowAdvancedEmailValidation (Optional) (default=false) Value can be either true or false
Validate the email address of the parties.

parties (required)

A list of recipient parties you're sending the folder to. Every entry must contain firstName, lastName, emailId, permission and sequence fields.

permission Use this field to assign folder permissions to a recipient. Can be any one of the following values:
FILL_FIELDS_AND_SIGN, FILL_FIELDS_ONLY, SIGN_ONLY, VIEW_ONLY, PARTY_ASSIGNER

isPlaceholder
(optional, default=false) Value can be either true or false
Use this field to initiate the party is a placeholder.
Note:
1. firstName, lastName, emailId parameter's value must be blank for this party.
2. To add the placeholder, one recipient must be requred with 'PARTY_ASSIGNER' permission.

partyRole (optional) Use this field to assign a role of placeholder.
Note: This parameter is only applicable when the party is a placeholder.

workflowSequence Use this field to assign a workflow sequence number to a recipient in the list of recipient parties.
If the document is signed in sequence, the recipient party will receive the folder invitation notification as per the workflow sequence number.
Note: Workflow sequence should be starting with 1 like 1,2,3,4, etc. Any gap in workflow sequence like 1,2,4 is not a valid case.
If a single person appears multiple times in the signing workflow, please assign a different workflowSequence each time the recipient is repeated.

sequence Use this field to assign a sequence number to a recipient in the list of recipient parties.
Use unique sequence numbers for each party starting with 1 like 1,2,3,4....
If a single person appears multiple times in the signing workflow, please assign a different sequence each time the recipient is repeated.

dialingCode Use this field to assign a country dial-in codes are mobile number prefixes to a recipient in the list of recipient parties.

mobileNumber Use this field to assign a mobile number to a recipient in the list of recipient parties.

signerAuthLevel

This parameter should be NO, SMS LINK, Email Access Code, User-defined Access Code, SMS Access Code and Voice Access Code.
The company should be enabled the below features for the below authentication level.

Features	Authentication Level
Authentication via SMS	SMS LINK
Authentication Via Email	Email Access Code
2FA Via Authy	SMS Access Code
2FA Via Authy	Voice Access Code
User-defined Access Code	User-defined Access Code

Note: A dialing code and mobile number must be required for the SMS Access Code and Voice Access Code authentication level.
Access code must be required for the User-defined Access Code authentication level.

userDefinedAccessCode

Codes are not case-sensitive
The system does not send this code so you must share this code with the signer directly
Access code can contain alphabets, numbers and the following special characters:
@,&,{,},%,(,),~,|,!,+,^

allowNameChange Value can be either true or false
Use this parameter to allow the signer to update first and last name before completing the signing process.
Note: Please make ensure the "Update Name Change"option is enabled from company settings.

partyIsEmailGroup Value can be either true or false
Use this parameter for creating a party as bulk.
Note: If this parameter is true, firstName, lastName and emailId of this party will be ignored.

emailGroupId Pass the email the group id you want to use to create bulk

allowSingleSignerInBulk Value can be either true or false
Use this parameter to allow only one person to sign in email group.

hostEmailId Use this parameter to pass the email id of in-person administrator.

sessionExpire
(optional, default=false) Value can be either true or false
Use this field to initiate the expire of the embedded signing session.

expiry
(required if sessionExpire is true) Use this field to enter the time duration in milliseconds of the expiry on the embedded signing session.

fields (optional) A list of different fields to be added to the document(s).

dependentFields (optional)

A list of dependent fields.

Parameter	Description
dependentFieldName	Name of the dependent field.
parentFieldName	Name of the parent field.
parentFieldValue	Value of the parent field.In the case of radio and checkbox value can be either `checked` or `unchecked`
options (optional)	In the case of textfield value can be either `isBlank` or `allowNull` or `contains`

senderEmail (optional) You can enter the email of another user in your account, which will be used for sending this document(s) folder to the recipient parties.

themeColor (optional) You can enter a css value for a color to match your website's look n feel when you embed Foxit eSign inside. The top blue band of the embedded screen is then replaced with the color provided by you.

hideDeclineToSign (optional, default=false) If true, it will hide the option of "Decline to Sign" for the signer.

hideMoreAction (optional, default=false) If true, it will hide the "More Actions" button in sending/signing session. In case of "Send Now": true, it will not hide anything

hideAddPartiesOption (optional, default=false) If true, it will hide the option to add parties option in Draft and Template Creation mode.

hideSignerSelectOption
(optional) Value can be either true or false
If true, it will hide the "Existing Signer Name/Email" input box on Recipient Parties in an embedded sending session.

hideSignerActions
(optional, default=false) Value can be either true or false
If true, it will hide the signer "edit", "change" and "remove" actions on Recipient Parties in an embedded sending session.

hideSenderName
(optional, default=false) Value can be either true or false
If true, it will hide the sender name on Recipient Parties in an embedded sending session.

hideFolderName
(optional, default=false) Value can be either true or false
If true, it will hide the folder name on navigation in both embedded sessions.

hideDocumentsName
(optional, default=false) Value can be either true or false
If true, it will hide the document name in both embedded sessions.

hideAddMeButton (optional) Value can be either true or false
If true, it will hide the "Add Me" button on Recipient Parties in an embedded sending session.

hideAddNewButton (optional) Value can be either true or false
If true, it will hide the "Add New" button on Recipient Parties in an embedded sending session.

hideAddGroupButton (optional) Value can be either true or false
If true, it will hide the "Add Group" button on Recipient Parties in an embedded sending session.

hideFieldNameForRecipients (optional, default=false) Value can be either true or false
Hide field names for Recipients for Data Entry Fields and Advanced Fields.(Except Radio button, Checkbox, Image and Hyperlink).

hideCheckboxBorder (optional, default=false) Value can be either true or false
Borders of Checkbox will be hidden in the executed documents.

selfSign(optional, default=false) Value can be either true or false
It enables embedded Self Sign via APIs.
Note: This parameter is only applicable when the createEmbeddedSendingSession parameter is true

selfSignerSuccessUrl (Optional, if selfSign is true) Enter the absolute URL for the landing page on your website/application, which the user will be redirected to after successfully Self Sign sending the folder in the embedded sending view.

RESPONSE

{
	"result":"success",
	"message":"folder of document(s) successfully created",
	"embeddedSigningSessions": [
          {
            "emailIdOfSigner": "johndoe@example.com",
            "embeddedToken": "EMBEDDED_TOKEN",
            "embeddedSessionURL": "UNIQUE_EMBEDDED_SESSION_URL"
          },
          {
            "emailIdOfSigner": "johndoe@example.com",
            "embeddedToken": "EMBEDDED_TOKEN",
            "embeddedSessionURL": "UNIQUE_EMBEDDED_SESSION_URL"
          }
        ],
	"folder":{
	    "folderId": 179,
	    "folderName": "fw4",
	    "folderAuthorId": 1,
	    "folderAuthorFirstName": "ABC",
	    "folderAuthorLastName": "XYZ",
	    "folderAuthorEmail": "abc@xyz.com",
	    "folderAuthorRole": "admin",
	    "folderCompanyId": 11,
	    "folderCreationDate": 1441268056000,
	    "folderSentDate": 1442470444000,
	    "folderStatus": "SHARED",
	    "folderDocumentIds": [
	      420
	    ],
	    "documentsList": [
	      {
	        "documentId": 420,
	        "companyId": 11,
	        "contractCreatedBy": 1,
	        "contractCreatedOn": 1441268055000,
	        "contractType": "W4",
	        "contractStatus": "WAITING_FOR_SIGNATURE",
	        "editable": false,
	        "contractVersionId": 488,
	        "contractVersionName": "fw4",
	        "contractVersionDesc": "This is a non-editable form W4",
	        "versionCreatedby": 1,
	        "versionCreatedOn": 1441268055000,
	        "contractVersionNumber": 1
	      }
	    ],
	    "folderRecipientParties": [
	      {
	        "partyId": 52,
	        "partyDetails": {
	          "partyId": 52,
	          "firstName": "John",
	          "lastName": "Doe",
	          "emailId": "johndoe@example.com",
	          "address": "",
	          "dateCreated": 1413013300000,
	          "signerAuthLevel":"Email Access Code"
	        },
	        "contractPermissions": "FILL_FIELDS_AND_SIGN",
	        "partySequence": 1,
	        "workflowSignSequence": 1,
	        "envelopeId": 179,
	        "sharingMode": "email",
	        "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=QoS4qeiO870mBXNbcuUWYA%3D%3D&partyId=52"
	      },
	      {
	        "partyId": 5,
	        "partyDetails": {
	          "partyId": 5,
	          "firstName": "test",
	          "lastName": "test",
	          "emailId": "test@esigngenie.com",
	          "address": "",
	          "dateCreated": 1413013300000,
	          "signerAuthLevel":"User-defined Access Code",
	          "userDefinedAccessCode":"123Test@"
	        },
	        "contractPermissions": "FILL_FIELDS_AND_SIGN",
	        "partySequence": 1,
	        "workflowSignSequence": 1,
	        "envelopeId": 179,
	        "sharingMode": "email",
	        "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=QoS4qeiO870mBXNbcuUWYA%3D%3D&partyId=52"
	      },
	      {
	        "partyId": 1,
	        "partyDetails": {
	          "partyId": 1,
	          "firstName": "John",
	          "lastName": "Doe",
	          "emailId": "johndoe@example.com",
	          "address": "New Delhi, India",
	          "dateCreated": 1404792207000
	        },
	        "contractPermissions": "FILL_FIELDS_AND_SIGN",
	        "partySequence": 2,
	        "workflowSignSequence": 2,
	        "envelopeId": 179,
	        "sharingMode": "email",
	        "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=QoS4qeiO870mBXNbcuUWYA%3D%3D&partyId=1"
	      }
	    ],
	    "folderAccessURLForAuthor": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=jZvyX4AFC2kv7AU%2BBtM16A%3D%3D&partyId=1",
	    "bulkId": 0,
	    "enforceSignWorkflow": false,
	    "currentWorkflowStep": 1,
	    "transactionSource": "API-1-via_file_upload",
	    "editable": false
	}
}

Sample Code (creating documents from file URLs)

echo '{
	"folderName":"Sample Documents",
	"fileUrls":[
		"URL_TO_DOCUMENT_1","URL_TO_DOCUMENT_2",...
	],
	"fileNames":[
		"document_1.pdf","document_2.pdf",...
	],
	"processTextTags":true,
	"processAcroFields":true,
	"signInSequence":false,
	"sendNow":false,
	"createEmbeddedSendingSession":false,
	"fixRecipientParties":true,
	"fixDocuments":true,
	"sendSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"sendErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"createEmbeddedSigningSession":true,
	"createEmbeddedSigningSessionForAllParties":true,
	"signSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signDeclineUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signLaterUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"themeColor":"ANY_CSS_COLOR_TO_MATCH_YOUR_APPLICATION",
	"sessionExpire":false,
	"expiry":300000,
	"allowSendNowAndEmbeddedSigningSession":false,
	"parties":[
		{
			"firstName":"FIRST_NAME_OF_RECIPIENT_PARTY",
			"lastName":"LAST_NAME_OF_RECIPIENT_PARTY",
			"emailId":"EMAIL_ID_OF_RECIPIENT_PARTY",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			"signerAuthLevel":"Email Access Code"
		},
		....
	],
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":50,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"optional name",
			"tooltip":"",
			"value":"optional value",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"

		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                       "type":"formulafield",
                       "formulafieldName":"Formula_Field_Name",
                       "formula":"[n1] * [n2]",
                       "fontSize":8,
                       "fontFamily":"default",
                       "fontColor":"#000000",
                       "documentNumber":1,
                       "pageNumber":1,
                       "x":100,
                       "y":280,
                       "tabOrder":1,
                       "width":50,
                       "height":100,
                       "party": 1,
                       "decimalPlaces": 2
                },
		{
			"type":"text",
			"x":552,
			"y":150,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers"
		},
		{
			"type":"signature",
			"x":200,
			"y":150,
			"width":100,
			"height":50,
			"documentNumber":1,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"dropdown",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"party":1,
			"value":"US",
			"options":["UK","Canada","Australia","US","France"]
		}
		]
	
}' | curl https://{{HOST_NAME}}/api/folders/createfolder \
-i \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json;charset=UTF-8" \
-d @- \
-X POST

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/createfolder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{
	"folderName":"Sample Documents",
	"fileUrls":[
		"URL_TO_DOCUMENT_1","URL_TO_DOCUMENT_2",...
	],
	"fileNames":[
		"document_1.pdf","document_2.pdf",...
	],
	"processTextTags":false,
	"processAcroFields":true,
	"signInSequence":false,
	"sendNow":false,
	"createEmbeddedSendingSession":false,
	"fixRecipientParties":true,
	"fixDocuments":true,
	"sendSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"sendErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"createEmbeddedSigningSession":true,
	"createEmbeddedSigningSessionForAllParties":true,
	"signSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signDeclineUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signLaterUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"themeColor":"ANY_CSS_COLOR_TO_MATCH_YOUR_APPLICATION",
	"sessionExpire":false,
	"expiry":300000,
	"allowSendNowAndEmbeddedSigningSession":false,
	"parties":[
		{
			"firstName":"FIRST_NAME_OF_RECIPIENT_PARTY",
			"lastName":"LAST_NAME_OF_RECIPIENT_PARTY",
			"emailId":"EMAIL_ID_OF_RECIPIENT_PARTY",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			"signerAuthLevel":"Email Access Code"
		},
		....
	],
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":50,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"optional name",
			"tooltip":"",
			"value":"optional value",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"

		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                       "type":"formulafield",
                       "formulafieldName":"Formula_Field_Name",
                       "formula":"[n1] + [n2]",
                       "fontSize":8,
                       "fontFamily":"default",
                       "fontColor":"#000000",
                       "documentNumber":1,
                       "pageNumber":1,
                       "x":100,
                       "y":280,
                       "tabOrder":1,
                       "width":50,
                       "height":100,
                       "party": 1,
                       "decimalPlaces": 2
                },
		{
			"type":"text",
			"x":552,
			"y":150,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers"
		},
		{
			"type":"signature",
			"x":200,
			"y":150,
			"width":100,
			"height":50,
			"documentNumber":1,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"dropdown",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"party":1,
			"value":"US",
			"options":["UK","Canada","Australia","US","France"]
		}
		]
	
}',
  
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/createfolder";
var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);
httpWebRequest.ContentType = "application/json; charset=utf-8";
httpWebRequest.Method = "POST";
httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = @"{
	""folderName"":""test"",
	""fileUrls"":[""URL_TO_DOCUMENT_1""],
	""fileNames"":[""eSignGenieSampleUpload.pdf""],	
	""processTextTags"":true,
	"processAcroFields":true,
	""signInSequence"":false,
	""sendNow"":false,
	""createEmbeddedSendingSession"":false,
	""fixRecipientParties"":true,
	""fixDocuments"":true,
	""sendSuccessUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""sendErrorUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""createEmbeddedSigningSession"":true,
	""createEmbeddedSigningSessionForAllParties"":true,
	""signSuccessUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""signDeclineUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""signLaterUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""signErrorUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""themeColor"":""ANY_CSS_COLOR_TO_MATCH_YOUR_APPLICATION"",
	"allowSendNowAndEmbeddedSigningSession":false,
	""parties"":[
		{
			""firstName"":""FIRST_NAME_OF_RECIPIENT_PARTY"",
			""lastName"":""LAST_NAME_OF_RECIPIENT_PARTY"",
			""emailId"":""EMAIL_ID_OF_RECIPIENT_PARTY"",
			""permission"":""FILL_FIELDS_AND_SIGN"",
			""sequence"":1,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			"signerAuthLevel":"SMS Access Code"
        }
		],
		""fields"":[
		{
			""type"":""text"",
			""x"":100,
			""y"":50,
			""width"":60,
			""height"":20,
			""documentNumber"":1,
			""pageNumber"":1,
			""tabOrder"":1,
			""party"":1,
			""name"":""optional name"",
			""tooltip"":"""",
			""value"":""optional value"",
			""required"":true,
			""characterLimit"":100,
			""fontSize"":12,
			""fontColor"":""#000000"",
			""validation"":""Letters""

		},
		{
			""type"":""text"",
			""x"":552,
			""y"":150,
			""width"":60,
			""height"":20,
			""documentNumber"":1,
			""pageNumber"":1,
			""tabOrder"":1,
			""party"":1,
			""fontSize"":8,
			""fontColor"":""#eee"",
			""validation"":""Numbers""
		},
		{
                       "type":"formulafield",
                       "formulafieldName":"Formula_Field_Name",
                       "formula":"[n1] + [n2]",
                       "fontSize":8,
                       "fontFamily":"default",
                       "fontColor":"#000000",
                       "documentNumber":1,
                       "pageNumber":1,
                       "x":100,
                       "y":280,
                       "tabOrder":1,
                       "width":50,
                       "height":100,
                       "party": 1,
                       "decimalPlaces": 2
                },
		{
			""type"":""signature"",
			""x"":200,
			""y"":150,
			""width"":100,
			""height"":50,
			""documentNumber"":1,
			""pageNumber"":1,
			""party"":1
		},
		{
			""type"":""dropdown"",
			""x"":200,
			""y"":250,
			""width"":80,
			""height"":20,
			""documentNumber"":1,
			""pageNumber"":1,
			""party"":1,
			""value"":""US"",
			""options"":[""UK"",""Canada"",""Australia"",""US"",""France""]
		}
		]
}";
                streamWriter.Write(json);
                streamWriter.Flush();
            }

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
            }

		URL url= new URL("https://{{HOST_NAME}}/api/folders/createfolder");
		HttpURLConnection con= (HttpURLConnection) url.openConnection();
		con.setDoOutput(true);
		try {
			con.setRequestMethod("POST");
			
		} catch (ProtocolException e) {
			e.printStackTrace();
		}
		con.setRequestProperty("Authorization", "Bearer ACCESS_TOKEN");
		con.setRequestProperty("Content-Type", "application/json");
		String input="{"
				+ "\"folderName\":\"Creating Folder From Uploading File\","
				+ "\"processTextTags\":true,"
				+ "\"processAcroFields\":true,"
				+ "\"sendNow\":false,"
				+ "\"fileUrls\":[\"https://developers.esigngenie.com/uploads/FoxiteSignAPISampleDoc.pdf\"]"
				
				+ "\"parties\":["
					+ "{"
						+ "\"firstName\":\"John\","
						+ "\"lastName\":\"Doe\","
						+ "\"emailId\":\"johndoe@example.com\","
						+ "\"permission\":\"FILL_FIELDS_AND_SIGN\","
						+ "\"sequence\":1"
					+ "},"
					+ "{"
						+ "\"firstName\":\"John\","
						+ "\"lastName\":\"Doe\","
						+ "\"emailId\":\"johndoe@example.com\","
						+ "\"permission\":\"FILL_FIELDS_AND_SIGN\","
						+ "\"sequence\":2"
					+ "}"
				+ "],"
				+ "\"createEmbeddedSigningSession\":true,"
				+ "\"createEmbeddedSigningSessionForAllParties\":true," 
				+ "\"allowSendNowAndEmbeddedSigningSession\":false,
		        + "\"senderEmail\":\"johndoe@example.com\""
				+ "}";	

		OutputStream os = con.getOutputStream();
		os.write(input.getBytes());
		os.flush();
		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();

You can also pass PDF document(s) as a multipart form data instead of passing a publicly accessible URLs. In this case pass the JSON as 'data' parameter and include file as a multipart form parameter 'file'. Make sure you're using multipart/form-data as a content type for this call.

Sample Code (creating documents from multipart form data)

curl https://{{HOST_NAME}}/api/folders/createfolder \
-i \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: multipart/form-data;charset=UTF-8" \
-F data='{"folderName":"Sample Documents","processTextTags":true,"processAcroFields":true,"signInSequence":false,"sendNow":false,"createEmbeddedSendingSession":false,"fixRecipientParties":true,"fixDocuments":true,"sendSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","sendErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","createEmbeddedSigningSession":true,"createEmbeddedSigningSessionForAllParties":true,"allowSendNowAndEmbeddedSigningSession":false,"signSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","signDeclineUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","signLaterUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","signErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","themeColor":"ANY_CSS_COLOR_TO_MATCH_YOUR_APPLICATION","parties":[{"firstName":"FIRST_NAME_OF_RECIPIENT_PARTY","lastName":"LAST_NAME_OF_RECIPIENT_PARTY","emailId":"EMAIL_ID_OF_RECIPIENT_PARTY","permission":"FILL_FIELDS_AND_SIGN","workflowSequence":1,"sequence":1}]}' \
-F file=@FILE_1_TO_UPLOAD \
-X POST

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/createfolder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '
-----011000010111000001101001
Content-Disposition: form-data; name="file"; filename="file1.pdf"
Content-Type: application/octet-stream

'.file_get_contents('/path/to/your/file1').'
-----011000010111000001101001
Content-Disposition: form-data; name="file"; filename="file2.pdf"
Content-Type: application/octet-stream

'.file_get_contents('/path/to/your/file2').'
-----011000010111000001101001
 Content-Disposition: form-data; name="data"

{"folderName":"Sample Documents","processTextTags":true,"processAcroFields":true,"signInSequence":false,"sendNow":false,"createEmbeddedSendingSession":false,"fixRecipientParties":true,"fixDocuments":true,"sendSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","sendErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","createEmbeddedSigningSession":false,"allowSendNowAndEmbeddedSigningSession":false,"emailIdOfEmbeddedSigner":"EMAIL_ID_OF_ONE_OF_THE_RECIPIENTS","signSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","signDeclineUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","signLaterUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","signErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION","parties":[{"firstName":"FIRST_NAME_OF_RECIPIENT_PARTY","lastName":"LAST_NAME_OF_RECIPIENT_PARTY","emailId":"EMAIL_ID_OF_RECIPIENT_PARTY","permission":"FILL_FIELDS_AND_SIGN","workflowSequence":1,"sequence":1}]}
-----011000010111000001101001--',

  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: multipart/form-data; boundary=---011000010111000001101001"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

URL url= new URL("https://{{HOST_NAME}}/api/folders/createfolder");
HttpURLConnection con= (HttpURLConnection) url.openConnection();
con.setDoOutput(true);
CookieHandler.setDefault(new CookieManager(null, CookiePolicy.ACCEPT_ALL));
String charset="UTF-8";
		
String input="{"
			+ "\"folderName\":\"Creating Folder From Uploading File\","
			+ "\"processTextTags\":true,"
			+ "\"processAcroFields\":true,"
			+ "\"sendNow\":false,"
			+ "\"parties\":["
				+ "{"
					+ "\"firstName\":\"John\","
					+ "\"lastName\":\"Doe\","
					+ "\"emailId\":\"johndoe@example.com\","
					+ "\"permission\":\"FILL_FIELDS_AND_SIGN\","
					+ "\"sequence\":1"
				+ "},"
				+ "{"
					+ "\"firstName\":\"John\","
					+ "\"lastName\":\"Doe\","
					+ "\"emailId\":\"johndoe@example.com\","
					+ "\"permission\":\"FILL_FIELDS_AND_SIGN\","
					+ "\"sequence\":2"
				+ "}"
			+ "],"
			+ "\"createEmbeddedSigningSession\":true,"
			+ "\"createEmbeddedSigningSessionForAllParties\":true," 
			+ "\"allowSendNowAndEmbeddedSigningSession\":false,"
	        + "\"senderEmail\":\"johndoe@example.com\""
			+ "}";	
		
		
File binaryFile = new File("D:\\Sample.pdf");
String boundary = "----"+ Long.toHexString(System.currentTimeMillis()) + "------"; 
String CRLF = "\r\n"; 
con.setRequestProperty("Content-Type","multipart/form-data; boundary=\"" + boundary + "\"");
		
con.setRequestProperty("Authorization", "Bearer ACCESS_TOKEN");
try (
	OutputStream output = con.getOutputStream();
	PrintWriter writer = new PrintWriter(new OutputStreamWriter(output, charset), true);
	) {
		   
	writer.append("--" + boundary).append(CRLF);
			    
	writer.append("Content-Disposition:form-data; name=\"data\"").append(CRLF);
			 
	writer.append(CRLF).append(input).append(CRLF).flush();
    writer.append("--" + boundary).append(CRLF);
	writer.append("Content-Disposition: form-data; name=\"file\"; filename=\"" + binaryFile.getName() + "\"").append(CRLF);
		   
	writer.append("Content-Transfer-Encoding: binary").append(CRLF);
	writer.append(CRLF).flush();
		    
	Files.copy(binaryFile.toPath(), output);
	output.flush();
	writer.append(CRLF).flush(); 
	writer.append("--" + boundary + "--").append(CRLF).flush();
		   
	}
	List<String> response = new ArrayList<String>();
	if (con.getResponseCode()== HttpURLConnection.HTTP_OK) {
	    BufferedReader reader = new BufferedReader(new InputStreamReader(con.getInputStream()));
		String line = null;
		while ((line = reader.readLine()) != null) {
			response.add(line);
		}
	            
		reader.close();
		con.disconnect();
	} else {
		throw new IOException("Server returned non-OK status: " + con.getResponseCode());
	}
		 
 
System.out.println("Finally Reply from server "+con.getResponseCode());

String file = @"C:\test\sample.pdf";
String url = "https://{{HOST_NAME}}/api/folders/createfolder";
String boundary = "---------------------------" + DateTime.Now.Ticks.ToString("x");
byte[] boundarybytes = System.Text.Encoding.ASCII.GetBytes("\r\n--" + boundary + "\r\n");

HttpWebRequest wr = (HttpWebRequest)WebRequest.Create(url);
wr.ContentType = "multipart/form-data; boundary=" + boundary;
wr.Method = "POST";
wr.KeepAlive = true;
wr.Credentials = System.Net.CredentialCache.DefaultCredentials;

Stream rs = wr.GetRequestStream();

string json = @"{
	""folderName"":""test"",
	""processTextTags"":true,
	""processAcroFields"":true,
	""signInSequence"":false,
	""sendNow"":false,
	""createEmbeddedSendingSession"":false,
	""fixRecipientParties"":true,
	""fixDocuments"":true,
	""sendSuccessUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""sendErrorUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""createEmbeddedSigningSession"":true,
	""createEmbeddedSigningSessionForAllParties"":true,
	""signSuccessUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""signDeclineUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""signLaterUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""signErrorUrl"":""https://{{HOST_NAME}}/demo-sign-success/"",
	""themeColor"":""#0066cb"",
	""allowSendNowAndEmbeddedSigningSession"":false,
	""parties"":[
		{
			""firstName"":""FIRST_NAME_OF_RECIPIENT_PARTY"",
			""lastName"":""LAST_NAME_OF_RECIPIENT_PARTY"",
			""emailId"":""EMAIL_ID_OF_RECIPIENT_PARTY"",
			""permission"":""FILL_FIELDS_AND_SIGN"",
			""sequence"":1,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			"signerAuthLevel":"SMS Access Code"
		}
		]	
}";

rs.Write(boundarybytes, 0, boundarybytes.Length);

string formdataTemplate = "Content-Disposition: form-data; name=\"data\"\r\n\r\n"+json;
byte[] formitembytes = System.Text.Encoding.UTF8.GetBytes(formdataTemplate);
rs.Write(formitembytes, 0, formitembytes.Length);

rs.Write(boundarybytes, 0, boundarybytes.Length);

string headerTemplate = "Content-Disposition: form-data; name=\"file\"; filename=\"sample.pdf\"\r\nContent-Type: application/pdf\r\n\r\n";
      
byte[] headerbytes = System.Text.Encoding.UTF8.GetBytes(headerTemplate);
rs.Write(headerbytes, 0, headerbytes.Length);

FileStream fileStream = new FileStream(file, FileMode.Open, FileAccess.Read);
byte[] buffer = new byte[4096];
int bytesRead = 0;
while ((bytesRead = fileStream.Read(buffer, 0, buffer.Length)) != 0) {
          rs.Write(buffer, 0, bytesRead);
}
fileStream.Close();

byte[] trailer = System.Text.Encoding.ASCII.GetBytes("\r\n--" + boundary + "--\r\n");
rs.Write(trailer, 0, trailer.Length);
rs.Close();

WebResponse wresp = null;
try {
     wresp = wr.GetResponse();
     Stream stream2 = wresp.GetResponseStream();
     StreamReader reader2 = new StreamReader(stream2);
     log.Debug(string.Format("File uploaded, server response is: {0}", reader2.ReadToEnd()));
} catch(Exception ex) {
     log.Error("Error uploading file", ex);
     if(wresp != null) {
         wresp.Close();
         wresp = null;
     }
} finally {
     wr = null;
}

Sending the Draft Folder

With Foxit eSign API, you can send any draft document by calling /folders/sendDraftFolder with the given parameters.

POST /folders/sendDraftFolder
Content-Type application/json

REQUEST

{
	"folderId":51798,
	"folderName":"MainFolder",
	"folderPassword":"",
	"signInSequence":false,
	"inPersonEnable":false,
	"hideMoreAction": false,
	"sendNow":true,	
	"signSuccessUrlAllParties":true,
	"allowAdvancedEmailValidation":true,
	"parties":[
		{
			"firstName":"ABC",
			"lastName":"XYZ",
			"emailId":"abc@xyz.com",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"allowNameChange":false,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			 "signerAuthLevel":"SMS Access Code"
		},
		{
			"firstName":"PartyFirstName2",
			"lastName":"PartyLastName2",
			"emailId":"mno@xyz.com",
			"permission":"FILL_FIELDS_AND_SIGN",
			"sequence":2,
			"hostEmailId":"hosteduseremail@xyz.com",
			"allowNameChange":false,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			"signerAuthLevel":"Email Access Code"
		},
		{
			"firstName":"PartyFirstName3",
			"lastName":"PartyLastName3",
			"emailId":"test@xyz.com",
			"permission":"FILL_FIELDS_AND_SIGN",
			"sequence":3,
			"hostEmailId":"hosteduseremail@xyz.com",
			"allowNameChange":false,			
			"signerAuthLevel":"User-defined Access Code",
			"userDefinedAccessCode":"123@Test"
		}
	],
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":130,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"TextFieldName",
			"tooltip":"",
			"value":"TextFieldValue",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"
			"hideFieldNameForRecipients":false
		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                       "type":"formulafield",
                       "formulafieldName":"Formula_Field_Name",
                       "formula":"[n1] * [n2]",
                       "fontSize":8,
                       "fontFamily":"default",
                       "fontColor":"#000000",
                       "documentNumber":1,
                       "pageNumber":1,
                       "x":100,
                       "y":280,
                       "tabOrder":1,
                       "width":50,
                       "height":100,
                       "party": 1,
                       "decimalPlaces": 2
                },
                
		{
			"type":"signature",
			"x":200,
			"y":130,
			"width":100,
			"height":50,
			"documentNumber":1,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"text",
			"textfieldName": "Signer Name",
			"x":300,
			"y":250,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"Signer Name",
			"characterLimit":100,
		 	"partyResponsible": 1,
			"required": true,
			"fontSize": 12,
			"fontFamily": "default",
			"fontColor": "#000000",
			"readOnly": true,
			"systemField": true
		},
		{
			"type":"text",
			"x":450,
			"y":130,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"TextFieldName2",
			"tooltip":"",
			"value":"12345",
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers",
			"required":true
		},
			"type":"accept",
			"party":1,
			"documentNumber":1,
			"pageNumber":1,
			"x":350,
			"y":505,
			"width":90,
			"height":15
		},
		{
			"type":"decline",
			"party":1,
			"documentNumber":1,
			"pageNumber":1,
			"x":450,
			"y":505,
			"width":90,
			"height":15
		},
		{
			"type":"text",
			"x":100,
			"y":230,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":2,
			"name":"TextFieldName3",
			"tooltip":"",
			"value":"TextFieldValueThree",
			"required":false,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"
		},
		{
			"type":"signature",
			"x":200,
			"y":230,
			"width":100,
			"height":50,
			"documentNumber":1,
			"pageNumber":1,
			"party":2
		},
		{
			"type":"text",
			"x":450,
			"y":230,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":2,
			"name":"12345678",
			"tooltip":"",
			"value":"1234",
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers",
			"required":true
		}
	],
	"createEmbeddedSigningSession":false,
		"emailIdOfEmbeddedSigner":"",
		"createEmbeddedSigningSessionForAllParties":false,
		"embeddedSignersEmailIds":["FIRST_EMBEDDED_SIGNER_EMAIL","SECOND_EMBEDDED_SIGNER_EMAIL"],
		"hideDeclineToSign":false,
		"hideNextRequiredFieldBtn":true,
		"signSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
		"signErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
		"signDeclineUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
		"signLaterUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
		"themeColor":"#C71585",
		"sessionExpire":false,
		"expiry":300000,
	"allowSendNowAndEmbeddedSigningSession":false,
	"createExecutedFolder": false,
	"custom_field1":{
			  	"name":"NAME",
			  	"value":"VALUE"
			},
	"custom_field2":{
			  	"name":"NAME",
			  	"value":"VALUE"
			},
		"emailTemplateId":0,
		"emailTemplateCustomFields":[
		  	{
		  		"tag":"custom_tag_value_1",
		  		"type":"plain",
		  		"value":"Email Template Custom value one."
		  	},
		  	{
		  		"tag":"custom_tag_1",
		  		"type":"plain",
		  		"value":""
		  	},
		  	{
		  		"tag":"custom_tag_2",
		  		"type":"plain",
		  		"value":"custom tag 2 Value."
		  	},
		  	{
		  		"tag":"custom_tag_link_1",
		  		"type":"hyperlink",
		  		"value":"",
		  		"url":"http://https://abc.com/hyperlink"
		  	}
		],
		"editEmailTemplate": {
			"emailTemplateSubject": "Email_Template_Subject'_${custom_tag_value_1}",
			"emailTemplateHtmlBody": 
				"<p>Email_Template_Body : </p>
				<p>${custom_tag_1} </p>
				<p>${custom_tag_2}</p>
				<p>$custom_tag_link_1}</p>
				<p>${custom_tag_1}</p>
				<p>&nbsp;  <span contenteditable=\"false\">${rec_full_name}</span>&nbsp;&nbsp; </p>
				<p><span contenteditable=\"false\">${rec_first_name}</span>&nbsp;&nbsp; </p>
				<p>&nbsp;&nbsp;<span contenteditable=\"false\">${sender_full_name}</span>&nbsp;&nbsp; </p>
				<p><span contenteditable=\"false\">${sender_first_name}</span>&nbsp;&nbsp; </p>
				<p>&nbsp;&nbsp;<span contenteditable=\"false\">${document_title}</span>&nbsp;&nbsp;</p>"
				....
			
			},
	"authenticationLevel":"NO",
	"senderEmail":"autheremailid@xyz.com",
	"signerInstructionId":1,
	"confirmationInstructionId":2,
	"signerInstructionCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_1",
  		"type":"plain",
  		"value":"Please review the document."
  	}
  	],
  	"confirmationInstructionCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_2",
  		"type":"plain",
  		"value":"Click here to confirm signing."
  	}
  	]
}

Parameter Description

folderId (required) Folder id you want to use to send the document for this folder. You can determine the folder id from the draft folder URL.
https://{{HOST_NAME}}/documents/viewdraftfolder?folder.envelopeId=2520579

folderName (optional) Name of the document(s) folder

folderPassword
(optional) This password will be required by the signer/author in order to open the digitally signed document. If the parameter is kept blank then no password will be required to open the digitally signed document

signInSequence Value can be either true or false
Use this field to determine whether recipients will sign the folder in a sequence.
If false, then all the recipients receive the invitation email simultaneously.
When true, then each recipient receives an invitation email successively after previous recipient completes the required task, like signing the documents or filling fields, etc.

inPersonEnable Value can be either true or false
Use this field to initiate the in-person signing process which can be easily completed on any device in a matter of minutes and avoids email based signatures where required.
If false, then all the recipients receive the invitation email simultaneously.
When true, then in-person administrator receives an invitation email to initiate the signing process for the signer.

sendNow
default true Value can be either true or false
Use this field to send the folder to the recipient parties. Each party will then receive a unique link in their email to sign the document. The invitation mail and subject in this case will be the same as the default invitation mail setup in your account.

createExecutedFolder
(optional, default=false) Value can be either true or false
folder automatically executed with the folder existing party.
Note: Every existing party has saved their signature and initial sign in our company profile.

createEmbeddedSigningSession (optional, default=false)

Value can be either true or false
If true then an embedded token will be generated in the response, for an embedded signing session for the recipient whose email will be given in the emailIdOfEmbeddedSigner, and that party will not receive any invitation email.

Parameter	Description
signSuccessUrl (optional,append ?parent=`false` if you want to redirect within the same iframe)	Enter the absolute URL for the landing page on your website/application, which the user will be redirected to after successfully signing the folder in the embedded signing view.
signErrorUrl (optional)	Enter the absolute URL for the landing page your website/application, which the user will be redirected to if error comes during signing the folder in the embedded signing view.
signDeclineUrl (optional)	If `true`, it will hide the option of "Decline to Sign" for the signer.
signLaterUrl (optional)	Enter the absolute URL for the landing page your website/application, which the user will be redirected to if he chooses to sign the folder later in the embedded signing view.
themeColor (optional)	You can enter a css value for a color to match your website's look n feel when you embed Foxit eSign inside. The top blue band of the embedded screen is then replaced with the color provided by you.
hideMoreAction (optional)	Value can be either `true` or `false` If `true`, it will hide the "More Actions" button in an signing session. In case of sendNow is `false`, it will not hide anything
hideDeclineToSign (optional, default=`false`)	If `true`, it will hide the option of "Decline to Sign" for the signer.
hideNextRequiredFieldBtn (optional, default=`false`)	Value can be either `true` or `false` If `true`, it will hide the Next Required Field button(top on the right side of the user interface) in an embedded signing session.
sessionExpire (optional, default=`false`)	Value can be either `true` or `false` Use this field to initiate the expire of the embedded signing session.
expiry (required if `sessionExpire` is `true`)	Use this field to enter the time duration in milliseconds of the expiry on the embedded signing session.

allowSendNowAndEmbeddedSigningSession (optional, default=false) Value can be either true or false
If true, Foxit eSign will send the invitation email to each recipient to sign the document with the unique embedded signing session link for the recipient whose email is included in emailIdOfEmbeddedSigner.
Note: This parameter is ONLY applicable when both parameters sendNow and createEmbeddedSigningSession is true

emailTemplateId (optional) If you want to use the email template other than the default email template, then pass that particular email template id.

emailTemplateCustomFields
(required if emailTemplateId is not 0)

A list of email template fields details you're sending the folder to. Every field must contain tag, type, value fields.

Parameter	Description
tag (required)	Email template custom field name
type (required)	type can be either `plain` or `hyperlink`
url (required if field type is `hyperlink`)	HYPERTEXT_REFERENCE of hyperlink
value (required)	Email template custom field value

authenticationLevel (optional)

Features	Authentication Level
Authentication via SMS	SMS LINK
Authentication Via Email	Email Access Code
2FA Via Authy	SMS Access Code
2FA Via Authy	Voice Access Code
User-defined Access Code	User-defined Access Code

Custom Fields (optional)
Two custom fields custom_field1 and custom_field2

Parameter	Description
name	Name of the custom field
value	Value of the custom field

Custom fields can be used for many purposes such as identifying the application and module where the signed document belongs. You can use the custom fields as per your requirements. Maximum of two custom fields can be passed to Foxit eSign via API that are stored at the folder level. The webhook response includes these custom fields.

allowAdvancedEmailValidation (Optional) (default=false) Value can be either true or false
Validate the email address of the parties.

parties (optional)

A list of recipient parties you're sending the folder to. Every entry must contain firstName, lastName, emailId, permission and sequence fields.

permission Use this field to assign folder permissions to a recipient. Can be any one of the following values:
FILL_FIELDS_AND_SIGN, FILL_FIELDS_ONLY, SIGN_ONLY, VIEW_ONLY, PARTY_ASSIGNER

partyRole (optional) Use this field to assign a role of placeholder.
Note: This parameter is only applicable when the party is a placeholder.

dialingCode Use this field to assign a country dial-in codes are mobile number prefixes to a recipient in the list of recipient parties.

mobileNumber Use this field to assign a mobile number to a recipient in the list of recipient parties.

signerAuthLevel

Features	Authentication Level
Authentication via SMS	SMS LINK
Authentication Via Email	Email Access Code
2FA Via Authy	SMS Access Code
2FA Via Authy	Voice Access Code
User-defined Access Code	User-defined Access Code

userDefinedAccessCode

Codes are not case-sensitive
The system does not send this code so you must share this code with the signer directly
Access code can contain alphabets, numbers and the following special characters:
@,&,{,},%,(,),~,|,!,+,^

allowNameChange Value can be either true or false
This parameter allows the signer to update first and last name before completing the signing process.
Note: Please make sure the "Update Name Change"option is enabled from company settings.

partyIsEmailGroup Value can be either true or false
Use this parameter for creating a party in bulk.
Note: If this parameter is true, firstName, lastName and emailId of this party will be ignored.

emailGroupId Pass email group id you want to use to create bulk

allowSingleSignerInBulk Value can be either true or false
Use this parameter to allow only one person to sign in email group.

hostEmailId Use this parameter to pass the email id of the in-person administrator.

fields (optional) A list of different fields to be added to the document(s).

senderEmail (optional) You can enter another user's email in your account, which will be used for sending this document(s) folder to the recipient parties.

signerInstructionId (optional) If you want to use the signer instructions other than the default signer instructions, then pass that particular signer instruction id like "signerInstructionId":1.

signerInstructionCustomFields
(required if signerInstructionId is not 0)

A list of signer instruction fields details you're sending the folder to. Every field must contain tag, type, value fields.

Parameter	Description
tag (required)	Signer Instruction custom field name
type (required)	type can be `plain`
value (required)	Signer Instruction custom field value (Note:- use HTML tag `<br>` for line break)

confirmationInstructionCustomFields
(required if confirmationInstructionId is not 0)

A list of confirmation instruction fields details you're sending the folder to. Every field must contain tag, type, value fields.

Parameter	Description
tag (required)	Confirmation Text custom field name
type (required)	type can be `plain`
value (required)	Confirmation Text custom field value (Note:- use HTML tag `<br>` for line break)

hideCheckboxBorder (optional, default=false) Value can be either true or false
Borders of Checkbox will be hidden in the executed documents.

RESPONSE

{
    "embeddedSigningSessions": [
        {
            "emailIdOfSigner": "abc@xyz.com",
            "embeddedToken": "EMBEDDED_TOKEN",
            "embeddedSessionURL": "UNIQUE_EMBEDDED_SESSION_URL"
        },
        {
            "emailIdOfSigner": "mno@xyz.com",
            "embeddedToken": "EMBEDDED_TOKEN",
            "embeddedSessionURL": "UNIQUE_EMBEDDED_SESSION_URL"
        }
    ],
    "folder": {
        "folderId": 51798,
        "folderName": "Draft_Docs_Send_By_Id_1",
        "folderCustomName": "",
        "folderPassword": null,
        "folderAuthorId": 15603,
        "folderAuthorFirstName": "abc",
        "folderAuthorLastName": "xyz",
        "folderAuthorEmail": "abc@xyz.com",
        "folderAuthorRole": "super_admin",
        "folderCompanyId": 86,
        "folderCreationDate": 1580240968000,
        "folderSentDate": 1580460679339,
        "folderStatus": "SHARED",
        "custom_field1": {
            "name": "NAME",
            "value": "VALUE"
        },
        "custom_field2": {
            "name": "NAME",
            "value": "VALUE"
        },
        "folderDocumentIds": [
            51897
        ],
        "documentsList": [
            {
                "documentId": 51897,
                "contractId": 51897,
                "companyId": 86,
                "contractCreatedBy": 15603,
                "contractCreatedOn": 1580240967000,
                "contractType": null,
                "contractStatus": "WAITING_FOR_SIGNATURE",
                "editable": false,
                "contractVersionId": 26809,
                "contractVersionName": "fw4",
                "contractVersionDesc": "This is a non-editable form W4",
                "versionCreatedby": 15603,
                "versionCreatedOn": 1580240967000,
                "contractVersionNumber": 1,
                "contractTransactionSource": null
            }
        ],
        "folderRecipientParties": [
            {
                "partyId": 15573,
                "partyDetails": {
                    "partyId": 15573,
                    "firstName": "ABC",
                    "lastName": "XYZ",
                    "emailId": "abc@xyz.com",
                    "address": "",
                    "dateCreated": 1530046694000,
                    "optOutEmails": false,
                    "companyId": 86,
                    "userRole": "admin",
                    "userAddedDate": 1550638146000,
                    "department": "",
                    "title": "",
                    "active": true,
                    "requestLocale": "auto",
                    "share_among_department": false,
                    "dialingCode": "+1",
                    "mobileNumber": null,
                    "docStatusFilter": "all",
                    "docDateFilter": "last60",
                    "managerId": null
                },
                "contractPermissions": "FILL_FIELDS_AND_SIGN",
                "partySequence": 1,
                "workflowSignSequence": 1,
                "envelopeId": 0,
                "sharingMode": "direct",
                "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=gayQGLXYdB491iyhRYf25g%3D%3D&partyId=15573",
                "securityMode": "none",
                "extraComments": null,
                "allowNameChange": false,
                "signerNameUpdated": false,
                "signatureId": null
            },
            {
                "partyId": 15603,
                "partyDetails": {
                    "partyId": 15603,
                    "firstName": "PartyFirstName2",
                    "lastName": "PartyLasrName2",
                    "emailId": "mno@xyz.com",
                    "address": "",
                    "dateCreated": 1536713561000,
                    "optOutEmails": false,
                    "companyId": 86,
                    "userRole": "super_admin",
                    "userAddedDate": 1536713561000,
                    "department": "",
                    "title": "",
                    "active": true,
                    "requestLocale": "auto",
                    "share_among_department": false,
                    "dialingCode": "+1",
                    "mobileNumber": null,
                    "docStatusFilter": "all",
                    "docDateFilter": "last30",
                    "managerId": null
                },
                "contractPermissions": "FILL_FIELDS_AND_SIGN",
                "partySequence": 2,
                "workflowSignSequence": 2,
                "envelopeId": 0,
                "sharingMode": "direct",
                "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=gayQGLXYdB491iyhRYf25g%3D%3D&partyId=15603",
                "securityMode": "none",
                "extraComments": null,
                "allowNameChange": false,
                "signerNameUpdated": false,
                "signatureId": null
            }
        ],
        "folderAccessURLForAuthor": null,
        "bulkId": 0,
        "enforceSignWorkflow": false,
        "currentWorkflowStep": 1,
        "transactionSource": "API-5-via_draft_send",
        "editable": false,
        "inPersonSignable": false,
        "overrideAccountReminders": false,
        "overrideAccountRecipientDelegation": false,
        "allowRecipientsToDelegate": false,
        "envelopeId": 51798,
        "envelopeName": "fW4",
        "envelopeOriginatorId": 15603,
        "envelopeCompanyId": 86,
        "envelopeDate": 1580240968000,
        "envelopeSharedDate": 1580460679339,
        "envelopeStatus": "SHARED",
        "envelopeContractIds": [
            51897
        ],
        "envelopePartyPermissions": [
            {
                "partyId": 15573,
                "partyDetails": {
                    "partyId": 15573,
                    "firstName": "ABC",
                    "lastName": "XYZ",
                    "emailId": "abc@xyz.com",
                    "address": "",
                    "dateCreated": 1530046694000,
                    "optOutEmails": false,
                    "companyId": 86,
                    "userRole": "admin",
                    "userAddedDate": 1550638146000,
                    "department": "",
                    "title": "",
                    "active": true,
                    "requestLocale": "auto",
                    "share_among_department": false,
                    "dialingCode": "+1",
                    "mobileNumber": null,
                    "docStatusFilter": "all",
                    "docDateFilter": "last60",
                    "managerId": null
                },
                "contractPermissions": "FILL_FIELDS_AND_SIGN",
                "partySequence": 1,
                "workflowSignSequence": 1,
                "envelopeId": 0,
                "sharingMode": "direct",
                "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=gayQGLXYdB491iyhRYf25g%3D%3D&partyId=15573",
                "securityMode": "none",
                "extraComments": null,
                "allowNameChange": false,
                "signerNameUpdated": false,
                "signatureId": null
            },
            {
                "partyId": 15603,
                "partyDetails": {
                    "partyId": 15603,
                    "firstName": "PartyFirstName2",
                    "lastName": "PartyLasrName2",
                    "emailId": "mno@xyz.com",
                    "address": "",
                    "dateCreated": 1536713561000,
                    "optOutEmails": false,
                    "companyId": 86,
                    "userRole": "super_admin",
                    "userAddedDate": 1536713561000,
                    "department": "",
                    "title": "",
                    "active": true,
                    "requestLocale": "auto",
                    "share_among_department": false,
                    "dialingCode": "+1",
                    "mobileNumber": null,
                    "docStatusFilter": "all",
                    "docDateFilter": "last30",
                    "managerId": null
                },
                "contractPermissions": "FILL_FIELDS_AND_SIGN",
                "partySequence": 2,
                "workflowSignSequence": 2,
                "envelopeId": 0,
                "sharingMode": "direct",
                "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=gayQGLXYdB491iyhRYf25g%3D%3D&partyId=15603",
                "securityMode": "none",
                "extraComments": null,
                "allowNameChange": false,
                "signerNameUpdated": false,
                "signatureId": null
            }
        ],
        "envelopeAuthenticationLevel": "NO",
        "allowSingleSignerInBulk": false
    },
    "result": "success",
    "message": "Folder of the document(s) successfully created"
}

Modify the Shared Folder

With Foxit eSign API, you can modify any shared folder by calling /folders/modifySharedFolder with the given parameters.

POST /folders/modifySharedFolder
Content-Type application/json

REQUEST

{
	"folderId":51798,
	"folderName":"MainFolder",
	"folderPassword":"",
	"signInSequence":false,
	"inPersonEnable":false,
	"hideMoreAction": false,
	"sendNow":true,
	"signSuccessUrlAllParties":true,
	"allowAdvancedEmailValidation":true,
	"parties":[
		{
			"firstName":"ABC",
			"lastName":"XYZ",
			"emailId":"abc@xyz.com",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"allowNameChange":false,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			 "signerAuthLevel":"SMS Access Code"
		},
		{
			"firstName":"PartyFirstName2",
			"lastName":"PartyLastName2",
			"emailId":"mno@xyz.com",
			"permission":"FILL_FIELDS_AND_SIGN",
			"sequence":2,
			"hostEmailId":"hosteduseremail@xyz.com",
			"allowNameChange":false,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			"signerAuthLevel":"Email Access Code"
		},
		{
			"firstName":"Test",
			"lastName":"test",
			"emailId":"test@test.com",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"allowNameChange":false,
			"signerAuthLevel":"User-defined Access Code",
			"userDefinedAccessCode":"123Test@"
		}
	],
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":130,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"TextFieldName",
			"tooltip":"",
			"value":"TextFieldValue",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"
			"hideFieldNameForRecipients":false
		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                       "type":"formulafield",
                       "formulafieldName":"Formula_Field_Name",
                       "formula":"[n1] + [n2]",
                       "fontSize":8,
                       "fontFamily":"default",
                       "fontColor":"#000000",
                       "documentNumber":1,
                       "pageNumber":1,
                       "x":100,
                       "y":280,
                       "tabOrder":1,
                       "width":50,
                       "height":100,
                       "party": 1,
                       "decimalPlaces": 2
                },
               
		{
			"type":"signature",
			"x":200,
			"y":130,
			"width":100,
			"height":50,
			"documentNumber":1,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"text",
			"textfieldName": "Signer Name",
			"x":300,
			"y":250,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"Signer Name",
			"characterLimit":100,
		 	"partyResponsible": 1,
			"required": true,
			"fontSize": 12,
			"fontFamily": "default",
			"fontColor": "#000000",
			"readOnly": true,
			"systemField": true
		},
		{
			"type":"text",
			"x":450,
			"y":130,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"TextFieldName2",
			"tooltip":"",
			"value":"12345",
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers",
			"required":true
		},
		{
			"type":"accept",
			"party":1,
			"documentNumber":1,
			"pageNumber":1,
			"x":350,
			"y":505,
			"width":90,
			"height":15
		},
		{
			"type":"decline",
			"party":1,
			"documentNumber":1,
			"pageNumber":1,
			"x":450,
			"y":505,
			"width":90,
			"height":15
		},
		{
			"type":"text",
			"x":100,
			"y":230,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":2,
			"name":"TextFieldName3",
			"tooltip":"",
			"value":"TextFieldValueThree",
			"required":false,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"
		},
		{
			"type":"signature",
			"x":200,
			"y":230,
			"width":100,
			"height":50,
			"documentNumber":1,
			"pageNumber":1,
			"party":2
		},
		{
			"type":"text",
			"x":450,
			"y":230,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":2,
			"name":"12345678",
			"tooltip":"",
			"value":"1234",
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers",
			"required":true
		}
	],
	"createEmbeddedSigningSession":false,
	"emailIdOfEmbeddedSigner":"",
	"createEmbeddedSigningSessionForAllParties":false,
	"embeddedSignersEmailIds":["FIRST_EMBEDDED_SIGNER_EMAIL","SECOND_EMBEDDED_SIGNER_EMAIL"],
	"hideDeclineToSign":false,
	"hideNextRequiredFieldBtn":true,
	"signSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signDeclineUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signLaterUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"themeColor":"#C71585",
	"sessionExpire":false,
	"expiry":300000,
	"allowSendNowAndEmbeddedSigningSession":false,
	"createEmbeddedSendingSession":false,
	"enableStepByStep":false,
	"hideSignerActions": false,
	"hideSenderName": true,
	"hideFolderName": false,
	"hideDocumentsName": true,
	"createExecutedFolder": false,
	"custom_field1":{
			  	"name":"NAME",
			  	"value":"VALUE"
			},
	"custom_field2":{
			  	"name":"NAME",
			  	"value":"VALUE"
			},
		"emailTemplateId":0,
		"emailTemplateCustomFields":[
		  	{
		  		"tag":"custom_tag_value_1",
		  		"type":"plain",
		  		"value":"Email Template Custom value one."
		  	},
		  	{
		  		"tag":"custom_tag_1",
		  		"type":"plain",
		  		"value":""
		  	},
		  	{
		  		"tag":"custom_tag_2",
		  		"type":"plain",
		  		"value":"custom tag 2 Value."
		  	},
		  	{
		  		"tag":"custom_tag_link_1",
		  		"type":"hyperlink",
		  		"value":"",
		  		"url":"http://https://abc.com/hyperlink"
		  	}
		],
		"editEmailTemplate": {
			"emailTemplateSubject": "Email_Template_Subject'_${custom_tag_value_1}",
			"emailTemplateHtmlBody": 
				"<p>Email_Template_Body : </p>
				<p>${custom_tag_1} </p>
				<p>${custom_tag_2}</p>
				<p>$custom_tag_link_1}</p>
				<p>${custom_tag_1}</p>
				<p>&nbsp;  <span contenteditable=\"false\">${rec_full_name}</span>&nbsp;&nbsp; </p>
				<p><span contenteditable=\"false\">${rec_first_name}</span>&nbsp;&nbsp; </p>
				<p>&nbsp;&nbsp;<span contenteditable=\"false\">${sender_full_name}</span>&nbsp;&nbsp; </p>
				<p><span contenteditable=\"false\">${sender_first_name}</span>&nbsp;&nbsp; </p>
				<p>&nbsp;&nbsp;<span contenteditable=\"false\">${document_title}</span>&nbsp;&nbsp;</p>"
				....
			
			},
	"authenticationLevel":"NO",
	"senderEmail":"autheremailid@xyz.com",
	"signerInstructionId":1,
	"confirmationInstructionId":2,
	"signerInstructionCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_1",
  		"type":"plain",
  		"value":"Please review the document."
  	}
  	],
  	"confirmationInstructionCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_2",
  		"type":"plain",
  		"value":"Click here to confirm signing."
  	}
  	]
}

Parameter Description

folderId (required) Folder id you want to use to modify the folder. You can determine the folder id from the shared folder URL.
https://{{HOST_NAME}}/documents/viewfolderforsigning?folder.envelopeId=2520579

folderName (optional) Name of the document(s) folder

signSuccessUrlAllParties
Default false Value can be either true or false
If true then folder will be redirected to after successfully signing the document on the absolute URL, which URL is provided by the signSuccessUrl parameter
Note: This parameter is only applicable when the sendNow parameter is true and sent a folder invitation email.

fixRecipientParties (required if createEmbeddedSendingSession is true) Value can be either true or false
If true then in the embedded sending view, you won't be able to change the parties for the folder, which are already added as a part of this API request.

enableStepByStep (optional, default=false) To enable step by step action in the embedded sending session.

hideSignerSelectOption
(optional) Value can be either true or false
If true, it will hide the "Existing Signer Name/Email" input box on Recipient Parties in an embedded sending session.

hideSenderName
(optional, default=false) Value can be either true or false
If true, it will hide the sender name on Recipient Parties in both embedded sessions.

hideFolderName
(optional, default=false) Value can be either true or false
If true, it will hide the folder name on navigation in both embedded sessions.

hideDocumentsName
(optional, default=false) Value can be either true or false
If true, it will hide the document name in both embedded sessions.

hideAddMeButton (optional) Value can be either true or false
If true, it will hide the "Add Me" button on Recipient Parties in an embedded sending session.

hideAddNewButton (optional) Value can be either true or false
If true, it will hide the "Add New" button on Recipient Parties in an embedded sending session.

hideAddGroupButton (optional) Value can be either true or false
If true, it will hide the "Add Group" button on Recipient Parties in an embedded sending session.

createEmbeddedSigningSession (optional, default=false)

Parameter	Description
signSuccessUrl (optional,append ?parent=`false` if you want to redirect within the same iframe)	Enter the absolute URL for the landing page on your website/application, which the user will be redirected to after successfully signing the folder in the embedded signing view.
signErrorUrl (optional)	Enter the absolute URL for the landing page your website/application, which the user will be redirected to if error comes during signing the folder in the embedded signing view.
signDeclineUrl (optional)	If `true`, it will hide the option of "Decline to Sign" for the signer.
signLaterUrl (optional)	Enter the absolute URL for the landing page your website/application, which the user will be redirected to if he chooses to sign the folder later in the embedded signing view.
themeColor (optional)	You can enter a css value for a color to match your website's look n feel when you embed Foxit eSign inside. The top blue band of the embedded screen is then replaced with the color provided by you.
hideMoreAction (optional)	Value can be either `true` or `false` If `true`, it will hide the "More Actions" button in an signing session. In case of sendNow is `false`, it will not hide anything.
hideDeclineToSign (optional, default=`false`)	If `true`, it will hide the option of "Decline to Sign" for the signer.
hideNextRequiredFieldBtn (optional, default=`false`)	Value can be either `true` or `false` If `true`, it will hide the Next Required Field button(top on the right side of the user interface) in an embedded signing session.
sessionExpire (optional, default=`false`)	Value can be either `true` or `false` Use this field to initiate the expire of the embedded signing session.
expiry (required if `sessionExpire` is `true`)	Use this field to enter the time duration in milliseconds of the expiry on the embedded signing session.

emailTemplateId (optional) If you want to use the email template other than the default email template, then pass that particular email template id.

emailTemplateCustomFields
(required if emailTemplateId is not 0)

A list of email template fields details you're sending the folder to. Every field must contain tag, type, and value fields.

Parameter	Description
tag (required)	Email template custom field name
type (required)	type can be either `plain` or `hyperlink`
url (required if field type is `hyperlink`)	HYPERTEXT_REFERENCE of hyperlink
value (required)	Email template custom field value

authenticationLevel (optional)

This parameter should be NO, SMS LINK, User-defined Access Code, Email Access Code, SMS Access Code and Voice Access Code.
The company should be enabled the below features for the below authentication level.

Features	Authentication Level
Authentication via SMS	SMS LINK
Authentication Via Email	Email Access Code
2FA Via Authy	SMS Access Code
2FA Via Authy	Voice Access Code
User-defined Access Code	User-defined Access Code

Custom Fields (optional)
Two custom fields custom_field1 and custom_field2

Parameter	Description
name	Name of the custom field
value	Value of the custom field

Custom fields can be used for many purposes, such as identifying the application and module where the signed document belongs. You can use the custom fields as per your requirements. Maximum of two custom fields can be passed to Foxit eSign via API that are stored at the folder level. The webhook response includes these custom fields.

allowAdvancedEmailValidation (Optional) (default=false) Value can be either true or false
Validate the email address of the parties.

parties (optional)

A list of recipient parties you're sending the folder to. Every entry must contain firstName, lastName, emailId, permission and sequence fields.

permission Use this field to assign folder permissions to a recipient. Can be any one of the following values:
FILL_FIELDS_AND_SIGN, FILL_FIELDS_ONLY, SIGN_ONLY, VIEW_ONLY, PARTY_ASSIGNER

isPlaceholder
(optional, default=false) Value can be either true or false
Use this field to initiate the party is a placeholder.
Note:
1. firstName, lastName, emailId parameter's value must be blank of this party.
2. To add the placeholder, one recipient must be requred with 'PARTY_ASSIGNER' permission.

partyRole (optional) Use this field to assign a role of placeholder.
Note: This parameter is only applicable when the party is a placeholder.

dialingCode Use this field to assign a country dial-in codes are mobile number prefixes to a recipient in the list of recipient parties.

mobileNumber Use this field to assign a mobile number to a recipient in the list of recipient parties.

signerAuthLevel

Features	Authentication Level
Authentication via SMS	SMS LINK
Authentication Via Email	Email Access Code
2FA Via Authy	SMS Access Code
2FA Via Authy	Voice Access Code
User-defined Access Code	User-defined Access Code

userDefinedAccessCode

Codes are not case sensitive
System does not send this code so you must share this code with the signer directly
Access code can contain alphabets, numbers and the following special characters:
@,&,{,},%,(,),~,|,!,+,^

allowNameChange Value can be either true or false
Use this parameter for allowing signer to update first and last name before completing the signing process.
Note: Please make sure the "Update Name Change"option is enabled from company settings.

partyIsEmailGroup Value can be either true or false
Use this parameter for creating party as bulk.
Note:If this parameter is true, firstName, lastName and emailId of this party will be ignored.

emailGroupId Pass email group id you want to use to create bulk

allowSingleSignerInBulk Value can be either true or false
Use this parameter to allow only one person to sign in email group.

hostEmailId Use this parameter to pass the email id of in-person administrator.

fields (optional) A list of different fields to be added to the document(s).

senderEmail (optional) You can enter email of another user in your account which will be used for sending this document(s) folder to the recipient parties.

signerInstructionId (optional) If you want to use the signer instructions other than the default signer instructions, then pass that particular signer instruction id like "signerInstructionId":1.

signerInstructionCustomFields
(required if signerInstructionId is not 0)

A list of signer instruction fields details you're sending the folder to. Every field must contain tag, type, value fields.

Parameter	Description
tag (required)	Signer Instruction custom field name
type (required)	type can be `plain`
value (required)	Signer Instruction custom field value (Note:- use HTML tag `<br>` for line break)

confirmationInstructionCustomFields
(required if confirmationInstructionId is not 0)

A list of confirmation instruction fields details you're sending the folder to. Every field must contain tag, type, value fields.

Parameter	Description
tag (required)	Confirmation Text custom field name
type (required)	type can be `plain`
value (required)	Confirmation Text custom field value (Note:- use HTML tag `<br>` for line break)

hideCheckboxBorder (optional, default=false) Value can be either true or false
Borders of Checkbox will be hidden in the executed documents.

RESPONSE

{
    "embeddedSigningSessions": [
        {
            "emailIdOfSigner": "abc@xyz.com",
            "embeddedToken": "EMBEDDED_TOKEN",
            "embeddedSessionURL": "UNIQUE_EMBEDDED_SESSION_URL"
        },
        {
            "emailIdOfSigner": "mno@xyz.com",
            "embeddedToken": "EMBEDDED_TOKEN",
            "embeddedSessionURL": "UNIQUE_EMBEDDED_SESSION_URL"
        }
    ],
    "folder": {
        "folderId": 51798,
        "folderName": "Folder_name_1",
        "folderCustomName": "",
        "folderPassword": null,
        "folderAuthorId": 15603,
        "folderAuthorFirstName": "abc",
        "folderAuthorLastName": "xyz",
        "folderAuthorEmail": "abc@xyz.com",
        "folderAuthorRole": "super_admin",
        "folderCompanyId": 86,
        "folderCreationDate": 1580240968000,
        "folderSentDate": 1580460679339,
        "folderStatus": "SHARED",
        "custom_field1": {
            "name": "NAME",
            "value": "VALUE"
        },
        "custom_field2": {
            "name": "NAME",
            "value": "VALUE"
        },
        "folderDocumentIds": [
            51897
        ],
        "documentsList": [
            {
                "documentId": 51897,
                "contractId": 51897,
                "companyId": 86,
                "contractCreatedBy": 15603,
                "contractCreatedOn": 1580240967000,
                "contractType": null,
                "contractStatus": "WAITING_FOR_SIGNATURE",
                "editable": false,
                "contractVersionId": 26809,
                "contractVersionName": "fw4",
                "contractVersionDesc": "this is a non editable form W4",
                "versionCreatedby": 15603,
                "versionCreatedOn": 1580240967000,
                "contractVersionNumber": 1,
                "contractTransactionSource": null
            }
        ],
        "folderRecipientParties": [
            {
                "partyId": 15573,
                "partyDetails": {
                    "partyId": 15573,
                    "firstName": "ABC",
                    "lastName": "XYZ",
                    "emailId": "abc@xyz.com",
                    "address": "",
                    "dateCreated": 1530046694000,
                    "optOutEmails": false,
                    "companyId": 86,
                    "userRole": "admin",
                    "userAddedDate": 1550638146000,
                    "department": "",
                    "title": "",
                    "active": true,
                    "requestLocale": "auto",
                    "share_among_department": false,
                    "dialingCode": "+1",
                    "mobileNumber": null,
                    "docStatusFilter": "all",
                    "docDateFilter": "last60",
                    "managerId": null
                },
                "contractPermissions": "FILL_FIELDS_AND_SIGN",
                "partySequence": 1,
                "workflowSignSequence": 1,
                "envelopeId": 0,
                "sharingMode": "direct",
                "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=gayQGLXYdB491iyhRYf25g%3D%3D&partyId=15573",
                "securityMode": "none",
                "extraComments": null,
                "allowNameChange": false,
                "signerNameUpdated": false,
                "signatureId": null
            },
            {
                "partyId": 15603,
                "partyDetails": {
                    "partyId": 15603,
                    "firstName": "PartyFirstName2",
                    "lastName": "PartyLasrName2",
                    "emailId": "mno@xyz.com",
                    "address": "",
                    "dateCreated": 1536713561000,
                    "optOutEmails": false,
                    "companyId": 86,
                    "userRole": "super_admin",
                    "userAddedDate": 1536713561000,
                    "department": "",
                    "title": "",
                    "active": true,
                    "requestLocale": "auto",
                    "share_among_department": false,
                    "dialingCode": "+1",
                    "mobileNumber": null,
                    "docStatusFilter": "all",
                    "docDateFilter": "last30",
                    "managerId": null
                },
                "contractPermissions": "FILL_FIELDS_AND_SIGN",
                "partySequence": 2,
                "workflowSignSequence": 2,
                "envelopeId": 0,
                "sharingMode": "direct",
                "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=gayQGLXYdB491iyhRYf25g%3D%3D&partyId=15603",
                "securityMode": "none",
                "extraComments": null,
                "allowNameChange": false,
                "signerNameUpdated": false,
                "signatureId": null
            }
        ],
        "folderAccessURLForAuthor": null,
        "bulkId": 0,
        "enforceSignWorkflow": false,
        "currentWorkflowStep": 1,
        "transactionSource": "API-5-via_draft_send",
        "editable": false,
        "inPersonSignable": false,
        "overrideAccountReminders": false,
        "overrideAccountRecipientDelegation": false,
        "allowRecipientsToDelegate": false,
        "envelopeId": 51798,
        "envelopeName": "fW4",
        "envelopeOriginatorId": 15603,
        "envelopeCompanyId": 86,
        "envelopeDate": 1580240968000,
        "envelopeSharedDate": 1580460679339,
        "envelopeStatus": "SHARED",
        "envelopeContractIds": [
            51897
        ],
        "envelopePartyPermissions": [
            {
                "partyId": 15573,
                "partyDetails": {
                    "partyId": 15573,
                    "firstName": "ABC",
                    "lastName": "XYZ",
                    "emailId": "abc@xyz.com",
                    "address": "",
                    "dateCreated": 1530046694000,
                    "optOutEmails": false,
                    "companyId": 86,
                    "userRole": "admin",
                    "userAddedDate": 1550638146000,
                    "department": "",
                    "title": "",
                    "active": true,
                    "requestLocale": "auto",
                    "share_among_department": false,
                    "dialingCode": "+1",
                    "mobileNumber": null,
                    "docStatusFilter": "all",
                    "docDateFilter": "last60",
                    "managerId": null
                },
                "contractPermissions": "FILL_FIELDS_AND_SIGN",
                "partySequence": 1,
                "workflowSignSequence": 1,
                "envelopeId": 0,
                "sharingMode": "direct",
                "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=gayQGLXYdB491iyhRYf25g%3D%3D&partyId=15573",
                "securityMode": "none",
                "extraComments": null,
                "allowNameChange": false,
                "signerNameUpdated": false,
                "signatureId": null
            },
            {
                "partyId": 15603,
                "partyDetails": {
                    "partyId": 15603,
                    "firstName": "PartyFirstName2",
                    "lastName": "PartyLasrName2",
                    "emailId": "mno@xyz.com",
                    "address": "",
                    "dateCreated": 1536713561000,
                    "optOutEmails": false,
                    "companyId": 86,
                    "userRole": "super_admin",
                    "userAddedDate": 1536713561000,
                    "department": "",
                    "title": "",
                    "active": true,
                    "requestLocale": "auto",
                    "share_among_department": false,
                    "dialingCode": "+1",
                    "mobileNumber": null,
                    "docStatusFilter": "all",
                    "docDateFilter": "last30",
                    "managerId": null
                },
                "contractPermissions": "FILL_FIELDS_AND_SIGN",
                "partySequence": 2,
                "workflowSignSequence": 2,
                "envelopeId": 0,
                "sharingMode": "direct",
                "folderAccessURL": "https://{{HOST_NAME}}/viewDocumentDirect?encrDocId=gayQGLXYdB491iyhRYf25g%3D%3D&partyId=15603",
                "securityMode": "none",
                "extraComments": null,
                "allowNameChange": false,
                "signerNameUpdated": false,
                "signatureId": null
            }
        ],
        "envelopeAuthenticationLevel": "NO",
        "allowSingleSignerInBulk": false
    },
    "result": "success",
    "message": "folder of document(s) successfully created"
}

Sending Signature Reminders

With Foxit eSign API, you can send reminders to the signers by calling /folders/signaturereminder with the given parameters.

POST /folders/signaturereminder
Content-Type application/json

REQUEST

{
		"folderId":51798
}

Parameter	Description
folderId (required)	Folder id for which you want to send signature reminders.

RESPONSE

{
    
    "result": "success",
    "reminder sent": 51798
}

Code Samples

curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
    "folderId":219
}' "https://{{HOST_NAME}}/api/folders/signaturereminder"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/signaturereminder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{
  	"folderId":219
}',
  
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/signaturereminder";

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);

            httpWebRequest.ContentType = "application/json; charset=utf-8";
            httpWebRequest.Method = "POST";
           
            httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = @"{""folderId"":"+ FOLDERIDTOSENDREMINDER+ "}";
                streamWriter.Write(json);
                streamWriter.Flush();
            }

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
                
            }

			String apiURL = "https://{{HOST_NAME}}/api/folders/signaturereminder/";
		    URL url= new URL(apiURL);
			HttpURLConnection httpConn= (HttpURLConnection) url.openConnection();
			httpConn.setDoOutput(true);
			httpConn.setRequestProperty("Content-Type", "application/json");
			httpConn.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		
			String urlParameters="{\"folderId\":FOLDER_ID}";
		
			DataOutputStream wr = new DataOutputStream(httpConn.getOutputStream());
			wr.writeBytes(urlParameters);
			
			   if (httpConn.getResponseCode() != HttpURLConnection.HTTP_OK) {
		            throw new RuntimeException("Failed : HTTP error code : "+ httpConn.getResponseCode());
		        }
		        BufferedReader br = new BufferedReader(new InputStreamReader(
		                (httpConn.getInputStream())));
		        String output;
		        System.out.println("Output from Server .... \n");
		        while ((output = br.readLine()) != null) {
		            System.out.println(output);
		        }
		        
		        httpConn.disconnect();

Cancel Folder

With Foxit eSign API, you can cancel/decline to sign documents by calling /folders/cancelFolder with the given parameters.

POST /folders/cancelFolder
Content-Type application/json

REQUEST

{
	"folderId":51798,
	"reason_for_cancellation":"REASON_FOR_CANCELLATION"
}

Parameter	Description
folderId (required)	Folder id you want to use to cancel this folder.
reason_for_cancellation (required)	Reason for Cancellation of the folder

RESPONSE

{
    "result": "success",
    "folders cancelled": 51798
}

Code Samples

curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
    "folderId":219,
    "reason_for_cancellation":"[REASON]"
}' "https://{{HOST_NAME}}/api/folders/cancelFolder"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/cancelFolder",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{
  	"folderId":219,
  	"reason_for_cancellation":"REASON_FOR_CANCELLATION"
}',
  
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/cancelFolder";

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);

            httpWebRequest.ContentType = "application/json; charset=utf-8";
            httpWebRequest.Method = "POST";
           
            httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = @"{""folderId"":"+ FOLDERIDTOSENDREMINDER+ ",""reason_for_cancellation":+[REASON]"}";
                streamWriter.Write(json);
                streamWriter.Flush();
            }

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
                
            }

			String apiURL = "https://{{HOST_NAME}}/api/folders/cancelFolder/";
		    URL url= new URL(apiURL);
			HttpURLConnection httpConn= (HttpURLConnection) url.openConnection();
			httpConn.setDoOutput(true);
			httpConn.setRequestProperty("Content-Type", "application/json");
			httpConn.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		
			String urlParameters="{\"folderId\":[FOLDER_ID],\"reason_for_cancellation\":"[REASON]"}";
		
			DataOutputStream wr = new DataOutputStream(httpConn.getOutputStream());
			wr.writeBytes(urlParameters);
			
			   if (httpConn.getResponseCode() != HttpURLConnection.HTTP_OK) {
		            throw new RuntimeException("Failed : HTTP error code : "+ httpConn.getResponseCode());
		        }
		        BufferedReader br = new BufferedReader(new InputStreamReader(
		                (httpConn.getInputStream())));
		        String output;
		        System.out.println("Output from Server .... \n");
		        while ((output = br.readLine()) != null) {
		            System.out.println(output);
		        }
		        
		        httpConn.disconnect();

Create embedded signing view

When embedded signing view is enabled, you can show a document within your application.

The embedded signing view URL obtained via embeddedSessionURL will look like the following:
https://{{HOST_NAME}}/embedded/embeddedsign?eetid={URL-ENCODED EMBEDDED-TOKEN}

You can embed Foxit eSign in your application using iFrame like
<div style="height: 100%; width: 100%; overflow: auto;" data-role="content"> <iframe id="esignIframe" src="[EMBED_SESSION_URL]" style="width: 99% !important;height: 99% !important;position: absolute;" frameborder="0"></iframe> </div>
You can style the outer div element as per your application look and feel.

Note: For better experience include <script type="text/javascript" src="https://{{HOST_NAME}}/js/esignGeniePostMessageParent.js"></script> and iframe id esignIframe.
In the iframe, you will see the document which the User needs to sign.

Once the user successfully eSign, They will be redirected to the application success URL which you submitted in the request.

Foxit eSign adds the following two more parameters to the original success URL:

Parameter	Description
folderId	This is the id of the folder that was signed by the party in the embedded session. You can use this id to query our API further to download the document PDF, etc.
event	Its value is `signing_success`, if the user successfully signs the document. Or `signing_declined`, if the user declines to sign the document.

Create embedded sending view

When embedded sending view is enabled, you can prepare a document within your application where you can drag and drop various fields on your document.

The embedded sending view URL obtained via embeddedSessionURL will look like the following:
https://{{HOST_NAME}}/embedded/embeddedsend?eetid={URL-ENCODED EMBEDDED-TOKEN}

You can embed Foxit eSign in your application using iFrame like
<div style="height: 100%; width: 100%; overflow: auto;" data-role="content"> <iframe src="[EMBED_SESSION_URL]" style="width: 99% !important;height: 99% !important;position: absolute;" frameborder="0"></iframe> </div>
You can style the outer div element as per your application look and feel.

In the iframe, you will see the document which the User needs to sign.

Once the user successfully sends the folder, he/she will be redirected to the application success URL which you submitted in the request.

Foxit eSign adds the following two more parameters to the original success URL:

Parameter	Description
folderId	This is the id of the folder that was sent by the party in the embedded session. You can use this id to query our API further to get the document status, etc.
event	Its value is `sending_success`, if the user successfully sends the document.

Update Envelope Fields

You can update the envelope and the custom fields (custom_field1 and custom_field2) anytime before execution using the 'Update Envelope Fields' API. Envelope fields for a party can only be updated if that party has not yet signed the document.

POST /folders/updateEnvelopeFields
Content-Type application/json

Request

{
	"folderId":FOLDER_ID,
	"custom_field1":{
		"name":"NAME",
		"value":"VALUE"
	},

	"custom_field2":{
		"name":"NAME",
		"value":"VALUE"
  	},
  	
  	"fields": {
	"FIELD1_NAME":"VALUE",
	"FIELD2_NAME":"VALUE",
	If formula field
	"FORMULA_FIELD_NAME":"Updated_Formula"
	If image field
	"IMAGE_FIELD_NAME":{ 
				"inputType":"url or base64",
				"imageName":"logo.png",
				"source": "URL or BASE64 String"	
			   },
	....
	}
	
}

RESPONSE

{
    "result": "success",
    "custom_field1":{
		"name":"NAME",
		"value":"VALUE"
	},

	"custom_field2":{
		"name":"NAME",
		"value":"VALUE"
  	},
    "allFieldsNameValue": [
        {
            "fieldId": 44796,
            "documentId": 4096,
            "documentVersionId": 4180,
            "fieldType": "textfield",
            "name": "FIELD1_NAME",
            "value": "VALUE"
        },
        {
            "fieldId": 44797,
            "documentId": 4096,
            "documentVersionId": 4180,
            "fieldType": "textfield",
            "name": "FIELD2_NAME",
            "value": "VALUE"
        }
    ]
}

Update Folder Recipients

You can change the first name, last name, and email if the recipient party has not signed on a shared or partially signed document using the 'Update Folder Recipients' API. Recipients can be changed only in the draft status folder.

POST /folders/updateFolder
Content-Type application/json

Request

{
	"folderId":FOLDER_ID,
	"allowAdvancedEmailValidation":true,
	"parties":[
        {
			"action": "update",
			"sequence":2,
			"firstName": "UPDATEDFIRSTNAME",
			"lastName": "UPDATEDLASTNAME ",
			"emailId": "UPDATEDEMAILID",
			"dialingCode": "+1",
			"mobileNumber": "9999999999"
		},
		{
			"action": "change",
			"sequence":3,
			"firstName": "UPDATEDFIRSTNAME",
			"lastName": "UPDATEDLASTNAME",
			"emailId": "UPDATEDEMAILID",
			"dialingCode": "+1",
			"mobileNumber": "9999999999"
		},
		...
	]
}

Parameter Description

folderId (required) Folder id you want to use to update recipients details

allowAdvancedEmailValidation (Optional) (default=false) Value can be either true or false
Validate the email address of the parties.

parties

A list of recipient parties you want update/change. Every entry must contain action, sequence, firstName, and lastName fields.

action	This is a mandatory parameter. Value can be either `update` or `change` Note: 'update' value can be used for Draft, Shared, Partially Signed folders. 'change' value can be used only in the Draft status folders.
sequence	The sequence number of the recipient in the list of recipient parties you want to update/change.
firstName	First name of the recipient you want to update/change.
lastName	Last name of the recipient you want to update/change.
emailId	Email id of the recipient you want to update/change. Note: This parameter is mandatory if the action value is 'change'.
dialingCode(optional)	Use this field to assign a country dial-in codes are mobile number prefixes to a recipient in the list of recipient parties.
mobileNumber(optional)	Use this field to assign a mobile number to a recipient in the list of recipient parties.

RESPONSE

{
    "parties": [
        {
            "Status": "Successfully Updated recipient party.",
            "partyDetails": {
                "partyId": 11111,
                "firstName": "UPDATEDFIRSTNAME",
                "lastName": "UPDATEDLASTNAME",
                "emailId": "UPDATEDEMAILID",
                "address": null,
                "dateCreated": null,
                "optOutEmails": false,
                "authenticationLevel": "NO",
                "companyId": COMPANY_ID,
                "subcontractorDescription": null,
                "subcontractorOrganization": null,
                "subcAddedDate": 1610516820000,
                "dialingCode": "+1",
                "mobileNumber": "9999999999",
                "placeholder": false
            }
        },
        {
            "Status": "Recipient replaced successfully.",
            "partyDetails": {
                "partyId": 22222,
                "firstName": "UPDATEDFIRSTNAME",
                "lastName": "UPDATEDLASTNAME",
                "emailId": "UPDATEDEMAILID",
                "address": null,
                "dateCreated": null,
                "optOutEmails": false,
                "authenticationLevel": "NO",
                "companyId": COMPANY_ID,
                "subcontractorDescription": null,
                "subcontractorOrganization": null,
                "subcAddedDate": 1610516820000,
                "dialingCode": "+1",
                "mobileNumber": "9999999999",
                "placeholder": false
            }
        }
    ],
    "folderId": FOLDER_ID
}

Regenerate Expired Embedded Signing Session Token

You can regenerate the expired folder embedded signing token for accessing the signature from the signer.

POST /embedded/regenerateEmbeddedSigningSession
Content-Type application/json

Request Parameters

{
    "folderId":FOLDER_ID,
    "emailId":"EMAIL_ID_OF_RECIPIENT_PARTY",
    "partyId":RECIPIENT_PARTY_Id
    "sessionExpire":true,
    "expiry":60000000
}

Parameter	Description
folderId (required)	Folder id you want to use to regenerate the expired folder embedded signing token for this folder. You can determine the folder id from the folder URL. https://{{HOST_NAME}}/documents/viewfolderforsigning?folder.envelopeId=`2520579`
emailId (required)	The recipient email id you want to use to regenerate the expired folder embedded signing token for this folder. The recipient party exists in this folder.
partyId (required if `emailId` is not provided)	Recipient party id you want to use to regenerate the expired folder embedded signing token for this folder. The recipient party exist in this folder.
sessionExpire (optional, default=`false`)	Value can be either `true` or `false` Use this field to initiate the expire of the embedded signing session.
expiry (required if `sessionExpire` is `true`)	Use this field to enter the time duration in milliseconds of the expiry on the embedded signing session.

Response

{
	"emailIdOfSigner": "EMAIL_ID_OF_RECIPIENT_PARTY",
	"embeddedToken": "EMBEDDED_TOKEN",
	"embeddedSessionURL": "UNIQUE_EMBEDDED_SESSION_URL"
}

Get Folder Data

You can poll our API to get the folder/document data

GET /folders/myfolder?folderId={FOLDER_ID}

Request Parameters

folderId

Your FOLDER_ID

RESPONSE

{
  "result": "success",
  "folder": {
    "folderId": 86377,
    "folderName": "eSignGenie Sample",
    "folderAuthorId": 1,
    "folderAuthorFirstName": "ABC",
    "folderAuthorLastName": "XYZ",
    "folderAuthorEmail": "abc@xyz.com",
    "folderAuthorRole": "admin",
    "folderCompanyId": 12,
    "folderCreationDate": 1473332678000,
    "folderSentDate": null,
    "folderStatus": "EXECUTED",
    "folderDocumentIds": [
      101857
    ],
    "documentsList": [
      {
        "documentId": 101857,
        "contractId": 101857,
        "companyId": 12,
        "contractCreatedBy": 1,
        "contractCreatedOn": 1473332676000,
        "contractType": "Sample",
        "contractStatus": "EXECUTED",
        "editable": false,
        "contractVersionId": 101715,
        "contractVersionName": "Foxit eSign Sample",
        "contractVersionDesc": "Foxit eSign Sample Document",
        "versionCreatedby": 1,
        "versionCreatedOn": 1473332676000,
        "contractVersionNumber": 1
      }
    ],
    "folderRecipientParties": [
      {
        "partyId": 1,
        "partyDetails": {
          "partyId": 1,
          "firstName": "John",
          "lastName": "Doe",
          "emailId": "johndoe@esigngenie.com",
          "address": "Delhi",
          "dateCreated": 1404837207000
        },
        "contractPermissions": "FILL_FIELDS_AND_SIGN",
        "partySequence": 1,
        "workflowSignSequence": 1,
        "envelopeId": 86377,
        "sharingMode": "email",
        "folderAccessURL": null,
        "securityMode": "none",
        "extraComments": null
      },
      {
        "partyId": 28,
        "partyDetails": {
          "partyId": 28,
          "firstName": "Jane",
          "lastName": "Doe",
          "emailId": "janedoe@esigngenie.com",
          "address": "",
          "dateCreated": 1404837216000
        },
        "contractPermissions": "FILL_FIELDS_AND_SIGN",
        "partySequence": 2,
        "workflowSignSequence": 2,
        "envelopeId": 86377,
        "sharingMode": "email",
        "folderAccessURL": null,
        "securityMode": "none",
        "extraComments": null
      }
    ],
    "folderAccessURLForAuthor": null,
    "bulkId": 0,
    "enforceSignWorkflow": false,
    "currentWorkflowStep": 0,
    "transactionSource": "eSignGenie WebApp",
    "editable": false,
    "inPersonSignable": false,
    "overrideAccountReminders": false,
    "envelopeId": 86377,
    "envelopeName": "eSignGenie Sample",
    "envelopeOriginatorId": 1,
    "envelopeCompanyId": 12,
    "envelopeDate": 1473332678000,
    "envelopeSharedDate": null,
    "envelopeStatus": "DRAFT",
    "envelopeContractIds": [
      101857
    ],
    "envelopePartyPermissions": [
      {
        "partyId": 1,
        "partyDetails": {
          "partyId": 1,
          "firstName": "John",
          "lastName": "Doe",
          "emailId": "johndoe@esigngenie.com",
          "address": "Delhi",
          "dateCreated": 1404837207000
        },
        "contractPermissions": "FILL_FIELDS_AND_SIGN",
        "partySequence": 1,
        "workflowSignSequence": 1,
        "envelopeId": 86377,
        "sharingMode": "email",
        "folderAccessURL": null,
        "securityMode": "none",
        "extraComments": null
      },
      {
        "partyId": 28,
        "partyDetails": {
          "partyId": 28,
          "firstName": "Jane",
          "lastName": "Doe",
          "emailId": "janedoe@esigngenie.com",
          "address": "",
          "dateCreated": 1404837216000
        },
        "contractPermissions": "FILL_FIELDS_AND_SIGN",
        "partySequence": 2,
        "workflowSignSequence": 2,
        "envelopeId": 86377,
        "sharingMode": "email",
        "folderAccessURL": null,
        "securityMode": "none",
        "extraComments": null
      }
    ]
  },
  "allFields": [
    {
      "fieldTagId": 898441,
      "contractId": 101857,
      "versionId": 101715,
      "templateId": 0,
      "companyId": 12,
      "fieldType": "textfield",
      "documentPageNumber": 1,
      "coordinateXRatio": 0.14267,
      "coordinateYRatio": 0.421053,
      "elementWidthRatio": 0.212766,
      "elementHeightRatio": 0.0205592,
      "docFieldId": "898441",
      "dependent": false,
      "parentTagId": "",
      "parentTagValueToCompare": "",
      "conditionResult": null,
      "tabOrder": null,
      "textfieldName": "Name of party",
      "value": "",
      "description": "",
      "partyResponsible": 1,
      "required": false,
      "multiLine": false,
      "fontSize": 8,
      "fontFamily": "default",
      "fontColor": "#000000",
      "readOnly": false,
      "systemField": false
    },
    {
      "fieldTagId": 898443,
      "contractId": 101857,
      "versionId": 101715,
      "templateId": 0,
      "companyId": 12,
      "fieldType": "signfield",
      "documentPageNumber": 1,
      "coordinateXRatio": 0.505436,
      "coordinateYRatio": 0.73602,
      "elementWidthRatio": 0.212766,
      "elementHeightRatio": 0.0246711,
      "docFieldId": "898443",
      "dependent": false,
      "parentTagId": "",
      "parentTagValueToCompare": "",
      "conditionResult": null,
      "tabOrder": null,
      "partyResponsible": 1,
      "signatureId": null
    },
    {
      "fieldTagId": 898445,
      "contractId": 101857,
      "versionId": 101715,
      "templateId": 0,
      "companyId": 12,
      "fieldType": "signfield",
      "documentPageNumber": 1,
      "coordinateXRatio": 0.505436,
      "coordinateYRatio": 0.797697,
      "elementWidthRatio": 0.212766,
      "elementHeightRatio": 0.0246711,
      "docFieldId": "898445",
      "dependent": false,
      "parentTagId": "",
      "parentTagValueToCompare": "",
      "conditionResult": null,
      "tabOrder": null,
      "partyResponsible": 28,
      "signatureId": null
    },
    {
      "fieldTagId": 898447,
      "contractId": 101857,
      "versionId": 101715,
      "templateId": 0,
      "companyId": 12,
      "fieldType": "datefield",
      "documentPageNumber": 1,
      "coordinateXRatio": 0.518202,
      "coordinateYRatio": 0.422697,
      "elementWidthRatio": 0.212766,
      "elementHeightRatio": 0.0205592,
      "docFieldId": "898447",
      "dependent": false,
      "parentTagId": "",
      "parentTagValueToCompare": "",
      "conditionResult": null,
      "tabOrder": null,
      "datefieldName": "date of contract",
      "value": "",
      "description": "",
      "partyResponsible": 28,
      "required": false,
      "dateFormat": "DD-MMM-YYYY",
      "readOnly": false,
      "systemField": false
    },
    {
      "fieldTagId": 898449,
      "contractId": 101857,
      "versionId": 101715,
      "templateId": 0,
      "companyId": 12,
      "fieldType": "checkboxfield",
      "documentPageNumber": 1,
      "coordinateXRatio": 0.453309,
      "coordinateYRatio": 0.578125,
      "elementWidthRatio": 0.0212766,
      "elementHeightRatio": 0.0164474,
      "docFieldId": "898449",
      "dependent": false,
      "parentTagId": "",
      "parentTagValueToCompare": "",
      "conditionResult": null,
      "tabOrder": null,
      "cbname": "",
      "description": "",
      "partyResponsible": 28,
      "cbgroup": "",
      "checked": false,
      "oneCbMandatoryInGroup": false,
      "multiCheckGroup": false,
      "displayAsRadioButton": false
    },
    {
      "fieldTagId": 898451,
      "contractId": 101857,
      "versionId": 101715,
      "templateId": 0,
      "companyId": 12,
      "fieldType": "checkboxfield",
      "documentPageNumber": 1,
      "coordinateXRatio": 0.580851,
      "coordinateYRatio": 0.578947,
      "elementWidthRatio": 0.0212766,
      "elementHeightRatio": 0.0164474,
      "docFieldId": "898451",
      "dependent": false,
      "parentTagId": "",
      "parentTagValueToCompare": "",
      "conditionResult": null,
      "tabOrder": null,
      "cbname": "",
      "description": "",
      "partyResponsible": 28,
      "cbgroup": "",
      "checked": false,
      "oneCbMandatoryInGroup": false,
      "multiCheckGroup": false,
      "displayAsRadioButton": false
    },
    {
      "fieldTagId": 1724179,
      "contractId": 101857,
      "versionId": 101715,
      "templateId": 0,
      "companyId": 12,
      "fieldType": "dropdownfield",
      "documentPageNumber": 1,
      "coordinateXRatio": 0.509028,
      "coordinateYRatio": 0.354372,
      "elementWidthRatio": 0.205761,
      "elementHeightRatio": 0.0206677,
      "docFieldId": "1486624780052513",
      "dependent": false,
      "parentTagId": "",
      "parentTagValueToCompare": "",
      "conditionResult": null,
      "tabOrder": null,
      "dropdownFieldName": "Month",
      "description": "",
      "value": "January",
      "dropdownOptions": "df~||~as~||~aasd sa~||~dsd~||~Option 1~||~~||~January",
      "dropdownNoOfOptions": 0,
      "partyResponsible": 0
    }
  ],
  "allFieldsNameValue": [
    {
      "fieldId": 898441,
      "documentId": 101857,
      "documentVersionId": 101715,
      "fieldType": "textfield",
      "name": "Name of party",
      "value": ""
    },
    {
      "fieldId": 898443,
      "documentId": 101857,
      "documentVersionId": 101715,
      "fieldType": "signfield"
    },
    {
      "fieldId": 898445,
      "documentId": 101857,
      "documentVersionId": 101715,
      "fieldType": "signfield"
    },
    {
      "fieldId": 898447,
      "documentId": 101857,
      "documentVersionId": 101715,
      "fieldType": "datefield",
      "name": "date of contract",
      "value": ""
    },
    {
      "fieldId": 898449,
      "documentId": 101857,
      "documentVersionId": 101715,
      "fieldType": "checkboxfield",
      "name": "",
      "value": "No"
    },
    {
      "fieldId": 898451,
      "documentId": 101857,
      "documentVersionId": 101715,
      "fieldType": "checkboxfield",
      "name": "",
      "value": "No"
    },
    {
      "fieldId": 1724179,
      "documentId": 101857,
      "documentVersionId": 101715,
      "fieldType": "dropdownfield",
      "name": "Month",
      "value": "January"
    }
  ],
  "Folder History": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "johndoe@esigngenie.com",
      "envelopeId": 86377,
      "dateChanged": 1564737942000,
      "changeDoneByParty": 1,
      "action": "Created"
    },
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "johndoe@esigngenie.com",
      "envelopeId": 86377,
      "dateChanged": 1564737997000,
      "changeDoneByParty": 1,
      "action": "InviteSentTo"
    },
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "janedoe@esigngenie.com",
      "envelopeId": 86377,
      "dateChanged": 1564738073000,
      "changeDoneByParty": 28,
      "action": "InviteAccepted"
    },
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "janedoe@esigngenie.com",
      "envelopeId": 86377,
      "dateChanged": 1564738091000,
      "changeDoneByParty": 28,
      "action": "Signed"
    },
    {
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "janedoe@esigngenie.com",
      "envelopeId": 86377,
      "dateChanged": 1564738092000,
      "changeDoneByParty": 1,
      "action": "InviteSentTo"
    }
  ]
}

Sample Code

curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Cache-Control: no-cache" "https://{{HOST_NAME}}/api/folders/myfolder?folderId=179"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/myfolder?folderId=179",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/myfolder?folderId=" + FOLDERID;

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);
            httpWebRequest.Method = "GET";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
                
            }

		int fid= ENTER_YOUR_FOLDER_ID;
		
		URL url= new URL("https://{{HOST_NAME}}.esignenie.com/api/folders/myfolder?folderId="+fid);
		HttpURLConnection con= (HttpURLConnection) url.openConnection();
		con.setDoOutput(true);
		con.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		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();

Get FolderIds By Folder Status and Date

You can poll our API to get the folderIds data

GET /folders/getAllFolderIdsByStatus?status={Folder Status}&dateFrom={Date from}&dateTo={Date To}

Request Parameters

Parameter	Description
status (optional)	Get FolderIds by the folder status. The status parameter can have any of the following values: EXECUTED,SHARED,DRAFT, PARTIALLY SIGNED, CANCELLED, EXPIRED and DELETED. Note: If you don't pass this parameter, then by default, get all type folder status.
dateFrom (required)	Start of the folder Creation Date range. By default set as YYYY-MM-DD
dateTo (required)	End of the folder Creation Date range. By default set as YYYY-MM-DD Note: `dateTo` value should be under the 6 months from `dateFrom` value.

RESPONSE

{
    "result": "success",
    "message": "The total envelope id is: 2",
    "allFolderIds": [
        53940,
        53945
    ]
}

Sample Code

curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Cache-Control: no-cache" "https://{{HOST_NAME}}/api/folders/getAllFolderIdsByStatus?status=SHARED&dateFrom=2021-08-15&dateTo=2021-12-14"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/getAllFolderIdsByStatus?status=SHARED&dateFrom=2021-08-15&dateTo=2021-12-14",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/getAllFolderIdsByStatus?status=SHARED&dateFrom=2021-08-15&dateTo=2021-12-14";

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);
            httpWebRequest.Method = "GET";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
                
            }

		int fid= ENTER_YOUR_FOLDER_ID;
		
		URL url= new URL("https://{{HOST_NAME}}.esignenie.com/api/folders/getAllFolderIdsByStatus?status=SHARED&dateFrom=2021-08-15&dateTo=2021-12-14");
		HttpURLConnection con= (HttpURLConnection) url.openConnection();
		con.setDoOutput(true);
		con.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		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();

Get Activity History

You can poll our API to get the folder history

GET /folders/viewActivityHistory?folderId={FOLDER_ID}

Request Parameters

folderId

Your FOLDER_ID

RESPONSE

{
  "result": "success",
  "details": {
        "folderId": 11111,
        "enclosedDocuments": "eSignGenie Sample",
        "envelopeRecipients": "ABC XYZ",
        "author": "ESG API",
        "status": "SHARED",
        "latestActivityDate": "12 Feb 2021, 11:44:06, IST",
        "dateCreated": "02 Feb 2021, 23:33:50, IST",
        "dateSent": "12 Feb 2021, 11:44:06, IST",
        "activities": [
            {
                "activity": "ESG API created this folder",
                "ipAddress": null,
                "folderStatus": "CREATED",
                "action": "Created",
                "time": "02 Feb 2021, 23:33:50, IST",
                "source": "Web",
                "user": "ESG API"
            },
            {
                "activity": "Invitation sent to ABC XYZ (test@test.com)",
                "ipAddress": null,
                "folderStatus": "SHARED",
                "action": "Invitation Sent",
                "time": "12 Feb 2021, 11:44:06, IST",
                "source": "Web",
                "user": "ABC XYZ"
            },
            {
                "activity": "Invitation accepted by ABC XYZ",
                "ipAddress": null,
                "folderStatus": "SHARED",
                "action": "Opened",
                "time": "12 Feb 2021, 11:46:45, IST",
                "source": "Web",
                "user": "ABC XYZ"
            },
            {
                "activity": "Folder viewed by ESG API (test@test1.com)",
                "ipAddress": null,
                "folderStatus": "SHARED",
                "action": "Viewed",
                "time": "12 Feb 2021, 11:44:07, IST",
                "source": "Web",
                "user": "ESG API"
            },
            {
                "activity": "Folder viewed by ABC XYZ (test@test.com)",
                "ipAddress": null,
                "folderStatus": "SHARED",
                "action": "Viewed",
                "time": "12 Feb 2021, 11:46:45, IST",
                "source": "Web",
                "user": "ABC XYZ"
            },
            {
                "activity": "Folder viewed by ABC XYZ (test@test.com)",
                "ipAddress": null,
                "folderStatus": "SHARED",
                "action": "Viewed",
                "time": "12 Feb 2021, 11:51:03, IST",
                "source": "Web",
                "user": "ABC XYZ"
            },
            {
                "activity": "Folder viewed by ABC XYZ (test@test.com)",
                "ipAddress": null,
                "folderStatus": "SHARED",
                "action": "Viewed",
                "time": "12 Feb 2021, 11:52:01, IST",
                "source": "Web",
                "user": "ABC XYZ"
            },
            {
                "activity": "Folder viewed by ESG API (test@test1.com)",
                "ipAddress": null,
                "folderStatus": "SHARED",
                "action": "Viewed",
                "time": "15 Feb 2021, 14:01:19, IST",
                "source": "Web",
                "user": "ESG API"
            },
            {
                "activity": "Folder viewed by ESG API (test@test1.com)",
                "ipAddress": null,
                "folderStatus": "SHARED",
                "action": "Viewed",
                "time": "15 Feb 2021, 15:08:35, IST",
                "source": "Web",
                "user": "ESG API"
            }
        ]
    }
}

Sample Code

curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Cache-Control: no-cache" "https://{{HOST_NAME}}/api/folders/viewActivityHistory?folderId=11111"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/viewActivityHistory?folderId=11111",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/viewActivityHistory?folderId=" + FOLDERID;

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);
            httpWebRequest.Method = "GET";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
                
            }

		int fid= ENTER_YOUR_FOLDER_ID;
		
		URL url= new URL("https://{{HOST_NAME}}.esignenie.com/api/folders/viewActivityHistory?folderId="+fid);
		HttpURLConnection con= (HttpURLConnection) url.openConnection();
		con.setDoOutput(true);
		con.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		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();

Download All Documents in Folder

You can download executed folder document(s) and signature certificate in a zip file.

GET /folders/download?folderId={FOLDER_ID}

Request Parameters

folderId

Your FOLDER_ID

Response

Returns ZIP file binary stream of all the documents in the folder with the signature certificate

Sample Code

C#
Java

var webAddr = "https://{{HOST_NAME}}/api/folders/download?folderId=" + FOLDER_ID +"&access_token="+ ACCESS_TOKEN;
           
            using (var client = new WebClient())
            {
                client.DownloadFile(webAddr, "FILE_PATH");
            }

		int fid= ENTER_FOLDER_ID;
	    String fileURL = "https://{{HOST_NAME}}/api/folders/download?folderId="+fid;
	    String saveDir = "D:\\";
	            
	    URL url= new URL(fileURL);
		HttpURLConnection httpConn= (HttpURLConnection) url.openConnection();

        List<String> response = new ArrayList<String>();
        
		httpConn.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		
        int responseCode = httpConn.getResponseCode();
       
        if (responseCode == HttpURLConnection.HTTP_OK) {
        	String contentType = httpConn.getContentType();
        	if(contentType.equals("application/json")) {
        		 BufferedReader reader = new BufferedReader(new InputStreamReader(
              		   httpConn.getInputStream()));
                 String line = null;
                 while ((line = reader.readLine()) != null) {
                     response.add(line);
                 }
                 
                 reader.close();
                 httpConn.disconnect();
        	} 
        	
        	else {
				String fileName = "";
                String disposition = httpConn.getHeaderField("Content-Disposition");
                
				int contentLength = httpConn.getContentLength();
     
                if (disposition != null) {
                    // extracts file name from header field
                    int index = disposition.indexOf("filename=");
                    if (index > 0) {
                        fileName = disposition.substring(index + 10,
                                disposition.length() - 1);
                    }
                } else {
                   
                    fileName = fileURL.substring(fileURL.lastIndexOf("/") + 1,
                            fileURL.length());
                }
     
               System.out.println("Content-Type = " + contentType);
                InputStream inputStream = httpConn.getInputStream();
                String saveFilePath = saveDir + File.separator + "abc.zip";
                FileOutputStream outputStream = new FileOutputStream(saveFilePath);
     
                int bytesRead = -1;
                byte[] buffer = new byte[BUFFER_SIZE];
                while ((bytesRead = inputStream.read(buffer)) != -1) {
                    outputStream.write(buffer, 0, bytesRead);
                }
                
                outputStream.close();
                inputStream.close();
                System.out.println("File downloaded");
        	}
     }
        else {
            System.out.println("No file to download. Server replied HTTP code: " + responseCode);
            BufferedReader reader = new BufferedReader(new InputStreamReader(
           		   httpConn.getErrorStream()));
              String line1 = null;
              while ((line1 = reader.readLine()) != null) {
                  response.add(line1);
              }
              
              reader.close();
              httpConn.disconnect();
              
        }

Download a Document

You can download the individual document as a pdf file.

GET /folders/document/download?folderId={FOLDER_ID}&docNumber={DOC_NUMBER}

Request Parameters

folderId	Your FOLDER_ID
docNumber	The document index starts from 1, whose PDF you want to download.

Response

Returns PDF file binary stream of the document, which you can save as a PDF file.

Sample Code

C#
Java

var webAddr = "https://{{HOST_NAME}}/api/folders/document/download?folderId=" + FOLDER_ID + "&docNumber=1&access_token=" + ACCESS_TOKEN;

            using (var client = new WebClient())
            {
                client.DownloadFile(webAddr,"FILE_PATH");
            }

		int fid= ENTER_FOLDER_ID;
	        String fileURL = "https://{{HOST_NAME}}/api/folders/document/download?folderId="+fid+"&docNumber=1";
	        
	        String saveDir = "D:\\test\\";
	      URL url= new URL(fileURL);
		HttpURLConnection httpConn= (HttpURLConnection) url.openConnection();

        List<String> response = new ArrayList<String>();
        
		httpConn.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		
        int responseCode = httpConn.getResponseCode();
        if (responseCode == HttpURLConnection.HTTP_OK) {
        	String contentType = httpConn.getContentType();
        	if(contentType.equals("application/json")) {
        		 BufferedReader reader = new BufferedReader(new InputStreamReader(
              		   httpConn.getInputStream()));
                 String line = null;
                 while ((line = reader.readLine()) != null) {
                     response.add(line);
                 }
                 
                 reader.close();
                 httpConn.disconnect();
        	} 
        	
        	else {
				String fileName = "";
                String disposition = httpConn.getHeaderField("Content-Disposition");
                
				int contentLength = httpConn.getContentLength();
     
                if (disposition != null) {
                    // extracts file name from header field
                    int index = disposition.indexOf("filename=");
                    if (index > 0) {
                        fileName = disposition.substring(index + 10,
                                disposition.length() - 1);
                    }
                } else {
                    // extracts file name from URL
                    fileName = fileURL.substring(fileURL.lastIndexOf("/") + 1,
                            fileURL.length());
                }
     
               System.out.println("Content-Type = " + contentType);
             
     
                // opens input stream from the HTTP connection
                InputStream inputStream = httpConn.getInputStream();
                String saveFilePath = saveDir + File.separator + "abc1.pdf";//fileName;
                 
                // opens an output stream to save into file
                FileOutputStream outputStream = new FileOutputStream(saveFilePath);
     
                int bytesRead = -1;
                byte[] buffer = new byte[BUFFER_SIZE];
                while ((bytesRead = inputStream.read(buffer)) != -1) {
                    outputStream.write(buffer, 0, bytesRead);
                }
                
                outputStream.close();
                inputStream.close();
                System.out.println("File downloaded");
        	}
            
        }
        
        else {
            System.out.println("No file to download. Server replied HTTP code: " + responseCode);
            BufferedReader reader = new BufferedReader(new InputStreamReader(
           		   httpConn.getErrorStream()));
              String line = null;
              while ((line = reader.readLine()) != null) {
                  response.add(line);
              }
              
              reader.close();
              httpConn.disconnect();
        }

Move your document(s) folders to recycle bin

Using Foxit eSign API, you can move your document(s) folders to recycle bin. Documents in recycle bin are permanently removed from Foxit eSign systems automatically after 14 days.

POST /folders/movetorecyclebin
Content-Type application/json

REQUEST

{
	"folderIds":[219]
}

Parameter	Description
folderIds	An array of folder IDs that you want to move to recycle bin

RESPONSE

{
	"result":"success"
}

Code Samples

curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
    "folderIds":[219]
}' "https://{{HOST_NAME}}/api/folders/movetorecyclebin"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/movetorecyclebin",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{
  	"folderIds":[219]
}',
  
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/movetorecyclebin";

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);

            httpWebRequest.ContentType = "application/json; charset=utf-8";
            httpWebRequest.Method = "POST";
           
            httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = @"{""folderIds"":["+ FOLDERIDSTODELETE+ "]}";
                streamWriter.Write(json);
                streamWriter.Flush();
            }

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
                
            }

			String apiURL = "https://{{HOST_NAME}}/api/folders/movetorecyclebin/";
		    URL url= new URL(apiURL);
			HttpURLConnection httpConn= (HttpURLConnection) url.openConnection();
			httpConn.setDoOutput(true);
			httpConn.setRequestProperty("Content-Type", "application/json");
			httpConn.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		
			String urlParameters="{\"folderIds\":[FOLDER_ID_1,FOLDER_ID_2]}";
		
			DataOutputStream wr = new DataOutputStream(httpConn.getOutputStream());
			wr.writeBytes(urlParameters);
			
			   if (httpConn.getResponseCode() != HttpURLConnection.HTTP_OK) {
		            throw new RuntimeException("Failed : HTTP error code : "+ httpConn.getResponseCode());
		        }
		        BufferedReader br = new BufferedReader(new InputStreamReader(
		                (httpConn.getInputStream())));
		        String output;
		        System.out.println("Output from Server .... \n");
		        while ((output = br.readLine()) != null) {
		            System.out.println(output);
		        }
		        
		        httpConn.disconnect();

Delete your Document(s) from Foxit eSign

Using Foxit eSign API, you can permanently remove your document(s) folders from Foxit eSign systems.

POST /folders/delete
Content-Type application/json

REQUEST

{
	"folderIds":[219]
}

Parameter	Description
folderIds	An array of folder IDs that you want to delete permanently.

RESPONSE

{
	"result":"success"
}

Code Samples

curl -X POST -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
    "folderIds":[219]
}' "https://{{HOST_NAME}}/api/folders/delete"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/delete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '{
  	"folderIds":[219]
}',
  
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/delete";

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);

            httpWebRequest.ContentType = "application/json; charset=utf-8";
            httpWebRequest.Method = "POST";
           
            httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = @"{""folderIds"":["+ FOLDERIDSTODELETE+ "]}";
                streamWriter.Write(json);
                streamWriter.Flush();
            }

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
                
            }

			String apiURL = "https://{{HOST_NAME}}/api/folders/delete/";
		    URL url= new URL(apiURL);
			HttpURLConnection httpConn= (HttpURLConnection) url.openConnection();
			httpConn.setDoOutput(true);
			httpConn.setRequestProperty("Content-Type", "application/json");
			httpConn.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		
			String urlParameters="{\"folderIds\":[FOLDER_ID_1,FOLDER_ID_2]}";
		
			DataOutputStream wr = new DataOutputStream(httpConn.getOutputStream());
			wr.writeBytes(urlParameters);
			
			   if (httpConn.getResponseCode() != HttpURLConnection.HTTP_OK) {
		            throw new RuntimeException("Failed : HTTP error code : "+ httpConn.getResponseCode());
		        }
		        BufferedReader br = new BufferedReader(new InputStreamReader(
		                (httpConn.getInputStream())));
		        String output;
		        System.out.println("Output from Server .... \n");
		        while ((output = br.readLine()) != null) {
		            System.out.println(output);
		        }
		        
		        httpConn.disconnect();

Get Deleted Folder History

You can poll our API to get the deleted folder history

GET folders/deletedLog?folderId={FOLDER_ID}

Request Parameters

folderId

Your FOLDER_ID

RESPONSE

{
    "result": "success",
    "Deleted Folder Log Info": [
        {
            "folderName": "dummy",
            "documentName": "dummy",
            "folderId": 61697,
            "documentId": "62420",
            "deletionDate": 1613713332000,
            "deletedBy": "Dhananjay Vermaw"
        }
    ],
    "Deleted Folder Log History": [
        {
            "partiesName": "Dhananjay Vermaw",
            "source": "API",
            "event": "Delete All Parties From Folder"
        },
        {
            "partiesName": "Dhananjay Vermaw",
            "source": "API",
            "event": "Delete All Invitation"
        },
        {
            "partiesName": "Dhananjay Vermaw",
            "source": "API",
            "event": "Delete All Folder Contracts"
        },
        {
            "partiesName": "Dhananjay Vermaw",
            "source": "API",
            "event": "Removing Signature Certificate"
        },
        {
            "partiesName": "Dhananjay Vermaw",
            "source": "API",
            "event": "Delete All Folder History"
        },
        {
            "partiesName": "Dhananjay Vermaw",
            "source": "API",
            "event": "Delete Folder"
        }
    ]
}

Sample Code

curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Cache-Control: no-cache" "https://{{HOST_NAME}}/api/folders/deletedLog?folderId=61692"

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/folders/deletedLog?folderId=61692",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/folders/deletedLog?folderId=" + FOLDERID;

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);
            httpWebRequest.Method = "GET";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
                
            }

	int fid= ENTER_YOUR_FOLDER_ID;
		
		URL url= new URL("https://{{HOST_NAME}}.esignenie.com/api/folders/deletedLog?folderId="+fid);
		HttpURLConnection con= (HttpURLConnection) url.openConnection();
		con.setDoOutput(true);
		con.setRequestProperty("Authorization","Bearer ACCESS_TOKEN");
		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();

Templates API

Create a template from PDF file

With Foxit eSign API, you can create a template by uploading a PDF document from your own application. To create a template from a PDF file, you can either provide publicly accessible URLs to PDF documents or pass PDF documents as multipart form data with the number of recipient parties, etc.

While creating the template from a PDF file, you can define various fields like a text field or signature field within the PDF document using simple Text Tags. You can assign various properties for these fields, like the party responsible for filling the data etc. These Text Tags will then be converted to Foxit eSign template fillable fields.
Or, if you don't want to use predefined Text Fields within the PDF document, then you can also request to create an embedded template preparation session where you can manually drag and drop each field on the template itself without leaving your application.

Preparing PDF documents with text tags to upload as a template

To create a PDF document from your application to create a template, you need to define the signature and other Foxit eSign fields in the documents, and who is allowed to fill in the data. Foxit eSign supports simple Text Tags.

Field Type: One of 'textfield', 'signfield', 'initialfield', 'datefield', 'checkboxfield', 'attachmentfield', 'imagefield', 'accept', 'decline' or short notations.
Party Number (optional): the sequence number of the recipient party from the parties list which will be responsible for filling this field.
Note: The values of the party number should be less than 20. and add the total parties in your template, which is the maximum party number value in all Text Tag.
Required/Optional Field: 'y' makes the field mandatory to be filled before signing while 'n' makes it optional.
Field Name: Optional. Assign a name to this field. Assigning names to fields is a good practice for better productivity as named fields are downloaded in the document form the data report and all the same named fields in a document will automatically take up the value typed once in any one of those fields. Please note not to include any space character for the name of the field (or anywhere else in the Text Tag) as it will then not recognize that word as a proper Text Tag syntax, instead you can use underscore which will then be replaced with a space character in the final Foxit eSign field.
Underscores: Optional. A way to increase the field's width.

There are other options that you can add before underscores for various other properties as follows:

Sizing

By default, the new field has the same width and height as the original text tag, however it can be overridden by adding custom width as 90 and height as 20 (in pixels):

${textfield:1:y:field_name:90:20}

Validation

You also can validate information for text fields inside the tags. For example, the max number of characters required are 12 and only Numbers:

${textfield:1:y:field_name:90:20:12:Numbers}

And if you want to stick to the default height and width for the new field (which is the height and width of the text tag)

${textfield:1:y:field_name:::12:Numbers}

NOTE: validation inputs are currently only available for textfields

Font Style

You can also control the font style for each new field via their text tags. For example, the following tag creates a textfield with 14 font size and gray as the font color

${textfield:1:y:field_name:90:20:12:Numbers:14:gray}

Pre-Filled Value

You can pass pre-filled value to the textfields via its text tags as shown below. Please make to replace any space character with '_' (underscore) else the system may not recognize that text tag.

${textfield:1:y:field_name:90:20:12:Numbers:14:gray:default_value}

NOTE: pre-filled values are currently only available for textfields

Mark as Dependent Field

You can make a field dependent on any other field value. To set a field dependent on another field, select the values of the independent field that will enable the signer to see the dependent field.

${t:1:y:field_name:90:20:12:Numbers:14:gray:default_value:parent_field_name:value_of_parent_field:options}

Column	Description
parent_field_name	Name of the parent field. NOTE: Only the following type of fields are allowed as the parent or independent field: `textfields\|textbox\|checkbox\|radiobutton\|dropdown`
value_of_parent_field	Value of the parent field. NOTE: In the case of radio button and checkbox, the value can be either `checked` or `unchecked`
options (optional)	In the case of textfield, the value can be either `isblank` or `allowNull` or `contains`

The full list of Field Types is:

TextField - textfield or t (short notation)
TextBox - textboxfield or tb (short notation)
FormulaField - formulafield or ff
Signature - signfield or s
Initial - initialfield or i
Date - datefield or d
Checkbox - checkboxfield or c (recommended)
Radio Button - radiobuttonfield or rb (recommended)
Secured Field - securedfield or sc
Attachment Field - attachmentfield or a
Image Field - imagefield or img
Signer Name Field - textfield or t
Date Signed - datefield or d
Accept Button - accept or ab
Decline Button - decline or db
PayField - payfield or pf

Examples

${textfield:1:y:client_name:________} - A mandatory textfield which is assigned to party number 1 with field name as 'client name'.
${tb:1:n:________________} - An optional textbox assinged to party 1.
${signfield:1:y:____} - A mandatory signature field assigned to party number 1.
${i:2:n} - An optional initial field assigned to party number 2.
${datefield:2:n::____} - An optional date field assigned to party number 2 with empty field name.
${c:2:y:male:gender:::multicheck} - A checkbox assigned to party number 2 with initial value as checked with name 'male' and group 'gender' with multiple check option enable to same group checkbox.
${c:1:y:yes:group-y} - A checkbox assigned to party number 1 with initial value as checked with name 'yes' and group 'group'. 'group-y' means group mandatory.
${rb:1:n:yes:grp1} - An un-selected radio button assigned to party 1 with the name yes and grp 'grp1'.
${rb:1:y:no:group2-y} - A radio button assigned to party number 1 with initial value as checked with the name 'no' and group 'group2'. 'group2-y' means group mandatory.
${sc:2:n:Credit_Card_Number:4:____} - A secured field assigned to party 2, which is optional with the name 'Credit Card Number' and only the last 4 characters to remain unmasked.
${attachmentfield:1:y:____} - A mandatory attachment field assigned to party number 1.
${img:1:n:stamp_image:120:50:__} - An optional image field is field name 'stamp image' with 120-pixel width and 50-pixels height, assigned to party number 1.
${textfield:1:y:Signer_Name:________} - A mandatory signer name field which is assigned to party number 1 with field name as 'Signer_Name'. This field is auto-populated once the document is opened by the signer.
${datefield:1:y:Date_Signed:_______} - A mandatory date signed field assigned to party number 1 with field name as 'Date_Signed'. This field will auto populate once the document is opened by the signer.
${accept:1:90:20} - A accept button field with 90-pixel width and 20-pixel height assigned to party number 1.
${decline:1:90:20} - A decline button field with 90-pixel width and 20-pixel height assigned to party number 1.
${payfield:1:paymentType:payeeOptions:productAndService:paymentDescription:paymentAmount} - Tag consolidates Payment Type, Product/Service, Payment Description, and Payment Amount to utilize the payment field.

Personalized Fields:We can use the personalized field tag while sending it via API in place of process tags. Personalized field creation instructions can be seen in the help center.

Examples

${field_7:1}Using this format, you can simply use the existing personalized field name and properties assigned to party #1.
${field_15:1:y:field_name:90:20} Using this format, you can simply use the existing personalized field name

Here is a PDF file with some other Text Tag samples: Sample Document.

Preparing PDF documents with Recipient Party Tags

Tag Type: Accepts only value as rp, which is an identifier of recipient party tags.
Party First Name: First name of the recipient party.
Party Last Name: Last name of the recipient party.
Party email: Email of the recipient party.
Party permission: Use this field to assign folder permissions to a recipient. It can be any one of the following values: FILL_FIELDS_AND_SIGN, FILL_FIELDS_ONLY, SIGN_ONLY, VIEW_ONLY
Party workflow sequence: If the document is signed in sequence, the recipient party will receive the notification as per the workflow sequence number. It should be starting with 1 like 1,2,3,4, etc.
Party sequence: Assign a sequence number to a recipient in the list of recipient parties. Use unique sequence numbers or party numbers for each party, starting with 1 like 1,2,3,4, etc.

Adding Fields on Template via API

Fields can also be added on the templates via an array of JSON objects in the input data for the API request. This way of adding fields gives you more control over the size of fields, their font color and font size, etc.

While adding the fields on each document page, the position of the fields is relative to the top left corner of that page.

Each field object must contain the following values:
NOTE: If one of these values is missing field may disappear.

type - (string) the type of field to be added at this place. Can be one of these values: text|signature|initial|textbox|date|secure|checkbox|radiobutton|dropdown|attachment|image|accept|decline
x - (int) the x location coordinate of the top left corner of the field in pixels
y - (int) the y location coordinate of the top left corner of the field in pixels
width - (int) the width of the field in pixel
height - (int) the height of the field in pixel
pageNumber - (int) page in the document where field needs to be added

There are other parameters which can be optional and different for different field types.

text or textbox type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
value - (string)
required - (boolean) value: either true or false
textAlignment - (string) value: left, center, or right
characterLimit - (int)
fontSize - (int)
fontColor (string) example: #0000FF for blue
validation (string) value: anyone from None(default) or Numbers or Letters or RegexValidation(in case of text type) or CanadianSin(Canadian SIN Number)
if the validation value is RegexValidation
- customValidationType (string) value: anyone from Error(default) or Warning.
- customValidationValue - (URLEncoded UTF-8 Javascript Regular Expression only)
- customValidationMsg - (string)
hideFieldNameForRecipients - (boolean) value: either true or false

formulafield type

party - (int) party index from the parties submitted in this request starting from 1
formulafieldName - (string)
formula - (string)
fontFamily - (string)
documentNumber - (int)
fontSize - (int)
fontColor (string) example: #0000FF for blue
x - (int) the x location coordinate of the top left corner of the field in pixels
y - (int) the y location coordinate of the top left corner of the field in pixels
width - (int) the width of the field in pixel
height - (int) the height of the field in pixel
pageNumber - (int) page in the document where field needs to be added
tabOrder - (int)
decimalPlaces - (int)

payfield type

payeeOptions - (string) Specify payment methods for the payee to choose from any of the following options:["CardPayment"] or ["AchBankPayment"] or ["CardPayment", "AchBankPayment"]
paymentType - (string) Determines payment amount type: "Fixed" or "Payee decides". Note: "Payee_decides" in case of text tag.
paymentAmount - (string) Required for 'Fixed' payment type, must be an integer or have up to two decimal places
paymentDescription - (string) Description of the payment (Character limit: 250)
productAndService (string) Name of the product or service (Character limit: 75)
documentNumber - (int)
pageNumber - (int) page in the document where field needs to be added
x - (int) the x location coordinate of the top left corner of the field in pixels
y - (int) the y location coordinate of the top left corner of the field in pixels
tabOrder - (int)
width - (int) the width of the field in pixel
height - (int) the height of the field in pixel
party - (int) party index from the parties submitted in this request starting from 1

Note:

signature or initial type

party - (int)
required - (boolean) value: either true or false

date type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
value - (string)
required - (boolean) value: either true or false
textAlignment - (string) value: left, center, or right
fontSize - (int)
fontColor (string) example: #0000FF for blue
dateFormat (string) example: MM-DD-YYYY for 01-31-2017
hideFieldNameForRecipients - (boolean) value: either true or false

secure type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
value - (string)
required - (boolean) value: either true or false
fontSize - (int)
fontColor (string) example: #0000FF for blue
charToDisplay (int)
hideFieldNameForRecipients - (boolean) value: either true or false

checkbox type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
group - (string)
required - (boolean) value: either true or false
multicheck - (boolean) value: either true or false
hideCheckboxBorder - (boolean) value: either true or false

dropdown type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
value - (string)
required - (boolean) value: either true or false
fontSize - (int)
fontColor (string) example: #0000FF for blue
options (array of strings)
hideFieldNameForRecipients - (boolean) value: either true or false

attachment type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
required - (boolean) value: either true or false
hideFieldNameForRecipients - (boolean) value: either true or false

image type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
required - (boolean) value: either true or false

signer name type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
required - (boolean) value: either true or false
fontSize - (int)
fontColor (string) example: #0000FF for blue
readOnly - (boolean) value: either true or false
systemField - (boolean) value: either true or false

date signed type

party - (int) party index from the parties submitted in this request starting from 1
name - (string)
tooltip - (string)
required - (boolean) value: either true or false
textAlignment - (string) value: left, center, or right
fontSize - (int)
fontColor (string) example: #0000FF for blue
dateFormat (string) example: MM-DD-YYYY for 04-30-2019
readOnly - (boolean) value: either true or false
systemField - (boolean) value: either true or false

accept or decline type

party - (int)

Creating the template

To create a template from PDF files, you must call /templates/createtemplate with the given parameters.

1. When using file URLs

POST /templates/createtemplate
Content-Type application/json

REQUEST

{
	"templateUrl":"URL_TO_DOCUMENT",
	"templateName":"template.pdf",
	"processTextTags":true,
	"processAcroFields":true,
	"numberOfParties":2,
	"themeColor":"#f4e542",
	"createEmbeddedTemplateSession":true,
 	"shareAll":true,
 	"authorEmail":"author@example.com",
	"redirectURL":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":50,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"optional name",
			"tooltip":"",
			"value":"optional value",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"

		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                       "type":"formulafield",
                       "formulafieldName":"Formula_Field_Name",
                       "formula":"[n1] + [n2]",
                       "fontSize":8,
                       "fontFamily":"default",
                       "fontColor":"#000000",
                       "documentNumber":1,
                       "pageNumber":1,
                       "x":100,
                       "y":280,
                       "tabOrder":1,
                       "width":50,
                       "height":100,
                       "party": 1,
                       "decimalPlaces": 2
                },
		{
			"type":"text",
			"x":552,
			"y":150,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"RegexValidation",
   			"customValidationType":"Warning",
   			"customValidationValue":"%2F%28%3F%3A%5Cd%7B3%7D%7C%5C%28%5Cd%7B3%7D%5C%29%29%28%5B-%5C%2F%5C.%5D%29%5Cd%7B3%7D%5C1%5Cd%7B4%7D%2F",
   			"customValidationMsg":"Phone Number Validation"
   			"hideFieldNameForRecipients":false
		},
		{
			"type":"signature",
			"x":200,
			"y":150,
			"width":100,
			"height":50,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"dropdown",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"pageNumber":1,
			"party":1,
			"value":"US",
			"options":["UK","Canada","Australia","US","France"]
		},
		{
			"type":"attachment",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"party":1,
			"required":true,
			"name":"optional name"
			
		},
		{
			"type":"text",
			"textfieldName": "Signer Name",
			"x":300,
			"y":250,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"Signer Name",
			"characterLimit":100,
		 	"partyResponsible": 1,
			"required": true,
			"fontSize": 12,
			"fontFamily": "default",
			"fontColor": "#000000",
			"readOnly": true,
			"systemField": true
		},
		{
			"type":"accept",
			"party":1,
			"pageNumber":1,
			"x":350,
			"y":505,
			"width":90,
			"height":20
		},
		{
			"type":"decline",
			"party":1,
			"pageNumber":1,
			"x":420,
			"y":505,
			"width":90,
			"height":20
		},		
		{
			"type": "date",
			"x":220,
			"y":150,
			"width":60,
			"height":20,
			"documentNumber":1,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"Date Signed",
			"required":true,
			"fontSize":12,
			"dateFormat": "MM-DD-YYYY",
			"readOnly": true,
			"systemField": true
		}
		],
		"parties":[
		{
			"permission":"FILL_FIELDS_AND_SIGN",
			"sequence":1,
			"partyRole":"PARTY_ROLE"
		},
		....
	]
	
}

Parameter Description

templateName (required) Name of the document(s) template

inputType (optional)
Default url Value can be either url or base64

templateUrl (required if inputType is url) URL to the PDF template you are creating. It should be publicly accessible when you are creating the template.

base64FileString
(required if inputType is base64) An array of BASE64 to PDF templates you are creating. It should be publicly accessible when you are creating the template.

processTextTags (optional) Value can be either true or false
Use this field to determine whether Foxit eSign should parse your documents for Text Tags to convert them into Foxit eSign fields.

processAcroFields (optional) Value can be either true or false
Use this field to determine whether Foxit eSign should parse your documents for AcroFields to convert them into Foxit eSign fields.

numberOfParties (required) Add the number of parties in your template.
Note: The values of this parameter should be less than 20.

parties

A list of parties you're adding to the template. Every entry must contain sequence field.

permission (optional)	Use this field to assign template permissions to a party. Can be any one of the following values: FILL_FIELDS_AND_SIGN, FILL_FIELDS_ONLY, SIGN_ONLY, VIEW_ONLY
partyRole (optional)	Use this field to assign a role of the party.
sequence	Use this field to assign a sequence number to a party. Use unique sequence numbers for each party starting with 1 like 1,2,3,4....

shareAll (required)
Default false Value can be either true or false
Share this template with all users in your account.

authorEmail (optional) You can enter the email of another user in your account which will be used as the author for this template.

themeColor (optional)
(required if createEmbeddedTemplateSession is true) You can enter a css value for a color to match your website's look n feel when you embed Foxit eSign inside. The top blue band of the embedded screen is then replaced with the color provided by you.

createEmbeddedTemplateSession
Default false Value can be either true or false
If true then an embedded token will be generated in the response, for an embedded template session, where you can directly open the Foxit eSign template, preparing a view in your application for dragging and dropping various fields on your template.

redirectURL (optional)
(required if createEmbeddedTemplateSession is true) Enter the absolute URL for the landing page on your website/application, which the user will be redirected to after clicking "save and close" in the embedded template view.

fixRecipientParties (optional, default=false) Value can be either true or false
If true, then in the embedded template view, you won't be able to change the parties for the template, which are already added as a part of this API request.
Else if false, you will be able to change the parties in the embedded template view.

fields (optional) A list of different fields to be added to the template.

hideMoreAction (optional, default=false) If true, it will hide the "More Actions" button in the template session.

hideShareWithAll (optional, default=false) If true, it will hide the "Share with All" option in the template session.

hideAddParty (optional, default=false) If true, it will hide all add party's options in an embedded template session.

hideMeButton (optional, default=false) If true, it will hide the "Me" button on Recipient Parties in an embedded template session.

hideOthersButton (optional, default=false) If true, it will hide the "Others" button on Recipient Parties in an embedded template session.

hideExistingContactSelectOption (optional, default=false) If true, it will hide the "Find and Add Existing Contact" input box on Recipient Parties in an embedded template session.

hideCheckboxBorder (optional, default=false) Value can be either true or false
Borders of Checkbox will be hidden in the executed documents.

RESPONSE

{

    "embeddedToken": "EMBEDDED_TOKEN",
    "embeddedTemplateSessionURL": "UNIQUE_EMBEDDED_SESSION_URL",
    "template": {
        "templateId": 174,
        "templateName": "testTemplate",
        "templateDesc": null,
        "templateType": null,
        "templateCreationDate": null,
        "templateLastUpdateDate": null,
        "editable": false,
        "numberOfParties": 1,
        "totalPages": 0,
        "companyId": 50,
        "templateCreatedBy": {
            "partyId": 3062,
            "firstName": "Govind",
            "lastName": "Bhandari",
            "emailId": "gbhandari@esigngenie.com",
            "address": "",
            "dateCreated": 1503527343000,
            "optOutEmails": false,
            "companyId": 50,
            "userRole": "super_admin",
            "userAddedDate": 1504550757000,
            "department": "",
            "title": "",
            "active": true,
            "requestLocale": "en",
            "share_among_department": false,
            "managerId": null
        },
        "templateLastUpdatedBy": {
            "partyId": 3062,
            "firstName": "Govind",
            "lastName": "Bhandari",
            "emailId": "gbhandari@esigngenie.com",
            "address": "",
            "dateCreated": 1503527343000,
            "optOutEmails": false,
            "companyId": 50,
            "userRole": "super_admin",
            "userAddedDate": 1504550757000,
            "department": "",
            "title": "",
            "active": true,
            "requestLocale": "en",
            "share_among_department": false,
            "managerId": null
        },
        "shareAll": false,
        "templateCustomName": ""
    },
    "result": "success",
    "message": "template successfully created"
}

Sample Code (creating a template from file URL)

echo '{
	"templateUrl":"URL_TO_DOCUMENT",
	"templateName":"template.pdf",
	"processTextTags":true,
	"processAcroFields":true,
	"numberOfParties":2,
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":50,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"optional name",
			"tooltip":"",
			"value":"optional value",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"

		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                        "type":"formulafield",
                        "formulafieldName":"Formula_Field_Name",
                        "formula":"[n1] + [n2]",
                        "fontSize":8,
                        "fontFamily":"default",
                        "fontColor":"#000000",
                        "documentNumber":1,
                        "pageNumber":1,
                        "x":100,
                        "y":280,
                        "tabOrder":1,
                        "width":50,
                        "height":100,
                        "party": 1,
                        "decimalPlaces": 2
                },
		{
			"type":"text",
			"x":552,
			"y":150,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers"
		},
		{
			"type":"signature",
			"x":200,
			"y":150,
			"width":100,
			"height":50,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"dropdown",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"pageNumber":1,
			"party":1,
			"value":"US",
			"options":["UK","Canada","Australia","US","France"]
		}
		]
	
}' | curl https://{{HOST_NAME}}/api/templates/createtemplate \
-i \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json;charset=UTF-8" \
-d @- \
-X POST

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/templates/createtemplate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>  '{
	"templateUrl":"URL_TO_DOCUMENT",
	"templateName":"template.pdf",
	"processTextTags":true,
	"processAcroFields":true,
	"numberOfParties":2,
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":50,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"optional name",
			"tooltip":"",
			"value":"optional value",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"

		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                        "type":"formulafield",
                        "formulafieldName":"Formula_Field_Name",
                        "formula":"[n1] * [n2]",
                        "fontSize":8,
                        "fontFamily":"default",
                        "fontColor":"#000000",
                        "documentNumber":1,
                        "pageNumber":1,
                        "x":100,
                        "y":280,
                        "tabOrder":1,
                        "width":50,
                        "height":100,
                        "party": 1,
                        "decimalPlaces": 2
                },
		{
			"type":"text",
			"x":552,
			"y":150,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers"
		},
		{
			"type":"signature",
			"x":200,
			"y":150,
			"width":100,
			"height":50,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"dropdown",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"pageNumber":1,
			"party":1,
			"value":"US",
			"options":["UK","Canada","Australia","US","France"]
		}
		]
	
}',
  
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

var webAddr = "https://{{HOST_NAME}}/api/templates/createtemplate";
var httpWebRequest = (HttpWebRequest)WebRequest.Create(webAddr);
httpWebRequest.ContentType = "application/json; charset=utf-8";
httpWebRequest.Method = "POST";
httpWebRequest.Headers.Add("Authorization", "Bearer " + ACCESS_TOKEN);

using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                string json = @"{
	""templateUrl"":""URL_TO_DOCUMENT"",
	""templateName"":""template.pdf"",
	""processTextTags"":true,
	""processAcroFields"":true,
	""numberOfParties"":2,
	   ""fields"":[
		{
			""type"":""text"",
			""x"":100,
			""y"":50,
			""width"":60,
			""height"":20,
			""pageNumber"":1,
			""tabOrder"":1,
			""party"":1,
			""name"":""optional name"",
			""tooltip"":"""",
			""value"":""optional value"",
			""required"":true,
			""characterLimit"":100,
			""fontSize"":12,
			""fontColor"":""#000000"",
			""validation"":""Letters""

		},
		{
			""type"":""text"",
			""x"":552,
			""y"":150,
			""width"":60,
			""height"":20,
			""pageNumber"":1,
			""tabOrder"":1,
			""party"":1,
			""fontSize"":8,
			""fontColor"":""#eee"",
			""validation"":""Numbers""
		},
		{
                        ""type"":""formulafield"",
                        ""formulafieldName"":""Formula_Field_Name"",
                        ""formula"":""[n1] + [n2]"",
                        ""fontSize"":8,
                        ""fontFamily"":""default"",
                        ""fontColor"":""#000000"",
                        ""documentNumber"":1,
                        ""pageNumber"":1,
                        ""x"":100,
                        ""y"":280,
                        ""tabOrder"":1,
                        ""width"":50,
                        ""height"":100,
                        ""party"": 1,
                        ""decimalPlaces"": 2
                },
		{
			""type"":""signature"",
			""x"":200,
			""y"":150,
			""width"":100,
			""height"":50,
			""pageNumber"":1,
			""party"":1
		},
		{
			""type"":""dropdown"",
			""x"":200,
			""y"":250,
			""width"":80,
			""height"":20,
			""pageNumber"":1,
			""party"":1,
			""value"":""US"",
			""options"":[""UK"",""Canada"",""Australia"",""US"",""France""]
		}
		]
}";
                streamWriter.Write(json);
                streamWriter.Flush();
            }

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var result = streamReader.ReadToEnd();
            }

		URL url= new URL("https://{{HOST_NAME}}/api/templates/createtemplate");
		HttpURLConnection con= (HttpURLConnection) url.openConnection();
		con.setDoOutput(true);
		try {
			con.setRequestMethod("POST");
			
		} catch (ProtocolException e) {
			e.printStackTrace();
		}
		con.setRequestProperty("Authorization", "Bearer ACCESS_TOKEN");
		con.setRequestProperty("Content-Type", "application/json");
		String input="{"
				+ "\"templateUrl\":\"URL_TO_DOCUMENT\","
				+ "\"templateName\":\"template.pdf\","
				+ "\"processTextTags\":true,"
				+ "\"processAcroFields\":true,"
				+ "\"numberOfParties\":2,"
				+ "}";	

		OutputStream os = con.getOutputStream();
		os.write(input.getBytes());
		os.flush();
		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();

You can also pass PDF documents as multipart form data instead of passing a publicly accessible URL. In this case, pass the JSON as 'data' parameter and include the file as a multipart form parameter 'file'. Make sure you use multipart/form-data as a content type for this call.

Sample Code (creating a template from multipart form data)

curl https://{{HOST_NAME}}/api/templates/createtemplate \
-i \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: multipart/form-data;charset=UTF-8" \
-F data='
 '{
	"templateName":"template.pdf",
	"processTextTags":true,
	"processAcroFields":true,
	"numberOfParties":2,
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":50,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"optional name",
			"tooltip":"",
			"value":"optional value",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"

		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                        "type":"formulafield",
                        "formulafieldName":"Formula_Field_Name",
                        "formula":"[n1] + [n2]",
                        "fontSize":8,
                        "fontFamily":"default",
                        "fontColor":"#000000",
                        "documentNumber":1,
                        "pageNumber":1,
                        "x":100,
                        "y":280,
                        "tabOrder":1,
                        "width":50,
                        "height":100,
                        "party": 1,
                        "decimalPlaces": 2
                },
		{
			"type":"text",
			"x":552,
			"y":150,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers"
		},
		{
			"type":"signature",
			"x":200,
			"y":150,
			"width":100,
			"height":50,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"dropdown",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"pageNumber":1,
			"party":1,
			"value":"US",
			"options":["UK","Canada","Australia","US","France"]
		}
		]
	
} \
-F file=@FILE_1_TO_UPLOAD \
-X POST

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://{{HOST_NAME}}/api/templates/createtemplate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => '
-----011000010111000001101001
Content-Disposition: form-data; name="file"; filename="file1.pdf"
Content-Type: application/octet-stream

'.file_get_contents('/path/to/your/file1').'
-----011000010111000001101001
 Content-Disposition: form-data; name="data"

 '{
	"templateName":"template.pdf",
	"processTextTags":true,
	"processAcroFields":true,
	"numberOfParties":2,
	"fields":[
		{
			"type":"text",
			"x":100,
			"y":50,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"name":"optional name",
			"tooltip":"",
			"value":"optional value",
			"required":true,
			"characterLimit":100,
			"fontSize":12,
			"fontColor":"#000000",
			"validation":"Letters"

		},{
			"type":"image",
			"name":"Image_Field_Name",
			"tooltip":"Image_Field_Description",
			"party":1,
			"required":false,		   
			"tabOrder":1,
			"width":220,
			"height":150,
			"x":350,
			"y":350,
			"documentNumber":1,
			"pageNumber":1		   
		},
		{
                        "type":"formulafield",
                        "formulafieldName":"Formula_Field_Name",
                        "formula":"[n1] + [n2]",
                        "fontSize":8,
                        "fontFamily":"default",
                        "fontColor":"#000000",
                        "documentNumber":1,
                        "pageNumber":1,
                        "x":100,
                        "y":280,
                        "tabOrder":1,
                        "width":50,
                        "height":100,
                        "party": 1,
                        "decimalPlaces": 2
                },
		{
			"type":"text",
			"x":552,
			"y":150,
			"width":60,
			"height":20,
			"pageNumber":1,
			"tabOrder":1,
			"party":1,
			"fontSize":8,
			"fontColor":"#eee",
			"validation":"Numbers"
		},
		{
			"type":"signature",
			"x":200,
			"y":150,
			"width":100,
			"height":50,
			"pageNumber":1,
			"party":1
		},
		{
			"type":"dropdown",
			"x":200,
			"y":250,
			"width":80,
			"height":20,
			"pageNumber":1,
			"party":1,
			"value":"US",
			"options":["UK","Canada","Australia","US","France"]
		}
		]
	
}
-----011000010111000001101001--',

  CURLOPT_HTTPHEADER => array(
    "authorization: Bearer YOUR_ACCESS_TOKEN",
    "cache-control: no-cache",
    "content-type: multipart/form-data; boundary=---011000010111000001101001"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

URL url= new URL("https://{{HOST_NAME}}/api/templates/createtemplate");
HttpURLConnection con= (HttpURLConnection) url.openConnection();
con.setDoOutput(true);
CookieHandler.setDefault(new CookieManager(null, CookiePolicy.ACCEPT_ALL));
String charset="UTF-8";
		
String input="{"
				+ "\"templateName\":\"template.pdf\","
				+ "\"processTextTags\":true,"
				+ "\"processAcroFields\":true,"
				+ "\"numberOfParties\":2,"
				+ "}";	
		
		
File binaryFile = new File("D:\\Sample.pdf");
String boundary = "----"+ Long.toHexString(System.currentTimeMillis()) + "------"; 
String CRLF = "\r\n"; 
con.setRequestProperty("Content-Type","multipart/form-data; boundary=\"" + boundary + "\"");
		
con.setRequestProperty("Authorization", "Bearer ACCESS_TOKEN");
try (
	OutputStream output = con.getOutputStream();
	PrintWriter writer = new PrintWriter(new OutputStreamWriter(output, charset), true);
	) {
		   
	writer.append("--" + boundary).append(CRLF);
			    
	writer.append("Content-Disposition:form-data; name=\"data\"").append(CRLF);
			 
	writer.append(CRLF).append(input).append(CRLF).flush();
    writer.append("--" + boundary).append(CRLF);
	writer.append("Content-Disposition: form-data; name=\"file\"; filename=\"" + binaryFile.getName() + "\"").append(CRLF);
		   
	writer.append("Content-Transfer-Encoding: binary").append(CRLF);
	writer.append(CRLF).flush();
		    
	Files.copy(binaryFile.toPath(), output);
	output.flush();
	writer.append(CRLF).flush(); 
	writer.append("--" + boundary + "--").append(CRLF).flush();
		   
	}
	List<String> response = new ArrayList<String>();
	if (con.getResponseCode()== HttpURLConnection.HTTP_OK) {
	    BufferedReader reader = new BufferedReader(new InputStreamReader(con.getInputStream()));
		String line = null;
		while ((line = reader.readLine()) != null) {
			response.add(line);
		}
	            
		reader.close();
		con.disconnect();
	} else {
		throw new IOException("Server returned non-OK status: " + con.getResponseCode());
	}
		 
 
System.out.println("Finally Reply from server "+con.getResponseCode());

String file = @"C:\test\sample.pdf";
String url = "https://{{HOST_NAME}}/api/templates/createtemplate";
String boundary = "---------------------------" + DateTime.Now.Ticks.ToString("x");
byte[] boundarybytes = System.Text.Encoding.ASCII.GetBytes("\r\n--" + boundary + "\r\n");

HttpWebRequest wr = (HttpWebRequest)WebRequest.Create(url);
wr.ContentType = "multipart/form-data; boundary=" + boundary;
wr.Method = "POST";
wr.KeepAlive = true;
wr.Credentials = System.Net.CredentialCache.DefaultCredentials;

Stream rs = wr.GetRequestStream();

string json = @"{
	""templateName"":""template.pdf"",
	""processTextTags"":true,
	""processAcroFields"":true,
	""numberOfParties"":2,
	   ""fields"":[
		{
			""type"":""text"",
			""x"":100,
			""y"":50,
			""width"":60,
			""height"":20,
			""pageNumber"":1,
			""tabOrder"":1,
			""party"":1,
			""name"":""optional name"",
			""tooltip"":"""",
			""value"":""optional value"",
			""required"":true,
			""characterLimit"":100,
			""fontSize"":12,
			""fontColor"":""#000000"",
			""validation"":""Letters""

		},
		{
                        ""type"":""formulafield"",
                        ""formulafieldName"":""Formula_Field_Name"",
                        ""formula"":""[n1] + [n2]"",
                        ""fontSize"":8,
                        ""fontFamily"":""default"",
                        ""fontColor"":""#000000"",
                        ""documentNumber"":1,
                        ""pageNumber"":1,
                        ""x"":100,
                        ""y"":280,
                        ""tabOrder"":1,
                        ""width"":50,
                        ""height"":100,
                        ""party"": 1,
                        ""decimalPlaces"": 2
                },
		{
			""type"":""text"",
			""x"":552,
			""y"":150,
			""width"":60,
			""height"":20,
			""pageNumber"":1,
			""tabOrder"":1,
			""party"":1,
			""fontSize"":8,
			""fontColor"":""#eee"",
			""validation"":""Numbers""
		},
		{
			""type"":""signature"",
			""x"":200,
			""y"":150,
			""width"":100,
			""height"":50,
			""pageNumber"":1,
			""party"":1
		},
		{
			""type"":""dropdown"",
			""x"":200,
			""y"":250,
			""width"":80,
			""height"":20,
			""pageNumber"":1,
			""party"":1,
			""value"":""US"",
			""options"":[""UK"",""Canada"",""Australia"",""US"",""France""]
		}
		]
}";

rs.Write(boundarybytes, 0, boundarybytes.Length);

string formdataTemplate = "Content-Disposition: form-data; name=\"data\"\r\n\r\n"+json;
byte[] formitembytes = System.Text.Encoding.UTF8.GetBytes(formdataTemplate);
rs.Write(formitembytes, 0, formitembytes.Length);

rs.Write(boundarybytes, 0, boundarybytes.Length);

string headerTemplate = "Content-Disposition: form-data; name=\"file\"; filename=\"sample.pdf\"\r\nContent-Type: application/pdf\r\n\r\n";
      
byte[] headerbytes = System.Text.Encoding.UTF8.GetBytes(headerTemplate);
rs.Write(headerbytes, 0, headerbytes.Length);

FileStream fileStream = new FileStream(file, FileMode.Open, FileAccess.Read);
byte[] buffer = new byte[4096];
int bytesRead = 0;
while ((bytesRead = fileStream.Read(buffer, 0, buffer.Length)) != 0) {
          rs.Write(buffer, 0, bytesRead);
}
fileStream.Close();

byte[] trailer = System.Text.Encoding.ASCII.GetBytes("\r\n--" + boundary + "--\r\n");
rs.Write(trailer, 0, trailer.Length);
rs.Close();

WebResponse wresp = null;
try {
     wresp = wr.GetResponse();
     Stream stream2 = wresp.GetResponseStream();
     StreamReader reader2 = new StreamReader(stream2);
     log.Debug(string.Format("File uploaded, server response is: {0}", reader2.ReadToEnd()));
} catch(Exception ex) {
     log.Error("Error uploading file", ex);
     if(wresp != null) {
         wresp.Close();
         wresp = null;
     }
} finally {
     wr = null;
}

Create a new folder of documents from templates

To create a folder of documents from templates, you need to make a call to /templates/createFolder with the following parameters and use template_id to specify the templates:

POST /templates/createFolder
Content-Type application/json

REQUEST

{
	"folderName":"Sample Documents",
	"templateIds":[ID_OF_TEMPLATE_A,ID_OF_TEMPLATE_B],
	"fields":
		{
			"FIELD1_NAME":"FIELD1_VALUE",
			"FIELD2_NAME":"FIELD2_VALUE",
			If image field
			"IMAGE_FIELD_NAME":{ 
				"inputType":"url or base64",
				"imageName":"logo.png",
				"source": "URL or BASE64 String"	
			   },
			....
		},
	"allowAdvancedEmailValidation":true,
	"metadata":{
	    "DATA_KEY1":"DATA_VALUE1",
	    "DATA_KEY2":"DATA_VALUE2",
	    "DATA_KEY3":"DATA_VALUE3",
	    "DATA_KEY4":"DATA_VALUE4",
	    ........
	}
	"parties":[
		{
			"firstName":"FIRST_NAME_OF_RECIPIENT_PARTY",
			"lastName":"LAST_NAME_OF_RECIPIENT_PARTY",
			"emailId":"EMAIL_ID_OF_RECIPIENT_PARTY",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"hostEmailId":"EMAIL_ID_OF_INPERSON_ADMINISTRATOR",
			"allowNameChange":true,
			"dialingCode": "+1",
			"mobileNumber": "RECIPIENT_PARTY_MOBILE_NUMBER",
			"signerAuthLevel":"Email Access Code"
		},
		{
			"firstName":"FIRST_NAME_OF_RECIPIENT_PARTY",
			"lastName":"LAST_NAME_OF_RECIPIENT_PARTY",
			"emailId":"EMAIL_ID_OF_RECIPIENT_PARTY",
			"permission":"FILL_FIELDS_AND_SIGN",
			"workflowSequence":1,
			"sequence":1,
			"hostEmailId":"EMAIL_ID_OF_INPERSON_ADMINISTRATOR",
			"allowNameChange":true,
			"signerAuthLevel":"User-defined Access Code",
			"userDefinedAccessCode":"123@Test"
		},
		....
	],
	"senderEmail":"user2@example.com",
	"signInSequence":false,
	"custom_field1":{
  	"name":"NAME",
  	"value":"VALUE"
         },
    
      	"custom_field2":{
  	"name":"NAME",
  	"value":"VALUE"
         },
	"sendNow":false,
	"signSuccessUrlAllParties":false,
	"emailTemplateId":2,
	"signerInstructionId":1,
	"confirmationInstructionId":2,
	"emailTemplateCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_1",
  		"type":"plain",
  		"value":"Please click on the View Document(s) link below to review and esign the documents as required."
  	},
  	{
  		"tag":"CUSTOM_TAGS_2",
  		"type":"hyperlink",
  		"value":"click here's",
  		"url":"HYPERTEXT_REFERENCE"
  	}
  	
  	
  	],
  	"signerInstructionCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_1",
  		"type":"plain",
  		"value":"Please review the document."
  	}
  	],
  	"confirmationInstructionCustomFields":[
  	{
  		"tag":"CUSTOM_TAGS_2",
  		"type":"plain",
  		"value":"Click here to confirm signing."
  	}
  	],
	"createEmbeddedSendingSession":false,
	"inPersonEnable":false,
	"fixRecipientParties":true,
	"fixDocuments":true,	
	"hideSignerSelectOption":false,
	"hideSignerActions": false,
	"hideSenderName": true,
	"hideFolderName": false,
	"hideDocumentsName": true,
	"hideAddMeButton":false,
	"hideAddNewButton":true,
	"enableStepByStep":false,
	"hideAddGroupButton":false,
	"sendSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"sendErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"createEmbeddedSigningSession":true,
	"createEmbeddedSigningSessionForAllParties":false,
	"embeddedSignersEmailIds":["FIRST_EMBEDDED_SIGNER_EMAIL","SECOND_EMBEDDED_SIGNER_EMAIL"],
	"signSuccessUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signDeclineUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signLaterUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"signErrorUrl":"YOUR_PAGE_TO_REDIRECT_USER_FROM_EMBEDDED_SESSION",
	"themeColor":"ANY_CSS_COLOR_TO_MATCH_YOUR_APPLICATION",	
	"sessionExpire":false,
	"expiry":300000,
	"allowSendNowAndEmbeddedSigningSession":false
}

Parameter Description

folderName (optional) Name of the document(s) folder
If this value is not provided, then the document(s) folder name is kept same as the template(s) name(s).

templateIds (required) An array of template IDs you want to use to create the documents for this folder. You can determine the template ID from the template URL.(https://{{HOST_NAME}}/templates/prepareimmutabletemplate?template.templateId={TEMPLATE_ID})

fields (optional) You may pass of the field values used in the templates to prefill them in the documents created from the template.
FIELD_NAME is the name of the field used in the template. FIELD_VALUE is the document field value.

Custom Fields (optional)
Two custom fields custom_field1 and custom_field2

Parameter	Description
name	Name of the custom field
value	Value of the custom field

Custom fields can be used for many purposes such as identifying the application and module where the signed document belongs. You can use the custom fields as per your requirements. Maximum of two custom fields can be passed to Foxit eSign via API that are stored at the folder level. The webhook response includes these custom field.

allowAdvancedEmailValidation (Optional) (default=false) Value can be either true or false
Validate the email address of the parties.

metadata (optional) This should be in the key value pair. Maximum 1000 key value pairs are allowed.

parties (required)

A list of recipient parties you're sending the folder to. Every entry must contain firstName, lastName, emailId, permission and sequence fields.

permission Use this field to assign folder permissions to a recipient. Can be any one of the following values:
FILL_FIELDS_AND_SIGN, FILL_FIELDS_ONLY, SIGN_ONLY, VIEW_ONLY, PARTY_ASSIGNER

isPlaceholder
(optional, default=false) Value can be either true or false
Use this field to initiate the party as a placeholder.
Note:
1. firstName, lastName, emailId parameter's value must be blank of this party.
2. To add the placeholder, one recipient must be requred with 'PARTY_ASSIGNER' permission.

partyRole (optional) Use this field to assign a role of placeholder.
Note: This parameter is only applicable when the party is a placeholder.

sequence Use this field to assign a sequence number to a recipient in the list of recipient parties.
Use unique sequence numbers for each party starting with 1 like 1,2,3,4....

dialingCode Use this field to assign a country dial-in codes are mobile number prefixes to a recipient in the list of recipient parties.

mobileNumber Use this field to assign a mobile number to a recipient in the list of recipient parties.

signerAuthLevel

Features	Authentication Level
Authentication via SMS	SMS LINK
Authentication Via Email	Email Access Code
2FA Via Authy	SMS Access Code
2FA Via Authy	Voice Access Code
User-defined Access Code	User-defined Access Code

userDefinedAccessCode

Codes are not case-sensitive
The system does not send this code so you must share this code with the signer directly
Access code can contain alphabets, numbers and the following special characters:
@,&,{,},%,(,),~,|,!,+,^

sessionExpire
(optional, default=false) Value can be either true or false
Use this field to initiate the expiration of the embedded signing session.

expiry
(required if sessionExpire is true) Use this field to enter the time duration in milliseconds of the expiry on the embedded signing session.

senderEmail (optional) You can enter the email of another user in your account which will be used for sending this document(s) folder to the recipient parties.

signInSequence
(optional, default=false) Value can be either true or false
Use this field to determine whether recipients will sign the folder in a sequence.
If false, then all the recipients receive the invitation email simultaneously. When true, then each recipient receives invitation email successively after previous recipient completes the required task, like signing the documents or filling fields, etc.

inPersonEnable
Default false Value can be either true or false
Use this field to initiate the in-person signing process which can be easily completed on any device in a matter of minutes and avoids email based signatures where required..
If false, then all the recipients receive the invitation email simultaneously. When true, then in-person administrator receives an invitation email to initiate the signing process for the signer.

sendNow
Default true Value can be either true or false
Use this field to send the folder to the recipient parties. Each party will then receive a unique link in their email to sign the document. The invitation mail and subject in this case will be the same as the default invitation mail setup in your account.

enableStepByStep (optional, default=false) To enable step by step action in the embedded sending session.

createEmbeddedSigningSession
(optional, default=false) Value can be either true or false
If false, then all the recipients receive an email invitation to sign the folder.
Else if true then an embedded signing session will be generated in the response, for the recipients whose emails will be given in the embeddedSignersEmailIds, and those recipients will not receive any invitation email.
Also, if its value is true then either createEmbeddedSigningSessionForAllParties value should also be true or embeddedSignersEmailIds should be non-empty

themeColor (optional) You can enter a css value for a color to match your website's look n feel when you embed Foxit eSign inside. The top blue band of the signing screen is then replaced with the color provided by you.