Methods

List Businesses

A list of existing businesses on your eversign account can be accessed by making a simple HTTP GET call to the eversign API's business endpoint.

API Response Objects:

Name Description
business_id Returns the Business ID of the given business.
business_status Returns 1 if the given business is active; or 2 if the given business is inactive or deleted.
business_identifier Returns the Vanity URL (sub domain) of the given business.
business_name Returns the Business Name of the given business.
creation_time_stamp Returns the creation date and time of the given business as UNIX time stamp.
is_primary Returns 1 if the given business is the Primary Business.




List Businesses HTTP GET

API Request

https://api.eversign.com/api/business ? access_key = YOUR_ACCESS_KEY

API Response

[{ "business_id": 1, "business_status": 1, "business_identifier": "first", "business_name": "My First Business", "creation_time_stamp": 1490203825, "is_primary": 1 }, { "business_id": 2, "business_status": 1, "business_identifier": "second", "business_name": "My Second Business", "creation_time_stamp": 1490203925, "is_primary": 0 }]

Create Document

In order to create a document an HTTP POST request containing a series of parameters and objects to the API's document is required. All parameters and objects are specified below:

Name Description Default
sandbox Set to 1 in order to enable Sandbox Mode. 0
is_draft Set to 1 in order to save this document as a draft. 0
title This parameter is used in order to specify a document title. -
message This parameter is used in order to specify a document message. -
use_signer_order Set to 1 in order to enable Signing Order for this document. 0
reminders Set to 1 in order to enable Auto Reminders for this document. 0
require_all_signers Set to 1 in order to require all signers to sign to complete this document. 0
custom_requester_name This parameter can be used to specify a custom requester name for this document. If used, all email communication related to this document and signing-related notifications will carry this name as the requester (sender) name. -
custom_requester_email This parameter can be used to specify a custom requester email address for this document. If used, all email communication related to this document and signing-related notifications will carry this email address as the requester (sender) email address. -
redirect This parameter is used to specify a custom completion redirect URL. If empty, the default Post-Signature Completion URL specified in your eversign Business or the eversign signature completion page will be used. Default URL
redirect_decline This parameter is used to specify a custom decline redirect URL. If empty, the default Post-Signature Decline URL specified in your eversign Business or the eversign signature declined page will be used. Default URL
client This parameter is used to specify an internal reference for your application, such as an identification string of the server or client making the API request. -
expires This parameter is used to specify a custom expiration date for your document. (Required format: Unix Time Stamp) If empty, the default document expiration period specified in your business settings will be used. Default Expiration
embedded_signing_enabled Set to 1 in order to enable Embedded Signing for this document. If enabled, this document can be signed within an iFrame embedded on your website and email authentication will be disabled. 0
flexible_signing Set to 1 in order to create this document without specifying fields. Signers will be able to place their own fields during signing. 0
use_hidden_tags Set to 1 to parse hidden tags placed on your document. 0

files Object
Document files can be uploaded to your document either by providing a URL, a reference to an existing file ID or through a base64 string. This object can contain multiple sub arrays.

Name Description Details
name Specify a name for the file to be uploaded. Required
file_id Specify an existing file reference ID in order to use a specific file that has already been uploaded once using your eversign account. Files can be uploaded using the API's built-in File Upload Method ». Required*
file_url A URL leading to the file you would like to upload as your document file. Click here to view all supported file formats. Required*
file_base64 Specify a base64 string of the file you would like to upload. Click here to view all supported file formats. Required*
Required* Please specify only one of three upload parameters (file_url, file_id or file_base64) for each sub array.

signers Object
This object must contain a sub array for each signer of the document being created. Each sub array requires a unique ID, name and email address.

Name Description Details
id A unique identification number (integer) for this signer. We recommend numbering your signers from 1 to X. Required
name This parameter is used to specify the full name of the current signer. Required
email This parameter is used to specify the email address of the current signer. Required
order If the use_signer_order parameter is set to 1, set this parameter to the signer order number of the current signer. Optional
pin This parameter is used to specify a Signer PIN for the current signer. Optional
message This parameter can be used to specify a custom message (upon document delivery) for the current signer. Please note that for the current signer the general document message will be overriden by this parameter. Optional
deliver_email This parameter is only applicable if embedded_signing_enabled is set to 1. By default, signers of embedded documents are not notified (default: deliver_email: 0) about a new document to be signed. Set deliver_email to 1 to send a notification email to this signer anyway. Optional
language This parameter is used to specify the language in which signing notifications (emails), the document status page and the signature process will appear for this signer. Optional
At least one signer Please note that at least one signer sub array must be specified.

