Adobe Sign (Preview)

Adobe Sign (Preview)

Adobe is the most trusted digital document sign service in the world. With Adobe Sign, you can transform manual processes into all-digital experiences. Incorporate Adobe Sign functionality into your favorite applications to create, send and monitor the status of agreements.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Throttling Limits

Name Calls Renewal Period
API calls per connection 1000 60 seconds

Actions

Create a library template from a document URL

This operation creates a template in Adobe Sign library from a document URL. Use this template for sending agreements

Required Parameters

Template Name
string
Agreement Name used to identify the template
Template Type
string
A list of one or more library template types
Share with
string
Specifies who should have access to this library document
URL
string
A publicly accessible URL for retrieving the document
Name
string
The name of the referenced document, with extension

Optional Parameters

URL (2)
string
A publicly accessible URL for retrieving the document
Name (2)
string
The name of the referenced document, with extension
URL (3)
string
A publicly accessible URL for retrieving the document
Name (3)
string
The name of the referenced document, with extension
URL (4)
string
A publicly accessible URL for retrieving the document
Name (4)
string
The name of the referenced document, with extension
URL (5)
string
A publicly accessible URL for retrieving the document
Name (5)
string
The name of the referenced document, with extension
URL (6)
string
A publicly accessible URL for retrieving the document
Name (6)
string
The name of the referenced document, with extension
URL (7)
string
A publicly accessible URL for retrieving the document
Name (7)
string
The name of the referenced document, with extension
URL (8)
string
A publicly accessible URL for retrieving the document
Name (8)
string
The name of the referenced document, with extension

Returns

Body
LibraryDocumentCreationResponse

A JSON object describing the library template

Create a library template from an uploaded document

This operation creates a template in Adobe Sign library from an uploaded document. Use this template for sending agreements.

Required Parameters

Template Name
string
Agreement Name used to identify the template
Template Type
string
A list of one or more library template types
Share with
string
Specifies who should have access to this library document
Document ID
string
The document ID received by uploading a document

Optional Parameters

Document ID (2)
string
The document ID received by uploading a document
Document ID (3)
string
The document ID received by uploading a document
Document ID (4)
string
The document ID received by uploading a document
Document ID (5)
string
The document ID received by uploading a document
Document ID (6)
string
The document ID received by uploading a document
Document ID (7)
string
The document ID received by uploading a document
Document ID (8)
string
The document ID received by uploading a document

Returns

Body
LibraryDocumentCreationResponse

A JSON object describing the library template

Create an agreement from a document URL and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Required Parameters

Agreement Name
string
The name of the agreement
URL
string
A publicly accessible URL for retrieving the document
Name
string
The name of the referenced document, with extension
Signature Type
string
The type of signature you would like to request - E-signature or Written
Recipient Email
string
Email of the recipient
Recipient Signing Order
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role
string
Specify the role of recipient
Recipient Email (2)
string
Email of the recipient
Recipient Signing Order (2)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (2)
string
Specify the role of recipient
Recipient Email (3)
string
Email of the recipient
Recipient Signing Order (3)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (3)
string
Specify the role of recipient
Recipient Email (4)
string
Email of the recipient
Recipient Signing Order (4)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (4)
string
Specify the role of recipient
Recipient Email (5)
string
Email of the recipient
Recipient Signing Order (5)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (5)
string
Specify the role of recipient
Recipient Email (6)
string
Email of the recipient
Recipient Signing Order (6)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (6)
string
Specify the role of recipient
Recipient Email (7)
string
Email of the recipient
Recipient Signing Order (7)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (7)
string
Specify the role of recipient

Optional Parameters

Message
string
An optional message to the recipients requesting their action
Days to Deadline
integer
The number of days that remain before the document expires
Reminder Frequency
string
How often do you want to send reminders?
Document Password
string
The password that should be used to encrypt the signed agreement PDF
URL (2)
string
A publicly accessible URL for retrieving the document
Name (2)
string
The name of the referenced document, with extension
URL (3)
string
A publicly accessible URL for retrieving the document
Name (3)
string
The name of the referenced document, with extension
URL (4)
string
A publicly accessible URL for retrieving the document
Name (4)
string
The name of the referenced document, with extension
URL (5)
string
A publicly accessible URL for retrieving the document
Name (5)
string
The name of the referenced document, with extension
URL (6)
string
A publicly accessible URL for retrieving the document
Name (6)
string
The name of the referenced document, with extension
URL (7)
string
A publicly accessible URL for retrieving the document
Name (7)
string
The name of the referenced document, with extension
URL (8)
string
A publicly accessible URL for retrieving the document
Name (8)
string
The name of the referenced document, with extension
Form Field Name (1)
string
The name of the field
Form Field Value (1)
string
The default value of the field
Form Field Name (2)
string
The name of the field
Form Field Value (2)
string
The default value of the field
Form Field Name (3)
string
The name of the field
Form Field Value (3)
string
The default value of the field
Form Field Name (4)
string
The name of the field
Form Field Value (4)
string
The default value of the field
Form Field Name (5)
string
The name of the field
Form Field Value (5)
string
The default value of the field
Form Field Name (6)
string
The name of the field
Form Field Value (6)
string
The default value of the field
Form Field Name (7)
string
The name of the field
Form Field Value (7)
string
The default value of the field
Form Field Name (8)
string
The name of the field
Form Field Value (8)
string
The default value of the field
Form Field Name (9)
string
The name of the field
Form Field Value (9)
string
The default value of the field
Form Field Name (10)
string
The name of the field
Form Field Value (10)
string
The default value of the field

