Connective eSignatures
Connective eSignatures is a renowned digital signature solution offering a vast amount of signature methods & compliance to the most stringent (inter)national regulations. eSignatures allows you to transform any paper-based process into an end-to-end digital flow with an unparalleled user experience. Streamline the signing process exactly how you want it to and send, sign & track all types of documents directly from your favorite business applications. Join more than 500 satisfied customers.
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 | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Connective Support |
URL | https://connective.eu/contact-support/ |
service@connective.eu |
Connector Metadata | |
---|---|
Publisher | Connective |
Website | https://www.connective.eu |
Privacy policy | https://connective.eu/privacy-policy/ |
Categories | IT Operations;Productivity |
Connective, a specialist in digital signatures, identity services, and smart document generation, has made the Connective eSignatures Connector for Power Automate available for usage. The Connector allows companies to forward documents that require a digital signature directly from their favorite Microsoft 365 applications – from Microsoft Teams to Word, SharePoint, Dynamics, OneDrive, and many others.
How to start using the connector
To start making use of the connector, reach out to your Relationship manager at Connective or go to our contact page on our website to receive the credentials.
This page will further detail the different actions available, as well as provide insight on the different ways these actions can be implemented.
Don't hesitate to have a look at our documentation website for further information or reach out to the support team through or support contact form or support mailbox: service@connective.eu
A glossary is available to explain the different terms being used within this documentation
Actions
The Connective eSignatures connector is based on API v3 of eSignatures. The eSignatures API is a REST API that allows external applications to integrate with and use the features listed in this document to create and manage signing flows.
The available actions can be grouped into different groups
Action Group | Available Actions |
---|---|
Uploading documents | Create Package |
Add Document to Package | |
Get Signing Locations | |
Set Process Information | |
Set Package Status | |
Create Instant Package | |
Retrieving the status of a document | Get Package Status |
Get Package List | |
Miscellaneous actions | Skip Signers |
Download Package | |
Package Expiry Extension | |
Send Package Reminder | |
Delete Package | |
Retrieving Audit Proof | Retrieve Package Audit Proofs |
Retrieve Document Audit Proofs | |
Retrieve Package Audit Proofs with Correlation ID | |
Retrieve Document Audit Proofs with Correlation ID | |
Add Proof from an External Source |
Creating a connection
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Connective eSignatures environment url | string | URL to your Connective eSignatures environment, eg. esignatures.connective.eu | True |
API username | securestring | API username to access the API | True |
API password | securestring | API password to access the API | True |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Add document to package |
This call will add a document to an existing package. |
Add Proof from External Source |
This call allows API users to add extra proofs from an external source to a location on a document. |
Create Instant Package |
This call creates a package with a single document in it and instantly prepares it for signing |
Create Package |
This call creates an empty package, allowing documents to be added to it |
Delete Package |
eSignatures does not automatically delete packages from the database once they have reached a final state. They are stored indefinitely. To delete packages from the database, users can use the Delete Package call. |
Document Correlation Audit Proof Download |
Correlation ids are used to track packages or documents across several passes through the eSignatures application. |
Download Document from Package |
The signed documents in a package can be downloaded one by one by an external system using this call. Each document will be downloaded as a PDF, or as an XML file stream, depending on the value of the DocumentType parameter. |
Download Package |
The package containing the signed documents can be downloaded by an external system using this call. |
Expiry Time Stamp |
A package may have the status Expired when a package passed a value for the ExpiryTimestamp parameter in the Create Package call. Such a package can no longer be signed. |
Get Package Status |
Retrieves the current state of the package and its documents. |
Get Signing Locations |
This call provides an overview of all signing locations inside the documents within a package. |
Package Audit Proof |
A package’s audit proofs xml can be retrieved when the package is fully signed. The same applies for a document: it only works when the containing package is fully signed. |
Package Audit Proof with document ID |
A package’s audit proofs xml can be retrieved when the package is fully signed. The same applies for a document: it only works when the containing package is fully signed. |
Package Correlation Audit Proof Download |
Correlation ids are used to track packages or documents across several passes through the eSignatures application. |
Package List |
Get a list of packages with their current status |
Send Package Reminders |
Company policy might require that a document is handled within a given timespan. Triggering the “send reminders” call will look up everybody who hasn’t signed and send them an extra notification as a reminder. |
Set Package Status |
By means of the Set Package Status call, you can change the status of a package. |
Set Process Information |
This webservice method updates the people involved in the process (stakeholders) and assigns them steps which need to be taken. |
Skip Signers |
This call skips all signers that haven’t signed yet and sets their status to “Skipped”, which results in the complete package being marked as “Finished”. |
Add document to package
This call will add a document to an existing package.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The package identifier.
|
PackageId | True | string |
Package Unique Id |
Document
|
Document | string |
Attached document in base64 encoded format. |
|
DocumentLanguage
|
DocumentLanguage | string |
Language to use in signature texts. |
|
DocumentName
|
DocumentName | string |
Name of the document to be shown in the eSignatures Portal. |
|
PageNumber
|
PageNumber | integer |
Number of the page on which to add a signing location |
|
Width
|
Width | string |
Width |
|
Height
|
Height | string |
Height |
|
Left
|
Left | string |
Position from the left of the page |
|
Top
|
Top | string |
Position from top of the page |
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Unique reference to a signing field, text marker or textfield. |
|
CorrelationId
|
CorrelationId | string |
Id that indicates which documents within this package are correlated with documents that have been signed in the past in other packages. |
|
DocumentType
|
DocumentType | string |
Type of document that will be signed. |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Reference given by the calling application. |
|
ErrorCode
|
ErrorCode | string |
Error code with variable information. |
|
Message
|
Message | string |
Error message detail text, not localized |
|
Representation
|
Representation | string |
Attached representation document in base64 format. This must be PDF data. |
|
RepresentationType
|
RepresentationType | string |
Type of the representation document. |
|
TargetType
|
TargetType | string |
The TargetType defines if an extra conversion to PDF/A needs to be done before signing. |
Returns
Name | Path | Type | Description |
---|---|---|---|
DocumentId
|
DocumentId | string |
Unique id for the document |
CreationTimestamp
|
CreationTimestamp | string |
Date and time the flow was created. Format: YYYY-MM-DDThh:mm:ss+zz:zz |
Locations
|
Locations | array of object |
Represents a possible location for a signature |
Id
|
Locations.Id | string |
Unique id for this location |
Label
|
Locations.Label | string |
Detected or specified label |
PageNumber
|
Locations.PageNumber | integer |
The page on which the location was found. |
Add Proof from External Source
This call allows API users to add extra proofs from an external source to a location on a document.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The unique ID of the Package
|
packageId | True | string |
The unique ID of the Package |
Content
|
Content | string |
The actual content of the proof. |
|
LocationId
|
LocationId | string |
Location of the signature for which the proof content was generated. |
|
Name
|
Name | string |
Name of the proof. |
|
Type
|
Type | string |
A machine-readable “type” key. Can be freely chosen. |
|
Description
|
Description | string |
Brief human-readable description of the proof. |
|
IpAddress
|
IpAddress | string |
IP address of the end user of the external source for which the proof was added. |
Create Instant Package
This call creates a package with a single document in it and instantly prepares it for signing
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Document
|
Document | byte |
Attached document in base64 encoded format. Required unless Multipart format is used. |
|
DocumentLanguage
|
DocumentLanguage | string |
Language to use in signature texts. Currently supported: en, nl, de, fr, es. |
|
DocumentName
|
DocumentName | string |
Name of the document and package to be shown in the eSignatures Portal. |
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
Initiator
|
Initiator | string |
Email address of a registered user |
|
Type
|
Type | string |
Signer / Receiver |
|
OrderIndex
|
OrderIndex | integer |
This number specifies in which order actors need to execute their action. |
|
PageNumber
|
PageNumber | integer |
Number of the page on which to add a signing location |
|
Width
|
Width | string |
Width |
|
Height
|
Height | string |
Height |
|
Left
|
Left | string |
Position from the left of the page |
|
Top
|
Top | string |
Position from top of the page |
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Unique reference to a signing field, text marker or textfield. |
|
SigningType
|
SigningType | string |
The signing type used in this actor's session. |
|
CommitmentTypes
|
CommitmentTypes | array of string |
One or more OIDs of commitment types. Can only be passed when signature policy is used. |
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Type of validation to execute during eID other smart card, or itsme signing session. |
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Defines which eID or other smart cards are allowed to sign during this session. |
|
SignaturePolicyId
|
SignaturePolicyId | string |
Signing policy details for the signature. |
|
Phonenumber
|
Phonenumber | string |
Phone number to receive an SMS OTP. |
|
RedirectUrl
|
RedirectUrl | string |
Url to which the end user is redirected after signing. |
|
SendNotifications
|
SendNotifications | boolean |
eSignatures can send e-mails to all the people who are allowed to sign. |
|
UserRoles
|
UserRoles | array of string |
Role or function of the signer. |
|
LegalNoticeCode
|
LegalNoticeCode | string |
Legal Notice |
|
LegalNoticeText
|
LegalNoticeText | string |
Custom legal notice text in case none of the three predefined legal notices apply. |
|
EmailAddress
|
EmailAddress | string |
EmailAddress |
|
FirstName
|
FirstName | string |
FirstName |
|
LastName
|
LastName | string |
LastName |
|
BirthDate
|
BirthDate | string |
BirthDate |
|
Language
|
Language | string |
Language |
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
CallBackUrl
|
CallBackUrl | string |
REST API URL that will be called each time an action has been completed for this package |
|
CorrelationId
|
CorrelationId | string |
Id that indicates which packages or documents are correlated |
|
DocumentGroupCode
|
DocumentGroupCode | string |
The ‘Code’ which identifies a document group in which the document should be shown |
|
ThemeCode
|
ThemeCode | string |
Theme that must be applied to the package |
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
This parameter determines whether packages can be downloaded from the WYSIWYS before signing |
|
ReassignEnabled
|
ReassignEnabled | boolean |
This parameter determines whether packages can be reassigned from the WYSIWYS to another approver/signer. |
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
This parameter determines after how many days the action URLs must expire when they are not used. |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Reference given by the calling application. This parameter will not be used by the eSignatures Portal |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Reference given by the calling application, this parameter will not be used by the eSignatures Portal |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Reference given by the calling application, this parameter will not be used by the eSignatures Portal |
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Url to which the end user is redirected after all fields have been signed with ‘face to face’ signing, or when all fields have been rejected. |
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
REST API URL that will be called when an end user requests to be notified. If no URL is supplied no call back is performed |
|
PdfErrorHandling
|
PdfErrorHandling | string |
How to deal with PDFs containing minor flaws |
|
Representation
|
Representation | string |
Attached representation document in base64 format |
|
RepresentationType
|
RepresentationType | string |
Type of the representation document, must be present when Representation is filled. Only “application/pdf” is supported. |
|
SigningTemplateCode
|
SigningTemplateCode | string |
The template configured in the portal will provide all necessary information |
|
TargetType
|
TargetType | string |
The TargetType defines if an extra conversion to PDF/A needs to be done before signing |
Returns
Name | Path | Type | Description |
---|---|---|---|
PackageId
|
PackageId | string |
Unique identifier of the package. |
CreationTimestamp
|
CreationTimestamp | string |
Date and time when the package was created according to the server. |
Create Package
This call creates an empty package, allowing documents to be added to it
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Content-Type
|
Content-Type | True | string |
Content-Type |
Initiator
|
Initiator | string |
Email address of a registered user. |
|
PackageName
|
PackageName | string |
Package name, seen in the eSignatures Portal and when downloading as zip file. |
|
CallBackUrl
|
CallBackUrl | string |
REST API URL that will be called each time an action has been completed for this package. |
|
CorrelationId
|
CorrelationId | string |
Id that indicates which packages are correlated. |
|
DocumentGroupCode
|
DocumentGroupCode | string |
The ‘Code’ which identifies a document group in which the package should be shown. |
|
ThemeCode
|
ThemeCode | string |
Theme that must be applied to the package |
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
This parameter determines whether packages can be downloaded from the WYSIWYS before signing. |
|
ReassignEnabled
|
ReassignEnabled | boolean |
This parameter determines whether packages can be reassigned from the WYSIWYS to another approver/signer. |
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
This parameter determines after how many days the action URLs must expire when they are not used. |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
The date and time when this package expires and can no longer be signed. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Reference given by the calling application. This parameter will not be used by the eSignatures Portal. |
|
ExternalPackageData
|
ExternalPackageData | string |
This field is reserved for future use. It can be used for customer-specific extensions to integrate with third-party services, such as Debit Card signing. |
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL to which the end user is redirected after all fields have been signed with 'face to face' signing, or when all fields have been rejected. |
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
REST API URL that will be called when an end user requests to be notified. |
Returns
Name | Path | Type | Description |
---|---|---|---|
PackageId
|
PackageId | string |
Unique identifier of the package. |
CreationTimestamp
|
CreationTimestamp | string |
Date and time when the package was created according to the server. |
Delete Package
eSignatures does not automatically delete packages from the database once they have reached a final state. They are stored indefinitely. To delete packages from the database, users can use the Delete Package call.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique ID of the Package
|
id | True | string |
Unique ID of the Package |
Document Correlation Audit Proof Download
Correlation ids are used to track packages or documents across several passes through the eSignatures application.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The correlation identifier.
|
correlationId | True | string |
The correlation identifier. |
Returns
- Body
- Content
Download Document from Package
The signed documents in a package can be downloaded one by one by an external system using this call. Each document will be downloaded as a PDF, or as an XML file stream, depending on the value of the DocumentType parameter.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique id for the signing package
|
id | True | string |
Unique id for the signing package |
Unique id of the document contained in the package
|
documentId | True | string |
Unique id of the document contained in the package |
Returns
- response
- binary
Download Package
The package containing the signed documents can be downloaded by an external system using this call.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique ID of the Package
|
id | True | string |
Unique ID of the Package |
Returns
- response
- binary
Expiry Time Stamp
A package may have the status Expired when a package passed a value for the ExpiryTimestamp parameter in the Create Package call. Such a package can no longer be signed.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique ID of the Package
|
id | True | string |
Unique ID of the Package |
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Get Package Status
Retrieves the current state of the package and its documents.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique id for the signing package
|
Id | True | string |
Unique id for the signing package |
Returns
Description for the Package shown to the eSignatures Portal user as file name.
- Body
- PackageStatus
Get Signing Locations
This call provides an overview of all signing locations inside the documents within a package.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of the signing field
|
Id | True | string |
Id of the signing field |
Returns
Name | Path | Type | Description |
---|---|---|---|
Documents
|
Documents | array of object | |
DocumentId
|
Documents.DocumentId | string |
Unique id for the document |
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
External reference for identification. Make sure to use a unique value. |
Locations
|
Documents.Locations | array of object |
Represents a possible location for a signature |
Id
|
Documents.Locations.Id | string |
Unique id for this location. |
Label
|
Documents.Locations.Label | string |
Value you entered as Request parameter. |
PageNumber
|
Documents.Locations.PageNumber | integer |
Number of the page on which the signature can be found. |
Package Audit Proof
A package’s audit proofs xml can be retrieved when the package is fully signed. The same applies for a document: it only works when the containing package is fully signed.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique ID of the Package
|
packageId | True | string |
Unique ID of the Package |
Returns
- Body
- Content
Package Audit Proof with document ID
A package’s audit proofs xml can be retrieved when the package is fully signed. The same applies for a document: it only works when the containing package is fully signed.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique ID of the Package
|
packageId | True | string |
Unique ID of the Package |
Unique ID of the Document
|
documentId | True | string |
Unique ID of the Document |
Returns
- Body
- Content
Package Correlation Audit Proof Download
Correlation ids are used to track packages or documents across several passes through the eSignatures application.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The correlation identifier.
|
correlationId | True | string |
The correlation identifier. |
Returns
- Body
- Content
Package List
Get a list of packages with their current status
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The continuation token / guid to know what page to return.
|
ContinuationToken | string |
The continuation token / guid to know what page to return. MUST BE EMPTY or the token returned from a PREVIOUS call. |
|
Gets or sets the maximum quantity.
|
MaxQuantity | integer |
Gets or sets the maximum quantity. |
|
Gets or sets the sort field.
|
SortField | string |
Gets or sets the sort field. |
|
Gets or sets the sort field.
|
SortOrder | string |
Gets or sets the sort field. |
|
Gets or sets the created before date.
|
CreatedBeforeDate | string |
Gets or sets the created before date. |
|
Gets or sets the status.
|
Status | string |
Gets or sets the status. |
|
Gets or sets the created after date.
|
createdAfterDate | string |
Gets or sets the created after date. |
Returns
Name | Path | Type | Description |
---|---|---|---|
ContinuationToken
|
ContinuationToken | string |
ContinuationToken |
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
Total
|
Total | integer |
Total |
Items
|
Items | array of Package |
Send Package Reminders
Company policy might require that a document is handled within a given timespan. Triggering the “send reminders” call will look up everybody who hasn’t signed and send them an extra notification as a reminder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique ID of the Package
|
PackageId | True | string |
Unique ID of the Package |
Set Package Status
By means of the Set Package Status call, you can change the status of a package.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique id for the signing package
|
Id | True | string |
Unique id for the signing package |
Status
|
Status | string |
Pending / Revoked |
Returns
Description for the Package shown to the eSignatures Portal user as file name.
- Body
- PackageStatus
Set Process Information
This webservice method updates the people involved in the process (stakeholders) and assigns them steps which need to be taken.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique ID of the Package
|
id | True | string |
Unique ID of the Package |
Type
|
Type | string |
Type |
|
OrderIndex
|
OrderIndex | string |
This number specifies in which order actors need to execute their action. |
|
LocationIds
|
LocationIds | array of string |
The location ids where a signature must be placed by this person. |
|
SigningType
|
SigningType | string |
The signing type used in this actor's session. |
|
CommitmentTypes
|
CommitmentTypes | array of string |
One or more OIDs of commitment types. Can only be passed when signature policy is used. |
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Type of validation to execute during eID other smart card, or itsme signing session. |
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Defines which eID or other smart cards are allowed to sign during this session. |
|
SignaturePolicyId
|
SignaturePolicyId | string |
Signing policy details for the signature. |
|
Phonenumber
|
Phonenumber | string |
Phone number to receive an SMS OTP. |
|
RedirectURL
|
RedirectURL | string |
Url to which the end user is redirected after signing, or rejecting. The redirect occurs immediately after signing or rejecting. |
|
SendNotifications
|
SendNotifications | boolean |
eSignatures can send e-mails to the actors whose action is required, such as signing |
|
UserRoles
|
UserRoles | array of string |
The location ids where a signature must be placed by this person. |
|
LegalNoticeCode
|
LegalNoticeCode | string |
The 3 values will point to the 3 legal notices built into the application. These can be altered in the Configuration Index. |
|
LegalNoticetext
|
LegalNoticetext | string |
Custom legal notice text in case none of the three predefined legal notices apply |
|
EmailAddress
|
EmailAddress | string |
Email Address |
|
FirstName
|
FirstName | string |
First Name |
|
Language
|
Language | string |
UI language of this stakeholder. Currently supported: en, nl, de, fr, es. |
|
LastName
|
LastName | string |
Last Name |
|
BirthDate
|
BirthDate | string |
Date of birth in format: YYYY-MM-DD |
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Reference given by the calling application. This parameter will not be used by the eSignatures Portal. |
Skip Signers
This call skips all signers that haven’t signed yet and sets their status to “Skipped”, which results in the complete package being marked as “Finished”.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Unique id of the Package
|
PackageId | True | string |
Unique id of the Package |
Definitions
Package
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | string | |
PackageStatus
|
PackageStatus | string | |
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Details for each of the documents in the package
Name | Path | Type | Description |
---|---|---|---|
DocumentId
|
DocumentId | string |
Unique id of the document |
ExternalDocumentReference
|
ExternalDocumentReference | string |
Returns the external reference of this document as it was passed in through the Add document to package call. |
DocumentName
|
DocumentName | string |
Name of the document |
DocumentType
|
DocumentType | string |
Type of document within the package. |
PackageStatus
Description for the Package shown to the eSignatures Portal user as file name.
Name | Path | Type | Description |
---|---|---|---|
PackageName
|
PackageName | string |
Description for the Package shown to the eSignatures Portal user as file name. |
CreationTimestamp
|
CreationTimestamp | string |
Date and time when the package was created according to the server. |
Initiator
|
Initiator | string |
Initiator field of the package as it was passed in at creation time. |
ExpiryTimestamp
|
ExpiryTimestamp | string |
UTC formatted time at which the document expires. Can be null. |
ExternalPackageReference
|
ExternalPackageReference | string |
Returns the external reference id of the package as it was passed in at creation time. |
F2FSigningUrl
|
F2FSigningUrl | string |
Link to the package which allows to pick from all the signing session at once. |
PackageStatus
|
PackageStatus | string |
Status of the package as a whole: |
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Details for each of the documents in the package. |
Stakeholders
|
Stakeholders | array of object |
Details for each of the persons which will interact with the package. |
Type
|
Stakeholders.Type | string |
Type of stakeholder: Person, PersonGroup, or ContactGroup. |
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Name of the person group. Only returned if Type was set to PersonGroup in the request. |
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Code of the contact group. Only returned if Type was set to ContactGroup in the request. |
EmailAddress
|
Stakeholders.EmailAddress | string |
Email address of the signer. |
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
External reference identifying this person in the external system. |
StakeholderId
|
Stakeholders.StakeholderId | string |
Unique id. |
Actors
|
Stakeholders.Actors | array of object |
Details of all steps to take. |
ActorId
|
Stakeholders.Actors.ActorId | string |
Unique id for this combination of action, stakeholder and document. |
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
URL that this person can open to interact with the package. |
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Array of URLs that the different persons of the PersonGroup or ContactGroup can open to interact with the package. |
EmailAddress
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
Email address of the person. |
Url
|
Stakeholders.Actors.ActionUrls.Url | string |
URL that this person can open to interact with the package. |
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
Draft (package has status Draft) |
Type
|
Stakeholders.Actors.Type | string |
Signer / Receiver |
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
The name of the end user who completed the action. |
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Timestamp of the moment on which this action was completed. |
Reason
|
Stakeholders.Actors.Reason | string |
Returns the text entered by the person who changed the status of a package to a final state (e.g. a reject). |
Locations
|
Stakeholders.Actors.Locations | array of object |
Represents a possible location for a signature. |
Id
|
Stakeholders.Actors.Locations.Id | string |
Unique id for this location |
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Returns the signing type that was used to sign the document. |
Content
Name | Path | Type | Description |
---|---|---|---|
uploads
|
uploads | array of object | |
upload
|
uploads.upload | array of object | |
start
|
uploads.upload.start | date-time | |
end
|
uploads.upload.end | date-time | |
signatures
|
uploads.upload.signatures | array of object | |
proofs
|
uploads.upload.signatures.proofs | array of object | |
name
|
uploads.upload.signatures.proofs.proof.name | string | |
type
|
uploads.upload.signatures.proofs.proof.type | string | |
index
|
uploads.upload.signatures.proofs.proof.index | boolean | |
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
locationId
|
uploads.upload.signatures.locationId | string | |
indexes
|
uploads.indexes | array of object | |
identifier
|
uploads.indexes.index.identifier | boolean | |
content
|
uploads.indexes.index.content | string | |
packageCorrelationId
|
uploads.packageCorrelationId | string | |
packageId
|
uploads.packageId | string |
binary
This is the basic data type 'binary'.