recipients Object
This object can contain a sub array for each CC of the document to be signed.

Name Description Details
name This parameter is used to specify the full name of the current CC. Required
email This parameter is used to specify the email address of the current CC. Required
language This parameter is used to specify the language in which document CC notifications (emails) and the document status page will appear for this CC. Optional

meta Object
This object contains optional key-value data that should be attached to the document. This data will be included when making a GET call for the document created.


fields Object
The fields that should be placed on the document, expressed as a 2-dimensional JSON array. One array of fields is required for each file provided in the files object. If a file has no fields, an empty array must be provided. This structure is illustrated below:

In our example above, the fields of type signature and text will be placed onto the pages of the first document file uploaded, and the fields of type note and attachment will be placed onto the second document file uploaded.


Name Description
type The type of the field to be placed. You can view a list of all available field types by clicking here.
x The field's horizontal margin from the left side of the document in pixels.
y The field's vertical margin from the top of the document in pixels.
width The field's width in pixels.
height The field's height in pixels.
page The number of the document page where the field should be placed.
signer The unique ID of the signer this field should be assigned to. If this field should become a No Signer field, please set this parameter to OWNER.
name The field's Field Label.
identifier The field's Field Identifier.
required Set to 1 in order to make this field a Required Field.
readonly Set to 1 in order to make this field a Read-Only Field.
validation_type Enable Field Validation for this field. Available validation types are email_address, letters_only and numbers_only.
text_style The letters B for bold, U for underlined and I for italic, in an order of your choice. Example: BUI
text_font Set to the font identifier of your preferred font, e.g. arial. Jump to section Field Style to learn about supported fonts.
text_size Set to your preferred font size number (string or integer), e.g. 16.
text_color Set to your preferred HEX color code, e.g. #FF0000
value Set to 1 to mark checkbox or radio fields checked; or specify text content for note or text fields. For dropdown fields, set this parameter to an option value in order to pre-select it.
options This parameter must contain a simple JSON array containing all available options of a dropdown field. In order to pre-select an option, simply set the value parameter to the option value.
group This parameter is used to identify radio button groups. radio fields belonging to the same group must carry the same group parameter. Please note that this parameter must be numeric.
No Fields If no signature fields are specified within your document creation request the eversign API will automatically append to your document an additional signature page containing signature fields to be completed by each signer.


Create Document HTTP POST

API Request