Returns

Body
AgreementCreationResponse

A JSON that contains the ID of the newly created agreement

Create an agreement from a library template and send for signature

This operation creates an agreement from a template stored in the user's Adobe Sign library and sends it for signature.

Required Parameters

Agreement Name
string
The name of the agreement
Document Library Template
string
Choose a document from the templates stored in your library
Signature Type
string
The type of signature you would like to request - E-signature or Written
Recipient Email
string
Email of the recipient
Recipient Signing Order
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role
string
Specify the role of recipient
Recipient Email (2)
string
Email of the recipient
Recipient Signing Order (2)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (2)
string
Specify the role of recipient
Recipient Email (3)
string
Email of the recipient
Recipient Signing Order (3)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (3)
string
Specify the role of recipient
Recipient Email (4)
string
Email of the recipient
Recipient Signing Order (4)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (4)
string
Specify the role of recipient
Recipient Email (5)
string
Email of the recipient
Recipient Signing Order (5)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (5)
string
Specify the role of recipient
Recipient Email (6)
string
Email of the recipient
Recipient Signing Order (6)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (6)
string
Specify the role of recipient
Recipient Email (7)
string
Email of the recipient
Recipient Signing Order (7)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (7)
string
Specify the role of recipient

Optional Parameters

Message
string
An optional message to the recipients requesting their action
Days to Deadline
integer
The number of days that remain before the document expires
Reminder Frequency
string
How often do you want to send reminders?
Document Password
string
The password that should be used to encrypt the signed agreement PDF
Document Library Template (2)
string
Choose a document from the templates stored in your library
Document Library Template (3)
string
Choose a document from the templates stored in your library
Document Library Template (4)
string
Choose a document from the templates stored in your library
Document Library Template (5)
string
Choose a document from the templates stored in your library
Document Library Template (6)
string
Choose a document from the templates stored in your library
Document Library Template (7)
string
Choose a document from the templates stored in your library
Document Library Template (8)
string
Choose a document from the templates stored in your library
Form Field Name (1)
string
The name of the field
Form Field Value (1)
string
The default value of the field
Form Field Name (2)
string
The name of the field
Form Field Value (2)
string
The default value of the field
Form Field Name (3)
string
The name of the field
Form Field Value (3)
string
The default value of the field
Form Field Name (4)
string
The name of the field
Form Field Value (4)
string
The default value of the field
Form Field Name (5)
string
The name of the field
Form Field Value (5)
string
The default value of the field
Form Field Name (6)
string
The name of the field
Form Field Value (6)
string
The default value of the field
Form Field Name (7)
string
The name of the field
Form Field Value (7)
string
The default value of the field
Form Field Name (8)
string
The name of the field
Form Field Value (8)
string
The default value of the field
Form Field Name (9)
string
The name of the field
Form Field Value (9)
string
The default value of the field
Form Field Name (10)
string
The name of the field
Form Field Value (10)
string
The default value of the field

Returns

Body
AgreementCreationResponse

A JSON that contains the ID of the newly created agreement

Create an agreement from an uploaded document and send for signature

This operation creates an agreement from a document uploaded in Adobe Sign and sends it for signature.

Required Parameters

Agreement Name
string
The name of the agreement
Document ID
string
The document ID received by uploading a document
Signature Type
string
The type of signature you would like to request - E-signature or Written
Recipient Email
string
Email of the recipient
Recipient Signing Order
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role
string
Specify the role of recipient
Recipient Email (2)
string
Email of the recipient
Recipient Signing Order (2)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (2)
string
Specify the role of recipient
Recipient Email (3)
string
Email of the recipient
Recipient Signing Order (3)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (3)
string
Specify the role of recipient
Recipient Email (4)
string
Email of the recipient
Recipient Signing Order (4)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (4)
string
Specify the role of recipient
Recipient Email (5)
string
Email of the recipient
Recipient Signing Order (5)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (5)
string
Specify the role of recipient
Recipient Email (6)
string
Email of the recipient
Recipient Signing Order (6)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (6)
string
Specify the role of recipient
Recipient Email (7)
string
Email of the recipient
Recipient Signing Order (7)
integer
Index starting with 1, that tells the order in which this recipient signs
Recipient Role (7)
string
Specify the role of recipient

Optional Parameters

Message
string
An optional message to the recipients requesting their action
Days to Deadline
integer
The number of days that remain before the document expires
Reminder Frequency
string
How often do you want to send reminders?
Document Password
string
The password that should be used to encrypt the signed agreement PDF
Document ID (2)
string
The document ID received by uploading a document
Document ID (3)
string
The document ID received by uploading a document
Document ID (4)
string
The document ID received by uploading a document
Document ID (5)
string
The document ID received by uploading a document
Document ID (6)
string
The document ID received by uploading a document
Document ID (7)
string
The document ID received by uploading a document
Document ID (8)
string
The document ID received by uploading a document
Form Field Name (1)
string
The name of the field
Form Field Value (1)
string
The default value of the field
Form Field Name (2)
string
The name of the field
Form Field Value (2)
string
The default value of the field
Form Field Name (3)
string
The name of the field
Form Field Value (3)
string
The default value of the field
Form Field Name (4)
string
The name of the field
Form Field Value (4)
string
The default value of the field
Form Field Name (5)
string
The name of the field
Form Field Value (5)
string
The default value of the field
Form Field Name (6)
string
The name of the field
Form Field Value (6)
string
The default value of the field
Form Field Name (7)
string
The name of the field
Form Field Value (7)
string
The default value of the field
Form Field Name (8)
string
The name of the field
Form Field Value (8)
string
The default value of the field
Form Field Name (9)
string
The name of the field
Form Field Value (9)
string
The default value of the field
Form Field Name (10)
string
The name of the field
Form Field Value (10)
string
The default value of the field

