eSignly API Features

Signing Request

Method

POST

URL

https://api.esignly.com/v1/docSignRequest/

Type

Params

Required

Values

POST

api_key

Y

string

POST

upl

Y

string (file path)

POST

signer_role

Y

array() {signer_role[0],signer_role[1]}...

POST

signer_email

Y

array() {signer_email[0],signer_email[1]...}

POST

title

Y

string

POST

subject

Y

string

POST

message

Y

String

POST

sign_pos

Y

int(0,1 and 2)

POST

is_chain

N

int(0 or 1 )

POST

is_ignored

N

int(0 or 1 )

POST

is_notify

N

int(0 or 1 )

POST

is_attachment_allow

N

int(0 or 1 )

POST

attachment_doc_type

N

array('pdf','doc','jpg' ....)

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "signature_request": { “details_url”: Details
, “has_error”:, “is_complete”:, “requester_email_address”:, “test_mode”:0 OR 1, }, "signatures": [ { "signature_id": , "signer_email_address": , "signer_name": "", "status_code": "SENT OR VIEWED OR SIGNED", "date": null, "system_details": null }, { "signature_id": , "signer_email_address": , "signer_name": "", "status_code": "SENT OR VIEWED OR SIGNED", "date": null, "system_details": null } ] }

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

415

{"error":"Error while processing doc."}

416

{"error":"Error while processing doc."}

412

{"error":"Recipient array are not validated."}

413

{"error":"Roles Input are not validated."}

414

{"error":"File upload error ."}

404_4

{"error":" No file found ."}

Cancel Signing Request

Method

POST

URL

https://api.esignly.com/v1/cancelSignReqest/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "cancel_request": { "has_error": false, "error_details": "", "signature_request_id": "f14ddedadb0856ce47ebddd799897f5e", "test_mode": 0 OR 1, "response": [ { "assign_title": "test from curl", "is_cancelled": "1" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

420

{"error":"Invalid Request key."}

421

{"error":"This Assignment is already cancelled."}

Delete Signing Request

Method

POST

URL

https://api.esignly.com/v1/deleteSignRequest/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ { "delete_request": { "has_error": false, "error_details": "", "signature_request_id": "f14ddedadb0856ce47ebddd799897f5e", "test_mode": 0 OR 1, "response": [ { "assign_title": "test from curl", "is_deleted": 1 } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

420

{"error":"Invalid Request key."}

422

{"error":"You are not authorized."}

Delete Recipient from signing request

Method

POST

URL

https://api.esignly.com/v1/deleteRecipent/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

POST

