E-Sign
E-Sign Anything. Anywhere. It's easy to e-sign and send your documents on any device with our secure electronic signature system.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | E-Sign Support |
| URL | https://www.e-sign.co.uk |
| support@e-sign.co.uk |
| Connector Metadata | |
|---|---|
| Publisher | E-Sign |
| Website | https://www.e-sign.co.uk |
| Privacy policy | https://www.e-sign.co.uk/privacy/ |
| Categories | Website |
Prerequisites
In order use this connector you must have a paid E-Sign account on the E-Sign platform. You can setup an account here https://app.e-sign.co.uk/#/register/11.
How to get credentials
The E-Sign API uses OAuth 2 to authenticate so once account is setup no additional steps are required.
Getting started with your connector
- Upload a file to E-Sign: This action takes a base64 string and uploads it the E-Sign platform
- Create a document from template: This action creates a new document, using the selected template.
Send a document for signing when a new email with an attachment is received from Microsoft Outlook or Gmail as shown below.

Known issues and limitations
In order for the upload function to work currently a String variable must be initialised and then declared. This is shown in the example above, this will allow a document to be uploaded to the E-Sign platform, and then be used for the new document.
API documentation
https://api.e-sign.co.uk/v3/index.html
FAQ
https://www.e-sign.co.uk/support/faqs/ https://www.e-sign.co.uk/contact-us/
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Create Envelope |
Create and send a new E-Sign envelope |
| Create Envelope From Template |
Create a new envelope for signing using one of your E-Sign templates. |
| Upload File to E-Sign Action |
Uploads a file to the E-Sign platform which can be used to create a document for signing |
Create Envelope
Create and send a new E-Sign envelope
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
title
|
title | True | string |
individual document title |
|
subject
|
subject | string |
Envelope subject |
|
|
description
|
description | string |
Envelope description |
|
|
title
|
title | True | string |
Envelope title |
|
id
|
id | True | string |
Previously uploaded file uuid |
|
id
|
id | string |
id |
|
|
signer_email
|
signer_email | string |
signer_email |
|
|
field_type
|
field_type | string |
field_type |
|
|
field_required
|
field_required | boolean |
field_required |
|
|
field_placeholder
|
field_placeholder | string |
field_placeholder |
|
|
field_value
|
field_value | string |
field_value |
|
|
x
|
x | string |
x |
|
|
y
|
y | string |
y |
|
|
page
|
page | integer |
page |
|
|
name
|
name | True | string |
signers name |
|
email
|
True | string |
signers email |
|
|
sign_in_sequential_order
|
sign_in_sequential_order | boolean |
sign_in_sequential_order |
|
|
name
|
name | string |
name |
|
|
email
|
string |
|
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
title
|
title | string |
title |
|
subject
|
subject | string |
subject |
|
description
|
description | string |
description |
|
envelope_status
|
envelope_status | string |
envelope_status |
|
href
|
href | string |
href |
|
language
|
language | string |
language |
|
thumbnail
|
thumbnail | string |
thumbnail |
|
documents
|
documents | array of object |
documents |
|
id
|
documents.id | string |
id |
|
title
|
documents.title | string |
title |
|
document_status
|
documents.document_status | string |
document_status |
|
id
|
documents.upload_file.id | string |
id |
|
uri
|
documents.upload_file.uri | string |
uri |
|
file_name
|
documents.upload_file.file_name | string |
file_name |
|
file_size
|
documents.upload_file.file_size | integer |
file_size |
|
processing
|
documents.upload_file.processing | boolean |
processing |
|
date_created
|
documents.upload_file.date_created | string |
date_created |
|
pages
|
documents.upload_file.pages | integer |
pages |
|
thumbnail
|
documents.upload_file.thumbnail | string |
thumbnail |
|
type
|
documents.upload_file.type | string |
type |
|
href
|
documents.upload_file.href | string |
href |
|
images
|
documents.upload_file.images | array of object |
images |
|
url
|
documents.upload_file.images.url | string |
url |
|
thumb_url
|
documents.upload_file.images.thumb_url | string |
thumb_url |
|
uri
|
documents.document_file.uri | string |
uri |
|
pages
|
documents.document_file.pages | integer |
pages |
|
signature_certificate_page
|
documents.document_file.signature_certificate_page | integer |
signature_certificate_page |
|
images
|
documents.document_file.images | array of object |
images |
|
url
|
documents.document_file.images.url | string |
url |
|
thumb_url
|
documents.document_file.images.thumb_url | string |
thumb_url |
|
attachment_files
|
documents.attachment_files | array of object |
attachment_files |
|
id
|
documents.attachment_files.id | string |
id |
|
uri
|
documents.attachment_files.uri | string |
uri |
|
file_name
|
documents.attachment_files.file_name | string |
file_name |
|
file_size
|
documents.attachment_files.file_size | integer |
file_size |
|
processing
|
documents.attachment_files.processing | boolean |
processing |
|
date_created
|
documents.attachment_files.date_created | string |
date_created |
|
pages
|
documents.attachment_files.pages | integer |
pages |
|
thumbnail
|
documents.attachment_files.thumbnail | string |
thumbnail |
|
type
|
documents.attachment_files.type | string |
type |
|
href
|
documents.attachment_files.href | string |
href |
|
images
|
documents.attachment_files.images | array of object |
images |
|
url
|
documents.attachment_files.images.url | string |
url |
|
thumb_url
|
documents.attachment_files.images.thumb_url | string |
thumb_url |
|
last_interaction
|
documents.last_interaction | string |
last_interaction |
|
document_fields
|
documents.document_fields | array of object |
document_fields |
|
id
|
documents.document_fields.id | string |
id |
|
signer_email
|
documents.document_fields.signer_email | string |
signer_email |
|
signer_id
|
documents.document_fields.signer_id | string |
signer_id |
|
field_type
|
documents.document_fields.field_type | string |
field_type |
|
field_required
|
documents.document_fields.field_required | boolean |
field_required |
|
field_placeholder
|
documents.document_fields.field_placeholder | string |
field_placeholder |
|
field_amount
|
documents.document_fields.field_amount | string |
field_amount |
|
field_value
|
documents.document_fields.field_value | string |
field_value |
|
field_dropdown_options
|
documents.document_fields.field_dropdown_options | array of string |
field_dropdown_options |
|
x
|
documents.document_fields.document_position.x | string |
x |
|
y
|
documents.document_fields.document_position.y | string |
y |
|
width
|
documents.document_fields.document_position.width | string |
width |
|
height
|
documents.document_fields.document_position.height | string |
height |
|
size
|
documents.document_fields.document_position.size | string |
size |
|
page
|
documents.document_fields.document_position.page | integer |
page |
|
signers
|
signers | array of object |
signers |
|
id
|
signers.id | string |
id |
|
name
|
signers.name | string |
name |
|
email
|
signers.email | string |
|
|
last
|
signers.viewed.last | string |
last |
|
amount_of_times
|
signers.viewed.amount_of_times | integer |
amount_of_times |
|
status
|
signers.envelope_status.status | string |
status |
|
signed_at
|
signers.envelope_status.signed_at | string |
signed_at |
|
declined_at
|
signers.envelope_status.declined_at | string |
declined_at |
|
individual_document_status
|
signers.individual_document_status | array of object |
individual_document_status |
|
document_id
|
signers.individual_document_status.document_id | string |
document_id |
|
status
|
signers.individual_document_status.status | string |
status |
|
signed_at
|
signers.individual_document_status.signed_at | string |
signed_at |
|
declined_at
|
signers.individual_document_status.declined_at | string |
declined_at |
|
declined_reason
|
signers.individual_document_status.declined_reason | string |
declined_reason |
|
authenticated_user
|
signers.signer_details.authenticated_user | boolean |
authenticated_user |
|
current_sequential_signer
|
signers.signer_details.current_sequential_signer | boolean |
current_sequential_signer |
|
registered_user
|
signers.signer_details.registered_user | boolean |
registered_user |
|
id_checker_document
|
signers.signer_details.id_checker_document | string |
id_checker_document |
|
dont_send_signing_emails
|
envelope_options.dont_send_signing_emails | boolean |
dont_send_signing_emails |
|
sign_in_sequential_order
|
envelope_options.sign_in_sequential_order | boolean |
sign_in_sequential_order |
|
last_interaction
|
envelope_meta.last_interaction | string |
last_interaction |
|
created_at
|
envelope_meta.created_at | string |
created_at |
|
audit_trail
|
envelope_meta.audit_trail | array of object |
audit_trail |
|
type
|
envelope_meta.audit_trail.type | string |
type |
|
datetime
|
envelope_meta.audit_trail.datetime | string |
datetime |
|
action
|
envelope_meta.audit_trail.action | string |
action |
|
name
|
envelope_meta.audit_trail.concern.name | string |
name |
|
email_address
|
envelope_meta.audit_trail.concern.email_address | string |
email_address |
|
instance
|
envelope_meta.audit_trail.resource.instance | string |
instance |
|
name
|
envelope_meta.audit_trail.resource.name | string |
name |
|
id
|
envelope_meta.audit_trail.resource.id | string |
id |
|
name
|
envelope_meta.author.name | string |
name |
|
email
|
envelope_meta.author.email | string |
|
|
tags
|
tags | array of object |
tags |
|
id
|
tags.id | string |
id |
|
name
|
tags.name | string |
name |
Create Envelope From Template
Create a new envelope for signing using one of your E-Sign templates.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
template id
|
id | string |
The UUID of the template (required unless template title) |
|
|
template title
|
template_title | string |
The title of the template (required unless template ID) |
|
|
upload_file
|
upload_file | string |
uploaded file id |
|
|
subject
|
subject | string |
template subject overrides the saved template title |
|
|
name
|
name | string |
signers name |
|
|
email
|
string |
signers email |
Returns
Upload File to E-Sign Action
Uploads a file to the E-Sign platform which can be used to create a document for signing
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
base64
|
base64 | True | string |
base64 |
|
title
|
title | True | string |
title |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
id |
|
title
|
title | string |
title |
|
subject
|
subject | string |
subject |
|
description
|
description | string |
description |
|
envelope_status
|
envelope_status | string |
envelope_status |
|
href
|
href | string |
href |
|
language
|
language | string |
language |
|
thumbnail
|
thumbnail | string |
thumbnail |
|
documents
|
documents | array of object |
documents |
|
id
|
documents.id | string |
id |
|
title
|
documents.title | string |
title |
|
document_status
|
documents.document_status | string |
document_status |
|
id
|
documents.upload_file.id | string |
id |
|
uri
|
documents.upload_file.uri | string |
uri |
|
file_name
|
documents.upload_file.file_name | string |
file_name |
|
file_size
|
documents.upload_file.file_size | integer |
file_size |
|
processing
|
documents.upload_file.processing | boolean |
processing |
|
date_created
|
documents.upload_file.date_created | string |
date_created |
|
pages
|
documents.upload_file.pages | integer |
pages |
|
thumbnail
|
documents.upload_file.thumbnail | string |
thumbnail |
|
type
|
documents.upload_file.type | string |
type |
|
href
|
documents.upload_file.href | string |
href |
|
images
|
documents.upload_file.images | array of object |
images |
|
url
|
documents.upload_file.images.url | string |
url |
|
thumb_url
|
documents.upload_file.images.thumb_url | string |
thumb_url |
|
uri
|
documents.document_file.uri | string |
uri |
|
pages
|
documents.document_file.pages | integer |
pages |
|
signature_certificate_page
|
documents.document_file.signature_certificate_page | integer |
signature_certificate_page |
|
images
|
documents.document_file.images | array of object |
images |
|
url
|
documents.document_file.images.url | string |
url |
|
thumb_url
|
documents.document_file.images.thumb_url | string |
thumb_url |
|
attachment_files
|
documents.attachment_files | array of object |
attachment_files |
|
id
|
documents.attachment_files.id | string |
id |
|
uri
|
documents.attachment_files.uri | string |
uri |
|
file_name
|
documents.attachment_files.file_name | string |
file_name |
|
file_size
|
documents.attachment_files.file_size | integer |
file_size |
|
processing
|
documents.attachment_files.processing | boolean |
processing |
|
date_created
|
documents.attachment_files.date_created | string |
date_created |
|
pages
|
documents.attachment_files.pages | integer |
pages |
|
thumbnail
|
documents.attachment_files.thumbnail | string |
thumbnail |
|
type
|
documents.attachment_files.type | string |
type |
|
href
|
documents.attachment_files.href | string |
href |
|
images
|
documents.attachment_files.images | array of object |
images |
|
url
|
documents.attachment_files.images.url | string |
url |
|
thumb_url
|
documents.attachment_files.images.thumb_url | string |
thumb_url |
|
last_interaction
|
documents.last_interaction | string |
last_interaction |
|
document_fields
|
documents.document_fields | array of object |
document_fields |
|
id
|
documents.document_fields.id | string |
id |
|
signer_email
|
documents.document_fields.signer_email | string |
signer_email |
|
signer_id
|
documents.document_fields.signer_id | string |
signer_id |
|
field_type
|
documents.document_fields.field_type | string |
field_type |
|
field_required
|
documents.document_fields.field_required | boolean |
field_required |
|
field_placeholder
|
documents.document_fields.field_placeholder | string |
field_placeholder |
|
field_amount
|
documents.document_fields.field_amount | string |
field_amount |
|
field_value
|
documents.document_fields.field_value | string |
field_value |
|
field_dropdown_options
|
documents.document_fields.field_dropdown_options | array of string |
field_dropdown_options |
|
x
|
documents.document_fields.document_position.x | string |
x |
|
y
|
documents.document_fields.document_position.y | string |
y |
|
width
|
documents.document_fields.document_position.width | string |
width |
|
height
|
documents.document_fields.document_position.height | string |
height |
|
size
|
documents.document_fields.document_position.size | string |
size |
|
page
|
documents.document_fields.document_position.page | integer |
page |
|
signers
|
signers | array of object |
signers |
|
id
|
signers.id | string |
id |
|
name
|
signers.name | string |
name |
|
email
|
signers.email | string |
|
|
last
|
signers.viewed.last | string |
last |
|
amount_of_times
|
signers.viewed.amount_of_times | integer |
amount_of_times |
|
status
|
signers.envelope_status.status | string |
status |
|
signed_at
|
signers.envelope_status.signed_at | string |
signed_at |
|
declined_at
|
signers.envelope_status.declined_at | string |
declined_at |
|
individual_document_status
|
signers.individual_document_status | array of object |
individual_document_status |
|
document_id
|
signers.individual_document_status.document_id | string |
document_id |
|
status
|
signers.individual_document_status.status | string |
status |
|
signed_at
|
signers.individual_document_status.signed_at | string |
signed_at |
|
declined_at
|
signers.individual_document_status.declined_at | string |
declined_at |
|
declined_reason
|
signers.individual_document_status.declined_reason | string |
declined_reason |
|
authenticated_user
|
signers.signer_details.authenticated_user | boolean |
authenticated_user |
|
current_sequential_signer
|
signers.signer_details.current_sequential_signer | boolean |
current_sequential_signer |
|
registered_user
|
signers.signer_details.registered_user | boolean |
registered_user |
|
id_checker_document
|
signers.signer_details.id_checker_document | string |
id_checker_document |
|
dont_send_signing_emails
|
envelope_options.dont_send_signing_emails | boolean |
dont_send_signing_emails |
|
sign_in_sequential_order
|
envelope_options.sign_in_sequential_order | boolean |
sign_in_sequential_order |
|
last_interaction
|
envelope_meta.last_interaction | string |
last_interaction |
|
created_at
|
envelope_meta.created_at | string |
created_at |
|
audit_trail
|
envelope_meta.audit_trail | array of object |
audit_trail |
|
type
|
envelope_meta.audit_trail.type | string |
type |
|
datetime
|
envelope_meta.audit_trail.datetime | string |
datetime |
|
action
|
envelope_meta.audit_trail.action | string |
action |
|
name
|
envelope_meta.audit_trail.concern.name | string |
name |
|
email_address
|
envelope_meta.audit_trail.concern.email_address | string |
email_address |
|
instance
|
envelope_meta.audit_trail.resource.instance | string |
instance |
|
name
|
envelope_meta.audit_trail.resource.name | string |
name |
|
id
|
envelope_meta.audit_trail.resource.id | string |
id |
|
name
|
envelope_meta.author.name | string |
name |
|
email
|
envelope_meta.author.email | string |
|
|
tags
|
tags | array of object |
tags |
|
name
|
tags.name | string |
name |
Triggers
| Completed Envelope |
When an envelope is fully completed by all signees |
| Created Envelope |
When a new envelope is created within E-Sign |
| Signee Signs |
When an individual signer signs a document of the Envelope |
Completed Envelope
When an envelope is fully completed by all signees
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
event
|
event | string |
event |
|
id
|
envelope.id | string |
id |
|
title
|
envelope.title | string |
title |
|
subject
|
envelope.subject | string |
subject |
|
description
|
envelope.description | string |
description |
|
envelope_status
|
envelope.envelope_status | string |
envelope_status |
|
href
|
envelope.href | string |
href |
|
language
|
envelope.language | string |
language |
|
documents
|
envelope.documents | array of object |
documents |
|
id
|
envelope.documents.id | string |
id |
|
title
|
envelope.documents.title | string |
title |
|
document_status
|
envelope.documents.document_status | string |
document_status |
|
id
|
envelope.documents.upload_file.id | string |
id |
|
uri
|
envelope.documents.upload_file.uri | string |
uri |
|
file_name
|
envelope.documents.upload_file.file_name | string |
file_name |
|
file_size
|
envelope.documents.upload_file.file_size | integer |
file_size |
|
processing
|
envelope.documents.upload_file.processing | boolean |
processing |
|
date_created
|
envelope.documents.upload_file.date_created | string |
date_created |
|
pages
|
envelope.documents.upload_file.pages | integer |
pages |
|
thumbnail
|
envelope.documents.upload_file.thumbnail | string |
thumbnail |
|
type
|
envelope.documents.upload_file.type | string |
type |
|
href
|
envelope.documents.upload_file.href | string |
href |
|
uri
|
envelope.documents.document_file.uri | string |
uri |
|
pages
|
envelope.documents.document_file.pages | integer |
pages |
|
signature_certificate_page
|
envelope.documents.document_file.signature_certificate_page | integer |
signature_certificate_page |
|
attachment_files
|
envelope.documents.attachment_files | array of object |
attachment_files |
|
id
|
envelope.documents.attachment_files.id | string |
id |
|
uri
|
envelope.documents.attachment_files.uri | string |
uri |
|
file_name
|
envelope.documents.attachment_files.file_name | string |
file_name |
|
file_size
|
envelope.documents.attachment_files.file_size | integer |
file_size |
|
processing
|
envelope.documents.attachment_files.processing | boolean |
processing |
|
date_created
|
envelope.documents.attachment_files.date_created | string |
date_created |
|
pages
|
envelope.documents.attachment_files.pages | integer |
pages |
|
thumbnail
|
envelope.documents.attachment_files.thumbnail | string |
thumbnail |
|
type
|
envelope.documents.attachment_files.type | string |
type |
|
href
|
envelope.documents.attachment_files.href | string |
href |
|
last_interaction
|
envelope.documents.last_interaction | string |
last_interaction |
|
document_fields
|
envelope.documents.document_fields | array of object |
document_fields |
|
id
|
envelope.documents.document_fields.id | string |
id |
|
signer_email
|
envelope.documents.document_fields.signer_email | string |
signer_email |
|
signer_id
|
envelope.documents.document_fields.signer_id | string |
signer_id |
|
field_type
|
envelope.documents.document_fields.field_type | string |
field_type |
|
field_required
|
envelope.documents.document_fields.field_required | boolean |
field_required |
|
field_placeholder
|
envelope.documents.document_fields.field_placeholder | string |
field_placeholder |
|
field_amount
|
envelope.documents.document_fields.field_amount | string |
field_amount |
|
field_value
|
envelope.documents.document_fields.field_value | string |
field_value |
|
field_dropdown_options
|
envelope.documents.document_fields.field_dropdown_options | array of string |
field_dropdown_options |
|
x
|
envelope.documents.document_fields.document_position.x | string |
x |
|
y
|
envelope.documents.document_fields.document_position.y | string |
y |
|
width
|
envelope.documents.document_fields.document_position.width | string |
width |
|
height
|
envelope.documents.document_fields.document_position.height | string |
height |
|
size
|
envelope.documents.document_fields.document_position.size | string |
size |
|
page
|
envelope.documents.document_fields.document_position.page | integer |
page |
|
signers
|
envelope.signers | array of object |
signers |
|
id
|
envelope.signers.id | string |
id |
|
name
|
envelope.signers.name | string |
name |
|
email
|
envelope.signers.email | string |
|
|
last
|
envelope.signers.viewed.last | string |
last |
|
amount_of_times
|
envelope.signers.viewed.amount_of_times | integer |
amount_of_times |
Created Envelope
When a new envelope is created within E-Sign
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
event
|
event | string |
event |
|
id
|
envelope.id | string |
id |
|
title
|
envelope.title | string |
title |
|
subject
|
envelope.subject | string |
subject |
|
description
|
envelope.description | string |
description |
|
envelope_status
|
envelope.envelope_status | string |
envelope_status |
|
href
|
envelope.href | string |
href |
|
language
|
envelope.language | string |
language |
|
documents
|
envelope.documents | array of object |
documents |
|
id
|
envelope.documents.id | string |
id |
|
title
|
envelope.documents.title | string |
title |
|
document_status
|
envelope.documents.document_status | string |
document_status |
|
id
|
envelope.documents.upload_file.id | string |
id |
|
uri
|
envelope.documents.upload_file.uri | string |
uri |
|
file_name
|
envelope.documents.upload_file.file_name | string |
file_name |
|
file_size
|
envelope.documents.upload_file.file_size | integer |
file_size |
|
processing
|
envelope.documents.upload_file.processing | boolean |
processing |
|
date_created
|
envelope.documents.upload_file.date_created | string |
date_created |
|
pages
|
envelope.documents.upload_file.pages | integer |
pages |
|
thumbnail
|
envelope.documents.upload_file.thumbnail | string |
thumbnail |
|
type
|
envelope.documents.upload_file.type | string |
type |
|
href
|
envelope.documents.upload_file.href | string |
href |
|
uri
|
envelope.documents.document_file.uri | string |
uri |
|
pages
|
envelope.documents.document_file.pages | integer |
pages |
|
signature_certificate_page
|
envelope.documents.document_file.signature_certificate_page | integer |
signature_certificate_page |
|
attachment_files
|
envelope.documents.attachment_files | array of object |
attachment_files |
|
id
|
envelope.documents.attachment_files.id | string |
id |
|
uri
|
envelope.documents.attachment_files.uri | string |
uri |
|
file_name
|
envelope.documents.attachment_files.file_name | string |
file_name |
|
file_size
|
envelope.documents.attachment_files.file_size | integer |
file_size |
|
processing
|
envelope.documents.attachment_files.processing | boolean |
processing |
|
date_created
|
envelope.documents.attachment_files.date_created | string |
date_created |
|
pages
|
envelope.documents.attachment_files.pages | integer |
pages |
|
thumbnail
|
envelope.documents.attachment_files.thumbnail | string |
thumbnail |
|
type
|
envelope.documents.attachment_files.type | string |
type |
|
href
|
envelope.documents.attachment_files.href | string |
href |
|
last_interaction
|
envelope.documents.last_interaction | string |
last_interaction |
|
document_fields
|
envelope.documents.document_fields | array of object |
document_fields |
|
id
|
envelope.documents.document_fields.id | string |
id |
|
signer_email
|
envelope.documents.document_fields.signer_email | string |
signer_email |
|
signer_id
|
envelope.documents.document_fields.signer_id | string |
signer_id |
|
field_type
|
envelope.documents.document_fields.field_type | string |
field_type |
|
field_required
|
envelope.documents.document_fields.field_required | boolean |
field_required |
|
field_placeholder
|
envelope.documents.document_fields.field_placeholder | string |
field_placeholder |
|
field_amount
|
envelope.documents.document_fields.field_amount | string |
field_amount |
|
field_value
|
envelope.documents.document_fields.field_value | string |
field_value |
|
field_dropdown_options
|
envelope.documents.document_fields.field_dropdown_options | array of string |
field_dropdown_options |
|
x
|
envelope.documents.document_fields.document_position.x | string |
x |
|
y
|
envelope.documents.document_fields.document_position.y | string |
y |
|
width
|
envelope.documents.document_fields.document_position.width | string |
width |
|
height
|
envelope.documents.document_fields.document_position.height | string |
height |
|
size
|
envelope.documents.document_fields.document_position.size | string |
size |
|
page
|
envelope.documents.document_fields.document_position.page | integer |
page |
|
signers
|
envelope.signers | array of object |
signers |
|
id
|
envelope.signers.id | string |
id |
|
name
|
envelope.signers.name | string |
name |
|
email
|
envelope.signers.email | string |
|
|
last
|
envelope.signers.viewed.last | string |
last |
|
amount_of_times
|
envelope.signers.viewed.amount_of_times | integer |
amount_of_times |
Signee Signs
When an individual signer signs a document of the Envelope
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
uuid
|
signer.uuid | string |
uuid |
|
name
|
signer.name | string |
name |
|
email_address
|
signer.email_address | string |
email_address |
|
signed_at
|
signer.signed_at | string |
signed_at |
|
declined_at
|
signer.declined_at | string |
declined_at |
|
declined_reason
|
signer.declined_reason | string |
declined_reason |
|
response_ip
|
signer.response_ip | string |
response_ip |
|
response_os
|
signer.response_os | string |
response_os |
|
response_browser
|
signer.response_browser | string |
response_browser |
|
response_browser_version
|
signer.response_browser_version | integer |
response_browser_version |
|
required_additional_fields
|
signer.required_additional_fields | array of |
required_additional_fields |
|
document_status
|
document_status | string |
document_status |
|
document_uuid
|
document_uuid | string |
document_uuid |
|
event_name
|
event_name | string |
event_name |