Returns

Body
AgreementCreationResponse

A JSON that contains the ID of the newly created agreement

Get a PDF of a signed agreement

This operation fetches the PDF file stream of the combined or signed agreement. Note that the file stream should be stored with a filename ending in .pdf file extension.

Required Parameters

Agreement ID
string
The agreement ID as provided by the action that creates the agreement

Optional Parameters

Attach Supporting Documents?
boolean
If true, attach supporting documents to the signed agreement PDF
Attach Audit Report?
boolean
If true, attach an audit report to the signed agreement PDF

Returns

The file stream of the document

Get a PDF of a signed agreement [DEPRECATED]

This operation fetches the PDF file stream of the combined or signed agreement. Note that the file stream should be stored with a filename ending in .pdf file extension.

Required Parameters

Agreement ID
string
The agreement ID as provided by the action that creates the agreement

Optional Parameters

Attach Supporting Documents?
boolean
If true, attach supporting documents to the signed agreement PDF
Attach Audit Report?
boolean
If true, attach an audit report to the signed agreement PDF

Returns

The file stream of the document

Get a document from an agreement

This operation fetches the file stream of a specific document of the agreement.

Required Parameters

Agreement ID
string
The agreement ID of the agreement whose document is needed
Document ID
string
The document ID of the specific document of the agreement

Returns

The file stream of the document

Get a document from an agreement [DEPRECATED]

This operation fetches the file stream of a specific document of the agreement.

Required Parameters

Agreement ID
string
The agreement ID of the agreement whose document is needed
Document ID
string
The document ID of the specific document of the agreement

Returns

The file stream of the document

Get a list of all agreements

This operation fetches the list of all agreements of the user.

Required Parameters

Template Name
string
Agreement Name used to identify the template
Template Type
string
A list of one or more library template types
Share with
string
Specifies who should have access to this library document
URL
string
A publicly accessible URL for retrieving the document
Name
string
The name of the referenced document, with extension

Optional Parameters

URL (2)
string
A publicly accessible URL for retrieving the document
Name (2)
string
The name of the referenced document, with extension
URL (3)
string
A publicly accessible URL for retrieving the document
Name (3)
string
The name of the referenced document, with extension
URL (4)
string
A publicly accessible URL for retrieving the document
Name (4)
string
The name of the referenced document, with extension
URL (5)
string
A publicly accessible URL for retrieving the document
Name (5)
string
The name of the referenced document, with extension
URL (6)
string
A publicly accessible URL for retrieving the document
Name (6)
string
The name of the referenced document, with extension
URL (7)
string
A publicly accessible URL for retrieving the document
Name (7)
string
The name of the referenced document, with extension
URL (8)
string
A publicly accessible URL for retrieving the document
Name (8)
string
The name of the referenced document, with extension

Returns

Body
UserAgreements

A JSON that contains the user agreement array object

Get a list of all library templates

This operation fetches the list of all documents stored as templates in the Adobe Sign library of the user.

Required Parameters

Template Name
string
Agreement Name used to identify the template
Template Type
string
A list of one or more library template types
Share with
string
Specifies who should have access to this library document
URL
string
A publicly accessible URL for retrieving the document
Name
string
The name of the referenced document, with extension

Optional Parameters

URL (2)
string
A publicly accessible URL for retrieving the document
Name (2)
string
The name of the referenced document, with extension
URL (3)
string
A publicly accessible URL for retrieving the document
Name (3)
string
The name of the referenced document, with extension
URL (4)
string
A publicly accessible URL for retrieving the document
Name (4)
string
The name of the referenced document, with extension
URL (5)
string
A publicly accessible URL for retrieving the document
Name (5)
string
The name of the referenced document, with extension
URL (6)
string
A publicly accessible URL for retrieving the document
Name (6)
string
The name of the referenced document, with extension
URL (7)
string
A publicly accessible URL for retrieving the document
Name (7)
string
The name of the referenced document, with extension
URL (8)
string
A publicly accessible URL for retrieving the document
Name (8)
string
The name of the referenced document, with extension

Returns

Body
DocumentLibraryItems

A JSON that contains the library template array object

Get a list of all the document IDs from an agreement

This operation fetches the IDs of all documents and supporting documents of an agreement.

Required Parameters

Agreement ID
string
The agreement ID of the agreement whose documents are needed

Optional Parameters

Supporting documents - Content Type
string
Content type of the supporting documents of the agreement

Returns

Body
AgreementDocumentsV6

A JSON that contains both the documents and supporting documents array objects

Get a list of all the document IDs from an agreement [DEPRECATED]

This operation fetches the IDs of all documents and supporting documents of an agreement.

Required Parameters

Agreement ID
string
The agreement ID of the agreement whose documents are needed

Optional Parameters

Supporting documents - Content Type
string
Content type of the supporting documents of the agreement

Returns

Body
AgreementDocuments

A JSON that contains both the documents and supporting documents array objects

Get the status of an agreement