https://api.eversign.com/api/document ? access_key = YOUR_ACCESS_KEY & business_id = 1
{ "sandbox": 0, "is_draft": 0, "embedded": 0, "title": "Sample Document", "message": "This is my general document message.", "use_signer_order": 1, "reminders": 1, "require_all_signers": 1, "custom_requester_name": "", "custom_requester_email": "", "redirect": "https://myredirect.com/completed", "redirect_decline": "https://myredirect.com/declined", "client": "", "expires": 1494276966, "embedded_signing_enabled": 0, "flexible_signing": 0, "use_hidden_tags": 0, "files": [{ "name": "My Document File", "file_url": "https://website.com/contract.pdf", "file_id": "", "file_base64": "" }, { "name": "My Second Document File", "file_url": "https://website.com/second_contract.pdf", "file_id": "", "file_base64": "" }], "signers": [{ "id": 1, "name": "Paul McSign", "email": "paul@mcsign.com", "order": 1, "pin": "3874", "message": "This is my custom message to Paul.", "deliver_email": "", "language": "en" }, { "id": 2, "name": "Julian McSign", "email": "julian@mcsign.com", "order": 2, "pin": "3944", "message": "", "deliver_email": "", "language": "en" }], "recipients": [{ "name": "Jane McSign", "email": "jane@mcsign.com", "language": "en" }, { "name": "Frank McSign", "email": "frank@mcsign.com", "language": "en" }], "meta": { "some_key": "some_value", "another_key": "another_value" }, "fields": [ [{ "type": "signature", "x": "120.43811219946572", "y": "479.02760463045416", "width": "120", "height": "35", "page": "2", "signer": "1", "name": "", "identifier": "unique_field_identifier_1", "required": 1, "readonly": 0, "validation_type": "", "text_size": "", "text_color": "", "text_font": "", "text_style": "", "value": "", "options": [], "group": "" }, { "type": "signature", "x": "363.49421193232416", "y": "479.5725734639359", "width": "120", "height": "35", "page": "2", "signer": "2", "name": "", "identifier": "unique_field_identifier_2", "required": 1, "readonly": 0, "validation_type": "", "text_size": "", "text_color": "", "text_font": "", "text_style": "", "value": "", "options": [], "group": "" }, { "type": "text", "x": "97.54942119323242", "y": "123.7079252003562", "width": "55", "height": "17", "page": "1", "signer": "1", "name": "Full Name", "identifier": "unique_field_identifier_3", "required": 1, "readonly": 0, "text_size": "", "text_color": "", "text_font": "", "text_style": "", "validation_type": "", "value": "", "options": [], "group": "" }, { "type": "text", "x": "276.2991985752449", "y": "123.16295636687445", "width": "55", "height": "17", "page": "1", "signer": "2", "name": "Full Name", "identifier": "unique_field_identifier_4", "required": 1, "readonly": 0, "validation_type": "letters_only", "text_size": "", "text_color": "", "text_font": "", "text_style": "", "value": "", "options": [], "group": "" }, { "type": "dropdown", "x": "440.4", "y": "204.2", "width": "92", "height": "23", "page": "2", "signer": "1", "name": "Dropdown", "identifier": "unique_field_identifier_5", "required": 1, "readonly": 0, "validation_type": "", "text_size": "", "text_color": "", "text_font": "", "text_style": "", "value": "Option 1", "options": [ "Option 1", "Option 2", "Option 3" ], "group": "" }] ] }

API Response

If successful, the eversign API will return the entire document in JSON format. In order to see how this response looks like, please jump to the Get Document section.

Use Template

An existing template can be used by making an HTTP POST request to the document endpoint containing some key parameters. All optional and required parameters are listed in the table below.

Look up your template Before using a template you might want to access it in order to review its signer and recipient roles, fields and other settings. In order to look up your template, a GET Template request is required.
Name Description
sandbox Set to 1 in order to enable Sandbox Mode.
template_id Set to the Template ID of the template you would like to use.
title This parameter is used in order to specify a document title.
message This parameter is used in order to specify a document message.
custom_requester_name This parameter can be used to specify a custom requester name for this document. If used, all email communication related to this document and signing-related notifications will carry this name as the requester (sender) name.
custom_requester_email This parameter can be used to specify a custom requester email address for this document. If used, all email communication related to this document and signing-related notifications will carry this email address as the requester (sender) email address.
redirect This parameter is used to specify a custom completion redirect URL. If empty, the default Post-Signature Completion URL specified in your eversign Business or the eversign signature completion page will be used.
redirect_decline This parameter is used to specify a custom decline redirect URL. If empty, the default Post-Signature Decline URL specified in your eversign Business or the eversign signature declined page will be used.
client This parameter is used to specify an internal reference for your application, such as an identification string of the server or client making the API request.
expires This parameter is used to specify a custom expiration date for your document. (Required format: Unix Time Stamp) If empty, the default document expiration period specified in your business settings will be used.
embedded_signing_enabled Set to 1 in order to enable Embedded Signing for this document. If enabled, this document can be signed within an iFrame embedded on your website and email authentication will be disabled.

signers Object
This object must contain a sub array for each signing role of your template. Each sub array must contain the role name, signer name and signer email address. At this point, an optional Signer PIN and message can be specified as well.

Name Description Details
role The name of this signing role. Required
name This parameter is used to specify the full name of the current signer. Optional
email This parameter is used to specify the email address of the current signer. Optional
pin This parameter is used to specify a Signer PIN for the current signer. Optional
message This parameter can be used to specify a custom message (upon document delivery) for the current signer. Please note that for the current signer the general document message will be overriden by this parameter. Optional
deliver_email This parameter is only applicable if embedded_signing_enabled is set to 1. By default, signers of embedded documents are not notified (default: deliver_email: 0) about a new document to be signed. Set deliver_email to 1 to send a notification email for this role anyway. Optional
language This parameter is used to specify the language in which signing notification emails, the document status page and the signature process will appear for this signer. Click here for a list of supported languages. Optional
All required roles must be specified Please note that all required roles must be specified in order to use a template.

