Connectors Reference

Adobe Sign

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

 

Status: Preview

Tier: Standard

Version: 1.0.1

 

Actions:

Name

Summary

GetAllAgreements ([internal][Optional]string x-api-client-id)

Get a list of all agreements

CreateAgreementById ([internal][Optional]string x-api-client-id, AgreementCreationInfoId AgreementCreationInfoId)

Create an agreement from an uploaded document and send for signature

CreateAgreementByTemplate ([internal][Optional]string x-api-client-id, AgreementCreationInfoTemplate AgreementCreationInfoTemplate)

Create an agreement from a library template and send for signature

CreateAgreementByUrl ([internal][Optional]string x-api-client-id, AgreementCreationInfoUrl AgreementCreationInfoUrl)

Create an agreement from a document URL and send for signature

GetAgreementInfo ([internal][Optional]string x-api-client-id, string agreementId)

Get the status of an agreement

GetAllDocumentsofAnAgreement ([internal][Optional]string x-api-client-id, string agreementId, [advanced][Optional]string supportingDocumentContentFormat)

Get a list of all the document IDs from an agreement

GetCombinedDocument ([internal][Optional]string x-api-client-id, string agreementId, [advanced][Optional]boolean attachSupportingDocuments, [advanced][Optional]boolean auditReport)

Get a PDF of a signed agreement

GetDocument ([internal][Optional]string x-api-client-id, string agreementId, string documentId)

Get a document from an agreement

GetLibraryDocuments ([internal][Optional]string x-api-client-id, [internal][Optional]string libraryTemplateType)

Get a list of all library templates

CreateLibraryDocumentById ([internal][Optional]string x-api-client-id, LibraryCreationInfoId LibraryCreationInfoId)

Create a library template from an uploaded document

CreateLibraryDocumentByUrl ([internal][Optional]string x-api-client-id, LibraryCreationInfoUrl LibraryCreationInfoUrl)

Create a library template from a document URL

CreateTransientDocument ([internal][Optional]string x-api-client-id, string File-Name, file File)

Upload a document and get a document ID

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AgreementCreationInfoId

 

AgreementCreationInfoTemplate

 

AgreementCreationInfoUrl

 

AgreementCreationResponse

 

AgreementDocuments

 

AgreementInfo

 

DisplayUserInfo

 

DisplayUserSetInfo

 

Document

 

DocumentHistoryEvent

 

DocumentLibraryItem

 

DocumentLibraryItems

 

file

File Content

LibraryCreationInfoId

 

LibraryCreationInfoUrl

 

LibraryDocumentCreationResponse

 

NextParticipantInfo

 

NextParticipantSetInfo

 

ParticipantInfo

 

ParticipantSetInfo

 

SupportingDocument

 

TransientDocumentResponse

 

UserAgreement

 

UserAgreements

 

 

Actions:

GetAllAgreements

Summary: Get a list of all agreements

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

 

Syntax:

AdobeSign.GetAllAgreements ([internal][Optional]string x-api-client-id)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

 

Returns:

          Type:UserAgreements

          Description: A JSON that contains the user agreement array object

 

CreateAgreementById

Summary: Create an agreement from an uploaded document and send for signature

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

 

Syntax:

AdobeSign.CreateAgreementById ([internal][Optional]string x-api-client-id, AgreementCreationInfoId AgreementCreationInfoId)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

AgreementCreationInfoId

AgreementCreationInfoId

 

 

True

 

Returns:

          Type:AgreementCreationResponse

          Description: A JSON that contains the ID of the newly created agreement

 

CreateAgreementByTemplate

Summary: Create an agreement from a library template and send for signature

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

 

Syntax:

AdobeSign.CreateAgreementByTemplate ([internal][Optional]string x-api-client-id, AgreementCreationInfoTemplate AgreementCreationInfoTemplate)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

AgreementCreationInfoTemplate

AgreementCreationInfoTemplate

 

 

True

 

Returns:

          Type:AgreementCreationResponse

          Description: A JSON that contains the ID of the newly created agreement

 

CreateAgreementByUrl

Summary: Create an agreement from a document URL and send for signature

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

 

Syntax:

AdobeSign.CreateAgreementByUrl ([internal][Optional]string x-api-client-id, AgreementCreationInfoUrl AgreementCreationInfoUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

AgreementCreationInfoUrl

AgreementCreationInfoUrl

 

 

True

 

Returns:

          Type:AgreementCreationResponse

          Description: A JSON that contains the ID of the newly created agreement

 

GetAgreementInfo

Summary: Get the status of an agreement

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

 

Syntax:

AdobeSign.GetAgreementInfo ([internal][Optional]string x-api-client-id, string agreementId)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

agreementId

string

(Agreement ID)

The agreement ID of the agreement whose information is needed

True

 

Returns:

          Type:AgreementInfo

          Description: The complete details about the agreement

 

GetAllDocumentsofAnAgreement

Summary: Get a list of all the document IDs from an agreement

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

 

Syntax:

AdobeSign.GetAllDocumentsofAnAgreement ([internal][Optional]string x-api-client-id, string agreementId, [advanced][Optional]string supportingDocumentContentFormat)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

agreementId

string

(Agreement ID)

The agreement ID of the agreement whose documents are needed

True

supportingDocumentContentFormat

string

(Supporting documents - Content Type)Values: [ORIGINAL, CONVERTED_PDF]

Content type of the supporting documents of the agreement

False

 

Returns:

          Type:AgreementDocuments

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

 

GetCombinedDocument

Summary: Get a PDF of a signed agreement

Description: 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.

 

Syntax:

AdobeSign.GetCombinedDocument ([internal][Optional]string x-api-client-id, string agreementId, [advanced][Optional]boolean attachSupportingDocuments, [advanced][Optional]boolean auditReport)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

agreementId

string

(Agreement ID)

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

True

attachSupportingDocuments

boolean

(Attach Supporting Documents?)

If true, attach supporting documents to the signed agreement PDF

False

auditReport

boolean

(Attach Audit Report?)

If true, attach an audit report to the signed agreement PDF

False

 

Returns:

          Type:string(binary)

          Summary: File Content

          Description: The file stream of the document

 

GetDocument

Summary: Get a document from an agreement

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

 

Syntax:

AdobeSign.GetDocument ([internal][Optional]string x-api-client-id, string agreementId, string documentId)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

agreementId

string

(Agreement ID)

The agreement ID of the agreement whose document is needed

True

documentId

string

(Document ID)

The document ID of the specific document of the agreement

True

 

Returns:

          Type:string(binary)

          Summary: File Content

          Description: The file stream of the document

 

GetLibraryDocuments

Summary: Get a list of all library templates

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

 

Syntax:

AdobeSign.GetLibraryDocuments ([internal][Optional]string x-api-client-id, [internal][Optional]string libraryTemplateType)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

libraryTemplateType

string

(Library Template Type)

External ID for which you would like to retrieve agreement information.

False

 

Returns:

          Type:DocumentLibraryItems

          Description: A JSON that contains the library template array object

 

CreateLibraryDocumentById

Summary: Create a library template from an uploaded document

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

 

Syntax:

AdobeSign.CreateLibraryDocumentById ([internal][Optional]string x-api-client-id, LibraryCreationInfoId LibraryCreationInfoId)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

LibraryCreationInfoId

LibraryCreationInfoId

 

 

True

 

Returns:

          Type:LibraryDocumentCreationResponse

          Description: A JSON object describing the library template

 

CreateLibraryDocumentByUrl

Summary: Create a library template from a document URL

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

 

Syntax:

AdobeSign.CreateLibraryDocumentByUrl ([internal][Optional]string x-api-client-id, LibraryCreationInfoUrl LibraryCreationInfoUrl)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

LibraryCreationInfoUrl

LibraryCreationInfoUrl

 

 

True

 

Returns:

          Type:LibraryDocumentCreationResponse

          Description: A JSON object describing the library template

 

CreateTransientDocument

Summary: Upload a document and get a document ID

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

 

Syntax:

AdobeSign.CreateTransientDocument ([internal][Optional]string x-api-client-id, string File-Name, file File)

 

Parameters:

Name

Type

Summary

Required

Related Action

x-api-client-id

string

 

Microsoft Flow Integration

False

File-Name

string

(File Name)

The name of the document to be uploaded, with extension

True

File

file

(File Content)

The file stream of the document to be uploaded

True

 

Returns:

          Type:TransientDocumentResponse

          Description: A JSON that contains the ID of the uploaded document

 


 

AgreementCreationInfoId

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentCreationInfo

DocumentCreationInfo

 

 

 

DocumentCreationInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Agreement Name

The name of the agreement

fileInfos1

FileInfos1

 

 

signatureType

string

Signature Type

The type of signature you would like to request - E-signature or Written  Values: [E-Signature, Written Signature]

recipientSetInfos1

RecipientSetInfos1

 

 

message

string

Message

An optional message to the recipients requesting their action

daysUntilSigningDeadline

integer

Days to Deadline

The number of days that remain before the document expires

reminderFrequency

string

Reminder Frequency

How often do you want to send reminders ?  Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED]