This operation fetches all the current information of an agreement, like status.

Required Parameters

Agreement ID
string
The agreement ID of the agreement whose information is needed

Returns

Body
AgreementInfoV6

Complete Agreement Details

Get the status of an agreement [DEPRECATED]

This operation fetches all the current information of an agreement, like status.

Required Parameters

Agreement ID
string
The agreement ID of the agreement whose information is needed

Returns

Body
AgreementInfo

The complete details about the agreement

Upload a document and get a document ID

This operation uploads a document in your Adobe Sign account and returns a document ID for it. This document is temporarily stored in Adobe Sign and the document ID can be used for further operations like creating an agreement.

Required Parameters

File Name
string
The name of the document to be uploaded, with extension
File Content
contentOnly
The file stream of the document to be uploaded

Returns

Body
TransientDocumentResponse

A JSON that contains the ID of the uploaded document

Triggers

When a new agreement is created

Triggers a new flow when a new agreement is created.

Required Parameters

Name
string
The name of the trigger
Scope
string
The scope of the trigger

Optional Parameters

Include Agreement Info?
boolean
Should detailed agreement info be sent in notification?
Include Agreement Participant Info?
boolean
Should agreement participant info be sent in notification?

Returns

When an agreement is sent to a participant

Triggers a new flow when an agreement is sent to a participant.

Required Parameters

Name
string
The name of the trigger
Scope
string
The scope of the trigger

Optional Parameters

Agreement Name/ID
string
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID.
Include Agreement Info?
boolean
Should detailed agreement info be sent in notification?
Include Agreement Participant Info?
boolean
Should agreement participant info be sent in notification?
Include Agreement Document Info?
boolean
Should agreement document info be sent in notification?

Returns

When an agreement workflow is completed successfully

Triggers a new flow when an agreement workflow is completed successfully

Required Parameters

Name
string
The name of the trigger
Scope
string
The scope of the trigger

Optional Parameters

Agreement Name/ID
string
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID.
Include Agreement Info?
boolean
Should detailed agreement info be sent in notification?
Include Agreement Participant Info?
boolean
Should agreement participant info be sent in notification?
Include Agreement Document Info?
boolean
Should agreement document info be sent in notification?
Include Agreement Signed Document Info?
boolean
Should a final copy of signed document on agreement completion be sent in notification?

Returns

When an event occurs

Triggers a new flow when an event occurs. Covers all Agreement, Mega Sign and Widget events.

Required Parameters

Name
string
The name of the trigger
Scope
string
The scope of the trigger

Optional Parameters

Resource Type
string
Specify only when "Scope" is "A specific resource". Select the resource type for which the flow should be triggered.
Resource ID
string
Specify only when "Scope" is "A specific resource". Enter the agreement or mega sign or widget ID for which the flow should be triggered.
Events
string
Include Agreement Info?
boolean
Should detailed agreement info be sent in notification?
Include Agreement Participant Info?
boolean
Should agreement participant info be sent in notification?
Include Agreement Document Info?
boolean
Should agreement document info be sent in notification?
Include Agreement Signed Document Info?
boolean
Should a final copy of signed document on agreement completion be sent in notification?
Include MegaSign Info?
boolean
Should detailed mega sign info be sent in notification?
Include Widget Info?
boolean
Should detailed widget info be sent in notification?
Include Widget Participant Info?
boolean
Should widget participant info be sent in notification?
Include Widget Documents Info?
boolean
Should widget document info be sent in notification?

Returns

When the state of an agreement changes

Triggers a new flow when the status of an agreement changes. Covers most common Agreement events such as creation, completion, etc.

Required Parameters

Name
string
The name of the trigger
Scope
string
The scope of the trigger

Optional Parameters

Agreement Name/ID
string
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID.
Events
string
Include Agreement Info?
boolean
Should detailed agreement info be sent in notification?
Include Agreement Participant Info?
boolean
Should agreement participant info be sent in notification?
Include Agreement Document Info?
boolean
Should agreement document info be sent in notification?
Include Agreement Signed Document Info?
boolean
Should a final copy of signed document be sent in notification of agreement completion?

Returns

Definitions

AgreementCreationResponse

A JSON that contains the ID of the newly created agreement

Agreement ID
string
The unique ID of the agreement that can be used to query status and download signed documents

AgreementDocuments

A JSON that contains both the documents and supporting documents array objects

Documents
array of Document
A list of objects representing the documents
Supporting Documents
array of SupportingDocument
A list of supporting documents. This is returned only if there are any supporting document in the agreement

AgreementDocumentsV6

A JSON that contains both the documents and supporting documents array objects

Documents
array of DocumentV6
A list of objects representing the documents
Supporting Documents
array of SupportingDocumentV6
A list of supporting documents. This is returned only if there are any supporting document in the agreement

AgreementInfo

The complete details about the agreement

Agreement ID
string
A unique ID that can be used to uniquely identify the agreement
Agreement Name
string
The name of the agreement, specified by the sender
Document Protection
string
Security information about the document that specifies whether or not a password is required to view and sign it
Events
array of DocumentHistoryEvent
An ordered list of the events in the audit trail of this document
Expiration Date
date
The date after which the agreement can no longer be signed
Latest Version ID
string
A unique ID which uniquely identifies the current version of the agreement
Message
string
The message associated with the agreement that the sender has provided
Next Participant Sets
array of NextParticipantSetInfo
Information about who needs to act next for this agreement
Participant Sets
array of ParticipantSetInfo
Information about all the participant sets of this document
Signature Type
string
Specifies the Signature type that was requested - E-signature or Written
Status
string
The current status of the agreement