recipients Object
This object must contain a sub array for each recipient (CC) role of your template. Each sub array must contain the role name, CC name and CC email address.

Name Description Details
role The name of this CC role. Required
name This parameter is used to specify the full name of the current CC. Required
email This parameter is used to specify the email address of the current CC. Required
language This parameter is used to specify the language in which document CC notifications (emails) and the document status page will appear for this CC. Click here for a list of supported languages. Optional

fields Object
This object must contain a sub array for each Merge Field of this template.

Name Description Details
identifier The field's Field Identifier. Required
value The field's value. Click here to see a list of allowed field values per field. Required

Use Template HTTP POST

API Request

https://api.eversign.com/api/document ? access_key = YOUR_ACCESS_KEY & business_id = 1
{ "sandbox": 0, "template_id": "j6yMcaF4gQBIIQ", "title": "My New Document", "message": "This is my message.", "custom_requester_name": "", "custom_requester_email": "", "redirect": "https://myredirect.com/completed", "redirect_decline": "https://myredirect.com/declined", "client": "", "expires": 1494276966, "embedded_signing_enabled": 0, "signers": [{ "role": "Sales Rep", "name": "Paul McSign", "email": "paul@mcsign.com", "pin": "1234", "message": "This is my custom message to Paul.", "deliver_email": "", "language": "en" }, { "role": "Client", "name": "Julian McSign", "email": "julian@mcsign.com", "pin": "4321", "message": "", "deliver_email": "", "language": "en" }], "recipients": [{ "role": "Assistant", "name": "Jane McSign", "email": "jane@mcsign.com", "language": "en" }, { "role": "Finance Department", "name": "Frank McSign", "email": "frank@mcsign.com", "language": "en" }], "fields": [{ "identifier": "unique_field_identifier_1", "value": "Merge Field Content" }, { "identifier": "unique_field_identifier_2", "value": "Other Merge Field Content" }] }

API Response

If successful, the eversign API will return the created document in JSON format. In order to see how a response like this looks like, please jump to the Get Document section.

Get Document/Template

An existing document or template can be accessed using a straightforward HTTP GET call. If successful, the API will return the entire document/template data set. All the objects contained in the API response are described below:


Name Description
document_hash The unique hash (identification) of the requested document.
requester_email The email address of the document sender.
custom_requester_name If specified during document creation, this parameter will contain your custom requester name.
custom_requester_email If specified during document creation, this parameter will contain your custom requester email address.
is_draft Returns 1 if the requested document is in draft status.
is_template Returns 1 if the requested document is a template.
is_completed Returns 1 if the signing of requested document has been completed.
is_archived Returns 1 if the requested document is archived.
is_deleted Returns 1 if the requested document is deleted.
is_trashed Returns 1 if the requested document is trashed.
is_cancelled Returns 1 if the requested document is cancelled.
embedded Returns 1 if the requested document is a Template Link.
in_person Returns 1 if In-Person Signing is active for the requested document.
permission Returns 1 if the requested template is available to its creator only, or returns 2 if the requested template is available to all Staff members (Templates only).
template_id Returns a template hash if the requested document has been created from a template.
title Returns the title of the requested document.
message Returns the general message of the requested document.
use_signer_order Returns 1 if a Signing Order is active for the requested document.
reminders Returns 1 if Auto Reminders are enabled for the requested document.
require_all_signers Returns 1 if all signers are required to sign to complete the requested document.
redirect Returns the completion redirect URL for the requested document.
redirect_decline Returns the decline redirect URL for the requested document.
client Returns your internal reference for this document (if specified during creation).
created Returns the requested document's creation UNIX time stamp.
expires Returns the requested document's expiration UNIX time stamp.
embedded_signing_enabled Returns 1 if Embedded Signing is enabled for this document.
flexible_signing Returns 1 if this document was created without any fields placed. The signers of this document are required to place fields during signing. [Only available for documents]

files Object

Name Description
name Returns the name of this document file.
file_id Returns the file ID of this document file.
pages Returns the number of pages contained in this document file.

signers Object