securityOptions

SecurityOptions

 

Sets optional secondary security parameters for your document

fileInfos2

FileInfos2

 

 

fileInfos3

FileInfos3

 

 

fileInfos4

FileInfos4

 

 

fileInfos5

FileInfos5

 

 

fileInfos6

FileInfos6

 

 

fileInfos7

FileInfos7

 

 

fileInfos8

FileInfos8

 

 

recipientSetInfos2

RecipientSetInfos2

 

 

recipientSetInfos3

RecipientSetInfos3

 

 

recipientSetInfos4

RecipientSetInfos4

 

 

recipientSetInfos5

RecipientSetInfos5

 

 

recipientSetInfos6

RecipientSetInfos6

 

 

recipientSetInfos7

RecipientSetInfos7

 

 

mergeFieldInfo1

MergeFieldInfo1

 

 

mergeFieldInfo2

MergeFieldInfo2

 

 

mergeFieldInfo3

MergeFieldInfo3

 

 

mergeFieldInfo4

MergeFieldInfo4

 

 

mergeFieldInfo5

MergeFieldInfo5

 

 

mergeFieldInfo6

MergeFieldInfo6

 

 

mergeFieldInfo7

MergeFieldInfo7

 

 

mergeFieldInfo8

MergeFieldInfo8

 

 

mergeFieldInfo9

MergeFieldInfo9

 

 

mergeFieldInfo10

MergeFieldInfo10

 

 

 

FileInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID

The document ID received by uploading a document

 

RecipientSetInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email

Email of the recipient

 

SecurityOptions

Summary:

Description: Sets optional secondary security parameters for your document

 

          Properties:

Name

Type

Summary

protectOpen

boolean

Password Protect Document?

Should the signed agreement PDF be encrypted using a password?

openPassword

string

Document Password

The password that should be used to encrypt the signed agreement PDF

 

FileInfos2

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (2)

The document ID received by uploading a document

 

FileInfos3

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (3)

The document ID received by uploading a document

 

FileInfos4

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (4)

The document ID received by uploading a document

 

FileInfos5

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (5)

The document ID received by uploading a document

 

FileInfos6

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (6)

The document ID received by uploading a document

 

FileInfos7

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (7)

The document ID received by uploading a document

 

FileInfos8

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (8)

The document ID received by uploading a document

 

RecipientSetInfos2

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (2)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (2)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (2)

Email of the recipient

 

RecipientSetInfos3

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (3)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (3)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (3)

Email of the recipient

 

RecipientSetInfos4

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (4)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (4)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (4)

Email of the recipient

 

RecipientSetInfos5

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (5)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (5)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (5)

Email of the recipient

 

RecipientSetInfos6

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (6)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (6)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (6)

Email of the recipient

 

RecipientSetInfos7

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (7)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (7)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (7)

Email of the recipient

 

MergeFieldInfo1

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (1)

The name of the field

defaultValue

string

Form Field Value (1)

The default value of the field

 

MergeFieldInfo2

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (2)

The name of the field

defaultValue

string

Form Field Value (2)

The default value of the field

 

MergeFieldInfo3

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (3)

The name of the field

defaultValue

string

Form Field Value (3)

The default value of the field

 

MergeFieldInfo4

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (4)

The name of the field

defaultValue

string

Form Field Value (4)

The default value of the field

 

MergeFieldInfo5

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (5)

The name of the field

defaultValue

string

Form Field Value (5)

The default value of the field

 

MergeFieldInfo6

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (6)

The name of the field

defaultValue

string

Form Field Value (6)

The default value of the field

 

MergeFieldInfo7

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (7)

The name of the field

defaultValue

string

Form Field Value (7)

The default value of the field

 

MergeFieldInfo8

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (8)

The name of the field

defaultValue

string

Form Field Value (8)

The default value of the field

 

MergeFieldInfo9

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (9)

The name of the field

defaultValue

string

Form Field Value (9)

The default value of the field

 

MergeFieldInfo10

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (10)

The name of the field

defaultValue

string

Form Field Value (10)

The default value of the field

 


 

AgreementCreationInfoTemplate

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentCreationInfo

DocumentCreationInfo

 

 

 

DocumentCreationInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Agreement Name

The name of the agreement

fileInfos1

FileInfos1

 

 

signatureType

string

Signature Type

The type of signature you would like to request - E-signature or Written  Values: [E-Signature, Written Signature]

recipientSetInfos1

RecipientSetInfos1

 

 

message

string

Message

An optional message to the recipients requesting their action