AgreementInfoV6

Complete Agreement Details

Agreement ID
string
A unique ID that can be used to uniquely identify the agreement
Agreement Name
string
The name of the agreement, specified by the sender
CCs
array of CcInfo
A list of one or more CCs that will be copied in the agreement transaction.
Created Date
date
Date when agreement was created
Document Visibility?
boolean
Is document visibility enabled?
Expiration Date
date
The date after which the agreement can no longer be signed
First Reminder Delay
integer
Integer which specifies the delay in hours before sending the first reminder.
Locale
string
The locale associated with this agreement - for example, en_US or fr_FR
Message
string
The message associated with the agreement that the sender has provided
Participant Sets
array of ParticipantSetInfoV6
Information about all the participant sets of this document
Reminder Frequency
string
How often do you want to send reminders?
Security Options
string
Security information about the document that specifies whether or not a password is required to view and sign it
Sender Email
string
The email of the sender
Signature Type
string
Specifies the Signature type that was requested – E-signature or Written
Status
string
The current status of the agreement
Workflow ID
string
The ID of custom workflow which defines the routing path of an agreement.

CombinedDocumentResponse

The file stream of the document

Agreement ID
string
The unique ID of the agreement that can be used to query status and download signed documents

DisplayUserInfo

Company
string
Displays the name of the company of the user, if available
Email
string
Displays the email of the user
Full Name
string
Displays the full name of the user, if available.

DisplayUserSetInfo

Display User Set Info
array of DisplayUserInfo
Displays the info about user set
Display User Set Name
string

Document

The information about the document

Document ID
string
The unique ID of the document
Mime Type
string
The Mime type of the document
Name
string
The name of the document
Num Pages
integer
Number of pages in the document

DocumentV6

The information about the document

Document ID
string
The unique ID of the document
Mime Type
string
The Mime type of the document
Name
string
The name of the document
Num Pages
integer
Number of pages in the document

DocumentHistoryEvent

Event Date
date
The date of the audit event
Event Description
string
A description of the audit event
Event Initiator
string
Email address of the user that initiated the event
Event Type
string
Type of agreement event
Participant Email
string
Email address of the user that initiated the event

DocumentLibraryItem

Library Template Id
string
The unique ID of the library document used when sending the document to be signed
Library Template Name
string
The name of the library template
Library Template Types
array of string
A list of one or more library template types
Modified Date
date
The day on which the library template was last modified
Template Sharing Mode
string
The scope of visibility of the library template

DocumentLibraryItems

A JSON that contains the library template array object

Library Templates List
array of DocumentLibraryItem
A list of library template items

DocumentResponse

The file stream of the document

Agreement ID
string
The unique ID of the agreement that can be used to query status and download signed documents

LibraryDocumentCreationResponse

A JSON object describing the library template

Library Template Id
string
The unique ID that can be used to refer to the library template

NextParticipantInfo

Email
string
The email address of the next participant
Name
string
The name of the next participant, if available
Waiting Since
date
The date since which the document has been waiting for the participant to take action

NextParticipantSetInfo

Next Participant Set Member Infos
array of NextParticipantInfo
Information about the members of the next participant set

ParticipantInfo

Company
string
The company of the participant, if available
Email
string
The email address of the participant
Name
string
The name of the participant, if available
Participant ID
string
The unique ID of the participant
Security Options
array of string
Security options that apply to the participant
Title
string
The title of the participant, if available

ParticipantSetInfo

Participant Set ID
string
The unique ID of the participant set
Participant Set Member Infos
array of ParticipantInfo
Information about the members of the recipient set
Participant Set Status
string
The participant set status with respect to the document
Private Message
string
Private message for the participants in the set
Role
array of string
The current roles of the participant set. A participant set can have one or more roles
Signing Order
integer
Index starting with 1, that tells the order in which this recipient signs
securityOptions
array of string
Security options that apply to the participant

ParticipantSetInfoV6

Order
integer
Index indicating position at which signing group needs to sign.
Participant Set Member Infos
array of MemberInfosV6
Information about the members of the recipient set
Participant Set Name
string
The name of the participant set
Participant Set Private Messsage
string
Private message for the participants in the set
Participant Set Visible Pages
array of string
The pages that are visible to the participant set
Role
string
The current roles of the participant set (signer, approver etc).

MemberInfosV6

Email
string
The email of the participant

SupportingDocument

The information about the supporting document

Supporting Document Field Name
string
The name of the supporting document field
Supporting Document ID
string
Unique ID representing the supporting document
Supporting Document Mime Type
string
The Mime type of the supporting document
Supporting Document Name
string
Display name of the supporting document
Supporting Document Pages
integer
Number of pages in the supporting document

SupportingDocumentV6

The information about the supporting document

Supporting Document Field Name
string
The name of the supporting document field
Supporting Document ID
string
Unique ID representing the supporting document
Supporting Document Mime Type
string
The Mime type of the supporting document
Supporting Document Name
string
Display name of the supporting document
Supporting Document Pages
integer
Number of pages in the supporting document

TransientDocumentResponse

A JSON that contains the ID of the uploaded document

Document ID
string
The document ID of the uploaded document

UserAgreement