Name Description
id Returns the unique signer ID of this signer.
name Returns the full name of this signer.
email Returns the email address of this signer.
role Returns the role name of this signer role (Templates only).
order Returns the signing order number of this signer.
pin Returns the Signer PIN assigned to this signer.
message Returns the custom message to this signer (if specified).
signed Returns 1 if this signer has signed the requested document.
signed_timestamp Returns a UNIX time stamp of the date of signature.
required Returns 1 if this signing role is required (Templates only).
deliver_email Returns 1 if an initial notification email was sent to the signer. This object is only applicable if embedded_signing_enabled is set to 1.
language Returns the 2-letter language code of the language chosen for this signer.
declined Returns 1 if this signer has declined to sign.
removed Returns 1 if this signer was removed.
bounced Returns 1 if the signer's email address could not be reached.
sent Returns 1 if the requested document has been sent to this signer.
viewed Returns 1 if this signer has viewed the requested document.
status Returns the signing status of this signer. Click here to view all existing signing statues values.

Signing Status Values:

  • declined: Signer has declined to sign
  • signed: Signer has signed
  • waiting_for_signature: Signer has not signed yet
  • on_hold: Document delivery is queued (waiting for other signers to sign)

recipients Object

Name Description
name Returns the full name of this CC.
email Returns the email address of this CC.
role Returns the role name of this CC role (Templates only).
message Returns the custom message to this CC (if specified).
required Returns 1 if this CC role is required (Templates only).
language Returns the 2-letter language code of the language chosen for this CC.

fields Object

Name Description
merge Returns 1 if the given field is a Merge Field.
identifier Returns the given field's Field Identifier.
name Returns the given field's Field Label.
options Returns an array of dropdown menu options (Dropdown fields only).
group Returns the Radio Button field group value.
value Returns the given field's value. Click here to see a list of allowed field values per field.
type Returns the given Field Type. Click here to see a list of all existing Field Types.
x Returns the given field's horizontal margin from the left side of the document in pixels.
y Returns the given field's vertical margin from the top of the document in pixels.
page Returns the number of the document page where the given field is placed.
width Returns the given field's width in pixels.
height Returns the given field's height in pixels.
signer Returns the unique signer ID of the signer the given field is assigned to.
validation_type Returns the validation type specified for the given field.
required Returns 1 if the given field is a Required Field.
readonly Returns 1 if the given field is a Read-Only Field.
text_size Returns the font size assigned to the given field.
text_color Returns the HEX color code assigned to the given field.
text_style Returns the B(old), U(nderline), I(talic) style options assigned to the given field.
text_font Returns the font identifier assigned to the given field.
files Returns an array of files attached to this field, each containing name (file name), size (file size in bytes) and url (URL to file) objects. For attachment fields only.

log Object

Name Description
event The identifier of the logged event.
signer The unique signer ID of the signer the logged event is assigned to.
timestamp The UNIX time stamp of the logged event.

Document Event Values:

There is a series of different event values that can be inside a document's log object:

  • document_created: Document has been created
  • document_edited: Document has been edited
  • document_completed: Document has been completed
  • document_sent: Document has been sent
  • document_restored: Document has been restored from trash
  • document_cancelled: Document has been cancelled
  • document_trashed: Document has been trashed
  • document_archived: Document has been archived
  • document_unarchived: Document has been unarchived
  • document_deleted: Document has been deleted
  • document_expired: Document has expired
  • document_viewed: Document has been opened/viewed
  • document_declined: Document has been declined
  • document_signed: Document has been signed by a signer

meta Object
If specified, this object contains a sub array for each custom field specified for the requested document.

Get Document/Template HTTP GET

API Request

Please find below an example HTTP GET request accessing an existing document or template:

https://api.eversign.com/api/document ? access_key = YOUR_ACCESS_KEY & business_id = 1 & document_hash = j6yMcaF2gQAIIQ

API Response