daysUntilSigningDeadline

integer

Days to Deadline

The number of days that remain before the document expires

reminderFrequency

string

Reminder Frequency

How often do you want to send reminders ?  Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED]

securityOptions

SecurityOptions

 

Sets optional secondary security parameters for your document

fileInfos2

FileInfos2

 

 

fileInfos3

FileInfos3

 

 

fileInfos4

FileInfos4

 

 

fileInfos5

FileInfos5

 

 

fileInfos6

FileInfos6

 

 

fileInfos7

FileInfos7

 

 

fileInfos8

FileInfos8

 

 

recipientSetInfos2

RecipientSetInfos2

 

 

recipientSetInfos3

RecipientSetInfos3

 

 

recipientSetInfos4

RecipientSetInfos4

 

 

recipientSetInfos5

RecipientSetInfos5

 

 

recipientSetInfos6

RecipientSetInfos6

 

 

recipientSetInfos7

RecipientSetInfos7

 

 

mergeFieldInfo1

MergeFieldInfo1

 

 

mergeFieldInfo2

MergeFieldInfo2

 

 

mergeFieldInfo3

MergeFieldInfo3

 

 

mergeFieldInfo4

MergeFieldInfo4

 

 

mergeFieldInfo5

MergeFieldInfo5

 

 

mergeFieldInfo6

MergeFieldInfo6

 

 

mergeFieldInfo7

MergeFieldInfo7

 

 

mergeFieldInfo8

MergeFieldInfo8

 

 

mergeFieldInfo9

MergeFieldInfo9

 

 

mergeFieldInfo10

MergeFieldInfo10

 

 

 

FileInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Document Library Template

Choose a document from the templates stored in your library

 

RecipientSetInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email

Email of the recipient

 

SecurityOptions

Summary:

Description: Sets optional secondary security parameters for your document

 

          Properties:

Name

Type

Summary

protectOpen

boolean

Password Protect Document?

Should the signed agreement PDF be encrypted using a password?

openPassword

string

Document Password

The password that should be used to encrypt the signed agreement PDF

 

FileInfos2

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Document Library Template (2)

Choose a document from the templates stored in your library

 

FileInfos3

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Document Library Template (3)

Choose a document from the templates stored in your library

 

FileInfos4

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Document Library Template (4)

Choose a document from the templates stored in your library

 

FileInfos5

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Document Library Template (5)

Choose a document from the templates stored in your library

 

FileInfos6

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Document Library Template (6)

Choose a document from the templates stored in your library

 

FileInfos7

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Document Library Template (7)

Choose a document from the templates stored in your library

 

FileInfos8

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Document Library Template (8)

Choose a document from the templates stored in your library

 

RecipientSetInfos2

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (2)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (2)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (2)

Email of the recipient

 

RecipientSetInfos3

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (3)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (3)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (3)

Email of the recipient

 

RecipientSetInfos4

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (4)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (4)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (4)

Email of the recipient

 

RecipientSetInfos5

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (5)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (5)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (5)

Email of the recipient

 

RecipientSetInfos6

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (6)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (6)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (6)

Email of the recipient

 

RecipientSetInfos7

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (7)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (7)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (7)

Email of the recipient

 

MergeFieldInfo1

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (1)

The name of the field

defaultValue

string

Form Field Value (1)

The default value of the field

 

MergeFieldInfo2

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (2)

The name of the field

defaultValue

string

Form Field Value (2)

The default value of the field

 

MergeFieldInfo3

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (3)

The name of the field

defaultValue

string

Form Field Value (3)

The default value of the field

 

MergeFieldInfo4

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (4)

The name of the field

defaultValue

string

Form Field Value (4)

The default value of the field

 

MergeFieldInfo5

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (5)

The name of the field

defaultValue

string

Form Field Value (5)

The default value of the field

 

MergeFieldInfo6

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (6)

The name of the field

defaultValue

string

Form Field Value (6)

The default value of the field

 

MergeFieldInfo7

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (7)

The name of the field

defaultValue

string

Form Field Value (7)

The default value of the field

 

MergeFieldInfo8

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (8)

The name of the field

defaultValue

string

Form Field Value (8)

The default value of the field

 

MergeFieldInfo9

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (9)

The name of the field

defaultValue

string

Form Field Value (9)

The default value of the field

 

MergeFieldInfo10

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (10)

The name of the field

defaultValue

string

Form Field Value (10)

The default value of the field

 


 

AgreementCreationInfoUrl

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentCreationInfo

DocumentCreationInfo

 

 

 

DocumentCreationInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Agreement Name

The name of the agreement