Agreement ID
string
A unique ID that can be used to uniquely identify the agreement
Display Date
date
The display date for the agreement
Display User Set Infos
array of DisplayUserSetInfo
The most relevant current user set for the agreement. It is typically the next signer if the agreement is from the current user, or the sender if received from another user
Esign
boolean
True if this is an e-sign document
Latest Version ID
string
A version ID which uniquely identifies the current version of the agreement
Name
string
Name of the Agreement
Status
string
The current status of the agreement

UserAgreements

A JSON that contains the user agreement array object

Agreement List
array of UserAgreement
An array of agreement items

WebhookPayload

Agreement
WebhookAgreementInfo
The complete information of the agreement
Agreement Parent ID
string
A Unique ID of the resource from which this agreement is created
Agreement Parent Type
string
Information about the resource from which agreement is created. Possible values: Widget or Mega Sign
Event
string
The event that has occured on the resource.
Event Acting User Email
string
The email of the user that created the event.
Event Acting User ID
string
The ID of the user that created the event.
Event Acting User IP Address
string
The IP address of the user who created the event
Event Date
date
The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time
Event Initiating User Email
string
The email of the user that initiated the event on behalf of acting user.
Event Initiating User ID
string
The ID of the user that initiated the event on behalf of acting user.
Event Participant Email
string
The email of the participant for the event.
Event Participant Id
string
The ID of the participant for the event.
Event Participant Role
string
The Role of the participant for the event.
Event Resource Type
string
The resource on which the event has occured.
Notification Applicable Users
array of ApplicableUsers
A list of users for whom this notification is applicable

ApplicableUsers

The information about the users for whom this notification is applicable

Is Payload Applicable User
boolean
Whether the data provided in this notification is applicable for this user or not
Notification Applicable User Email
string
The email of the user for whom this notification is applicable
Notification Applicable User ID
string
The unique ID of the user for whom this notification is applicable
Notification Applicable User Role
string
The role of the user in the workflow for whom this notification is generated

WebhookPayloadWithoutNextParticipantSet

Agreement
WebhookAgreementInfoWithoutNextParticipantSet
The complete information of the agreement
Agreement Parent ID
string
A Unique ID of the resource from which this agreement is created
Agreement Parent Type
string
Information about the resource from which agreement is created. Possible values: Widget or Mega Sign
Event
string
The event that has occured on the resource.
Event Acting User Email
string
The email of the user that created the event.
Event Acting User ID
string
The ID of the user that created the event.
Event Acting User IP Address
string
The IP address of the user who created the event
Event Date
date
The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time
Event Initiating User Email
string
The email of the user that initiated the event on behalf of acting user.
Event Initiating User ID
string
The ID of the user that initiated the event on behalf of acting user
Event Participant Email
string
The email of the participant for the event.
Event Participant Id
string
The ID of the participant for the event.
Event Resource Type
string
The resource on which the event has occured.
Notification Applicable Users
array of ApplicableUsers
A list of users for whom this notification is applicable

WebhookPayloadWithSignedDocumentForStatusChange

Action Type
string
The action for which the event has occurred.
Agreement
WebhookAgreementInfoWithSignedDocument
The complete information of the agreement
Agreement Parent ID
string
A Unique ID of the resource from which this agreement is created
Agreement Parent Type
string
Information about the resource from which agreement is created. Possible values: Widget or Mega Sign
Event
string
The event that has occured on the resource.
Event Acting User Email
string
The email of the user that created the event.
Event Acting User ID
string
The ID of the user that created the event.
Event Acting User IP Address
string
The IP address of the user who created the event
Event Date
date
The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time
Event Initiating User Email
string
The email of the user that initiated the event on behalf of acting user.
Event Initiating User ID
string
The ID of the user that initiated the event on behalf of acting user
Event Participant Email
string
The email of the participant for the event.
Event Participant Id
string
The ID of the participant for the event.
Event Participant Role
string
The Role of the participant for the event.
Event Resource Type
string
The resource on which the event has occured.
Notification Applicable Users
array of ApplicableUsers
A list of users for whom this notification is applicable
Sub Event
string
The sub event that has occured on a resource.

WebhookPayloadWithSignedDocument

Agreement
WebhookAgreementInfoWithSignedDocument
The complete information of the agreement
Agreement Parent ID
string
A Unique ID of the resource from which this agreement is created
Agreement Parent Type
string
Information about the resource from which agreement is created. Possible values: Widget or Mega Sign
Event
string
The event that has occured on the resource.
Event Acting User Email
string
The email of the user that created the event.
Event Acting User ID
string
The ID of the user that created the event.
Event Acting User IP Address
string
The IP address of the user who created the event
Event Date
date
The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time
Event Initiating User Email
string
The email of the user that initiated the event on behalf of acting user.
Event Initiating User ID
string
The ID of the user that initiated the event on behalf of acting user
Event Participant Email
string
The email of the participant for the event.
Event Participant Id
string
The ID of the participant for the event.
Event Participant Role
string
The Role of the participant for the event.
Event Resource Type
string
The resource on which the event has occured.
Notification Applicable Users
array of ApplicableUsers
A list of users for whom this notification is applicable

WebhookPayloadGeneric