{ "document_hash": "A4X5GeinpUtjhz", "requester_email": "your@email.com", "custom_requester_name": "", "custom_requester_email": "", "is_draft": 0, "is_template": 0, "is_completed": 0, "is_archived": 0, "is_deleted": 0, "is_trashed": 0, "is_cancelled": 0, "embedded": 0, "in_person": 0, "permission": "", "template_id": "", "title": "Sample Document", "message": "This is my general document message.", "use_signer_order": 1, "reminders": 1, "require_all_signers": 1, "redirect": "https://myredirect.com/completed", "redirect_decline": "https://myredirect.com/declined", "client": "", "created": 1491822481, "expires": 1494276966, "embedded_signing_enabled": 0, "flexible_signing": 0, "files": [{ "name": "My Document File", "file_id": "FMA4SyCuHjrusK", "pages": 3 }], "signers": [{ "id": 1, "name": "Paul McSign", "email": "paul@mcsign.com", "role": "", "order": 1, "pin": 3874, "message": "This is my custom message to Paul.", "signed": 0, "signed_timestamp": "", "required": 0, "deliver_email": "", "language": "en", "declined": 0, "removed": 0, "bounced": 0, "sent": 1, "viewed": 0, "status": "waiting_for_signature" }, { "id": 2, "name": "Julian McSign", "email": "julian@mcsign.com", "role": "", "order": 2, "pin": 3944, "message": "", "signed": 0, "signed_timestamp": "", "required": 0, "deliver_email": "", "language": "en", "declined": 0, "removed": 0, "bounced": 0, "sent": 0, "viewed": 0, "status": "on_hold" }], "recipients": [{ "name": "Jane McSign", "email": "jane@mcsign.com", "role": "", "message": "", "required": 0, "language": "en", }, { "name": "Frank McSign", "email": "frank@mcsign.com", "role": "", "message": "", "required": 0, "language": "en", }], "fields": [ [{ "merge": 0, "identifier": "unique_field_identifier_1", "name": "", "options": "", "group": "", "value": "", "type": "signature", "x": 120.43811219947, "y": 479.02760463045, "page": 2, "width": 120, "height": 35, "signer": 1, "validation_type": "", "required": 1, "readonly": 0, "text_size": "", "text_color": "", "text_style": "", "text_font": "", "files": "" }, { "merge": 0, "identifier": "unique_field_identifier_2", "name": "", "options": "", "group": "", "value": "", "type": "signature", "x": 363.49421193232, "y": 479.57257346394, "page": 2, "width": 120, "height": 35, "signer": 2, "validation_type": "", "required": 1, "readonly": 0, "text_size": "", "text_color": "", "text_style": "", "text_font": "", "files": "" }, { "merge": 0, "identifier": "unique_field_identifier_3", "name": "Full Name", "options": "", "group": "", "value": "", "type": "text", "x": 97.549421193232, "y": 123.70792520036, "page": 1, "width": 55, "height": 17, "signer": 1, "validation_type": "", "required": 1, "readonly": 0, "text_size": 10, "text_color": "#000000", "text_style": "", "text_font": "arial", "files": "" }, { "merge": 0, "identifier": "unique_field_identifier_4", "name": "Full Name", "options": "", "group": "", "value": "", "type": "text", "x": 276.29919857524, "y": 123.16295636687, "page": 1, "width": 55, "height": 17, "signer": 2, "validation_type": "letters_only", "required": 1, "readonly": 0, "text_size": 10, "text_color": "#000000", "text_style": "", "text_font": "arial", "files": "" }, { "merge": 0, "identifier": "unique_field_identifier_5", "name": "Dropdown", "options": [ "Option 1", "Option 2", "Option 3" ], "group": "", "value": "Option 1", "type": "dropdown", "x": 440.4, "y": 204.2, "page": 2, "width": 92, "height": 23, "signer": 1, "validation_type": "", "required": 1, "readonly": 0, "text_size": "", "text_color": "", "text_style": "", "text_font": "", "files": "" }] ], "log": [{ "event": "document_created", "signer": "", "timestamp": 1491822484 }, { "event": "document_sent", "signer": 1, "timestamp": 1491822485 }], "meta": { "some_key": "some_value", "another_key": "another_value" } }

List Documents

A list of existing documents can be accessed by making a simple HTTP GET call. By appending the API's type parameter to the API request URL and setting it to a document status you can filter your results accordingly.

type Parameter: This parameter accepts the following status values:

  • all
  • my_action_required
  • waiting_for_others
  • completed
  • drafts
  • cancelled

List Documents HTTP GET

API Request

Please find below an example HTTP GET request accessing a list of all existing documents:

https://api.eversign.com/api/document ? access_key = YOUR_ACCESS_KEY & business_id = 1 & type = all

API Response

If a successful request is made, the eversign API will return an array containing all existing documents.

List Templates