fileInfos1

FileInfos1

 

 

signatureType

string

Signature Type

The type of signature you would like to request - E-signature or Written  Values: [E-Signature, Written Signature]

recipientSetInfos1

RecipientSetInfos1

 

 

message

string

Message

An optional message to the recipients requesting their action

daysUntilSigningDeadline

integer

Days to Deadline

The number of days that remain before the document expires

reminderFrequency

string

Reminder Frequency

How often do you want to send reminders ?  Values: [DAILY_UNTIL_SIGNED, WEEKLY_UNTIL_SIGNED]

securityOptions

SecurityOptions

 

Sets optional secondary security parameters for your document

fileInfos2

FileInfos2

 

 

fileInfos3

FileInfos3

 

 

fileInfos4

FileInfos4

 

 

fileInfos5

FileInfos5

 

 

fileInfos6

FileInfos6

 

 

fileInfos7

FileInfos7

 

 

fileInfos8

FileInfos8

 

 

recipientSetInfos2

RecipientSetInfos2

 

 

recipientSetInfos3

RecipientSetInfos3

 

 

recipientSetInfos4

RecipientSetInfos4

 

 

recipientSetInfos5

RecipientSetInfos5

 

 

recipientSetInfos6

RecipientSetInfos6

 

 

recipientSetInfos7

RecipientSetInfos7

 

 

mergeFieldInfo1

MergeFieldInfo1

 

 

mergeFieldInfo2

MergeFieldInfo2

 

 

mergeFieldInfo3

MergeFieldInfo3

 

 

mergeFieldInfo4

MergeFieldInfo4

 

 

mergeFieldInfo5

MergeFieldInfo5

 

 

mergeFieldInfo6

MergeFieldInfo6

 

 

mergeFieldInfo7

MergeFieldInfo7

 

 

mergeFieldInfo8

MergeFieldInfo8

 

 

mergeFieldInfo9

MergeFieldInfo9

 

 

mergeFieldInfo10

MergeFieldInfo10

 

 

 

FileInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL

A publicly accessible URL for retrieving the document

name

string

Name

The name of the referenced document, with extension

 

RecipientSetInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email

Email of the recipient

 

SecurityOptions

Summary:

Description: Sets optional secondary security parameters for your document

 

          Properties:

Name

Type

Summary

protectOpen

boolean

Password Protect Document?

Should the signed agreement PDF be encrypted using a password?

openPassword

string

Document Password

The password that should be used to encrypt the signed agreement PDF

 

FileInfos2

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (2)

A publicly accessible URL for retrieving the document

name

string

Name (2)

The name of the referenced document, with extension

 

FileInfos3

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (3)

A publicly accessible URL for retrieving the document

name

string

Name (3)

The name of the referenced document, with extension

 

FileInfos4

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (4)

A publicly accessible URL for retrieving the document

name

string

Name (4)

The name of the referenced document, with extension

 

FileInfos5

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (5)

A publicly accessible URL for retrieving the document

name

string

Name (5)

The name of the referenced document, with extension

 

FileInfos6

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (6)

A publicly accessible URL for retrieving the document

name

string

Name (6)

The name of the referenced document, with extension

 

FileInfos7

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (7)

A publicly accessible URL for retrieving the document

name

string

Name (7)

The name of the referenced document, with extension

 

FileInfos8

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (8)

A publicly accessible URL for retrieving the document

name

string

Name (8)

The name of the referenced document, with extension

 

RecipientSetInfos2

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (2)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (2)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (2)

Email of the recipient

 

RecipientSetInfos3

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (3)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (3)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (3)

Email of the recipient

 

RecipientSetInfos4

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (4)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (4)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (4)

Email of the recipient

 

RecipientSetInfos5

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (5)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (5)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (5)

Email of the recipient

 

RecipientSetInfos6

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (6)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (6)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (6)

Email of the recipient

 

RecipientSetInfos7

Summary:

Description:

 

          Properties:

Name

Type

Summary

recipientSetMemberInfos1

RecipientSetMemberInfos1

 

 

signingOrder

integer

Recipient Signing Order (7)

Index starting with 1, that tells the order in which this recipient signs

recipientSetRole

string

Recipient Role (7)

Specify the role of recipient  Values: [Signer, Approver, Acceptor, Form filler, Certified recipient, Delegate to approver, Delegate to signer, Delegate to form filler, Delegate to certified recipient, Delegate to acceptor]

 

RecipientSetMemberInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Recipient Email (7)

Email of the recipient

 

MergeFieldInfo1

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (1)

The name of the field

defaultValue

string

Form Field Value (1)