Action Type
string
The action for which the event has occurred.
Agreement
WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo
The complete information of the agreement
Agreement Parent ID
string
A Unique ID of the resource from which this agreement is created
Agreement Parent Type
string
Information about the resource from which agreement is created. Possible values: Widget or Mega Sign
Event
string
The event that has occured on the resource.
Event Acting User Email
string
The email of the user that created the event.
Event Acting User ID
string
The ID of the user that created the event.
Event Acting User IP Address
string
The IP address of the user who created the event
Event Date
date
The date of the event. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time
Event Initiating User Email
string
The email of the user that initiated the event on behalf of acting user.
Event Initiating User ID
string
The ID of the user that initiated the event on behalf of acting user
Event Participant Email
string
The email of the participant for the event.
Event Participant Id
string
The ID of the participant for the event.
Event Participant Role
string
The Role of the participant for the event.
Event Resource Type
string
The resource on which the event has occured.
Mega Sign
WebhookMegaSignInfo
The complete information of the mega sign
Notification Applicable Users
array of ApplicableUsers
A list of users for whom this notification is applicable
Sub Event
string
The sub event that has occured on a resource.
Widget
WebhookWidgetInfo
The complete information of the widget

WebhookAgreementInfo

The complete information of the agreement

CCs
array of CcInfo
A list of one or more CCs that will be copied in the agreement transaction.
Creation Date
date
Date when agreement was created
Document Visibility?
boolean
Is document visibility enabled
Documents
array of WebhookDocument
A list of objects representing the documents
Expiration Time
string
Time after which Agreement expires and needs to be signed before it
External Group
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
External ID
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
First Reminder Delay
integer
Integer which specifies the delay in hours before sending the first reminder.
ID
string
The unique ID of the agreement
Locale
string
The locale associated with this agreement
Message
string
An optional message to the participants, describing what is being sent or why their signature is required
Name
string
The name of the agreement
Next Participant Sets
array of WebhookParticipantSets
The next participant sets info
Participant Sets
array of WebhookParticipantSets
The participant sets info
Post Sign Redirect Url
string
A publicly accessible url to which the user will be sent after successfully completing the signing process
Reminder Frequency
string
Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used
Sender Email
string
Email of agreement sender
Signature Type
string
Specifies the Signature type that was requested - E-signature or Written
Status
string
The current status of the agreement
Supporting Documents
array of WebhookSupportingDocument
A list of supporting documents
Vaulting Enabled?
boolean
For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted
Workflow ID
string
The ID of custom workflow which defines the routing path of an agreement.

WebhookAgreementInfoWithoutNextParticipantSet

The complete information of the agreement

CCs
array of CcInfo
A list of one or more CCs that will be copied in the agreement transaction.
Creation Date
date
Date when agreement was created
Document Visibility?
boolean
Is document visibility enabled
Expiration Time
string
Time after which Agreement expires and needs to be signed before it
External Group
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
External ID
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
First Reminder Delay
integer
Integer which specifies the delay in hours before sending the first reminder.
ID
string
The unique ID of the agreement
Locale
string
The locale associated with this agreement
Message
string
An optional message to the participants, describing what is being sent or why their signature is required
Name
string
The name of the agreement
Participant Sets
array of WebhookParticipantSets
The participant sets info
Post Sign Redirect Url
string
A publicly accessible url to which the user will be sent after successfully completing the signing process
Reminder Frequency
string
Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used
Sender Email
string
Email of agreement sender
Signature Type
string
Specifies the Signature type that was requested - E-signature or Written
Status
string
The current status of the agreement
Vaulting Enabled?
boolean
For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted
Workflow ID
string
The ID of custom workflow which defines the routing path of an agreement.

WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo

The complete information of the agreement

CCs
array of CcInfo
A list of one or more CCs that will be copied in the agreement transaction.
Creation Date
date
Date when agreement was created
Document Visibility?
boolean
Is document visibility enabled
Documents
array of WebhookDocument
A list of objects representing the documents
Expiration Time
string
Time after which Agreement expires and needs to be signed before it
External Group
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
External ID
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
First Reminder Delay
integer
Integer which specifies the delay in hours before sending the first reminder.
ID
string
The unique ID of the agreement
Locale
string
The locale associated with this agreement
Message
string
An optional message to the participants, describing what is being sent or why their signature is required
Name
string
The name of the agreement
Next Participant Sets
array of WebhookParticipantSets
The next participant sets info
Participant Sets
array of WebhookParticipantSets
The participant sets info
Post Sign Redirect Url
string
A publicly accessible url to which the user will be sent after successfully completing the signing process
Reminder Frequency
string
Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used
Sender Email
string
Email of agreement sender
Signature Type
string
Specifies the Signature type that was requested - E-signature or Written
Signed Document Info
string
A base64 encoded string of the signed document
Status
string
The current status of the agreement
Supporting Documents
array of WebhookSupportingDocument
A list of supporting documents This is returned only if there are any supporting document in the agreement
Vaulting Enabled?
boolean
For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted
Workflow ID
string
The ID of custom workflow which defines the routing path of an agreement.

WebhookAgreementInfoWithSignedDocument

The complete information of the agreement

