Adobe Acrobat Sign Sandbox
Adobe is the most trusted digital document sign service in the world. With Adobe Acrobat Sign, you can transform manual processes into all-digital experiences. Incorporate Adobe Acrobat 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 - US Department of Defense (DoD) |
Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Adobe Acrobat Sign Support |
URL | https://helpx.adobe.com/contact/enterprise-support.dc.html#sign |
support@echosign.zendesk.com |
Connector Metadata | |
---|---|
Publisher | Adobe Inc. |
Website | https://acrobat.adobe.com/us/en/sign.html |
Privacy policy | https://www.adobe.com/privacy/policy.html |
Categories | Website |
Adobe Acrobat Sign Sandbox
The Adobe Acrobat Sign Sandbox is a modified enterprise-tier account in an environment discrete from the production environment. The purpose of the sandbox is to allow administrators to test setting configurations, API calls, library templates, custom workflows, and new features that are approaching release.
Adobe Acrobat Sign account is required.
N/A
N/A
N/A
N/A
Connector user guide https://helpx.adobe.com/sign/using/adobesign-sandbox.html
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 250 | 60 seconds |
Cancel an agreement |
Cancels the agreement identified by agreementId in the path. |
Create a library template from a document URL |
This operation creates a template in Adobe Acrobat Sign library from a document URL. Use this template for sending agreements |
Create a library template from a document URL (Old) [DEPRECATED] |
This operation creates a template in Adobe Acrobat Sign library from a document URL. Use this template for sending agreements |
Create a library template from an uploaded document |
This operation creates a template in Adobe Acrobat Sign library from an uploaded document. Use this template for sending agreements. |
Create a library template from an uploaded document (Old) [DEPRECATED] |
This operation creates a template in Adobe Acrobat Sign library from an uploaded document. Use this template for sending agreements. |
Create an agreement from a document URL and send for signature |
This operation creates an agreement from a document uploaded in Adobe Acrobat Sign and sends it for signature. |
Create an agreement from a document URL and send for signature (Old) [DEPRECATED] |
This operation creates an agreement from a document uploaded in Adobe Acrobat Sign and sends it for signature. |
Create an agreement from a file content and send for signature |
This operation creates an agreement from a file in Adobe Acrobat Sign and sends it for signature. |
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 Acrobat Sign library and sends it for signature. |
Create an agreement from a library template and send for signature (Old) [DEPRECATED] |
This operation creates an agreement from a template stored in the user's Adobe Acrobat Sign library and sends it for signature. |
Create an agreement from a workflow and send for signature |
This operation creates an agreement from a workflow in Adobe Acrobat Sign and sends it for signature. |
Create an agreement from an uploaded document and send for signature |
This operation creates an agreement from a document uploaded in Adobe Acrobat Sign and sends it for signature. |
Create an agreement from an uploaded document and send for signature (Old) [DEPRECATED] |
This operation creates an agreement from a document uploaded in Adobe Acrobat Sign and sends it for signature. |
Get a document from an agreement |
This operation fetches the file stream of a specific document of the agreement. |
Get a document from an agreement [DEPRECATED] |
This action has been deprecated. Please use Get a document from an agreement instead.
|
Get a list of all agreements |
This operation fetches the list of all agreements of the user. |
Get a list of all agreements (Old) [DEPRECATED] |
This operation fetches the list of all agreements of the user. |
Get a list of all agreements based on search criteria |
This operation searches agreements by criteria such as Workflow ID, etc. |
Get a list of all groups the user belongs to |
This operation fetches the list of all groups user belongs to. |
Get a list of all library templates |
This operation fetches the list of all documents stored as templates in the Adobe Acrobat Sign library of the user. |
Get a list of all library templates (Old) [DEPRECATED] |
This operation fetches the list of all documents stored as templates in the Adobe Acrobat Sign library of the user. |
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. |
Get a list of all the document IDs from an agreement [DEPRECATED] |
This action has been deprecated. Please use Get a list of all the document IDs from an agreement instead.
|
Get a list of all web forms |
This operation fetches the list of all web forms of the user. |
Get a list of all workflows |
This operation fetches the list of all workflows of the user. |
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. |
Get a PDF of a signed agreement [DEPRECATED] |
This action has been deprecated. Please use Get a PDF of a signed agreement instead.
|
Get a PDF of the agreement's audit trail |
This operation fetches the PDF file stream of the agreement audit trail. Note that the file stream should be stored with a filename ending in .pdf file extension. |
Get form field data of agreement (Old) [DEPRECATED] |
Retrieves data entered into the interactive form fields of the agreement. |
Get form field data of agreement in CSV format |
Retrieves data entered into the interactive form fields of the agreement. |
Get form field data of agreement in JSON format |
Retrieves data entered into the interactive form fields of the agreement. |
Get the detailed info of the workflow |
This operation fetches detailed pieces of information about the workflow. |
Get the status of an agreement |
This operation fetches all the current information of an agreement, like status. |
Get the status of an agreement [DEPRECATED] |
This action has been deprecated. Please use Get the status of an agreement instead.
|
Retrieve the Signing URL |
This operation retrieves the URL for the e-sign page for the current signer(s) of an agreement. |
Upload a document and get a document ID |
This operation uploads a document in your Adobe Acrobat Sign account and returns a document ID for it. This document is temporarily stored in Adobe Acrobat Sign and the document ID can be used for further operations like creating an agreement. |
Upload a document and get a document ID (Old) [DEPRECATED] |
This operation uploads a document in your Adobe Acrobat Sign account and returns a document ID for it. This document is temporarily stored in Adobe Acrobat Sign and the document ID can be used for further operations like creating an agreement. |
Cancels the agreement identified by agreementId in the path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement which is to be cancelled. |
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Agrement State
|
state | string |
The state in which the agreement should land. |
|
Comment
|
comment | string |
An optional comment describing the reason of cancellation to the recipients. |
|
Others
|
notifyOthers | boolean |
Whether or not you would like the recipients to be notified. |
This operation creates a template in Adobe Acrobat Sign library from a document URL. Use this template for sending agreements
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Template Name
|
name | True | string |
Agreement Name used to identify the template |
Template Type
|
templateTypes | True | array of string |
A list of one or more library template types |
Sharing Mode
|
sharingMode | True | string |
Specifies who should have access to this library document |
URL
|
url | True | string |
A publicly accessible URL for retrieving the raw file content |
Name
|
name | True | string |
The original system file name of the document being sent |
Type
|
mimeType | True | string |
The mime type of the referenced file, e.g. application/pdf |
Template State
|
state | True | string |
State of the library document. |
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
Returns
A JSON object describing the library template
This operation creates a template in Adobe Acrobat Sign library from a document URL. Use this template for sending agreements
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Template Name
|
name | True | string |
Agreement Name used to identify the template |
Template Type
|
libraryTemplateTypes | True | string |
A list of one or more library template types |
Share with
|
librarySharingMode | True | string |
Specifies who should have access to this library document |
URL
|
url | True | string |
A publicly accessible URL for retrieving the document |
Name
|
name | True | string |
The name of the referenced document, with extension |
URL (2)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (2)
|
name | string |
The name of the referenced document, with extension |
|
URL (3)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (3)
|
name | string |
The name of the referenced document, with extension |
|
URL (4)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (4)
|
name | string |
The name of the referenced document, with extension |
|
URL (5)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (5)
|
name | string |
The name of the referenced document, with extension |
|
URL (6)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (6)
|
name | string |
The name of the referenced document, with extension |
|
URL (7)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (7)
|
name | string |
The name of the referenced document, with extension |
|
URL (8)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (8)
|
name | string |
The name of the referenced document, with extension |
|
URL (9)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (9)
|
name | string |
The name of the referenced document, with extension |
|
URL (10)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (10)
|
name | string |
The name of the referenced document, with extension |
Returns
A JSON object describing the library template
This operation creates a template in Adobe Acrobat Sign library from an uploaded document. Use this template for sending agreements.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Template Name
|
name | True | string |
Agreement Name used to identify the template |
Template Type
|
templateTypes | True | array of string |
A list of one or more library template types |
Sharing Mode
|
sharingMode | True | string |
Specifies who should have access to this library document |
ID
|
transientDocumentId | True | string |
The document id received by uploading a transient document |
Template State
|
state | True | string |
State of the library document. |
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
Returns
A JSON object describing the library template
This operation creates a template in Adobe Acrobat Sign library from an uploaded document. Use this template for sending agreements.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Template Name
|
name | True | string |
Agreement Name used to identify the template |
Template Type
|
libraryTemplateTypes | True | string |
A list of one or more library template types |
Share with
|
librarySharingMode | True | string |
Specifies who should have access to this library document |
Document ID
|
transientDocumentId | True | string |
The document ID received by uploading a document |
Document ID (2)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (3)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (4)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (5)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (6)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (7)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (8)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (9)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (10)
|
transientDocumentId | string |
The document ID received by uploading a document |
Returns
A JSON object describing the library template
This operation creates an agreement from a document uploaded in Adobe Acrobat Sign and sends it for signature.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Agreement Name
|
name | True | string |
The name of the agreement |
URL
|
url | True | string |
A publicly accessible URL for retrieving the raw file content |
Name
|
name | True | string |
The original system file name of the document being sent |
Type
|
mimeType | True | string |
The mime type of the referenced file, e.g. application/pdf |
Signature Type
|
signatureType | True | string |
Specifies the Signature type that was requested - E-signature or Written |
Participant Email
|
True | string |
The email of the participant |
|
Authentication
|
authenticationMethod | string |
Default authentication: email (None) |
|
Password
|
password | string |
The password required for the participant |
|
Country Code
|
countryCode | string |
Recipient's phone country code required to view & sign the document |
|
Phone No.
|
phone | string |
Recipient's phone number required to view & sign the agreement |
|
Order
|
order | True | integer |
Index starting with 1, indicating position at which signing group needs to sign. |
Role
|
role | True | string |
The current roles of the participant set (signer, approver etc). |
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
|
Message
|
message | string |
An optional message to the recipients requesting their action |
|
Email
|
string |
The email of the CC of the agreement |
||
Expiration Time
|
expirationTime | string |
Time after which Agreement expires. Example: 2020-12-31T23:59:00Z |
|
Reminder Frequency
|
reminderFrequency | string |
How often do you want to send reminders ? |
|
Document Password
|
openPassword | string |
The password that should be used to encrypt the signed agreement PDF |
|
Name
|
fieldName | string |
The name of the field |
|
Value
|
defaultValue | string |
The default value of the field |
|
Redirect Delay
|
redirectDelay | string |
The delay (in seconds) before the user is taken to the success page. |
|
Redirect URL
|
redirectUrl | string |
URL to redirect after completing the signing process, e.g. https://adobe.com |
|
Initial Emails
|
initEmails | string |
Control notification mails for Agreement initiation events. |
Returns
A JSON that contains the ID of the newly created agreement
This operation creates an agreement from a document uploaded in Adobe Acrobat Sign and sends it for signature.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement Name
|
name | True | string |
The name of the agreement |
URL
|
url | True | string |
A publicly accessible URL for retrieving the document |
Name
|
name | True | string |
The name of the referenced document, with extension |
Signature Type
|
signatureType | True | string |
The type of signature you would like to request - E-signature or Written |
Recipient Email
|
True | string |
Email of the recipient |
|
Recipient Signing Order
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role
|
recipientSetRole | True | string |
Specify the role of recipient |
Message
|
message | string |
An optional message to the recipients requesting their action |
|
Days to Deadline
|
daysUntilSigningDeadline | integer |
The number of days that remain before the document expires |
|
Reminder Frequency
|
reminderFrequency | string |
How often do you want to send reminders? |
|
Document Password
|
openPassword | string |
The password that should be used to encrypt the signed agreement PDF |
|
URL (2)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (2)
|
name | string |
The name of the referenced document, with extension |
|
URL (3)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (3)
|
name | string |
The name of the referenced document, with extension |
|
URL (4)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (4)
|
name | string |
The name of the referenced document, with extension |
|
URL (5)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (5)
|
name | string |
The name of the referenced document, with extension |
|
URL (6)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (6)
|
name | string |
The name of the referenced document, with extension |
|
URL (7)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (7)
|
name | string |
The name of the referenced document, with extension |
|
URL (8)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (8)
|
name | string |
The name of the referenced document, with extension |
|
URL (9)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (9)
|
name | string |
The name of the referenced document, with extension |
|
URL (10)
|
url | string |
A publicly accessible URL for retrieving the document |
|
Name (10)
|
name | string |
The name of the referenced document, with extension |
|
Recipient Email (2)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (2)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (2)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (3)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (3)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (3)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (4)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (4)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (4)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (5)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (5)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (5)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (6)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (6)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (6)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (7)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (7)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (7)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (8)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (8)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (8)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (9)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (9)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (9)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (10)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (10)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (10)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (11)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (11)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (11)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (12)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (12)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (12)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (13)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (13)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (13)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (14)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (14)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (14)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (15)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (15)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (15)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (16)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (16)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (16)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (17)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (17)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (17)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (18)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (18)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (18)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (19)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (19)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (19)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (20)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (20)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (20)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (21)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (21)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (21)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (22)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (22)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (22)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (23)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (23)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (23)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (24)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (24)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (24)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (25)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (25)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (25)
|
recipientSetRole | True | string |
Specify the role of recipient |
Form Field Name (1)
|
fieldName | string |
The name of the field |
|
Form Field Value (1)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (2)
|
fieldName | string |
The name of the field |
|
Form Field Value (2)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (3)
|
fieldName | string |
The name of the field |
|
Form Field Value (3)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (4)
|
fieldName | string |
The name of the field |
|
Form Field Value (4)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (5)
|
fieldName | string |
The name of the field |
|
Form Field Value (5)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (6)
|
fieldName | string |
The name of the field |
|
Form Field Value (6)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (7)
|
fieldName | string |
The name of the field |
|
Form Field Value (7)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (8)
|
fieldName | string |
The name of the field |
|
Form Field Value (8)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (9)
|
fieldName | string |
The name of the field |
|
Form Field Value (9)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (10)
|
fieldName | string |
The name of the field |
|
Form Field Value (10)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (11)
|
fieldName | string |
The name of the field |
|
Form Field Value (11)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (12)
|
fieldName | string |
The name of the field |
|
Form Field Value (12)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (13)
|
fieldName | string |
The name of the field |
|
Form Field Value (13)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (14)
|
fieldName | string |
The name of the field |
|
Form Field Value (14)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (15)
|
fieldName | string |
The name of the field |
|
Form Field Value (15)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (16)
|
fieldName | string |
The name of the field |
|
Form Field Value (16)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (17)
|
fieldName | string |
The name of the field |
|
Form Field Value (17)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (18)
|
fieldName | string |
The name of the field |
|
Form Field Value (18)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (19)
|
fieldName | string |
The name of the field |
|
Form Field Value (19)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (20)
|
fieldName | string |
The name of the field |
|
Form Field Value (20)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (21)
|
fieldName | string |
The name of the field |
|
Form Field Value (21)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (22)
|
fieldName | string |
The name of the field |
|
Form Field Value (22)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (23)
|
fieldName | string |
The name of the field |
|
Form Field Value (23)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (24)
|
fieldName | string |
The name of the field |
|
Form Field Value (24)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (25)
|
fieldName | string |
The name of the field |
|
Form Field Value (25)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (26)
|
fieldName | string |
The name of the field |
|
Form Field Value (26)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (27)
|
fieldName | string |
The name of the field |
|
Form Field Value (27)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (28)
|
fieldName | string |
The name of the field |
|
Form Field Value (28)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (29)
|
fieldName | string |
The name of the field |
|
Form Field Value (29)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (30)
|
fieldName | string |
The name of the field |
|
Form Field Value (30)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (31)
|
fieldName | string |
The name of the field |
|
Form Field Value (31)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (32)
|
fieldName | string |
The name of the field |
|
Form Field Value (32)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (33)
|
fieldName | string |
The name of the field |
|
Form Field Value (33)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (34)
|
fieldName | string |
The name of the field |
|
Form Field Value (34)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (35)
|
fieldName | string |
The name of the field |
|
Form Field Value (35)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (36)
|
fieldName | string |
The name of the field |
|
Form Field Value (36)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (37)
|
fieldName | string |
The name of the field |
|
Form Field Value (37)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (38)
|
fieldName | string |
The name of the field |
|
Form Field Value (38)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (39)
|
fieldName | string |
The name of the field |
|
Form Field Value (39)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (40)
|
fieldName | string |
The name of the field |
|
Form Field Value (40)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (41)
|
fieldName | string |
The name of the field |
|
Form Field Value (41)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (42)
|
fieldName | string |
The name of the field |
|
Form Field Value (42)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (43)
|
fieldName | string |
The name of the field |
|
Form Field Value (43)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (44)
|
fieldName | string |
The name of the field |
|
Form Field Value (44)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (45)
|
fieldName | string |
The name of the field |
|
Form Field Value (45)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (46)
|
fieldName | string |
The name of the field |
|
Form Field Value (46)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (47)
|
fieldName | string |
The name of the field |
|
Form Field Value (47)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (48)
|
fieldName | string |
The name of the field |
|
Form Field Value (48)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (49)
|
fieldName | string |
The name of the field |
|
Form Field Value (49)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (50)
|
fieldName | string |
The name of the field |
|
Form Field Value (50)
|
defaultValue | string |
The default value of the field |
Returns
A JSON that contains the ID of the newly created agreement
This operation creates an agreement from a file in Adobe Acrobat Sign and sends it for signature.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Agreement Name
|
name | True | string |
The name of the agreement |
Name
|
fileName | True | string |
The name of the document to be uploaded, with extension |
Content
|
formData | True | byte |
The file stream of the document to be uploaded |
Signature Type
|
signatureType | True | string |
The type of signature you would like to request - e-signature or written |
Participant Email
|
True | string |
The email of the participant |
|
Authentication
|
authenticationMethod | string |
Default authentication: email (None) |
|
Password
|
password | string |
The password required for the participant |
|
Country Code
|
countryCode | string |
Recipient's phone country code required to view & sign the document |
|
Phone No.
|
phone | string |
Recipient's phone number required to view & sign the agreement |
|
Order
|
order | True | integer |
Index starting with 1, indicating position at which signing group needs to sign. |
Role
|
role | True | string |
The current roles of the participant set (signer, approver etc). |
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
|
Message
|
message | string |
An optional message to the recipients requesting their action |
|
Email
|
string |
The email of the CC of the agreement |
||
Expiration Time
|
expirationTime | string |
Time after which Agreement expires. Example: 2020-12-31T23:59:00Z |
|
Reminder Frequency
|
reminderFrequency | string |
How often do you want to send reminders ? |
|
Document Password
|
openPassword | string |
The password that should be used to encrypt the signed agreement PDF |
|
Name
|
fieldName | string |
The name of the field |
|
Value
|
defaultValue | string |
The default value of the field |
|
Redirect Delay
|
redirectDelay | string |
The delay (in seconds) before the user is taken to the success page. |
|
Redirect URL
|
redirectUrl | string |
URL to redirect after completing the signing process, e.g. https://adobe.com |
|
Initial Emails
|
initEmails | string |
Control notification mails for Agreement initiation events. |
Returns
A JSON that contains the ID of the newly created agreement
This operation creates an agreement from a template stored in the user's Adobe Acrobat Sign library and sends it for signature.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Agreement Name
|
name | True | string |
The name of the agreement |
Template
|
libraryDocumentId | True | string |
Choose a document from the templates stored in your library |
Signature Type
|
signatureType | True | string |
The type of signature you would like to request - e-signature or written |
Participant Email
|
True | string |
The email of the participant |
|
Authentication
|
authenticationMethod | string |
Default authentication: email (None) |
|
Password
|
password | string |
The password required for the participant |
|
Country Code
|
countryCode | string |
Recipient's phone country code required to view & sign the document |
|
Phone No.
|
phone | string |
Recipient's phone number required to view & sign the agreement |
|
Order
|
order | True | integer |
Index starting with 1, indicating position at which signing group needs to sign. |
Role
|
role | True | string |
The current roles of the participant set (signer, approver etc). |
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
|
Message
|
message | string |
An optional message to the recipients requesting their action |
|
Email
|
string |
The email of the CC of the agreement |
||
Expiration Time
|
expirationTime | string |
Time after which Agreement expires. Example: 2020-12-31T23:59:00Z |
|
Reminder Frequency
|
reminderFrequency | string |
How often do you want to send reminders ? |
|
Document Password
|
openPassword | string |
The password that should be used to encrypt the signed agreement PDF |
|
Name
|
fieldName | string |
The name of the field |
|
Value
|
defaultValue | string |
The default value of the field |
|
Redirect Delay
|
redirectDelay | string |
The delay (in seconds) before the user is taken to the success page. |
|
Redirect URL
|
redirectUrl | string |
URL to redirect after completing the signing process, e.g. https://adobe.com |
|
Initial Emails
|
initEmails | string |
Control notification mails for Agreement initiation events. |
Returns
A JSON that contains the ID of the newly created agreement
This operation creates an agreement from a template stored in the user's Adobe Acrobat Sign library and sends it for signature.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement Name
|
name | True | string |
The name of the agreement |
Document Library Template
|
libraryDocumentId | True | string |
Choose a document from the templates stored in your library |
Signature Type
|
signatureType | True | string |
The type of signature you would like to request - E-signature or Written |
Recipient Email
|
True | string |
Email of the recipient |
|
Recipient Signing Order
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role
|
recipientSetRole | True | string |
Specify the role of recipient |
Message
|
message | string |
An optional message to the recipients requesting their action |
|
Days to Deadline
|
daysUntilSigningDeadline | integer |
The number of days that remain before the document expires |
|
Reminder Frequency
|
reminderFrequency | string |
How often do you want to send reminders? |
|
Document Password
|
openPassword | string |
The password that should be used to encrypt the signed agreement PDF |
|
Document Library Template (2)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Document Library Template (3)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Document Library Template (4)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Document Library Template (5)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Document Library Template (6)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Document Library Template (7)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Document Library Template (8)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Document Library Template (9)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Document Library Template (10)
|
libraryDocumentId | string |
Choose a document from the templates stored in your library |
|
Recipient Email (2)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (2)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (2)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (3)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (3)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (3)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (4)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (4)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (4)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (5)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (5)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (5)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (6)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (6)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (6)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (7)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (7)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (7)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (8)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (8)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (8)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (9)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (9)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (9)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (10)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (10)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (10)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (11)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (11)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (11)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (12)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (12)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (12)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (13)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (13)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (13)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (14)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (14)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (14)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (15)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (15)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (15)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (16)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (16)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (16)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (17)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (17)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (17)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (18)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (18)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (18)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (19)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (19)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (19)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (20)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (20)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (20)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (21)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (21)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (21)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (22)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (22)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (22)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (23)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (23)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (23)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (24)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (24)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (24)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (25)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (25)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (25)
|
recipientSetRole | True | string |
Specify the role of recipient |
Form Field Name (1)
|
fieldName | string |
The name of the field |
|
Form Field Value (1)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (2)
|
fieldName | string |
The name of the field |
|
Form Field Value (2)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (3)
|
fieldName | string |
The name of the field |
|
Form Field Value (3)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (4)
|
fieldName | string |
The name of the field |
|
Form Field Value (4)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (5)
|
fieldName | string |
The name of the field |
|
Form Field Value (5)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (6)
|
fieldName | string |
The name of the field |
|
Form Field Value (6)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (7)
|
fieldName | string |
The name of the field |
|
Form Field Value (7)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (8)
|
fieldName | string |
The name of the field |
|
Form Field Value (8)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (9)
|
fieldName | string |
The name of the field |
|
Form Field Value (9)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (10)
|
fieldName | string |
The name of the field |
|
Form Field Value (10)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (11)
|
fieldName | string |
The name of the field |
|
Form Field Value (11)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (12)
|
fieldName | string |
The name of the field |
|
Form Field Value (12)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (13)
|
fieldName | string |
The name of the field |
|
Form Field Value (13)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (14)
|
fieldName | string |
The name of the field |
|
Form Field Value (14)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (15)
|
fieldName | string |
The name of the field |
|
Form Field Value (15)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (16)
|
fieldName | string |
The name of the field |
|
Form Field Value (16)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (17)
|
fieldName | string |
The name of the field |
|
Form Field Value (17)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (18)
|
fieldName | string |
The name of the field |
|
Form Field Value (18)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (19)
|
fieldName | string |
The name of the field |
|
Form Field Value (19)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (20)
|
fieldName | string |
The name of the field |
|
Form Field Value (20)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (21)
|
fieldName | string |
The name of the field |
|
Form Field Value (21)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (22)
|
fieldName | string |
The name of the field |
|
Form Field Value (22)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (23)
|
fieldName | string |
The name of the field |
|
Form Field Value (23)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (24)
|
fieldName | string |
The name of the field |
|
Form Field Value (24)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (25)
|
fieldName | string |
The name of the field |
|
Form Field Value (25)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (26)
|
fieldName | string |
The name of the field |
|
Form Field Value (26)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (27)
|
fieldName | string |
The name of the field |
|
Form Field Value (27)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (28)
|
fieldName | string |
The name of the field |
|
Form Field Value (28)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (29)
|
fieldName | string |
The name of the field |
|
Form Field Value (29)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (30)
|
fieldName | string |
The name of the field |
|
Form Field Value (30)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (31)
|
fieldName | string |
The name of the field |
|
Form Field Value (31)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (32)
|
fieldName | string |
The name of the field |
|
Form Field Value (32)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (33)
|
fieldName | string |
The name of the field |
|
Form Field Value (33)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (34)
|
fieldName | string |
The name of the field |
|
Form Field Value (34)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (35)
|
fieldName | string |
The name of the field |
|
Form Field Value (35)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (36)
|
fieldName | string |
The name of the field |
|
Form Field Value (36)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (37)
|
fieldName | string |
The name of the field |
|
Form Field Value (37)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (38)
|
fieldName | string |
The name of the field |
|
Form Field Value (38)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (39)
|
fieldName | string |
The name of the field |
|
Form Field Value (39)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (40)
|
fieldName | string |
The name of the field |
|
Form Field Value (40)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (41)
|
fieldName | string |
The name of the field |
|
Form Field Value (41)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (42)
|
fieldName | string |
The name of the field |
|
Form Field Value (42)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (43)
|
fieldName | string |
The name of the field |
|
Form Field Value (43)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (44)
|
fieldName | string |
The name of the field |
|
Form Field Value (44)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (45)
|
fieldName | string |
The name of the field |
|
Form Field Value (45)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (46)
|
fieldName | string |
The name of the field |
|
Form Field Value (46)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (47)
|
fieldName | string |
The name of the field |
|
Form Field Value (47)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (48)
|
fieldName | string |
The name of the field |
|
Form Field Value (48)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (49)
|
fieldName | string |
The name of the field |
|
Form Field Value (49)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (50)
|
fieldName | string |
The name of the field |
|
Form Field Value (50)
|
defaultValue | string |
The default value of the field |
Returns
A JSON that contains the ID of the newly created agreement
This operation creates an agreement from a workflow in Adobe Acrobat Sign and sends it for signature.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | True | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Group Name/ID
|
groupId | True | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
Workflow Name/ID
|
workflowIdParam | True | string |
Select custom workflow from the list or enter the custom workflow ID. |
agreementWorkflowSchema
|
agreementWorkflowSchema | True | dynamic |
Details for the selected event. |
Returns
A JSON that contains the ID of the newly created agreement
This operation creates an agreement from a document uploaded in Adobe Acrobat Sign and sends it for signature.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Agreement Name
|
name | True | string |
The name of the agreement |
ID
|
transientDocumentId | True | string |
The document id received by uploading a transient document |
Signature Type
|
signatureType | True | string |
The type of signature you would like to request - e-signature or written |
Participant Email
|
True | string |
The email of the participant |
|
Authentication
|
authenticationMethod | string |
Default authentication: email (None) |
|
Password
|
password | string |
The password required for the participant |
|
Country Code
|
countryCode | string |
Recipient's phone country code required to view & sign the document |
|
Phone No.
|
phone | string |
Recipient's phone number required to view & sign the agreement |
|
Order
|
order | True | integer |
Index starting with 1, indicating position at which signing group needs to sign. |
Role
|
role | True | string |
The current roles of the participant set (signer, approver etc). |
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
|
Message
|
message | string |
An optional message to the recipients requesting their action |
|
Email
|
string |
The email of the CC of the agreement |
||
Expiration Time
|
expirationTime | string |
Time after which Agreement expires. Example: 2020-12-31T23:59:00Z |
|
Reminder Frequency
|
reminderFrequency | string |
How often do you want to send reminders ? |
|
Document Password
|
openPassword | string |
The password that should be used to encrypt the signed agreement PDF |
|
Name
|
fieldName | string |
The name of the field |
|
Value
|
defaultValue | string |
The default value of the field |
|
Redirect Delay
|
redirectDelay | string |
The delay (in seconds) before the user is taken to the success page. |
|
Redirect URL
|
redirectUrl | string |
URL to redirect after completing the signing process, e.g. https://adobe.com |
|
Initial Emails
|
initEmails | string |
Control notification mails for Agreement initiation events. |
Returns
A JSON that contains the ID of the newly created agreement
This operation creates an agreement from a document uploaded in Adobe Acrobat Sign and sends it for signature.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement Name
|
name | True | string |
The name of the agreement |
Document ID
|
transientDocumentId | True | string |
The document ID received by uploading a document |
Signature Type
|
signatureType | True | string |
The type of signature you would like to request - E-signature or Written |
Recipient Email
|
True | string |
Email of the recipient |
|
Recipient Signing Order
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role
|
recipientSetRole | True | string |
Specify the role of recipient |
Message
|
message | string |
An optional message to the recipients requesting their action |
|
Days to Deadline
|
daysUntilSigningDeadline | integer |
The number of days that remain before the document expires |
|
Reminder Frequency
|
reminderFrequency | string |
How often do you want to send reminders? |
|
Document Password
|
openPassword | string |
The password that should be used to encrypt the signed agreement PDF |
|
Document ID (2)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (3)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (4)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (5)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (6)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (7)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (8)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (9)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Document ID (10)
|
transientDocumentId | string |
The document ID received by uploading a document |
|
Recipient Email (2)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (2)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (2)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (3)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (3)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (3)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (4)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (4)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (4)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (5)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (5)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (5)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (6)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (6)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (6)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (7)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (7)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (7)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (8)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (8)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (8)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (9)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (9)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (9)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (10)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (10)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (10)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (11)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (11)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (11)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (12)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (12)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (12)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (13)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (13)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (13)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (14)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (14)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (14)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (15)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (15)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (15)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (16)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (16)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (16)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (17)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (17)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (17)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (18)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (18)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (18)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (19)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (19)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (19)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (20)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (20)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (20)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (21)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (21)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (21)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (22)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (22)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (22)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (23)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (23)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (23)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (24)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (24)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (24)
|
recipientSetRole | True | string |
Specify the role of recipient |
Recipient Email (25)
|
True | string |
Email of the recipient |
|
Recipient Signing Order (25)
|
signingOrder | True | integer |
Index starting with 1, that tells the order in which this recipient signs |
Recipient Role (25)
|
recipientSetRole | True | string |
Specify the role of recipient |
Form Field Name (1)
|
fieldName | string |
The name of the field |
|
Form Field Value (1)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (2)
|
fieldName | string |
The name of the field |
|
Form Field Value (2)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (3)
|
fieldName | string |
The name of the field |
|
Form Field Value (3)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (4)
|
fieldName | string |
The name of the field |
|
Form Field Value (4)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (5)
|
fieldName | string |
The name of the field |
|
Form Field Value (5)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (6)
|
fieldName | string |
The name of the field |
|
Form Field Value (6)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (7)
|
fieldName | string |
The name of the field |
|
Form Field Value (7)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (8)
|
fieldName | string |
The name of the field |
|
Form Field Value (8)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (9)
|
fieldName | string |
The name of the field |
|
Form Field Value (9)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (10)
|
fieldName | string |
The name of the field |
|
Form Field Value (10)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (11)
|
fieldName | string |
The name of the field |
|
Form Field Value (11)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (12)
|
fieldName | string |
The name of the field |
|
Form Field Value (12)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (13)
|
fieldName | string |
The name of the field |
|
Form Field Value (13)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (14)
|
fieldName | string |
The name of the field |
|
Form Field Value (14)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (15)
|
fieldName | string |
The name of the field |
|
Form Field Value (15)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (16)
|
fieldName | string |
The name of the field |
|
Form Field Value (16)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (17)
|
fieldName | string |
The name of the field |
|
Form Field Value (17)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (18)
|
fieldName | string |
The name of the field |
|
Form Field Value (18)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (19)
|
fieldName | string |
The name of the field |
|
Form Field Value (19)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (20)
|
fieldName | string |
The name of the field |
|
Form Field Value (20)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (21)
|
fieldName | string |
The name of the field |
|
Form Field Value (21)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (22)
|
fieldName | string |
The name of the field |
|
Form Field Value (22)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (23)
|
fieldName | string |
The name of the field |
|
Form Field Value (23)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (24)
|
fieldName | string |
The name of the field |
|
Form Field Value (24)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (25)
|
fieldName | string |
The name of the field |
|
Form Field Value (25)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (26)
|
fieldName | string |
The name of the field |
|
Form Field Value (26)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (27)
|
fieldName | string |
The name of the field |
|
Form Field Value (27)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (28)
|
fieldName | string |
The name of the field |
|
Form Field Value (28)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (29)
|
fieldName | string |
The name of the field |
|
Form Field Value (29)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (30)
|
fieldName | string |
The name of the field |
|
Form Field Value (30)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (31)
|
fieldName | string |
The name of the field |
|
Form Field Value (31)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (32)
|
fieldName | string |
The name of the field |
|
Form Field Value (32)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (33)
|
fieldName | string |
The name of the field |
|
Form Field Value (33)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (34)
|
fieldName | string |
The name of the field |
|
Form Field Value (34)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (35)
|
fieldName | string |
The name of the field |
|
Form Field Value (35)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (36)
|
fieldName | string |
The name of the field |
|
Form Field Value (36)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (37)
|
fieldName | string |
The name of the field |
|
Form Field Value (37)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (38)
|
fieldName | string |
The name of the field |
|
Form Field Value (38)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (39)
|
fieldName | string |
The name of the field |
|
Form Field Value (39)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (40)
|
fieldName | string |
The name of the field |
|
Form Field Value (40)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (41)
|
fieldName | string |
The name of the field |
|
Form Field Value (41)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (42)
|
fieldName | string |
The name of the field |
|
Form Field Value (42)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (43)
|
fieldName | string |
The name of the field |
|
Form Field Value (43)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (44)
|
fieldName | string |
The name of the field |
|
Form Field Value (44)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (45)
|
fieldName | string |
The name of the field |
|
Form Field Value (45)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (46)
|
fieldName | string |
The name of the field |
|
Form Field Value (46)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (47)
|
fieldName | string |
The name of the field |
|
Form Field Value (47)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (48)
|
fieldName | string |
The name of the field |
|
Form Field Value (48)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (49)
|
fieldName | string |
The name of the field |
|
Form Field Value (49)
|
defaultValue | string |
The default value of the field |
|
Form Field Name (50)
|
fieldName | string |
The name of the field |
|
Form Field Value (50)
|
defaultValue | string |
The default value of the field |
Returns
A JSON that contains the ID of the newly created agreement
This operation fetches the file stream of a specific document of the agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose document is needed |
Document ID
|
documentId | True | string |
The document ID of the specific document of the agreement |
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Returns
The file stream of the document
- response
- DocumentResponse
This action has been deprecated. Please use Get a document from an agreement instead.
This operation fetches the file stream of a specific document of the agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose document is needed |
Document ID
|
documentId | True | string |
The document ID of the specific document of the agreement |
Returns
The file stream of the document
- response
- DocumentResponse
This operation fetches the list of all agreements of the user.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Cursor
|
cursor | string |
Used to navigate through the pages. If not provided, returns the first page. |
|
Page Size
|
pageSize | integer |
Number of items in the response page. By default: 100; Max: 10000 |
|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
Returns
A JSON that contains the user agreement array object
- Body
- userAgreementListV6
This operation fetches the list of all agreements of the user.
Returns
A JSON that contains the user agreement array object
- Body
- UserAgreements
This operation searches agreements by criteria such as Workflow ID, etc.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
|
Workflow Name/ID
|
workflowId | string |
Select custom workflow from the list or enter the custom workflow ID. |
|
Created After
|
gt | string |
The minimum allowed date-time. Example: 2020-12-31T23:59:00Z |
|
Created Before
|
lt | string |
The maximum allowed date-time. Example: 2023-12-31T23:59:00Z |
|
Page Size
|
pageSize | integer |
Number of items in the response page. By default: 50; Max: 500 |
|
Start Index
|
startIndex | integer |
0-based first row (offset) of the search results to return. |
Returns
A JSON that contains the user agreement array object
- Body
- userAgreementListV6
This operation fetches the list of all groups user belongs to.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
User ID
|
userId | True | string |
To get result for authorized user, user ID can be replaced by 'me' without quotes. |
Returns
A JSON that contains the list of groups for given user
- Body
- UserGroupsInfoV6
This operation fetches the list of all documents stored as templates in the Adobe Acrobat Sign library of the user.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Cursor
|
cursor | string |
Used to navigate through the pages. If not provided, returns the first page. |
|
Page Size
|
pageSize | integer |
Number of items in the response page. By default: 100; Max: 10000 |
|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
Returns
A JSON that contains the library template array object
- Body
- LibraryDocuments
This operation fetches the list of all documents stored as templates in the Adobe Acrobat Sign library of the user.
Returns
A JSON that contains the library template array object
- Body
- DocumentLibraryItems
This operation fetches the IDs of all documents and supporting documents of an agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose documents are needed |
Supporting documents - Content Type
|
supportingDocumentContentFormat | string |
Content type of the supporting documents of the agreement |
|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Returns
A JSON that contains both the documents and supporting documents array objects
- Body
- AgreementDocumentsV6
This action has been deprecated. Please use Get a list of all the document IDs from an agreement instead.
This operation fetches the IDs of all documents and supporting documents of an agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose documents are needed |
Supporting documents - Content Type
|
supportingDocumentContentFormat | string |
Content type of the supporting documents of the agreement |
Returns
A JSON that contains both the documents and supporting documents array objects
- Body
- AgreementDocuments
This operation fetches the list of all web forms of the user.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Cursor
|
cursor | string |
Used to navigate through the pages. If not provided, returns the first page. |
|
Page Size
|
pageSize | integer |
Number of items in the response page. By default: 100; Max: 10000 |
|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
Returns
A JSON that contains the user web form array object
- Body
- userWidgetListV6
This operation fetches the list of all workflows of the user.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Include Draft Workflows
|
includeDraftWorkflows | boolean |
Include draft workflows |
|
Include Inactive Workflows
|
includeInactiveWorkflows | boolean |
Include inactive workflows |
|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
Returns
A JSON that contains the user workflow array object
- Body
- userWorkflowListV6
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.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID as provided by the action that creates the agreement |
Attach Supporting Documents?
|
attachSupportingDocuments | boolean |
If true, attach supporting documents to the signed agreement PDF |
|
Attach Audit Report?
|
attachAuditReport | boolean |
If true, attach an audit report to the signed agreement PDF |
|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Returns
The file stream of the document
- response
- CombinedDocumentResponse
This action has been deprecated. Please use Get a PDF of a signed agreement instead.
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.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID as provided by the action that creates the agreement |
Attach Supporting Documents?
|
attachSupportingDocuments | boolean |
If true, attach supporting documents to the signed agreement PDF |
|
Attach Audit Report?
|
auditReport | boolean |
If true, attach an audit report to the signed agreement PDF |
Returns
The file stream of the document
- response
- CombinedDocumentResponse
This operation fetches the PDF file stream of the agreement audit trail. Note that the file stream should be stored with a filename ending in .pdf file extension.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose information is needed |
Returns
The file stream of the agreement audit trail
- response
- AgreementAuditTrailResponse
Retrieves data entered into the interactive form fields of the agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose information is needed |
Returns
- response
- file
Retrieves data entered into the interactive form fields of the agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose information is needed |
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Returns
The content of the Form Data
- Form Data Content
- binary
Retrieves data entered into the interactive form fields of the agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose information is needed |
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Returns
The content of the Form Data
- Form Data Content
- object
This operation fetches detailed pieces of information about the workflow.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Workflow ID
|
workflowId | True | string |
The workflow ID of the workflow whose information is needed |
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
|
Group Name/ID
|
groupId | string |
ID of the group. To use this - field 'In The Name Of' needs to be selected |
Returns
A JSON that contains detailed info about the workflow
This operation fetches all the current information of an agreement, like status.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose information is needed |
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Returns
Complete Agreement Details
- Body
- AgreementInfoV6
This action has been deprecated. Please use Get the status of an agreement instead.
This operation fetches all the current information of an agreement, like status.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID of the agreement whose information is needed |
Returns
The complete details about the agreement
- Body
- AgreementInfo
This operation retrieves the URL for the e-sign page for the current signer(s) of an agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Agreement ID
|
agreementId | True | string |
The agreement ID as provided by the action that creates the agreement |
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Returns
- Body
- SigningUrlResponse
This operation uploads a document in your Adobe Acrobat Sign account and returns a document ID for it. This document is temporarily stored in Adobe Acrobat Sign and the document ID can be used for further operations like creating an agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Name
|
File-Name | True | string |
The name of the document to be uploaded, with extension |
File Content
|
File | True | contentOnly |
The file stream of the document to be uploaded |
In the name of
|
x-api-user | string |
The email of API caller in the format: email:adobesignuser@domain.com |
Returns
A JSON that contains the ID of the uploaded document
This operation uploads a document in your Adobe Acrobat Sign account and returns a document ID for it. This document is temporarily stored in Adobe Acrobat Sign and the document ID can be used for further operations like creating an agreement.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Name
|
File-Name | True | string |
The name of the document to be uploaded, with extension |
File Content
|
File | True | contentOnly |
The file stream of the document to be uploaded |
Returns
A JSON that contains the ID of the uploaded document
When a group event occurs |
Triggers a new flow when a group event occurs. Covers all Agreement, Mega Sign and Web Form events. |
When a new agreement is created |
Triggers a new flow when a new agreement is created. |
When a web form agreement event occurs |
Triggers a new flow when web form agreement event occurs. Covers most common Agreement events such as creation, completion, etc. |
When an agreement is sent to a participant |
Triggers a new flow when an agreement is sent to a participant. |
When an agreement workflow is completed successfully |
Triggers a new flow when an agreement workflow is completed successfully |
When an event occurs |
Triggers a new flow when an event occurs. Covers all Agreement, Mega Sign and Web Form events. |
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. |
Triggers a new flow when a group event occurs. Covers all Agreement, Mega Sign and Web Form events.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name of the trigger |
Group Name/ID
|
resourceId | string |
ID of the group |
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
The events for which the flow should be triggered |
Include Agreement Info?
|
includeDetailedInfo | boolean |
Should detailed agreement info be sent in notification? |
|
Include Agreement Participant Info?
|
includeParticipantsInfo | boolean |
Should agreement participant info be sent in notification? |
|
Include Agreement Document Info?
|
includeDocumentsInfo | boolean |
Should agreement document info be sent in notification? |
|
Include Agreement Signed Document Info?
|
includeSignedDocuments | boolean |
Should a final copy of signed document on agreement completion be sent in notification? |
|
Include MegaSign Info?
|
includeDetailedInfo | boolean |
Should detailed mega sign info be sent in notification? |
|
Include Web Form Info?
|
includeDetailedInfo | boolean |
Should detailed web form info be sent in notification? |
|
Include Web Form Participant Info?
|
includeParticipantsInfo | boolean |
Should web form participant info be sent in notification? |
|
Include Web Form Documents Info?
|
includeDocumentsInfo | boolean |
Should web form document info be sent in notification? |
Returns
Triggers a new flow when a new agreement is created.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name of the trigger |
Scope
|
scope | True | string |
The scope of the trigger |
Subscription
|
webhookSubscriptionEvents | True | array of string |
The events for which the flow should be triggered |
Include Agreement Info?
|
includeDetailedInfo | boolean |
Should detailed agreement info be sent in notification? |
|
Include Agreement Participant Info?
|
includeParticipantsInfo | boolean |
Should agreement participant info be sent in notification? |
Returns
Triggers a new flow when web form agreement event occurs. Covers most common Agreement events such as creation, completion, etc.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name of the trigger |
Web Forms Page Size
|
pageSize | integer |
Select the number of web forms to display in the drop down list |
|
Web Form Name/ID
|
resourceId | True | string |
Select web form from the list or enter the web form ID. |
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
The events for which the flow should be triggered |
Include Agreement Info?
|
includeDetailedInfo | boolean |
Should detailed agreement info be sent in notification? |
|
Include Agreement Participant Info?
|
includeParticipantsInfo | boolean |
Should agreement participant info be sent in notification? |
|
Include Agreement Document Info?
|
includeDocumentsInfo | boolean |
Should agreement document info be sent in notification? |
|
Include Agreement Signed Document Info?
|
includeSignedDocuments | boolean |
Should a final copy of signed document be sent in notification of agreement completion? |
Returns
Triggers a new flow when an agreement is sent to a participant.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name of the trigger |
Scope
|
scope | True | string |
The scope of the trigger |
Agreement Name/ID
|
resourceId | string |
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID. |
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
The events for which the flow should be triggered |
Include Agreement Info?
|
includeDetailedInfo | boolean |
Should detailed agreement info be sent in notification? |
|
Include Agreement Participant Info?
|
includeParticipantsInfo | boolean |
Should agreement participant info be sent in notification? |
|
Include Agreement Document Info?
|
includeDocumentsInfo | boolean |
Should agreement document info be sent in notification? |
Returns
- Body
- WebhookPayload
Triggers a new flow when an agreement workflow is completed successfully
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name of the trigger |
Scope
|
scope | True | string |
The scope of the trigger |
Agreement Name/ID
|
resourceId | string |
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID. |
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
The events for which the flow should be triggered |
Include Agreement Info?
|
includeDetailedInfo | boolean |
Should detailed agreement info be sent in notification? |
|
Include Agreement Participant Info?
|
includeParticipantsInfo | boolean |
Should agreement participant info be sent in notification? |
|
Include Agreement Document Info?
|
includeDocumentsInfo | boolean |
Should agreement document info be sent in notification? |
|
Include Agreement Signed Document Info?
|
includeSignedDocuments | boolean |
Should a final copy of signed document on agreement completion be sent in notification? |
Returns
Triggers a new flow when an event occurs. Covers all Agreement, Mega Sign and Web Form events.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name of the trigger |
Scope
|
scope | True | string |
The scope of the trigger |
Resource Type
|
resourceType | string |
Specify only when "Scope" is "A specific resource". Select the resource type for which the flow should be triggered. |
|
Resource ID
|
resourceId | string |
Specify only when "Scope" is "A specific resource". Enter the agreement or mega sign or web form or group ID for which the flow should be triggered. |
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
The events for which the flow should be triggered |
Include Agreement Info?
|
includeDetailedInfo | boolean |
Should detailed agreement info be sent in notification? |
|
Include Agreement Participant Info?
|
includeParticipantsInfo | boolean |
Should agreement participant info be sent in notification? |
|
Include Agreement Document Info?
|
includeDocumentsInfo | boolean |
Should agreement document info be sent in notification? |
|
Include Agreement Signed Document Info?
|
includeSignedDocuments | boolean |
Should a final copy of signed document on agreement completion be sent in notification? |
|
Include MegaSign Info?
|
includeDetailedInfo | boolean |
Should detailed mega sign info be sent in notification? |
|
Include Web Form Info?
|
includeDetailedInfo | boolean |
Should detailed web form info be sent in notification? |
|
Include Web Form Participant Info?
|
includeParticipantsInfo | boolean |
Should web form participant info be sent in notification? |
|
Include Web Form Documents Info?
|
includeDocumentsInfo | boolean |
Should web form document info be sent in notification? |
Returns
Triggers a new flow when the status of an agreement changes. Covers most common Agreement events such as creation, completion, etc.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Name
|
name | True | string |
The name of the trigger |
Scope
|
scope | True | string |
The scope of the trigger |
Agreement Name/ID
|
resourceId | string |
Specify only when "Scope" is "A specific agreement". Select an agreement from the list or enter the agreement ID. |
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
The events for which the flow should be triggered |
Include Agreement Info?
|
includeDetailedInfo | boolean |
Should detailed agreement info be sent in notification? |
|
Include Agreement Participant Info?
|
includeParticipantsInfo | boolean |
Should agreement participant info be sent in notification? |
|
Include Agreement Document Info?
|
includeDocumentsInfo | boolean |
Should agreement document info be sent in notification? |
|
Include Agreement Signed Document Info?
|
includeSignedDocuments | boolean |
Should a final copy of signed document be sent in notification of agreement completion? |
Returns
A JSON that contains the ID of the newly created agreement
Name | Path | Type | Description |
---|---|---|---|
Agreement ID
|
agreementId | string |
The unique ID of the agreement that can be used to query status and download signed documents |
A JSON that contains the ID of the newly created agreement
Name | Path | Type | Description |
---|---|---|---|
Agreement ID
|
id | string |
The unique ID of the agreement that can be used to query status and download signed documents |
A JSON that contains both the documents and supporting documents array objects
Name | Path | Type | Description |
---|---|---|---|
Documents
|
documents | array of Document |
A list of objects representing the documents |
Supporting Documents
|
supportingDocuments | array of SupportingDocument |
A list of supporting documents. This is returned only if there are any supporting document in the agreement |
A JSON that contains both the documents and supporting documents array objects
Name | Path | Type | Description |
---|---|---|---|
Documents
|
documents | array of DocumentV6 |
A list of objects representing the documents |
Supporting Documents
|
supportingDocuments | array of SupportingDocumentV6 |
A list of supporting documents. This is returned only if there are any supporting document in the agreement |
The complete details about the agreement
Name | Path | Type | Description |
---|---|---|---|
Agreement ID
|
agreementId | string |
A unique ID that can be used to uniquely identify the agreement |
Events
|
events | array of DocumentHistoryEvent |
An ordered list of the events in the audit trail of this document |
Expiration Date
|
expiration | date |
The date after which the agreement can no longer be signed |
Latest Version ID
|
latestVersionId | string |
A unique ID which uniquely identifies the current version of the agreement |
Message
|
message | string |
The message associated with the agreement that the sender has provided |
Agreement Name
|
name | string |
The name of the agreement, specified by the sender |
Next Participant Sets
|
nextParticipantSetInfos | array of NextParticipantSetInfo |
Information about who needs to act next for this agreement |
Participant Sets
|
participantSetInfos | array of ParticipantSetInfo |
Information about all the participant sets of this document |
Signature Type
|
signatureType | string |
Specifies the Signature type that was requested - E-signature or Written |
Document Protection
|
securityOptions | string |
Security information about the document that specifies whether or not a password is required to view and sign it |
Status
|
status | string |
The current status of the agreement |
Complete Agreement Details
Name | Path | Type | Description |
---|---|---|---|
Agreement ID
|
id | string |
A unique ID that can be used to uniquely identify the agreement |
Created Date
|
createdDate | date |
Date when agreement was created |
First Reminder Delay
|
firstReminderDelay | integer |
Integer which specifies the delay in hours before sending the first reminder. |
Reminder Frequency
|
reminderFrequency | string |
How often do you want to send reminders? |
Expiration Date
|
expiration | date |
The date after which the agreement can no longer be signed |
Locale
|
locale | string |
The locale associated with this agreement - for example, en_US or fr_FR |
Message
|
message | string |
The message associated with the agreement that the sender has provided |
Agreement Name
|
name | string |
The name of the agreement, specified by the sender |
Document Visibility?
|
documentVisibilityEnabled | boolean |
Is document visibility enabled? |
Participant Sets
|
participantSetsInfo | array of ParticipantSetInfoV6 |
Information about all the participant sets of this document |
Signature Type
|
signatureType | string |
Specifies the Signature type that was requested - E-signature or Written |
Security Options
|
securityOptions | string |
Security information about the document that specifies whether or not a password is required to view and sign it |
Status
|
status | string |
The current status of the agreement |
Sender Email
|
senderEmail | string |
The email of the sender |
Workflow ID
|
workflowId | string |
The ID of custom workflow which defines the routing path of an agreement. |
CCs
|
ccs | array of CcInfo |
A list of one or more CCs that will be copied in the agreement transaction. |
Group ID
|
groupId | string |
The unique identifier of the group to which the agreement belongs to. |
The file stream of the agreement audit trail
The file stream of the agreement audit trail
- Agreement Audit Trail Content
- binary
Name | Path | Type | Description |
---|---|---|---|
Company
|
company | string |
Displays the name of the company of the user, if available |
Email
|
string |
Displays the email of the user |
|
Full Name
|
fullName | string |
Displays the full name of the user, if available. |
Name | Path | Type | Description |
---|---|---|---|
Display User Set Info
|
displayUserSetMemberInfos | array of DisplayUserInfo |
Displays the info about user set |
Display User Set Name
|
displayUserSetName | string |
The information about the document
Name | Path | Type | Description |
---|---|---|---|
Document ID
|
documentId | string |
The unique ID of the document |
Mime Type
|
mimeType | string |
The Mime type of the document |
Name
|
name | string |
The name of the document |
Num Pages
|
numPages | integer |
Number of pages in the document |
The information about the document
Name | Path | Type | Description |
---|---|---|---|
Document ID
|
id | string |
The unique ID of the document |
Mime Type
|
mimeType | string |
The Mime type of the document |
Name
|
name | string |
The name of the document |
Num Pages
|
numPages | integer |
Number of pages in the document |
Name | Path | Type | Description |
---|---|---|---|
Event Initiator
|
actingUserEmail | string |
Email address of the user that initiated the event |
Event Date
|
date | date |
The date of the audit event |
Event Description
|
description | string |
A description of the audit event |
Participant Email
|
participantEmail | string |
Email address of the user that initiated the event |
Event Type
|
type | string |
Type of agreement event |
Name | Path | Type | Description |
---|---|---|---|
Library Template Id
|
libraryDocumentId | string |
The unique ID of the library document used when sending the document to be signed |
Library Template Types
|
libraryTemplateTypes | array of string |
A list of one or more library template types |
Modified Date
|
modifiedDate | date |
The day on which the library template was last modified |
Library Template Name
|
name | string |
The name of the library template |
Template Sharing Mode
|
scope | string |
The scope of visibility of the library template |
A JSON that contains the library template array object
Name | Path | Type | Description |
---|---|---|---|
Library Templates List
|
libraryDocumentList | array of DocumentLibraryItem |
A list of library template items |
A JSON object describing the library template
Name | Path | Type | Description |
---|---|---|---|
Library Template Id
|
libraryDocumentId | string |
The unique ID that can be used to refer to the library template |
Name | Path | Type | Description |
---|---|---|---|
Email
|
string |
The email address of the next participant |
|
Name
|
name | string |
The name of the next participant, if available |
Waiting Since
|
waitingSince | date |
The date since which the document has been waiting for the participant to take action |
Name | Path | Type | Description |
---|---|---|---|
Next Participant Set Member Infos
|
nextParticipantSetMemberInfos | array of NextParticipantInfo |
Information about the members of the next participant set |
Name | Path | Type | Description |
---|---|---|---|
Company
|
company | string |
The company of the participant, if available |
Email
|
string |
The email address of the participant |
|
Name
|
name | string |
The name of the participant, if available |
Participant ID
|
participantId | string |
The unique ID of the participant |
Security Options
|
securityOptions | array of string |
Security options that apply to the participant |
Title
|
title | string |
The title of the participant, if available |
Name | Path | Type | Description |
---|---|---|---|
Participant Set ID
|
participantSetId | string |
The unique ID of the participant set |
Participant Set Member Infos
|
participantSetMemberInfos | array of ParticipantInfo |
Information about the members of the recipient set |
Private Message
|
privateMessage | string |
Private message for the participants in the set |
Role
|
roles | array of string |
The current roles of the participant set. A participant set can have one or more roles |
securityOptions
|
securityOptions | array of string |
Security options that apply to the participant |
Signing Order
|
signingOrder | integer |
Index starting with 1, that tells the order in which this recipient signs |
Participant Set Status
|
status | string |
The participant set status with respect to the document |
Name | Path | Type | Description |
---|---|---|---|
Participant Set Member Infos
|
memberInfos | array of MemberInfosV6 |
Information about the members of the recipient set |
Order
|
order | integer |
Index indicating position at which signing group needs to sign. |
Role
|
role | string |
The current roles of the participant set (signer, approver etc). |
Participant Set Name
|
name | string |
The name of the participant set |
Participant Set Private Messsage
|
privateMessage | string |
Private message for the participants in the set |
Participant Set Visible Pages
|
visiblePages | array of string |
The pages that are visible to the participant set |
Name | Path | Type | Description |
---|---|---|---|
Participant Email
|
string |
The email of the participant |
|
Authentication
|
securityOption.authenticationMethod | string |
Default authentication: email (None) |
Password
|
securityOption.password | string |
The password required for the participant |
Country Code
|
securityOption.phoneInfo.countryCode | string |
Recipient's phone country code required to view & sign the document |
Phone No.
|
securityOption.phoneInfo.phone | string |
Recipient's phone number required to view & sign the agreement |
Name | Path | Type | Description |
---|---|---|---|
Email for Sign URL
|
string |
The email address of the signer associated with this signing url |
|
Sign URL
|
esignUrl | string |
The URL address of the signer associated with this signing url |
Name | Path | Type | Description |
---|---|---|---|
Array of URLs for signer sets
|
signingUrlSetInfos | array of SigningUrlSetInfo |
An array of urls for signer sets involved in this agreement |
Name | Path | Type | Description |
---|---|---|---|
- Signing URL Array
|
signingUrls | array of SigningUrl |
An array of urls for current signer set |
- Sign URL set name
|
signingUrlSetName | string |
The name of the current signer set |
The information about the supporting document
Name | Path | Type | Description |
---|---|---|---|
Supporting Document Name
|
displayLabel | string |
Display name of the supporting document |
Supporting Document Field Name
|
fieldName | string |
The name of the supporting document field |
Supporting Document Mime Type
|
mimeType | string |
The Mime type of the supporting document |
Supporting Document Pages
|
numPages | integer |
Number of pages in the supporting document |
Supporting Document ID
|
supportingDocumentId | string |
Unique ID representing the supporting document |
The information about the supporting document
Name | Path | Type | Description |
---|---|---|---|
Supporting Document Name
|
displayLabel | string |
Display name of the supporting document |
Supporting Document Field Name
|
fieldName | string |
The name of the supporting document field |
Supporting Document Mime Type
|
mimeType | string |
The Mime type of the supporting document |
Supporting Document Pages
|
numPages | integer |
Number of pages in the supporting document |
Supporting Document ID
|
id | string |
Unique ID representing the supporting document |
A JSON that contains the ID of the uploaded document
Name | Path | Type | Description |
---|---|---|---|
Document ID
|
transientDocumentId | string |
The document ID of the uploaded document |
Name | Path | Type | Description |
---|---|---|---|
Agreement ID
|
agreementId | string |
A unique ID that can be used to uniquely identify the agreement |
Display User Set Infos
|
displayUserSetInfos | 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 |
Display Date
|
displayDate | date |
The display date for the agreement |
Esign
|
esign | boolean |
True if this is an e-sign document |
Latest Version ID
|
latestVersionId | string |
A version ID which uniquely identifies the current version of the agreement |
Name
|
name | string |
Name of the Agreement |
Status
|
status | string |
The current status of the agreement |
A JSON that contains the user agreement array object
Name | Path | Type | Description |
---|---|---|---|
Agreement List
|
userAgreementList | array of UserAgreement |
An array of agreement items |
Name | Path | Type | Description |
---|---|---|---|
Display User Set Infos
|
displayParticipantSetInfos | 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 |
Display Date
|
displayDate | string |
The display date for the agreement |
Esign
|
esign | boolean |
True if this is an e-sign document |
Hidden
|
hidden | boolean |
True if agreement is hidden for the user |
Group ID
|
groupId | string |
Unique identifier of the group |
Latest Version ID
|
latestVersionId | string |
A version ID which uniquely identifies the current version of the agreement |
Name
|
name | string |
Name of the Agreement |
Parent ID
|
parentId | string |
The parent id of a megaSign child OR the originating id of a web form agreement instance |
Agreement ID
|
id | string |
The unique identifier of the agreement |
Status
|
status | string |
The current status of the agreement |
Type
|
type | string |
The kind of agreement |
A JSON that contains the user agreement array object
Name | Path | Type | Description |
---|---|---|---|
page
|
page | page |
Pagination information for navigating through the response |
Agreement List
|
userAgreementList | array of UserAgreementV6 |
An array of agreement items |
Pagination information for navigating through the response
Name | Path | Type | Description |
---|---|---|---|
nextCursor
|
nextCursor | string |
Used to navigate to the next page. If not returned, there are no further pages. |
Name | Path | Type | Description |
---|---|---|---|
Event
|
event | string |
The event that has occured on the resource. |
Event Date
|
eventDate | 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 Resource Type
|
eventResourceType | string |
The resource on which the event has occured. |
Agreement Parent Type
|
eventResourceParentType | string |
Information about the resource from which agreement is created. Possible values: Web Form or Mega Sign |
Agreement Parent ID
|
eventResourceParentId | string |
A Unique ID of the resource from which this agreement is created |
Event Participant Role
|
participantRole | string |
The Role of the participant for the event. |
Event Participant Id
|
participantUserId | string |
The ID of the participant for the event. |
Event Participant Email
|
participantUserEmail | string |
The email of the participant for the event. |
Event Acting User ID
|
actingUserId | string |
The ID of the user that created the event. |
Event Acting User Email
|
actingUserEmail | string |
The email of the user that created the event. |
Event Acting User IP Address
|
actingUserIpAddress | string |
The IP address of the user who created the event |
Event Initiating User ID
|
initiatingUserId | string |
The ID of the user that initiated the event on behalf of acting user. |
Event Initiating User Email
|
initiatingUserEmail | string |
The email of the user that initiated the event on behalf of acting user. |
Notification Applicable Users
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
A list of users for whom this notification is applicable |
Agreement
|
agreement | WebhookAgreementInfo |
The complete information of the agreement |
The information about the users for whom this notification is applicable
Name | Path | Type | Description |
---|---|---|---|
Notification Applicable User ID
|
id | string |
The unique ID of the user for whom this notification is applicable |
Notification Applicable User Email
|
string |
The email of the user for whom this notification is applicable |
|
Notification Applicable User Role
|
role | string |
The role of the user in the workflow for whom this notification is generated |
Is Payload Applicable User
|
payloadApplicable | boolean |
Whether the data provided in this notification is applicable for this user or not |
Name | Path | Type | Description |
---|---|---|---|
Event
|
event | string |
The event that has occured on the resource. |
Event Date
|
eventDate | 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 Resource Type
|
eventResourceType | string |
The resource on which the event has occured. |
Agreement Parent Type
|
eventResourceParentType | string |
Information about the resource from which agreement is created. Possible values: Web Form or Mega Sign |
Agreement Parent ID
|
eventResourceParentId | string |
A Unique ID of the resource from which this agreement is created |
Event Participant Id
|
participantUserId | string |
The ID of the participant for the event. |
Event Participant Email
|
participantUserEmail | string |
The email of the participant for the event. |
Event Acting User ID
|
actingUserId | string |
The ID of the user that created the event. |
Event Acting User Email
|
actingUserEmail | string |
The email of the user that created the event. |
Event Acting User IP Address
|
actingUserIpAddress | string |
The IP address of the user who created the event |
Event Initiating User ID
|
initiatingUserId | string |
The ID of the user that initiated the event on behalf of acting user |
Event Initiating User Email
|
initiatingUserEmail | string |
The email of the user that initiated the event on behalf of acting user. |
Notification Applicable Users
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
A list of users for whom this notification is applicable |
Agreement
|
agreement | WebhookAgreementInfoWithoutNextParticipantSet |
The complete information of the agreement |
Name | Path | Type | Description |
---|---|---|---|
Event
|
event | string |
The event that has occured on the resource. |
Event Date
|
eventDate | 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 |
Sub Event
|
subEvent | string |
The sub event that has occured on a resource. |
Agreement Parent Type
|
eventResourceParentType | string |
Information about the resource from which agreement is created. Possible values: Web Form or Mega Sign |
Agreement Parent ID
|
eventResourceParentId | string |
A Unique ID of the resource from which this agreement is created |
Event Participant Id
|
participantUserId | string |
The ID of the participant for the event. |
Event Participant Email
|
participantUserEmail | string |
The email of the participant for the event. |
Event Acting User ID
|
actingUserId | string |
The ID of the user that created the event. |
Event Acting User Email
|
actingUserEmail | string |
The email of the user that created the event. |
Event Acting User IP Address
|
actingUserIpAddress | string |
The IP address of the user who created the event |
Action Type
|
actionType | string |
The action for which the event has occurred. |
Event Initiating User ID
|
initiatingUserId | string |
The ID of the user that initiated the event on behalf of acting user |
Event Initiating User Email
|
initiatingUserEmail | string |
The email of the user that initiated the event on behalf of acting user. |
Event Resource Type
|
eventResourceType | string |
The resource on which the event has occured. |
Event Participant Role
|
participantRole | string |
The Role of the participant for the event. |
Notification Applicable Users
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
A list of users for whom this notification is applicable |
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocument |
The complete information of the agreement |
Name | Path | Type | Description |
---|---|---|---|
Event
|
event | string |
The event that has occured on the resource. |
Event Date
|
eventDate | 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 |
Agreement Parent Type
|
eventResourceParentType | string |
Information about the resource from which agreement is created. Possible values: Web Form or Mega Sign |
Agreement Parent ID
|
eventResourceParentId | string |
A Unique ID of the resource from which this agreement is created |
Event Resource Type
|
eventResourceType | string |
The resource on which the event has occured. |
Event Participant Role
|
participantRole | string |
The Role of the participant for the event. |
Event Participant Id
|
participantUserId | string |
The ID of the participant for the event. |
Event Participant Email
|
participantUserEmail | string |
The email of the participant for the event. |
Event Acting User ID
|
actingUserId | string |
The ID of the user that created the event. |
Event Acting User Email
|
actingUserEmail | string |
The email of the user that created the event. |
Event Acting User IP Address
|
actingUserIpAddress | string |
The IP address of the user who created the event |
Event Initiating User ID
|
initiatingUserId | string |
The ID of the user that initiated the event on behalf of acting user |
Event Initiating User Email
|
initiatingUserEmail | string |
The email of the user that initiated the event on behalf of acting user. |
Notification Applicable Users
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
A list of users for whom this notification is applicable |
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocument |
The complete information of the agreement |
Name | Path | Type | Description |
---|---|---|---|
Event
|
event | string |
The event that has occured on the resource. |
Event Date
|
eventDate | 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 |
Sub Event
|
subEvent | string |
The sub event that has occured on a resource. |
Agreement Parent Type
|
eventResourceParentType | string |
Information about the resource from which agreement is created. Possible values: Web Form or Mega Sign |
Agreement Parent ID
|
eventResourceParentId | string |
A Unique ID of the resource from which this agreement is created |
Event Resource Type
|
eventResourceType | string |
The resource on which the event has occured. |
Event Participant Role
|
participantRole | string |
The Role of the participant for the event. |
Event Participant Id
|
participantUserId | string |
The ID of the participant for the event. |
Event Participant Email
|
participantUserEmail | string |
The email of the participant for the event. |
Event Acting User ID
|
actingUserId | string |
The ID of the user that created the event. |
Event Acting User Email
|
actingUserEmail | string |
The email of the user that created the event. |
Event Initiating User ID
|
initiatingUserId | string |
The ID of the user that initiated the event on behalf of acting user |
Event Initiating User Email
|
initiatingUserEmail | string |
The email of the user that initiated the event on behalf of acting user. |
Action Type
|
actionType | string |
The action for which the event has occurred. |
Event Acting User IP Address
|
actingUserIpAddress | string |
The IP address of the user who created the event |
Notification Applicable Users
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
A list of users for whom this notification is applicable |
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
The complete information of the agreement |
Mega Sign
|
megaSign | WebhookMegaSignInfo |
The complete information of the mega sign |
Web Form
|
widget | WebhookWidgetInfo |
The complete information of the web form |
Name | Path | Type | Description |
---|---|---|---|
Event
|
event | string |
The agreement event that has occured on the web form. |
Event Date
|
eventDate | 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 |
Sub Event
|
subEvent | string |
The sub event that has occured on a web form. |
Agreement Parent Type - Web Form
|
eventResourceParentType | string |
Value that indicates an agreement is created from web form. |
Web Form ID
|
eventResourceParentId | string |
A unique ID of the web form from which this agreement is created |
Event Resource Type - Agreement
|
eventResourceType | string |
The resource on which the event has occured. |
Event Participant Role
|
participantRole | string |
The Role of the participant for the event. |
Event Participant Id
|
participantUserId | string |
The ID of the participant for the event. |
Event Participant Email
|
participantUserEmail | string |
The email of the participant for the event. |
Event Acting User ID
|
actingUserId | string |
The ID of the user that created the event. |
Event Acting User Email
|
actingUserEmail | string |
The email of the user that created the event. |
Event Initiating User ID
|
initiatingUserId | string |
The ID of the user that initiated the event on behalf of acting user |
Event Initiating User Email
|
initiatingUserEmail | string |
The email of the user that initiated the event on behalf of acting user. |
Action Type
|
actionType | string |
The action for which the event has occurred. |
Event Acting User IP Address
|
actingUserIpAddress | string |
The IP address of the user who created the event |
Notification Applicable Users
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
A list of users for whom this notification is applicable |
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
The complete information of the agreement |
Name | Path | Type | Description |
---|---|---|---|
Event
|
event | string |
The event that has occured for a group. |
Event Date
|
eventDate | 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 |
Sub Event
|
subEvent | string |
The sub event that has occured for a group. |
Agreement Parent Type - Web Form
|
eventResourceParentType | string |
Information about the group from which agreement is created. |
Web Form ID
|
eventResourceParentId | string |
A unique ID of the group from which this agreement is created |
Event Resource Type - Agreement
|
eventResourceType | string |
The group for which the event has occured. |
Event Participant Role
|
participantRole | string |
The Role of the participant for the event. |
Event Participant Id
|
participantUserId | string |
The ID of the participant for the event. |
Event Participant Email
|
participantUserEmail | string |
The email of the participant for the event. |
Event Acting User ID
|
actingUserId | string |
The ID of the user that created the event. |
Event Acting User Email
|
actingUserEmail | string |
The email of the user that created the event. |
Event Initiating User ID
|
initiatingUserId | string |
The ID of the user that initiated the event on behalf of acting user |
Event Initiating User Email
|
initiatingUserEmail | string |
The email of the user that initiated the event on behalf of acting user. |
Action Type
|
actionType | string |
The action for which the event has occurred. |
Event Acting User IP Address
|
actingUserIpAddress | string |
The IP address of the user who created the event |
Notification Applicable Users
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
A list of users for whom this notification is applicable |
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
The complete information of the agreement |
Mega Sign
|
megaSign | WebhookMegaSignInfo |
The complete information of the mega sign |
Web Form
|
widget | WebhookWidgetInfo |
The complete information of the web form |
The complete information of the agreement
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the agreement |
Name
|
name | string |
The name of the agreement |
Signature Type
|
signatureType | string |
Specifies the Signature type that was requested - E-signature or Written |
Status
|
status | string |
The current status of the agreement |
CCs
|
ccs | array of CcInfo |
A list of one or more CCs that will be copied in the agreement transaction. |
Creation Date
|
createdDate | date |
Date when agreement was created |
Expiration Time
|
expirationTime | string |
Time after which Agreement expires and needs to be signed before it |
External ID
|
externalId.id | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
External Group
|
externalId.group | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
First Reminder Delay
|
firstReminderDelay | integer |
Integer which specifies the delay in hours before sending the first reminder. |
Locale
|
locale | string |
The locale associated with this agreement |
Message
|
message | string |
An optional message to the participants, describing what is being sent or why their signature is required |
Reminder Frequency
|
reminderFrequency | 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
|
senderEmail | string |
Email of agreement sender |
Vaulting Enabled?
|
vaultingInfo.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 |
Document Visibility?
|
documentVisibilityEnabled | boolean |
Is document visibility enabled |
Workflow ID
|
workflowId | string |
The ID of custom workflow which defines the routing path of an agreement. |
Post Sign Redirect Url
|
postSignOption.redirectUrl | string |
A publicly accessible url to which the user will be sent after successfully completing the signing process |
Participant Sets
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
The participant sets info |
Next Participant Sets
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
The next participant sets info |
Documents
|
documentsInfo.documents | array of WebhookDocument |
A list of objects representing the documents |
Supporting Documents
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
A list of supporting documents |
The complete information of the agreement
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the agreement |
Name
|
name | string |
The name of the agreement |
Signature Type
|
signatureType | string |
Specifies the Signature type that was requested - E-signature or Written |
Status
|
status | string |
The current status of the agreement |
CCs
|
ccs | array of CcInfo |
A list of one or more CCs that will be copied in the agreement transaction. |
Creation Date
|
createdDate | date |
Date when agreement was created |
Document Visibility?
|
documentVisibilityEnabled | boolean |
Is document visibility enabled |
Expiration Time
|
expirationTime | string |
Time after which Agreement expires and needs to be signed before it |
External ID
|
externalId.id | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
External Group
|
externalId.group | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
First Reminder Delay
|
firstReminderDelay | integer |
Integer which specifies the delay in hours before sending the first reminder. |
Locale
|
locale | string |
The locale associated with this agreement |
Message
|
message | string |
An optional message to the participants, describing what is being sent or why their signature is required |
Reminder Frequency
|
reminderFrequency | 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
|
senderEmail | string |
Email of agreement sender |
Vaulting Enabled?
|
vaultingInfo.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 |
Post Sign Redirect Url
|
postSignOption.redirectUrl | string |
A publicly accessible url to which the user will be sent after successfully completing the signing process |
Workflow ID
|
workflowId | string |
The ID of custom workflow which defines the routing path of an agreement. |
Participant Sets
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
The participant sets info |
The complete information of the agreement
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the agreement |
Name
|
name | string |
The name of the agreement |
Signature Type
|
signatureType | string |
Specifies the Signature type that was requested - E-signature or Written |
Status
|
status | string |
The current status of the agreement |
CCs
|
ccs | array of CcInfo |
A list of one or more CCs that will be copied in the agreement transaction. |
Creation Date
|
createdDate | date |
Date when agreement was created |
Expiration Time
|
expirationTime | string |
Time after which Agreement expires and needs to be signed before it |
External ID
|
externalId.id | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
External Group
|
externalId.group | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
First Reminder Delay
|
firstReminderDelay | integer |
Integer which specifies the delay in hours before sending the first reminder. |
Locale
|
locale | string |
The locale associated with this agreement |
Message
|
message | string |
An optional message to the participants, describing what is being sent or why their signature is required |
Reminder Frequency
|
reminderFrequency | 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 |
Post Sign Redirect Url
|
postSignOption.redirectUrl | string |
A publicly accessible url to which the user will be sent after successfully completing the signing process |
Workflow ID
|
workflowId | string |
The ID of custom workflow which defines the routing path of an agreement. |
Sender Email
|
senderEmail | string |
Email of agreement sender |
Document Visibility?
|
documentVisibilityEnabled | boolean |
Is document visibility enabled |
Vaulting Enabled?
|
vaultingInfo.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 |
Participant Sets
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
The participant sets info |
Next Participant Sets
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
The next participant sets info |
Documents
|
documentsInfo.documents | array of WebhookDocument |
A list of objects representing the documents |
Supporting Documents
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
A list of supporting documents This is returned only if there are any supporting document in the agreement |
Signed Document Info
|
signedDocumentInfo.document | string |
A base64 encoded string of the signed document |
The complete information of the agreement
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the agreement |
Name
|
name | string |
The name of the agreement |
Signature Type
|
signatureType | string |
Specifies the Signature type that was requested - E-signature or Written |
Status
|
status | string |
The current status of the agreement |
CCs
|
ccs | array of CcInfo |
A list of one or more CCs that will be copied in the agreement transaction |
Creation Date
|
createdDate | date |
Date when agreement was created |
Document Visibility?
|
documentVisibilityEnabled | boolean |
Is document visibility enabled |
Expiration Time
|
expirationTime | string |
Time after which Agreement expires and needs to be signed before it |
External ID
|
externalId.id | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
External Group
|
externalId.group | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
First Reminder Delay
|
firstReminderDelay | integer |
Integer which specifies the delay in hours before sending the first reminder. |
Locale
|
locale | string |
The locale associated with this agreement |
Message
|
message | string |
An optional message to the participants, describing what is being sent or why their signature is required |
Reminder Frequency
|
reminderFrequency | 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
|
senderEmail | string |
Email of agreement sender |
Vaulting Enabled?
|
vaultingInfo.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 |
Post Sign Redirect Url
|
postSignOption.redirectUrl | string |
A publicly accessible url to which the user will be sent after successfully completing the signing process |
Workflow ID
|
workflowId | string |
The ID of custom workflow which defines the routing path of an agreement. |
Participant Sets
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
The participant sets info |
Documents
|
documentsInfo.documents | array of WebhookDocument |
A list of objects representing the documents |
Supporting Documents
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
A list of supporting documents This is returned only if there are any supporting document in the agreement |
Signed Document Info
|
signedDocumentInfo.document | string |
A base64 encoded string of the signed document |
The complete information of the mega sign
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the megasign |
Name
|
name | string |
The name of the megasign |
Status
|
status | string |
The status of the megasign |
CCs
|
ccs | array of MegaSignCcInfo |
A list of one or more email addresses that you want to copy on this megasign. |
External ID
|
externalId.id | string |
An arbitrary value from your system, which can be specified at sending time and then later returned or queried |
First Reminder Delay
|
firstReminderDelay | integer |
Integer which specifies the delay in hours before sending the first reminder. |
Locale
|
locale | string |
The locale associated with this agreement |
Message
|
message | string |
An optional message to the participants, describing what is being sent or why their signature is required |
Post Sign Redirect Url
|
postSignOption.redirectUrl | string |
A publicly accessible url to which the user will be sent after successfully completing the signing process |
Sender Email
|
senderEmail | string |
Email of megasign creator |
Signature Type
|
signatureType | string |
Specifies the Signature type that was requested - E-signature or Written |
Vaulting Enabled?
|
vaultingInfo.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 |
Child Agreements File Info
|
childAgreementsInfo.fileInfo | MegaSignChildAgreementsFileInfo |
File info containing per child agreement information of megaSign. |
The complete information of the web form
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the web form |
Name
|
name | string |
The name of the web form |
Status
|
status | string |
The status of the web form |
Authentication Failure Info
|
authFailureInfo | AuthFailureWidgetRedirectionInfo |
URL and associated properties for the error page the web form signer will be taken after failing to authenticate |
CCs
|
ccs | array of WidgetCcInfo |
A list of one or more email addresses that you want to copy on this web form. |
Creation Date
|
createdDate | date |
Date when web form was created |
Completion Info
|
completionInfo | WidgetCompletionRedirectionInfo |
URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form |
Creator Email
|
creatorEmail | string |
The email of the creator of the web form |
Vaulting Enabled?
|
vaultingInfo.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 |
Additional Participant Sets Info
|
participantSetsInfo.additionalParticipantSets | array of WidgetParticipantSetInfo |
List of all the participants in the web form except web form signer |
First Participant Set Role
|
participantSetsInfo.widgetParticipantSet.role | string |
Role assumed by all participants in the set (signer, approver etc.) |
First Participant Set Order
|
participantSetsInfo.widgetParticipantSet.order | integer |
Index indicating sequential signing group (specified for hybrid routing) |
Documents
|
documentsInfo.documents | array of WidgetWebhookDocument |
A list of objects representing the documents |
URL and associated properties for the error page the web form signer will be taken after failing to authenticate
Name | Path | Type | Description |
---|---|---|---|
Auth Failure Redirect Delay
|
delay | integer |
The delay (in seconds) before the user is taken to the resultant page |
Auth Failure Redirect Deframe
|
deframe | boolean |
If deframe is false, the resultant page will be shown inside the web form frame |
Auth Failure Redirect Url
|
url | string |
A publicly accessible url to which the user will be sent after successfully completing the web form |
URL and associated properties for the success page the web form signer will be taken to after performing desired action on the web form
Name | Path | Type | Description |
---|---|---|---|
Completion Redirect Delay
|
delay | integer |
The delay (in seconds) before the user is taken to the resultant page |
Completion Redirect Deframe
|
deframe | boolean |
If deframe is false, the resultant page will be shown inside the web form frame |
Completion Redirect Url
|
url | string |
A publicly accessible url to which the user will be sent after successfully completing the web form |
Name | Path | Type | Description |
---|---|---|---|
Member Infos
|
memberInfos | array of MemberInfos |
The information about participant members |
Order
|
order | integer |
Index indicating position at which signing group needs to sign. |
Role
|
role | string |
Role assumed by all participants in the set (signer, approver etc.) |
Status
|
status | string |
Current status of the agreement from the perspective of the user |
ID
|
id | string |
The ID of the participant set |
Name
|
name | string |
The name of the participant set |
Private Message
|
privateMessage | string |
Private message for the participants in the set |
File info containing per child agreement information of megaSign.
Name | Path | Type | Description |
---|---|---|---|
Child Agreements File ID
|
childAgreementsInfoFileId | string |
The ID of the file containing information about the existing childAgreementsInfo of the megaSign. |
The information about the document of the web form
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the document |
Name
|
name | string |
The name of the document |
The information about the document of the agreement
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique ID of the document |
Name
|
name | string |
The name of the document |
The information about the supporting document
Name | Path | Type | Description |
---|---|---|---|
Name
|
displayLabel | string |
Display name of the supporting document |
Field Name
|
fieldName | string |
The name of the supporting document field |
ID
|
id | string |
The unique ID representing the supporting document |
The information about the CC of the web form
Name | Path | Type | Description |
---|---|---|---|
Email
|
string |
Email of the CC participant of the web form |
The information about the CC of the mega sign
Name | Path | Type | Description |
---|---|---|---|
Email
|
string |
Email of the CC participant of the megasign |
The information about the CC of the agreement
Name | Path | Type | Description |
---|---|---|---|
Email
|
string |
The email of the CC of the agreement |
|
Label
|
label | string |
The label of the CC list as returned in workflow description |
Visible Pages
|
visiblePages | array of string |
The pages that are visible to the CC |
Name | Path | Type | Description |
---|---|---|---|
Role
|
role | string |
Role assumed by all participants in the set (signer, approver etc.) |
ID
|
id | string |
The unique identifier of the participant set |
Member Infos
|
memberInfos | array of MemberInfos |
The information about the participant members |
Order
|
order | integer |
Index indicating sequential signing group (specified for hybrid routing) |
Name | Path | Type | Description |
---|---|---|---|
ID
|
id | string |
The unique Id of the participant |
Email
|
string |
The email of the participant |
|
Company
|
company | string |
The company of the participant |
Name
|
name | string |
The name of the participant |
Private Message
|
privateMessage | string |
The private message of the participant |
Status
|
status | string |
The status of the participant |
A JSON object describing the library template
Name | Path | Type | Description |
---|---|---|---|
Library Template Id
|
id | string |
The unique ID that can be used to refer to the library template |
Name | Path | Type | Description |
---|---|---|---|
Library Template Id
|
id | string |
The unique identifier that is used to refer to the library template |
Hidden
|
hidden | boolean |
True if Library Document is hidden |
Template Type(s)
|
templateTypes | array of string |
A list of one or more library template types |
Modified Date
|
modifiedDate | date |
The day on which the library template was last modified |
Library Template Name
|
name | string |
The name of the library template |
Template Sharing Mode
|
sharingMode | string |
The scope of visibility of the library template |
Creator Email
|
creatorEmail | string |
Email address of the library document creator. |
Group ID
|
groupId | string |
The unique identifier of the group to which the library template belongs to. |
Status
|
status | string |
Status of the library document |
A JSON that contains the library template array object
Name | Path | Type | Description |
---|---|---|---|
page
|
page | page |
Pagination information for navigating through the response |
Library Templates List
|
libraryDocumentList | array of LibraryDocument |
A list of library template items |
Name | Path | Type | Description |
---|---|---|---|
Web Form ID
|
id | string |
The unique identifier of a web form |
Modified Date
|
modifiedDate | string |
The date on which the web form was last modified |
Hidden
|
hidden | boolean |
True if agreement is hidden for the user |
Group ID
|
groupId | string |
Unique identifier of the group |
Name
|
name | string |
The name of the web form |
Status
|
status | string |
The web form status |
Url
|
url | string |
The hosted url of the web form |
Javascript
|
javascript | string |
The embedded javascript code of the web form |
A JSON that contains the user web form array object
Name | Path | Type | Description |
---|---|---|---|
page
|
page | page |
Pagination information for navigating through the response |
Web Form List
|
userWidgetList | array of UserWidgetV6 |
An array of web form items |
Name | Path | Type | Description |
---|---|---|---|
Workflow ID
|
id | string |
The unique identifier of a workflow |
Description
|
description | string |
Description provided for this workflow at the time of its creation |
Created Date
|
created | string |
The date on which the workflow was created. Format would be yyyy-MM-dd'T'HH:mm:ssZ |
Modified Date
|
modified | string |
The date on which the workflow was modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ |
Name
|
name | string |
The name of the workflow |
Display Name
|
displayName | string |
The display name of the workflow |
Status
|
status | string |
The workflow status |
Scope
|
scope | string |
The workflow scope |
Originator ID
|
originatorId | string |
Initial originator of the workflow |
Scope ID
|
scopeId | string |
Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId. |
A JSON that contains the user workflow array object
Name | Path | Type | Description |
---|---|---|---|
Workflow List
|
userWorkflowList | array of UserWorkflowV6 |
An array of workflow items |
A JSON that contains workflow default params object
Name | Path | Type | Description |
---|---|---|---|
Default Value
|
defaultValue | string |
Default value of the field if input for this field is not provided and this field is required |
Editable
|
editable | boolean |
Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation |
Required
|
required | boolean |
Whether this field is required or optional |
Visible
|
visible | boolean |
Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user |
A JSON that contains detailed info about the workflow
Name | Path | Type | Description |
---|---|---|---|
Default Values
|
defaultValues | array of string |
An array of default emails that will be used if no input is provided for this list element |
Editable
|
editable | boolean |
Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation |
Label
|
label | string |
A display text for the workflow user that can be used for the current CC list |
Max CC entries
|
maxListCount | integer |
Maximum number of entries allowed in the current CC list |
Min CC entries
|
minListCount | integer |
Minimum number of entries allowed in the current CC list |
CC List Name
|
name | string |
Name of the current CC list |
Required
|
required | boolean |
Whether this field is required or optional |
Visible
|
visible | boolean |
Whether current field is visible or not. If visible attribute for this field is false then this field should not be shown in the agreement creation page using this workflow |
A JSON that contains info about expiration
Name | Path | Type | Description |
---|---|---|---|
Default Value
|
defaultValue | string |
Default value of the field if input for this field is not provided and this field is required |
Editable
|
editable | boolean |
Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation |
Agreement Expiration Max Days
|
maxDays | integer |
Maximum number of days for agreement expiration |
Required
|
required | boolean |
Whether this field is required or optional |
Visible
|
visible | boolean |
Whether current field is visible or not. If visible attribute for this field is false then this field should not be shown in the agreement creation page using this workflow |
A JSON that contains info about files
Name | Path | Type | Description |
---|---|---|---|
Label
|
label | string |
Display label of this field for external users |
Name
|
name | string |
Name of the fileInfo element |
Required
|
required | boolean |
Whether this field is required or optional |
Workflow Library Documents
|
workflowLibraryDocumentSelectorList | array of WorkflowLibraryDocumentV6 |
A list of workflow library documents out of which one workflow library document can be selected with this fileInfo object |
A JSON that contains info about workflow library document
Name | Path | Type | Description |
---|---|---|---|
Label
|
label | string |
A display text for this form for workflow users |
Date Modified
|
modifiedDate | string |
The date on which the library document was last modified. Format would be yyyy-MM-dd'T'HH:mm:ssZ. For example, e.g 2016-02-25T18:46:19Z represents UTC time |
Sharing Mode
|
sharingMode | string |
Specifies who should have access to this library document. GLOBAL sharing is a restricted operation |
Template Types
|
templateTypes | array of |
A list of one or more library template types |
Workflow Library Document ID
|
workflowLibDoc | string |
An id of the workflow library document that can be provided as an input file in the custom workflow agreement creation request |
A JSON that contains detailed info about the workflow locale
Name | Path | Type | Description |
---|---|---|---|
Available Locales
|
availableLocales | array of string |
Which locales can be chosen for this workflow |
Default Value
|
defaultValue | string |
Default value of the field if input for this field is not provided and this field is required |
Editable
|
editable | boolean |
Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation |
Required
|
required | boolean |
Whether this field is required or optional |
Visible
|
visible | boolean |
Whether current field is visible or not. If visible attribute for this field is false then this field should not be visible in the agreement creation UI using this workflow to user |
A JSON that contains detailed info about the merge field
Name | Path | Type | Description |
---|---|---|---|
Default Value
|
defaultValue | string |
Default value of the field if input for this field is not provided and this field is required |
Display Name
|
displayName | string |
The display text that can be shown for this custom field |
Editable
|
editable | boolean |
Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation |
Custom Field Name
|
fieldName | string |
Name of the custom field in this workflow |
Required
|
required | boolean |
Whether this field is required or optional |
Visible
|
visible | boolean |
Whether current field should be visible on agreement creation page. If visible attribute for this field is false then this field should not be shown on the agreement creation page using this workflow |
A JSON that contains detailed info about the password
Name | Path | Type | Description |
---|---|---|---|
Password
|
defaultValue | string |
Default value of the password info field |
Editable
|
editable | boolean |
Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation |
Label
|
label | string |
Label of password field |
Name
|
name | string |
Name of password field |
Required
|
required | boolean |
Whether this field is required or optional |
Visible
|
visible | boolean |
Whether password info field is visible on agreement creation page |
A JSON that contains detailed info about recipients list
Name | Path | Type | Description |
---|---|---|---|
Allow Sender
|
allowSender | boolean |
Whether sender is allowed as a recipient |
Allow Sender
|
allowfax | boolean |
Whether fax is allowed or not |
Authentication Method
|
authenticationMethod | string |
Authentication method for the current recipient list to have access to view and sign the document, |
Default Email/Fax Value
|
defaultValue | string |
A default email or fax number |
Editable
|
editable | boolean |
Whether current field can be edited. If editable attribute for this field is false then this field should not be provided in the agreement creation request and default value of this field will be used in agreement creation |
Label
|
label | string |
A display text for the workflow user that can be used for the current recipients list |
Maximum recipients
|
maxListCount | integer |
Maximum number of entries allowed in the current recipient list |
Minimum recipients
|
minListCount | integer |
Minimum number of entries allowed in the current recipient list |
Name of Recipient Info List
|
name | string |
Name of the current Recipient Info list |
Participant Role
|
role | string |
The current role of the participant |
Visible
|
visible | boolean |
Whether current field is visible. If visible attribute for this field is false then this field should not be shown in the agreement creation UI using this workflow to user |
A JSON that contains detailed info about the workflow
Name | Path | Type | Description |
---|---|---|---|
agreementNameInfo
|
agreementNameInfo | WorkflowDefaultParamsV6 |
A JSON that contains workflow default params object |
authoringInfo
|
authoringInfo | WorkflowDefaultParamsV6 |
A JSON that contains workflow default params object |
CC List Info
|
ccsListInfo | array of CCsListInfoDescriptionV6 |
Information about CC list input field in the agreement creation request |
Workflow Creation Date
|
created | string |
The day on which the workflow was created |
Workflow Description
|
description | string |
Description provided for this workflow at the time of its creation |
Workflow Display Name
|
displayName | string |
The display name of the workflow |
expirationInfo
|
expirationInfo | ExpirationFieldInfoDescriptionV6 |
A JSON that contains info about expiration |
Files Info
|
fileInfos | array of FileInfosDescriptionV6 |
Information about file info input field in the agreement creation request |
localeInfo
|
localeInfo | LocaleFieldInfoDescriptionV6 |
A JSON that contains detailed info about the workflow locale |
Merge Fields Info
|
mergeFieldsInfo | array of MergeFieldInfoDescriptionV6 |
Information about custom infos input field in the agreement creation request |
messageInfo
|
messageInfo | WorkflowDefaultParamsV6 |
A JSON that contains workflow default params object |
Modified Date
|
modified | string |
The day on which the workflow was last modified |
Workflow Name
|
name | string |
The name of the workflow |
passwordInfo
|
passwordInfo | PasswordFieldInfoDescriptionV6 |
A JSON that contains detailed info about the password |
Recipients List Info
|
recipientsListInfo | array of RecipientsListInfoDescriptionV6 |
Information about recepients info input field in the agreement creation request |
Workflow Scope
|
scope | string |
The workflow scope |
Workflow Status
|
status | string |
The workflow status |
Workflow Originator ID
|
originatorId | string |
Initial originator of the workflow |
Workflow Scope ID
|
scopeId | string |
Identifier of scope. Currently it is applicable for scope GROUP only and the value will be groupId |
Name | Path | Type | Description |
---|---|---|---|
Value
|
value | boolean |
Value of the setting |
Inherited
|
inherited | boolean |
True if setting is inherited from its group or account value |
Name | Path | Type | Description |
---|---|---|---|
libaryDocumentCreationVisible
|
libaryDocumentCreationVisible | BooleanSettingInfoV6 | |
sendRestrictedToWorkflows
|
sendRestrictedToWorkflows | BooleanSettingInfoV6 | |
userCanSend
|
userCanSend | BooleanSettingInfoV6 | |
widgetCreationVisible
|
widgetCreationVisible | BooleanSettingInfoV6 |
Name | Path | Type | Description |
---|---|---|---|
Group ID
|
id | string |
Unique identifier of the group |
Is Group Admin
|
isGroupAdmin | boolean |
True if user is group admin |
Is Primary Group
|
isPrimaryGroup | boolean |
True if the group is the user's primary group |
Status
|
status | string |
Status of the group membership |
Created Date
|
createdDate | date |
Date group was created |
Group Name
|
name | string |
Name of the group |
settings
|
settings | SettingsInfoV6 |
A JSON that contains the list of groups for given user
Name | Path | Type | Description |
---|---|---|---|
User Groups List
|
groupInfoList | array of UserGroupInfoV6 |
An array of user group info items |
This is the basic data type 'binary'.
This is the type 'object'.
This is the basic data type 'file'.