The default value of the field

 

MergeFieldInfo2

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (2)

The name of the field

defaultValue

string

Form Field Value (2)

The default value of the field

 

MergeFieldInfo3

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (3)

The name of the field

defaultValue

string

Form Field Value (3)

The default value of the field

 

MergeFieldInfo4

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (4)

The name of the field

defaultValue

string

Form Field Value (4)

The default value of the field

 

MergeFieldInfo5

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (5)

The name of the field

defaultValue

string

Form Field Value (5)

The default value of the field

 

MergeFieldInfo6

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (6)

The name of the field

defaultValue

string

Form Field Value (6)

The default value of the field

 

MergeFieldInfo7

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (7)

The name of the field

defaultValue

string

Form Field Value (7)

The default value of the field

 

MergeFieldInfo8

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (8)

The name of the field

defaultValue

string

Form Field Value (8)

The default value of the field

 

MergeFieldInfo9

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (9)

The name of the field

defaultValue

string

Form Field Value (9)

The default value of the field

 

MergeFieldInfo10

Summary:

Description:

 

          Properties:

Name

Type

Summary

fieldName

string

Form Field Name (10)

The name of the field

defaultValue

string

Form Field Value (10)

The default value of the field

 


 

AgreementCreationResponse

Summary:

Description: A JSON that contains the ID of the newly created agreement

 

          Properties:

Name

Type

Summary

agreementId

string

Agreement ID

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


 

AgreementDocuments

Summary:

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

 

          Properties:

Name

Type

Summary

documents

array of (Document)

Documents

A list of objects representing the documents

supportingDocuments

array of (SupportingDocument)

Supporting Documents

A list of supporting documents. This is returned only if there are any supporting document in the agreement


 

AgreementInfo

Summary:

Description: The complete details about the agreement

 

          Properties:

Name

Type

Summary

agreementId

string

Agreement ID

A unique ID that can be used to uniquely identify the agreement

events

array of (DocumentHistoryEvent)

Events

An ordered list of the events in the audit trail of this document

expiration

string(date)

Expiration Date

The date after which the agreement can no longer be signed

latestVersionId

string

Latest Version ID

A unique ID which uniquely identifies the current version of the agreement

message

string

Message

The message associated with the agreement that the sender has provided

name

string

Agreement Name

The name of the agreement, specified by the sender

nextParticipantSetInfos

array of (NextParticipantSetInfo)

Next Participant Sets

Information about who needs to act next for this agreement

participantSetInfos

array of (ParticipantSetInfo)

Participant Sets

Information about all the participant sets of this document

signatureType

string

Signature Type

Specifies the Signature type that was requested - E-signature or Written  Values: [ESIGN, WRITTEN]

securityOptions

string

Document Protection

Security information about the document that specifies whether or not a password is required to view and sign it

status

string

Status

The current status of the agreement  Values: [OUT_FOR_SIGNATURE, WAITING_FOR_REVIEW, SIGNED, APPROVED, ABORTED, DOCUMENT_LIBRARY, WIDGET, EXPIRED, ARCHIVED, PREFILL, AUTHORING, WAITING_FOR_FAXIN, WAITING_FOR_VERIFICATION, WIDGET_WAITING_FOR_VERIFICATION, WAITING_FOR_PAYMENT, OUT_FOR_APPROVAL, OTHER]


 

DisplayUserInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

company

string

Company

Displays the name of the company of the user, if available

email

string

Email

Displays the email of the user

fullName

string

Full Name

Displays the full name of the user, if available.


 

DisplayUserSetInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayUserSetMemberInfos

array of (DisplayUserInfo)

Display User Set Info

Displays the info about user set

displayUserSetName

string

Display User Set Name

 


 

Document

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentId

string

Document ID

Unique ID of the document

mimeType

string

Mime Type

The Mime type of the document

name

string

Name

The name of the document

numPages

integer

Num Pages

Number of pages in the document


 

DocumentHistoryEvent

Summary:

Description:

 

          Properties:

Name

Type

Summary

actingUserEmail

string

Event Initiator

Email address of the user that initiated the event

date

string(date)

Event Date

The date of the audit event

description

string

Event Description

A description of the audit event

participantEmail

string

Participant Email

Email address of the user that initiated the event

type

string

Event Type