In order to access a list of templates, please set the API's type parameter to templates, or to one of the other allowed status values.

type Parameter: This parameter accepts the following status values:

  • templates
  • templates_archived
  • template_drafts





List Templates HTTP GET

API Request

Please find below an example HTTP GET request accessing a list of all existing documents:

https://api.eversign.com/api/document ? access_key = YOUR_ACCESS_KEY & business_id = 1 & type = templates

API Response

If a successful request is made, the eversign API will return an array containing all existing templates.

Send Reminder

A reminder can be sent on a per-signer basis only. In order to send a reminder to an individual signer, a simple HTTP POST request to the API's send_reminder endpoint is required.

The following two parameters must be contained in the HTTP POST request:

Name Description Details
document_hash The unique hash (ID) of the document to send a reminder for. Required
signer_id The ID of the signer to send a reminder to. Required











Send Reminder HTTP POST

API Request

https://api.eversign.com/api/send_reminder ? access_key = YOUR_ACCESS_KEY & business_id = 1
{ "document_hash": "j6yMcaF2gQBIIS", "signer_id": "1" }

API Response

If successful, the API will return the following response:

{ "success": true, }

Delete Document/Template

A document or template can be deleted by making an HTTP DELETE call to API's document endpoint and appending the document_hash GET parameter containing the document or template hash.

Only status cancelled or draft Please note that only cancelled documents and draft documents or templates can be deleted.









Delete Document/Template HTTP DELETE

API Request

https://api.eversign.com/api/document ? access_key = YOUR_ACCESS_KEY & business_id = 1 & document_hash = j6yMcaF2gQBIIS

API Response

If successful, the API will return the following response:

{ "success": true, }

Cancel Document

A document can be cancelled by making an HTTP DELETE call to the API's document endpoint and appending both the document_hash GET parameter containing the document hash and the cancel GET parameter and setting it to 1.














Cancel Document HTTP DELETE

API Request

https://api.eversign.com/api/document ? access_key = YOUR_ACCESS_KEY & business_id = 1 & document_hash = j6yMcaF2gQBIIS & cancel = 1

API Response

If successful, the API will return the following response:

{ "success": true, }

Download Original PDF

The original PDF file of a document can be downloaded by making an HTTP GET request to the API's download_raw_document endpoint and setting the document_hash HTTP GET parameter to the hash of the document you would like to download.










Download Original PDF HTTP GET

API Request

https://api.eversign.com/api/download_raw_document ? access_key = YOUR_ACCESS_KEY & business_id = 1 & document_hash = j6yMcaF2gQBIIS

API Response

If successful, the eversign API will return the original version of the requested document as PDF.

Download Final PDF

The final PDF version of a document can be downloaded by making an HTTP GET request to the API's download_final_document endpoint and setting the document_hash HTTP GET parameter to the hash of the document you would like to download.

Additionally, by appending the API's audit_trail HTTP GET parameter and setting it to 1 your final PDF will come with an attached Audit Trail document.








Download Final PDF HTTP GET

API Request

https://api.eversign.com/api/download_final_document ? access_key = YOUR_ACCESS_KEY & business_id = 1 & document_hash = j6yMcaF2gQBIIS & audit_trail = 1

API Response

If successful, the eversign API will return the final version of the requested document as PDF.

Upload File

Document files can be uploaded to your eversign business by making an HTTP POST request containing the file content to the API's file endpoint. The API will then return a unique file_id that can be re-used when creating documents via the API.

API Response Objects:

Name Description
file_id Returns the file's unique identification hash.
total_pages Returns the number of document pages.
















Upload File HTTP POST

API Request

In order to upload a file, please send a multipart/form-data request containing the key parameter named upload and the file as value via HTTP POST request to the following URL:

https://api.eversign.com/api/file ? access_key = YOUR_ACCESS_KEY & business_id = 1

API Response

If successful, the API will return a response object containing an ID for the uploaded file, the number of pages and an array containing an URL to each document page converted to PNG.

{ "file_id": "lZJk9QZ8ze3777", "total_pages": 3 }

Errors

Whenever an API request to the eversign API fails, an error will be returned. Errors always carry "success": false, an error code, a type object and an info string.









Sample Error

Please find below an example error message returned by the eversign API:

{ "success": false, "error": { "code": 103, "type": "invalid_api_function", "info": "This API Function does not exist." } }