signature_id

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "delete_recipient_request": { "has_error": false, "error_details": "", "signature_request_id": "f14ddedadb0856ce47ebddd799897f5e", "test_mode": 0 OR 1, "response": [ { "signature_id": "300725712", "is_deleted": 1 } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

420

{"error":"Invalid Request key."}

Edit Recipient Email

Method

POST

URL

https://api.esignly.com/v1/editRecipient/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

POST

signer_email_old[0]

Y

array

POST

signer_email_new[0]

Y

array

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ { "edit_recipient_request": { "has_error": false, "error_details": "", "signature_request_id": "7807fbca5d2faf3c4646d3e354054971", "test_mode": 0 OR 1, "response": [ { "status": "Email id is updated successfully" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

412

{"error":"Recipient array are not validated."}

420

{"error":"Invalid Request key."}

423

{"error":"Invalid Email."}

Add more recipients

Method

POST

URL

https://api.esignly.com/v1/addMoreRecipient/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

POST

signer_role

Y

array() {signer_role[0],signer_role[1]}...

POST

signer_email

Y

array() {signer_email[0],signer_email[1]...}

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ { "add_more_recipients": { "has_error": false, "error_details": "", "test_mode": 1, "response": [ { "status": "Signing request sent successfully" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

420

{"error":"Invalid Request Key."}

422

{"error":"You are not authorized."}

423

{"error":"Invalid Email."}

426

{"error":"Invalid Request."}

Get service balance

Method

POST

URL

https://api.esignly.com/v1/getServiceBalance/

Type

Params

Required

Values

POST

api_key

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ { "user_balance": { "has_error": false, "error_details": "", "test_mode": 0 OR 1, "response": [ { "total_template_balance": "unlimited" }, { "total_signing_balance": "unlimited" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

Get Document status

Method

POST

URL

https://api.esignly.com/v1/checkSignStatus/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "signature_request": { "details_url": "https://acc.localhost.com/assignments/specific/7807fbca5d2faf3c4646d3e354054971", "has_error": false, "is_complete": false, "requester_email_address": "rajesh.c@cisinlabs.com", "signature_request_id": "7807fbca5d2faf3c4646d3e354054971", "test_mode": 0 OR 1, }, "signatures": [ { "signature_id": "300725712", "signer_email_address": "amit.n@cisinlabs.com", "signer_name": "", "status_code": "SENT", "date": null, "system_details": null }, { "signature_id": "900172008", "signer_email_address": "rajesh@gmail.com", "signer_name": "", "status_code": "SENT", "date": null, "system_details": null } ] } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

420

{"error":"Invalid Request Key."}

Create Signature request by template key

Method

POST

URL

https://api.esignly.com/v1/createSignRequest/

Type

Params

Required

Values

POST

api_key

Y

string

POST

template_key

Y

string 

POST

signer_role

Y

array() {signer_role[0],signer_role[1]}...

POST

signer_email

Y

array() {signer_email[0],signer_email[1]...}

POST

title

Y

string

POST

subject

Y

string

POST

message

Y

String

POST

is_chaining

N

int(0 or 1 )

POST

is_ignored

N

int(0 or 1 )

POST

is_notify

N

int(0 or 1 )

POST

is_attachment_allow

N

int(0 or 1 )

POST

is_attachment_required

N

int(0 or 1 )

POST

attachment_doc_type

N

array('pdf','doc','jpg' ....)

POST

dynamic_key(name of your dynamic key)

N

value (string)

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "signature_request": { “details_url”: Details
“has_error”:, “is_complete”:, “requester_email_address”:, “test_mode”:0 OR 1, }, "signatures": [ { "signature_id":, "signer_email_address":, "signer_name": "", "status_code": "SENT OR VIEWED OR SIGNED", "date": null, "system_details": null }, { "signature_id":, "signer_email_address":, "signer_name": "", "status_code": "SENT OR VIEWED OR SIGNED", "date": null, "system_details": null } ] } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

422

{"error":"You are not authorized."}

424

{"error":"Template do not satisfy the given properties in request."}

Create InPerson signing request by template key

Method

POST

URL

https://api.esignly.com/v1/createInPersonSignRequest/

Type

Params

Required

Values

POST

api_key

Y

string

POST

template_key

Y

string 

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "inperson_signing": { "has_error": false, "error_details": "", "test_mode": 1, "response": { "inperson_link": "https:\/\/www.localhost.com\/request\/inPersonSigning?request=4973ca0907d45060aa1b1a3731f8a671", "inperson_key": "4973ca0907d45060aa1b1a3731f8a671" } } }

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

422

{"error":"You are not authorized."}

GetTemplateProperty

Method

POST

URL

https://api.esignly.com/v1/getTemplateProperty/

Type

Params

Required

Values

POST

api_key

Y

string

POST

template_key

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ { "templates": { "account_key": "460736320", "email_address": "rajesh.c@cisinlabs.com", "title": "test key", "template_key": "bce8d9d924d856532005c56021ec74ca", "has_error": false, "test_mode": 1, "error_details": "Success", "fields": [ { "is_dynamic": "1", "dynamic_key": "textbox_33L4Fl", "dynamic_label": "textbox1", "field_type": "textbox", "position": { "top": 104.5, "left": 58.5 }, "width": 100, "height": 40, "font_size": "", "required": "1" }, { "is_dynamic": "1", "dynamic_key": "checkbox_TLzcqu", "dynamic_label": "checkbox2", "field_type": "checkbox", "position": { "top": 124.5, "left": 355.5 }, "width": 30, "height": 30, "font_size": "", "required": "1" }, { "is_dynamic": "1", "dynamic_key": "signdate_1xxnaf", "dynamic_label": "signdate3", "field_type": "signdate", "position": { "top": 133.5, "left": 561 }, "width": 120, "height": 30, "font_size": "", "required": "1" }, { "is_dynamic": "0", "dynamic_key": "", "dynamic_label": "", "field_type": "sign", "position": { "top": 34.5, "left": 52.5 }, "width": 100, "height": 40, "font_size": "", "required": "1" }, { "is_dynamic": "0", "dynamic_key": "", "dynamic_label": "", "field_type": "sign", "position": { "top": 46.5, "left": 418.5 }, "width": 100, "height": 40, "font_size": "", "required": "1" } ], "signer_roles": [ { "name": "Manager" }, { "name": "client" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

Download Document

Method

POST

URL

https://api.esignly.com/v1/downloadDoc/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "download_docs": { "has_error": false, "error_details": "", "test_mode": 0 OR 1, "response": { "file_url": "location to read the file" } } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

Auto Attach Signature

Method

POST

URL

https://api.esignly.com/v1/autoAttachSignature/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "auto_attach": { "has_error": false, "error_details": "", "test_mode": 0 OR 1, "response": [ { "status": "Your signature attached successfully" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

425

{"error":"Please create your signature first."}

426

{"error":"Invalid Request."}

Send Documents

Method

POST

URL

https://api.esignly.com/v1/sendDocs/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

POST

email

Y

array() {email[0],email[1]...}

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ { "send_docs": { "has_error": false, "error_details": "", "test_mode": 1, "response": [ { "status": "docs sent successfully" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

420

{"error":"Invalid Request Key."}

422

{"error":"You are not authorized."}

423

{"error":"Invalid Email."}

426

{"error":"Invalid Request."}

List signing request

Method

POST

URL

https://api.esignly.com/v1/listSignRequest/

Type

Params

Required

Values

POST

api_key

Y

string

POST

page

Y

string(0,1,2... as per no of pages)

POST

result_per_page

Y

5,10,20,50

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "sign_list": { "has_error": false, "page": "1", "num_pages": 1, "num_results": 2, "page_size": 10, "error_details": "", "test_mode": 1, "signature_requests": [ { "title": "test by api", "is_complete": false, "requester_email_address": "rajesh.c@cisinlabs.com", "signature_request_id": "20838273fd70f3b2ff503bca8732a9b1", "message": "my message", "signature": [ { "signature_id": "460736320", "signer_email_address": "test@gmail.com", "signer_name": "test", "status_code": "COMPLETED", "date": "2015-11-04 17:05:17", "system_details": "{\"ip\":\"127.0.0.1\",\"user_agent\":\"Mozilla\\/5.0 (X11; Ubuntu; Linux x86_64; rv:40.0) Gecko\\/20100101 Firefox\\/40.0\"}" }, { "signature_id": "443428409", "signer_email_address": "nilesh@gmail.com", "signer_name": "", "status_code": "SENT", "date": null, "system_details": null } ] }, { "title": "test by api", "is_complete": false, "requester_email_address": "rajesh.c@cisinlabs.com", "signature_request_id": "9295b5a07d38f37df40281f54f017110", "message": "my message", "signature": [ { "signature_id": "460736320", "signer_email_address": "test@gmail.com", "signer_name": "test", "status_code": "SENT", "date": null, "system_details": null }, { "signature_id": "443428409", "signer_email_address": "nilesh@gmail.com", "signer_name": "", "status_code": "SENT", "date": null, "system_details": null } ] } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

422

{"error":"You are not authorized."}

426

{"error":"Invalid Request."}

430

{"error":"No records found."}

431

{"error":"result_per_page limit exceed."}

Send Request reminder

Method

POST

URL

https://api.esignly.com/v1/sendReminder/

Type

Params

Required

Values

POST

api_key

Y

string

POST

signature_request_id

Y

string

POST

email

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

"sendReminder": { "has_error": false, "error_details": "", "test_mode": 1, "response": [ { "status": "Reminder sent successfully" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

403

{"error":You do not have sufficient signing request balance to perform this action."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

420

{"error":"Invalid Request Key."}

422

{"error":"You are not authorized."}

423

{"error":"Invalid email."}

426

{"error":"Invalid Request."}

Template listing

Method

POST

URL

https://api.esignly.com/v1/listTemplate/

Type

Params

Required

Values

POST

api_key

Y

string

POST

page

Y

string(0,1,2..)

POST

result_per_page

Y

5,10,20,50

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "template_list": { "has_error": false, "page": 1, "num_pages": 1, "num_results": 3, "page_size": 10, "error_details": "", "test_mode": 1, "templates": [ { "tempalate_key": "73510bf2e1219639fb607d11f3dff83f", "title": "temp test", "message": "template description", "signer_roles": [ { "name": "client" }, { "name": "manager" } ] }, { "tempalate_key": "12fa2c13d2f4923eeb254e49b4453d7f", "title": "csv format", "message": "my template subject", "signer_roles": [ { "name": "client" }, { "name": "manager" } ] } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

422

{"error":"You are not authorized."}

426

{"error":"Invalid Request."}

430

{"error":"No records found."}

431

{"error":"result_per_page limit exceed."}

Delete template

Method

POST

URL

https://api.esignly.com/v1/delTemplate/

Type

Params

Required

Values

POST

api_key

Y

string

POST

template_key

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "del_template": { "has_error": false, "error_details": "", "test_mode": 1, "response": [ { "status": "Template deleted successfully" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

422

{"error":"You are not authorized."}

426

{"error":"Invalid Request."}

User Account Detail

Method

POST

URL

https://api.esignly.com/v1/getAccount/

Type

Params

Required

Values

POST

api_key

Y

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "user_account": { "has_error": false, "error_details": "", "test_mode": 1, "response": [ { "account_id": "460736320", "email": "test@gmail.com", "is_paid": true, "quotas": { "total_template_balance": "unlimited", "total_signing_balance": "unlimited" }, "plan": { "name": "10signing request 5 templates 15 status api hits within a day.", "plan_type": "monthly", "amount": "$ 39.00", "features": [ { "title": "api_doc_signing" }, { "title": "api_signing" }, { "title": "api_signing_status" }, { "title": "get_template_data" }, { "title": "api_service_balance" }, { "title": "api_cancel_signing_request" }, { "title": "api_delete_recipient_request" }, { "title": "api_delete_signing_request" }, { "title": "api_edit_recipient_request" }, { "title": "api_user_balance_request" } ] } } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

422

{"error":"You are not authorized."}

426

{"error":"Invalid Request."}

Verify Documents

Method

POST

URL

https://api.esignly.com/v1/verifyDocument/

Type

Params

Required

Values

POST

api_key

Y

string

POST

user_pdf_file

Optional

string (file path)

POST

doc_hash_key

Optional

string

api_key must be sent with all client requests. The api_key helps the server to validate the request source.

Response (JSON)

Status

Response

200

{ "verify_document": { "has_error": false, "error_details": "", "test_mode": 1, "response": [ { "status": "Document is enforced by eSignly" } ] } } auth_key (string) - all further API calls must have this key in header

 

 

auth_key (string) - all further API calls must have this key in header

401

{"error":Invalid API Key."}

402

{"error":"All API request are exhausted."}

404

{"error":"IP does not match with the registered IP."}

405

{"error":"No API plan found for this API Key."}

407

{"error":"Sorry your payment is not verified."}

408

{"error":"You have exceeded your daily limit."}

410

{"error":"URL is not authorized."}

411

{"error":"This features does not exist in your plan."}

422

{"error":"You are not authorized."}

426

{"error":"Invalid Request."}