Type of agreement event  Values: [CREATED, UPLOADED_BY_SENDER, FAXED_BY_SENDER, AGREEMENT_MODIFIED, USER_ACK_AGREEMENT_MODIFIED, PRESIGNED, SIGNED, ESIGNED, DIGSIGNED, APPROVED, OFFLINE_SYNC, FAXIN_RECEIVED, SIGNATURE_REQUESTED, APPROVAL_REQUESTED, RECALLED, REJECTED, EXPIRED, EXPIRED_AUTOMATICALLY, SHARED, EMAIL_VIEWED, AUTO_CANCELLED_CONVERSION_PROBLEM, SIGNER_SUGGESTED_CHANGES, SENDER_CREATED_NEW_REVISION, PASSWORD_AUTHENTICATION_FAILED, KBA_AUTHENTICATION_FAILED, KBA_AUTHENTICATED, WEB_IDENTITY_AUTHENTICATED, WEB_IDENTITY_SPECIFIED, EMAIL_BOUNCED, WIDGET_ENABLED, WIDGET_DISABLED, DELEGATED, AUTO_DELEGATED, REPLACED_SIGNER, VAULTED, DOCUMENTS_DELETED, OTHER]


 

DocumentLibraryItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Library Template Id

The unique ID of the library document used when sending the document to be signed

libraryTemplateTypes

array of (string)

Library Template Types

A list of one or more library template types

modifiedDate

string(date)

Modified Date

The day on which the library template was last modified

name

string

Library Template Name

The name of the library template

scope

string

Template Sharing Mode

The scope of visibility of the library template  Values: [PERSONAL, SHARED, GLOBAL]


 

DocumentLibraryItems

Summary:

Description: A JSON that contains the library template array object

 

          Properties:

Name

Type

Summary

libraryDocumentList

array of (DocumentLibraryItem)

Library Templates List

A list of library template items


 

file

Summary: File Content

Description: The file stream of the document to be uploaded

 

          Properties:

Name

Type

Summary


 

LibraryCreationInfoId

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentCreationInfo

LibraryDocumentCreationInfo

 

 

 

LibraryDocumentCreationInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Template Name

Agreement Name used to identify the template

libraryTemplateTypes

string

Template Type

A list of one or more library template types  Values: [Reusable document, Reusable form field layer, Both]

librarySharingMode

string

Share with

Specifies who should have access to this library document  Values: [Only me, Any user in my group, Any user in my organization]

fileInfos1

FileInfos1

 

 

fileInfos2

FileInfos2

 

 

fileInfos3

FileInfos3

 

 

fileInfos4

FileInfos4

 

 

fileInfos5

FileInfos5

 

 

fileInfos6

FileInfos6

 

 

fileInfos7

FileInfos7

 

 

fileInfos8

FileInfos8

 

 

 

FileInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID

The document ID received by uploading a document

 

FileInfos2

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (2)

The document ID received by uploading a document

 

FileInfos3

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (3)

The document ID received by uploading a document

 

FileInfos4

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (4)

The document ID received by uploading a document

 

FileInfos5

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (5)

The document ID received by uploading a document

 

FileInfos6

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (6)

The document ID received by uploading a document

 

FileInfos7

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (7)

The document ID received by uploading a document

 

FileInfos8

Summary:

Description:

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID (8)

The document ID received by uploading a document

 


 

LibraryCreationInfoUrl

Summary:

Description:

 

          Properties:

Name

Type

Summary

libraryDocumentCreationInfo

LibraryDocumentCreationInfo

 

 

 

LibraryDocumentCreationInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Template Name

Agreement Name used to identify the template

libraryTemplateTypes

string

Template Type

A list of one or more library template types  Values: [Reusable document, Reusable form field layer, Both]

librarySharingMode

string

Share with

Specifies who should have access to this library document  Values: [Only me, Any user in my group, Any user in my organization]

fileInfos1

FileInfos1

 

 

fileInfos2

FileInfos2

 

 

fileInfos3

FileInfos3

 

 

fileInfos4

FileInfos4

 

 

fileInfos5

FileInfos5

 

 

fileInfos6

FileInfos6

 

 

fileInfos7

FileInfos7

 

 

fileInfos8

FileInfos8

 

 

 

FileInfos1

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL

A publicly accessible URL for retrieving the document

name

string

Name

The name of the referenced document, with extension

 

FileInfos2

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (2)

A publicly accessible URL for retrieving the document

name

string

Name (2)

The name of the referenced document, with extension

 

FileInfos3

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (3)

A publicly accessible URL for retrieving the document

name

string

Name (3)

The name of the referenced document, with extension

 

FileInfos4

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (4)

A publicly accessible URL for retrieving the document

name

string

Name (4)

The name of the referenced document, with extension

 

FileInfos5

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (5)

A publicly accessible URL for retrieving the document

name

string

Name (5)

The name of the referenced document, with extension

 

