Connectors Reference

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.

 

Status: Preview

Tier: Premium

Version: 2.0

 

Actions:

Name

Summary

UploadFile ([internal]string Content-Type, UploadFileParameterBody body)

Upload File to E-Sign Action

CreateEnvelopeFromTemplate ([internal]string Content-Type, CreateEnvelopeFromTemplateParameterBody body)

Create Envelope From Template

CreateEnvelope ([internal]string Content-Type, CreateEnvelopeParameterBody body)

Create Envelope

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

CreateEnvelopeFromTemplateParameterBody

 

CreateEnvelopeFromTemplateResponse

 

CreateEnvelopeParameterBody

 

CreateEnvelopeResponse

 

UploadFileParameterBody

 

UploadFileResponse

 

 

Actions:

UploadFile

Summary: Upload File to E-Sign Action

Description: Uploads a file to the E-Sign platform which can be used to create a document for signing

 

Syntax:

E-Sign.UploadFile ([internal]string Content-Type, UploadFileParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

UploadFileParameterBody

 

 

True

 

Returns:

††††††††† Type:UploadFileResponse

 

CreateEnvelopeFromTemplate

Summary: Create Envelope From Template

Description: Create a new envelope for signing using one of your E-Sign templates.

 

Syntax:

E-Sign.CreateEnvelopeFromTemplate ([internal]string Content-Type, CreateEnvelopeFromTemplateParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

CreateEnvelopeFromTemplateParameterBody

 

 

True

 

Returns:

††††††††† Type:CreateEnvelopeFromTemplateResponse

 

CreateEnvelope

Summary: Create Envelope

Description: Create and send a new E-Sign envelope

 

Syntax:

E-Sign.CreateEnvelope ([internal]string Content-Type, CreateEnvelopeParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

 

 

True

body

CreateEnvelopeParameterBody

 

 

True

 

Returns:

††††††††† Type:CreateEnvelopeResponse

 


 

CreateEnvelopeFromTemplateParameterBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

The UUID of the template (required unless template title)

template_title

string

 

The title of the template (required unless template ID)

upload_file

string

 

uploaded file id

subject

string

 

template subject overrides the saved template title


 

CreateEnvelopeFromTemplateResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary


 

CreateEnvelopeParameterBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

title

string

 

individual document title

subject

string

 

Envelope subject

description

string

 

Envelope description

documents

array of (DocumentsItem)

 

documents

signers

array of (SignersItem)

 

signers

envelope_options

Envelope_options

 

envelope_options

carbon_copies

array of (Carbon_copiesItem)

 

carbon_copies

 

DocumentsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

title

string

 

Envelope title

upload_file

Upload_file

 

upload_file

attachment_files

array of (Attachment_filesItem)

 

attachment_files

document_fields

array of (Document_fieldsItem)

 

document_fields

 

Upload_file

Summary:

Description: upload_file

 

††††††††† Properties:

Name

Type

Summary

id

string

 

Previously uploaded file uuid

 

Attachment_filesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

 

Document_fieldsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

signer_email

string

 

signer_email

field_type

string

 

field_type

field_required

boolean

 

field_required

field_placeholder

string

 

field_placeholder

field_value

string

 

field_value

document_position

Document_position

 

document_position

 

Document_position

Summary:

Description: document_position

 

††††††††† Properties:

Name

Type

Summary

x

string

 

x

y

string

 

y

page

integer(int32)

 

page

 

SignersItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

name

string

 

signers name

email

string

 

signers email

 

Envelope_options

Summary:

Description: envelope_options

 

††††††††† Properties:

Name

Type

Summary

sign_in_sequential_order

boolean

 

sign_in_sequential_order† Values: [, ]

 

Carbon_copiesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

name

string

 

name

email

string

 

email

 


 

CreateEnvelopeResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

title

string

 

title

subject

string

 

subject

description

string

 

description

envelope_status

string

 

envelope_status

href

string

 

href

language

string

 

language

thumbnail

string

 

thumbnail

documents

array of (DocumentsItem)

 

documents

signers

array of (SignersItem)

 

signers

envelope_options

Envelope_options

 

envelope_options

envelope_meta

Envelope_meta

 

envelope_meta

tags

array of (TagsItem)

 

tags

 

DocumentsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

title

string

 

title

document_status

string

 

document_status

upload_file

Upload_file

 

upload_file

document_file

Document_file

 

document_file

attachment_files

array of (Attachment_filesItem)

 

attachment_files

last_interaction

string

 

last_interaction

document_fields

array of (Document_fieldsItem)

 

document_fields

 

Upload_file

Summary:

Description: upload_file

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

uri

string

 

uri

file_name

string

 

file_name

file_size

integer(int32)

 

file_size

processing

boolean

 

processing

date_created

string

 

date_created

pages

integer(int32)

 

pages

thumbnail

string

 

thumbnail

type

string

 

type

href

string

 

href

images

array of (ImagesItem)

 

images

 

ImagesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

url

string

 

url

thumb_url

string

 

thumb_url

 

Document_file

Summary:

Description: document_file

 

††††††††† Properties:

Name

Type

Summary

uri

string

 

uri

pages

integer(int32)

 

pages

signature_certificate_page

integer(int32)

 

signature_certificate_page

images

array of (ImagesItem)

 

images

 

ImagesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

url

string

 

url

thumb_url

string

 

thumb_url

 

Attachment_filesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

uri

string

 

uri

file_name

string

 

file_name

file_size

integer(int32)

 

file_size

processing

boolean

 

processing

date_created

string

 

date_created

pages

integer(int32)

 

pages

thumbnail

string

 

thumbnail

type

string

 

type

href

string

 

href

images

array of (ImagesItem)

 

images

 

ImagesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

url

string

 

url

thumb_url

string

 

thumb_url

 

Document_fieldsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

signer_email

string

 

signer_email

signer_id

string

 

signer_id

field_type

string

 

field_type

field_required

boolean

 

field_required

field_placeholder

string

 

field_placeholder

field_amount

string

 

field_amount

field_value

string

 

field_value

field_dropdown_options

array of (string)

 

field_dropdown_options

document_position

Document_position

 

document_position

 

Document_position

Summary:

Description: document_position

 

††††††††† Properties:

Name

Type

Summary

x

string

 

x

y

string

 

y

width

string

 

width

height

string

 

height

size

string

 

size

page

integer(int32)

 

page

 

SignersItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

name

string

 

name

email

string

 

email

viewed

Viewed

 

viewed

envelope_status

Envelope_status

 

envelope_status

individual_document_status

array of (Individual_document_statusItem)

 

individual_document_status

signer_details

Signer_details

 

signer_details

 

Viewed

Summary:

Description: viewed

 

††††††††† Properties:

Name

Type

Summary

last

string

 

last

amount_of_times

integer(int32)

 

amount_of_times

 

Envelope_status

Summary:

Description: envelope_status

 

††††††††† Properties:

Name

Type

Summary

status

string

 

status

signed_at

string

 

signed_at

declined_at

string

 

declined_at

 

Individual_document_statusItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

document_id

string

 

document_id

status

string

 

status

signed_at

string

 

signed_at

declined_at

string

 

declined_at

declined_reason

string

 

declined_reason

 

Signer_details

Summary:

Description: signer_details

 

††††††††† Properties:

Name

Type

Summary

authenticated_user

boolean

 

authenticated_user

current_sequential_signer

boolean

 

current_sequential_signer

registered_user

boolean

 

registered_user

id_checker_document

string

 

id_checker_document

 

Envelope_options

Summary:

Description: envelope_options

 

††††††††† Properties:

Name

Type

Summary

dont_send_signing_emails

boolean

 

dont_send_signing_emails

sign_in_sequential_order

boolean

 

sign_in_sequential_order

 

Envelope_meta

Summary:

Description: envelope_meta

 

††††††††† Properties:

Name

Type

Summary

last_interaction

string

 

last_interaction

created_at

string

 

created_at

audit_trail

array of (Audit_trailItem)

 

audit_trail

author

Author

 

author

 

Audit_trailItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

type

string

 

type

datetime

string

 

datetime

action

string

 

action

concern

Concern

 

concern

resource

Resource

 

resource

 

Concern

Summary:

Description: concern

 

††††††††† Properties:

Name

Type

Summary

name

string

 

name

email_address

string

 

email_address

 

Resource

Summary:

Description: resource

 

††††††††† Properties:

Name

Type

Summary

instance

string

 

instance

name

string

 

name

id

string

 

id

 

Author

Summary:

Description: author

 

††††††††† Properties:

Name

Type

Summary

name

string

 

name

email

string

 

email

 

TagsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

name

string

 

name

 


 

UploadFileParameterBody

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

base64

string

 

base64

extension

string

 

extension

title

string

 

title

type

string

 

type


 

UploadFileResponse

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

title

string

 

title

subject

string

 

subject

description

string

 

description

envelope_status

string

 

envelope_status

href

string

 

href

language

string

 

language

thumbnail

string

 

thumbnail

documents

array of (DocumentsItem)

 

documents

signers

array of (SignersItem)

 

signers

envelope_options

Envelope_options

 

envelope_options

envelope_meta

Envelope_meta

 

envelope_meta

tags

array of (TagsItem)

 

tags

 

DocumentsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

title

string

 

title

document_status

string

 

document_status

upload_file

Upload_file

 

upload_file

document_file

Document_file

 

document_file

attachment_files

array of (Attachment_filesItem)

 

attachment_files

last_interaction

string

 

last_interaction

document_fields

array of (Document_fieldsItem)

 

document_fields

 

Upload_file

Summary:

Description: upload_file

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

uri

string

 

uri

file_name

string

 

file_name

file_size

integer(int32)

 

file_size

processing

boolean

 

processing

date_created

string

 

date_created

pages

integer(int32)

 

pages

thumbnail

string

 

thumbnail

type

string

 

type

href

string

 

href

images

array of (ImagesItem)

 

images

 

ImagesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

url

string

 

url

thumb_url

string

 

thumb_url

 

Document_file

Summary:

Description: document_file

 

††††††††† Properties:

Name

Type

Summary

uri

string

 

uri

pages

integer(int32)

 

pages

signature_certificate_page

integer(int32)

 

signature_certificate_page

images

array of (ImagesItem)

 

images

 

ImagesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

url

string

 

url

thumb_url

string

 

thumb_url

 

Attachment_filesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

uri

string

 

uri

file_name

string

 

file_name

file_size

integer(int32)

 

file_size

processing

boolean

 

processing

date_created

string

 

date_created

pages

integer(int32)

 

pages

thumbnail

string

 

thumbnail

type

string

 

type

href

string

 

href

images

array of (ImagesItem)

 

images

 

ImagesItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

url

string

 

url

thumb_url

string

 

thumb_url

 

Document_fieldsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

signer_email

string

 

signer_email

signer_id

string

 

signer_id

field_type

string

 

field_type

field_required

boolean

 

field_required

field_placeholder

string

 

field_placeholder

field_amount

string

 

field_amount

field_value

string

 

field_value

field_dropdown_options

array of (string)

 

field_dropdown_options

document_position

Document_position

 

document_position

 

Document_position

Summary:

Description: document_position

 

††††††††† Properties:

Name

Type

Summary

x

string

 

x

y

string

 

y

width

string

 

width

height

string

 

height

size

string

 

size

page

integer(int32)

 

page

 

SignersItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

id

string

 

id

name

string

 

name

email

string

 

email

viewed

Viewed

 

viewed

envelope_status

Envelope_status

 

envelope_status

individual_document_status

array of (Individual_document_statusItem)

 

individual_document_status

signer_details

Signer_details

 

signer_details

 

Viewed

Summary:

Description: viewed

 

††††††††† Properties:

Name

Type

Summary

last

string

 

last

amount_of_times

integer(int32)

 

amount_of_times

 

Envelope_status

Summary:

Description: envelope_status

 

††††††††† Properties:

Name

Type

Summary

status

string

 

status

signed_at

string

 

signed_at

declined_at

string

 

declined_at

 

Individual_document_statusItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

document_id

string

 

document_id

status

string

 

status

signed_at

string

 

signed_at

declined_at

string

 

declined_at

declined_reason

string

 

declined_reason

 

Signer_details

Summary:

Description: signer_details

 

††††††††† Properties:

Name

Type

Summary

authenticated_user

boolean

 

authenticated_user

current_sequential_signer

boolean

 

current_sequential_signer

registered_user

boolean

 

registered_user

id_checker_document

string

 

id_checker_document

 

Envelope_options

Summary:

Description: envelope_options

 

††††††††† Properties:

Name

Type

Summary

dont_send_signing_emails

boolean

 

dont_send_signing_emails

sign_in_sequential_order

boolean

 

sign_in_sequential_order

 

Envelope_meta

Summary:

Description: envelope_meta

 

††††††††† Properties:

Name

Type

Summary

last_interaction

string

 

last_interaction

created_at

string

 

created_at

audit_trail

array of (Audit_trailItem)

 

audit_trail

author

Author

 

author

 

Audit_trailItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

type

string

 

type

datetime

string

 

datetime

action

string

 

action

concern

Concern

 

concern

resource

Resource

 

resource

 

Concern

Summary:

Description: concern

 

††††††††† Properties:

Name

Type

Summary

name

string

 

name

email_address

string

 

email_address

 

Resource

Summary:

Description: resource

 

††††††††† Properties:

Name

Type

Summary

instance

string

 

instance

name

string

 

name

id

string

 

id

 

Author

Summary:

Description: author

 

††††††††† Properties:

Name

Type

Summary

name

string

 

name

email

string

 

email

 

TagsItem

Summary:

Description:

 

††††††††† Properties:

Name

Type

Summary

name

string

 

name