CCs
array of CcInfo
A list of one or more CCs that will be copied in the agreement transaction
Creation Date
date
Date when agreement was created
Document Visibility?
boolean
Is document visibility enabled
Documents
array of WebhookDocument
A list of objects representing the documents
Expiration Time
string
Time after which Agreement expires and needs to be signed before it
External Group
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
External ID
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
First Reminder Delay
integer
Integer which specifies the delay in hours before sending the first reminder.
ID
string
The unique ID of the agreement
Locale
string
The locale associated with this agreement
Message
string
An optional message to the participants, describing what is being sent or why their signature is required
Name
string
The name of the agreement
Participant Sets
array of WebhookParticipantSets
The participant sets info
Post Sign Redirect Url
string
A publicly accessible url to which the user will be sent after successfully completing the signing process
Reminder Frequency
string
Optional parameter that sets how often you want to send reminders to the participants. If it is not specified, the default frequency set for the account will be used
Sender Email
string
Email of agreement sender
Signature Type
string
Specifies the Signature type that was requested - E-signature or Written
Signed Document Info
string
A base64 encoded string of the signed document
Status
string
The current status of the agreement
Supporting Documents
array of WebhookSupportingDocument
A list of supporting documents This is returned only if there are any supporting document in the agreement
Vaulting Enabled?
boolean
For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted
Workflow ID
string
The ID of custom workflow which defines the routing path of an agreement.

WebhookMegaSignInfo

The complete information of the mega sign

CCs
array of MegaSignCcInfo
A list of one or more email addresses that you want to copy on this megasign.
Child Agreements File Info
MegaSignChildAgreementsFileInfo
File info containing per child agreement information of megaSign.
External ID
string
An arbitrary value from your system, which can be specified at sending time and then later returned or queried
First Reminder Delay
integer
Integer which specifies the delay in hours before sending the first reminder.
ID
string
The unique ID of the megasign
Locale
string
The locale associated with this agreement
Message
string
An optional message to the participants, describing what is being sent or why their signature is required
Name
string
The name of the megasign
Post Sign Redirect Url
string
A publicly accessible url to which the user will be sent after successfully completing the signing process
Sender Email
string
Email of megasign creator
Signature Type
string
Specifies the Signature type that was requested - E-signature or Written
Status
string
The status of the megasign
Vaulting Enabled?
boolean
For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted

WebhookWidgetInfo

The complete information of the widget

Additional Participant Sets Info
array of WidgetParticipantSetInfo
List of all the participants in the widget except widget signer
Authentication Failure Info
AuthFailureWidgetRedirectionInfo
URL and associated properties for the error page the widget signer will be taken after failing to authenticate
CCs
array of WidgetCcInfo
A list of one or more email addresses that you want to copy on this widget.
Completion Info
WidgetCompletionRedirectionInfo
URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget
Creation Date
date
Date when widget was created
Creator Email
string
The email of the creator of the widget
Documents
array of WidgetWebhookDocument
A list of objects representing the documents
First Participant Set Order
integer
Index indicating sequential signing group (specified for hybrid routing)
First Participant Set Role
string
Role assumed by all participants in the set (signer, approver etc.)
ID
string
The unique ID of the widget
Name
string
The name of the widget
Status
string
The status of the widget
Vaulting Enabled?
boolean
For accounts set up for document vaulting and the option to enable per agreement, this determines whether the document is to be vaulted

AuthFailureWidgetRedirectionInfo

URL and associated properties for the error page the widget signer will be taken after failing to authenticate

Auth Failure Redirect Deframe
boolean
If deframe is false, the resultant page will be shown inside the widget frame
Auth Failure Redirect Delay
integer
The delay (in seconds) before the user is taken to the resultant page
Auth Failure Redirect Url
string
A publicly accessible url to which the user will be sent after successfully completing the widget

WidgetCompletionRedirectionInfo

URL and associated properties for the success page the widget signer will be taken to after performing desired action on the widget

Completion Redirect Deframe
boolean
If deframe is false, the resultant page will be shown inside the widget frame
Completion Redirect Delay
integer
The delay (in seconds) before the user is taken to the resultant page
Completion Redirect Url
string
A publicly accessible url to which the user will be sent after successfully completing the widget

WebhookParticipantSets

ID
string
The ID of the participant set
Member Infos
array of MemberInfos
The information about participant members
Name
string
The name of the participant set
Order
integer
Index indicating position at which signing group needs to sign.
Private Message
string
Private message for the participants in the set
Role
string
Role assumed by all participants in the set (signer, approver etc.)
Status
string
Current status of the agreement from the perspective of the user

MegaSignChildAgreementsFileInfo

File info containing per child agreement information of megaSign.

Child Agreements File ID
string
The ID of the file containing information about the existing childAgreementsInfo of the megaSign.

WidgetWebhookDocument

The information about the document of the widget

ID
string
The unique ID of the document
Name
string
The name of the document

WebhookDocument

The information about the document of the agreement

ID
string
The unique ID of the document
Name
string
The name of the document

WebhookSupportingDocument

The information about the supporting document

Field Name
string
The name of the supporting document field
ID
string
The unique ID representing the supporting document
Name
string
Display name of the supporting document

WidgetCcInfo

The information about the CC of the widget

Email
string
Email of the CC participant of the widget

MegaSignCcInfo

The information about the CC of the mega sign

Email
string
Email of the CC participant of the megasign

CcInfo

The information about the CC of the agreement

Email
string
The email of the CC of the agreement
Label
string
The label of the CC list as returned in workflow description
Visible Pages
array of string
The pages that are visible to the CC

WidgetParticipantSetInfo

ID
string
The unique identifier of the participant set
Member Infos
array of MemberInfos
The information about the participant members
Order
integer
Index indicating sequential signing group (specified for hybrid routing)
Role
string
Role assumed by all participants in the set (signer, approver etc.)

MemberInfos

Company
string
The company of the participant
Email
string
The email of the participant
ID
string
The unique Id of the participant
Name
string
The name of the participant
Private Message
string
The private message of the participant
Status
string
The status of the participant