FileInfos6

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (6)

A publicly accessible URL for retrieving the document

name

string

Name (6)

The name of the referenced document, with extension

 

FileInfos7

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (7)

A publicly accessible URL for retrieving the document

name

string

Name (7)

The name of the referenced document, with extension

 

FileInfos8

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentURL

DocumentURL

Document

File at a public URL location

 

DocumentURL

Summary: Document

Description: File at a public URL location

 

          Properties:

Name

Type

Summary

url

string

URL (8)

A publicly accessible URL for retrieving the document

name

string

Name (8)

The name of the referenced document, with extension

 


 

LibraryDocumentCreationResponse

Summary:

Description: A JSON object describing the library template

 

          Properties:

Name

Type

Summary

libraryDocumentId

string

Library Template Id

The unique ID that can be used to refer to the library template


 

NextParticipantInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

email

string

Email

The email address of the next participant

name

string

Name

The name of the next participant, if available

waitingSince

string(date)

Waiting Since

The date since which the document has been waiting for the participant to take action


 

NextParticipantSetInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

nextParticipantSetMemberInfos

array of (NextParticipantInfo)

Next Participant Set Member Infos

Information about the members of the next participant set


 

ParticipantInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

company

string

Company

The company of the participant, if available

email

string

Email

The email address of the participant

name

string

Name

The name of the participant, if available

participantId

string

Participant ID

The unique ID of the participant

securityOptions

array of (string)

Security Options

Security options that apply to the participant

title

string

Title

The title of the participant, if available


 

ParticipantSetInfo

Summary:

Description:

 

          Properties:

Name

Type

Summary

participantSetId

string

Participant Set ID

The unique ID of the participant set

participantSetMemberInfos

array of (ParticipantInfo)

Participant Set Member Infos

Information about the members of the recipient set

privateMessage

string

Private Message

Private message for the participants in the set

roles

array of (string)

Role

The current roles of the participant set. A participant set can have one or more roles

securityOptions

array of (string)

 

Security options that apply to the participant

signingOrder

integer

Signing Order

Index starting with 1, that tells the order in which this recipient signs

status

string

Participant Set Status

The participant set status with respect to the document  Values: [WAITING_FOR_MY_SIGNATURE, WAITING_FOR_MY_APPROVAL, WAITING_FOR_MY_DELEGATION, OUT_FOR_SIGNATURE, SIGNED, APPROVED, RECALLED, HIDDEN, NOT_YET_VISIBLE, WAITING_FOR_FAXIN, ARCHIVED, UNKNOWN, PARTIAL, FORM, WAITING_FOR_AUTHORING, OUT_FOR_APPROVAL, WIDGET, EXPIRED, WAITING_FOR_MY_REVIEW, IN_REVIEW, OTHER]


 

SupportingDocument

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayLabel

string

Supporting Document Name

Display name of the supporting document

fieldName

string

Supporting Document Field Name

The name of the supporting document field

mimeType

string

Supporting Document Mime Type

The Mime type of the supporting document

numPages

integer(int32)

Supporting Document Pages

Number of pages in the supporting document

supportingDocumentId

string

Supporting Document ID

Unique Id representing the supporting document


 

TransientDocumentResponse

Summary:

Description: A JSON that contains the ID of the uploaded document

 

          Properties:

Name

Type

Summary

transientDocumentId

string

Document ID

The document ID of the uploaded document


 

UserAgreement

Summary:

Description:

 

          Properties:

Name

Type

Summary

agreementId

string

Agreement ID

A unique ID that can be used to uniquely identify the agreement

displayUserSetInfos

array of (DisplayUserSetInfo)

Display User Set Infos

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

displayDate

string(date)

Display Date

The display date for the agreement

esign

boolean

Esign

True if this is an e-sign document

latestVersionId

string

Latest Version ID

A version ID which uniquely identifies the current version of the agreement

name

string

Name

Name of the Agreement

status

string

Status

The current status of the agreement  Values: [WAITING_FOR_MY_SIGNATURE, WAITING_FOR_MY_APPROVAL, WAITING_FOR_MY_DELEGATION, OUT_FOR_SIGNATURE, OUT_FOR_APPROVAL, SIGNED, APPROVED, RECALLED, WAITING_FOR_FAXIN, ARCHIVED, FORM, EXPIRED, WIDGET, WAITING_FOR_AUTHORING]


 

UserAgreements

Summary:

Description: A JSON that contains the user agreement array object

 

          Properties:

Name

Type

Summary

userAgreementList

array of (UserAgreement)

Agreement List

An array of agreement items