Nitro Sign Enterprise Verified (Preview)
Nitro Sign Enterprise Verified is a renowned digital signature solution offering a vast amount of signature methods & compliance to the most stringent (inter)national regulations. NSEV 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.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | 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) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - 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) |
| 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) |
| Contact | |
|---|---|
| Name | Nitro Support |
| URL | https://www.gonitro.com/support |
| service@gonitro.com |
| Connector Metadata | |
|---|---|
| Publisher | Nitro Software Belgium NV |
| Website | https://www.gonitro.com |
| Privacy policy | https://www.gonitro.com/legal/privacy-policy |
| Categories | IT Operations;Productivity |
Nitro Sign Enterprise Verified Connector
Nitro Software, a specialist in Smart Document Solutions, has made the Nitro Sign Enterprise Verified 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. Nitro Sign Enterprise Verified - previously known as Nitro Sign Premium and Connective eSignatures.
Prerequisites
To start making use of the connector, an existing subscription to Nitro Sign Enterprise Verified is required. Reach out to your contact at Nitro Software or go to our help and support page on our website to receive the credentials.
Documentation
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 our help and support page or support mailbox: mailto:service@gonitro.com. The API documentation is also available in Postman format.
A glossary is available to explain the different terms being used within this documentation
Supported Operations
The Nitro Sign Enterprise Verified connector is based on API v4 of Nitro Sign Enterprise Verified. The 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 |
|---|---|
| Packages | Get all packages |
| Get Package by ID | |
| Get Package Status | |
| Create a new Package (standard or instant) | |
| Delete a Package by ID | |
| Update the status of a Package | |
| Get a Package's expiry date | |
| Update a Package's expiry date | |
| Skip Signers | |
| Send reminders | |
| Download a Package | |
| Download the audit trail of a Package | |
| Documents | Add a document to a package |
| Download a signed Document from a Package | |
| Stakeholders | Delete a Stakeholder by ID |
| Get all stakeholders of a Package | |
| Add a stakeholder to a package | |
| Process | Get all process steps of a Package |
| Process | Add a step in the Package's process |
| Process | Overwrite process steps of a Package |
| Process | Get all actions of a process step |
| Process | Delete a process step and all its actors |
| Process | Add an actor to a process step |
| Process | Get all actions in the current process step |
| Other | Get all the languages enabled in the application |
| Get all themes that can be assigned to a Package | |
| Get all document groups to which a Package can be assigned | |
| Get all configured signing methods |
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 |
|---|---|---|---|
| Nitro Sign host | string | host and path to your Nitro Sign environment, e.g. contoso.sign.gonitro.com/esig | 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 a document to a package |
Adds a document to an existing package. |
| Add a stakeholder to a package |
Adds a stakeholder to the package |
| Add a step in the package's process |
Adds a set of actions to the package's process. |
| Add an actor to a process step |
Adds an actor to a process step. |
| Create a new package (standard or instant) |
Creates a new package. By default, the package is created as a draft. To create an instant package that is immediately ready for signing, set the Note: The |
| Delete a process step and all its actors |
Deletes a process step and all its actors. |
| Delete Package by ID |
Deletes a package by its ID. |
| Delete stakeholder by ID |
Deletes a stakeholder by its ID. |
| Download Document from Package |
Download a signed document from a package. Each document will be downloaded as a PDF or XML file. |
| Download Package |
Used for downloading all documents in a certain package as a Zip file. |
| Download the audit trail of the Package |
Download a signed audit trail about the lifetime of a package. |
| Get a package's expiry date |
Retrieve the expiry date of a package |
| Get all actions in the current process step |
Gets the current set of actions that can be completed in parallel. |
| Get all actions of a process step |
Gets a particular set of actions that can be completed in parallel from the process. |
| Get all packages |
Gets all packages, these are sorted by creationDate |
| Get all process steps |
Gets all actions that will have to be performed on the package. |
| Get all stakeholders of a package |
Retrieves the stakeholders of the package |
| Get Package by ID |
Retrieves a package by its ID. |
| Get Package Status |
Retrieves the current state of the package. |
| Overwrite process steps of a package |
Overwrites all actors in a package using a 2D array where each set of actors are actions that can be performed in parallel. |
| Retrieve all document groups to which packages can be assigned |
Retrieves all document groups to which packages can be assigned |
| Retrieve all languages that are enabled in the application |
Retrieves all languages that are enabled in the application |
| Retrieve all themes that can be assigned to a package |
Retrieves all themes that can be assigned to a package. Possible to page the result by providing a MaxQuantity and a continuationToken |
| Return all signing methods that are currently configured |
Returns all signing methods that are currently configured |
| 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. |
| Skip Signers |
This call skips all signers that haven't finished yet and sets their status to 'Skipped', resulting in the complete package being marked as 'Finished'. |
| Update a package's expiry date |
Update the expiry date of a package |
| Update Package Status |
Updates the status of a package. |
Add a document to a package
Adds a document to an existing package.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Package unique identifier
|
packageId | True | string |
Package unique identifier |
|
Name
|
Name | True | string |
Name of the document |
|
IsOptional
|
IsOptional | boolean |
Indicates if the document should be optional for signing |
|
|
Language
|
Language | True | string |
A country's 2-letter ISO code (ISO 639-1) |
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
A globally unique identifier |
|
|
TargetType
|
TargetType | string |
Will only work when the server is configured for document conversions. |
|
|
TargetFormat
|
TargetFormat | string |
The target format defines if an extra conversion needs to be done. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
How to deal with PDFs containing minor flaws |
|
|
ContentType
|
ContentType | True | string |
MIME type of the document |
|
Base64Data
|
Base64Data | True | byte |
Base64-encoded document content |
|
Type
|
Type | True | string |
The type of element |
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
Page
|
Page | integer |
Page number of the document |
|
|
Top
|
Top | number |
Top position in pixels |
|
|
Left
|
Left | number |
Left position in pixels |
|
|
Width
|
Width | number |
Width of the element |
|
|
Height
|
Height | number |
Height of the element |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Name
|
Name | string |
The name of the legal notice to be added to the signing field. |
|
|
Content
|
Content | string |
Custom legal notice content. |
|
|
Language
|
Language | string |
A country's 2-letter ISO code (ISO 639-1) |
Returns
- Body
- Response.Document
Add a stakeholder to a package
Adds a stakeholder to the package
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier for the package
|
packageId | True | string |
Unique identifier for the package |
|
Type
|
Type | True | string |
The type of stakeholder |
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
Language
|
Language | True | string |
A country's 2-letter ISO code (ISO 639-1) |
|
FirstName
|
FirstName | string |
First name of the stakeholder |
|
|
LastName
|
LastName | True | string |
Last name of the stakeholder |
|
EmailAddress
|
EmailAddress | True |
An email address |
|
|
BirthDate
|
BirthDate | date | ||
|
PhoneNumber
|
PhoneNumber | string |
A phone number |
|
|
AdditionalProperties
|
AdditionalProperties | object |
The configurable additional properties of the stakeholder |
|
|
Type
|
Type | True | string |
Type of action that will have to be performed on a package |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Suppress notifications for the actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Redirect URL after the actor's action is completed |
|
|
RedirectType
|
RedirectType | string | ||
|
BackButtonUrl
|
BackButtonUrl | url |
URL to which the user is sent after closing the session |
|
|
Id
|
Id | string |
Identifier of an existing element. If used, all other fields should be empty. |
|
|
Type
|
Type | string |
The type of element |
|
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
Page
|
Page | integer |
Page number of the document |
|
|
Top
|
Top | number |
Top position in pixels |
|
|
Left
|
Left | number |
Left position in pixels |
|
|
Width
|
Width | number |
Width of the element |
|
|
Height
|
Height | number |
Height of the element |
|
|
DocumentId
|
DocumentId | string |
Identifier of the document in the package |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Name
|
Name | string |
The name of the legal notice to be added to the signing field. |
|
|
Content
|
Content | string |
Custom legal notice content. |
|
|
Language
|
Language | string |
A country's 2-letter ISO code (ISO 639-1) |
Returns
- Body
- Response.Stakeholder
Add a step in the package's process
Adds a set of actions to the package's process.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
Type
|
Type | True | string |
Type of action that will have to be performed on a package |
|
StakeholderId
|
StakeholderId | True | string |
Identifier of a stakeholder in the package |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Suppress notifications for the actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Redirect URL after the actor's action is completed |
|
|
Id
|
Id | string |
Identifier of an existing element. If used, all other fields should be empty. |
|
|
Type
|
Type | string |
The type of element |
|
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
Page
|
Page | integer |
Page number of the document |
|
|
Top
|
Top | number |
Top position in pixels |
|
|
Left
|
Left | number |
Left position in pixels |
|
|
Width
|
Width | number |
Width of the element |
|
|
Height
|
Height | number |
Height of the element |
|
|
DocumentId
|
DocumentId | string |
Identifier of the document in the package |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Name
|
Name | string |
The name of the legal notice to be added to the signing field. |
|
|
Content
|
Content | string |
Custom legal notice content. |
|
|
Language
|
Language | string |
A country's 2-letter ISO code (ISO 639-1) |
Returns
A set of actors in a process step.
- response
- array of Response.Actor
Add an actor to a process step
Adds an actor to a process step.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
The index of the process step
|
stepIndex | True | integer |
The index of the process step |
|
Type
|
Type | True | string |
Type of action that will have to be performed on a package |
|
StakeholderId
|
StakeholderId | True | string |
Identifier of a stakeholder in the package |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Suppress notifications for the actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Redirect URL after the actor's action is completed |
|
|
Id
|
Id | string |
Identifier of an existing element. If used, all other fields should be empty. |
|
|
Type
|
Type | string |
The type of element |
|
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
Page
|
Page | integer |
Page number of the document |
|
|
Top
|
Top | number |
Top position in pixels |
|
|
Left
|
Left | number |
Left position in pixels |
|
|
Width
|
Width | number |
Width of the element |
|
|
Height
|
Height | number |
Height of the element |
|
|
DocumentId
|
DocumentId | string |
Identifier of the document in the package |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Name
|
Name | string |
The name of the legal notice to be added to the signing field. |
|
|
Content
|
Content | string |
Custom legal notice content. |
|
|
Language
|
Language | string |
A country's 2-letter ISO code (ISO 639-1) |
Returns
- Body
- Response.Actor
Create a new package (standard or instant)
Creates a new package. By default, the package is created as a draft. To create an instant package that is immediately ready for signing, set the status property to Pending.
Note: The POST /packages endpoint allows you to create both standard and instant packages.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Name
|
Name | True | string |
Name of the package |
|
Initiator
|
Initiator | True |
An email address |
|
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
Status
|
Status | string |
The status of the created package.
|
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Document group code for the package |
|
|
ExpiryDate
|
ExpiryDate | date-time |
A date-time value in ISO 8601 format |
|
|
Name
|
Name | True | string |
Name of the document |
|
IsOptional
|
IsOptional | boolean |
Indicates if the document should be optional for signing |
|
|
Language
|
Language | True | string |
A country's 2-letter ISO code (ISO 639-1) |
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
A globally unique identifier |
|
|
TargetType
|
TargetType | string |
Will only work when the server is configured for document conversions. |
|
|
TargetFormat
|
TargetFormat | string |
The target format defines if an extra conversion needs to be done. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
How to deal with PDFs containing minor flaws |
|
|
ContentType
|
ContentType | True | string |
MIME type of the document |
|
Base64Data
|
Base64Data | True | byte |
Base64-encoded document content |
|
Type
|
Type | True | string |
The type of element |
|
Page
|
Page | integer |
Page number of the document |
|
|
Top
|
Top | number |
Top position in pixels |
|
|
Left
|
Left | number |
Left position in pixels |
|
|
Width
|
Width | number |
Width of the element |
|
|
Height
|
Height | number |
Height of the element |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Name
|
Name | string |
The name of the legal notice to be added to the signing field. |
|
|
Content
|
Content | string |
Custom legal notice content. |
|
|
Type
|
Type | True | string |
The type of stakeholder |
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
Language
|
Language | True | string |
A country's 2-letter ISO code (ISO 639-1) |
|
FirstName
|
FirstName | string |
First name of the stakeholder |
|
|
LastName
|
LastName | True | string |
Last name of the stakeholder |
|
EmailAddress
|
EmailAddress | True |
An email address |
|
|
BirthDate
|
BirthDate | date | ||
|
PhoneNumber
|
PhoneNumber | string |
A phone number |
|
|
AdditionalProperties
|
AdditionalProperties | object |
The configurable additional properties of the stakeholder |
|
|
Type
|
Type | True | string |
Type of action that will have to be performed on a package |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Suppress notifications for the actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Redirect URL after the actor's action is completed |
|
|
RedirectType
|
RedirectType | string | ||
|
BackButtonUrl
|
BackButtonUrl | url |
URL to which the user is sent after closing the session |
|
|
ProcessStep
|
ProcessStep | integer |
The process step number |
|
|
DocumentIndex
|
DocumentIndex | True | integer |
Index of the document in the package (starting from 0) - only available in the Create Package endpoint |
|
Type
|
Type | True | string |
The type of element |
|
Page
|
Page | integer |
Page number of the document |
|
|
Top
|
Top | number |
Top position in pixels |
|
|
Left
|
Left | number |
Left position in pixels |
|
|
Width
|
Width | number |
Width of the element |
|
|
Height
|
Height | number |
Height of the element |
|
|
SigningMethods
|
SigningMethods | True | array of string | |
|
Name
|
Name | string |
The name of the legal notice to be added to the signing field. |
|
|
Content
|
Content | string |
Custom legal notice content. |
|
|
ThemeCode
|
ThemeCode | string |
Identifier of the theme for the package |
|
|
CallBackUrl
|
CallBackUrl | url |
URL for callback after actions are performed |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | url |
URL for callback when a signer requests a new signing URL |
|
|
DefaultRedirectUrl
|
DefaultRedirectUrl | url |
Redirect URL after action completion |
|
|
F2fRedirectUrl
|
F2fRedirectUrl | url |
Redirect URL after face-to-face signing |
|
|
IsUnsignedContentDownloadable
|
IsUnsignedContentDownloadable | boolean |
Whether unsigned content can be downloaded |
|
|
IsReassignEnabled
|
IsReassignEnabled | boolean |
Whether reassignment is enabled |
Returns
- Body
- Response.Package.Get
Delete a process step and all its actors
Deletes a process step and all its actors.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
The index of the process step
|
stepIndex | True | integer |
The index of the process step |
Delete Package by ID
Deletes a package by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
Delete stakeholder by ID
Deletes a stakeholder by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
Unique identifier of the stakeholder
|
stakeholderId | True | string |
Unique identifier of the stakeholder |
Download Document from Package
Download a signed document from a package. Each document will be downloaded as a PDF or XML file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
Unique identifier of the document contained in the package
|
documentId | True | string |
Unique identifier of the document contained in the package |
Returns
- response
- binary
Download Package
Used for downloading all documents in a certain package as a Zip file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
Returns
- response
- binary
Download the audit trail of the Package
Download a signed audit trail about the lifetime of a package.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
A language 2 letter ISO code (ISO 639-1)
|
culture | True | string |
A language 2 letter ISO code (ISO 639-1) |
Returns
- response
- binary
Get a package's expiry date
Retrieve the expiry date of a package
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
Returns
A date-time value in ISO 8601 format
- response
- Common.DateTime
Get all actions in the current process step
Gets the current set of actions that can be completed in parallel.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
Items | array of Response.Actor |
Get all actions of a process step
Gets a particular set of actions that can be completed in parallel from the process.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
The index of the process step
|
stepIndex | True | integer |
The index of the process step |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
Items | array of Response.Actor |
Get all packages
Gets all packages, these are sorted by creationDate
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The page number to retrieve
|
pageNumber | integer |
The page number to retrieve |
|
|
Number of items per page
|
pageSize | integer |
Number of items per page |
|
|
Return packages created before this date
|
createdBefore | date-time |
Return packages created before this date |
|
|
Return packages created after this date
|
createdAfter | date-time |
Return packages created after this date |
|
|
Status of the packages to filter
|
status | string |
Status of the packages to filter |
|
|
Document group code to filter packages
|
documentGroupCode | string |
Document group code to filter packages |
|
|
Email of the package initiator to filter
|
initiator |
Email of the package initiator to filter |
||
|
Name of the package to filter
|
packageName | string |
Name of the package to filter |
|
|
External reference to filter packages
|
externalReference | string |
External reference to filter packages |
|
|
Specify how the result is sorted, default is descending
|
sort | string |
Specify how the result is sorted, default is descending |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
PageNumber
|
PageNumber | integer |
Current page number |
|
PageSize
|
PageSize | integer |
Number of items per page |
|
TotalPages
|
TotalPages | integer |
Total number of pages |
|
TotalItems
|
TotalItems | integer |
Total number of items |
|
Items
|
Items | array of Response.Package.Get |
Get all process steps
Gets all actions that will have to be performed on the package.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of array | ||
|
items
|
array of Response.Actor |
A set of actors in a process step. |
Get all stakeholders of a package
Retrieves the stakeholders of the package
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier for the package
|
packageId | True | string |
Unique identifier for the package |
Returns
- response
- array of Response.Stakeholder
Get Package by ID
Retrieves a package by its ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
Returns
- Body
- Response.Package.Get
Get Package Status
Retrieves the current state of the package.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier for the package
|
packageId | True | string |
Unique identifier for the package |
Returns
Overwrite process steps of a package
Overwrites all actors in a package using a 2D array where each set of actors are actions that can be performed in parallel.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
Type
|
Type | True | string |
Type of action that will have to be performed on a package |
|
StakeholderId
|
StakeholderId | True | string |
Identifier of a stakeholder in the package |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Suppress notifications for the actor |
|
|
RedirectUrl
|
RedirectUrl | url |
Redirect URL after the actor's action is completed |
|
|
Id
|
Id | string |
Identifier of an existing element. If used, all other fields should be empty. |
|
|
Type
|
Type | string |
The type of element |
|
|
ExternalReference
|
ExternalReference | string |
External reference for the package |
|
|
Page
|
Page | integer |
Page number of the document |
|
|
Top
|
Top | number |
Top position in pixels |
|
|
Left
|
Left | number |
Left position in pixels |
|
|
Width
|
Width | number |
Width of the element |
|
|
Height
|
Height | number |
Height of the element |
|
|
DocumentId
|
DocumentId | string |
Identifier of the document in the package |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
Name
|
Name | string |
The name of the legal notice to be added to the signing field. |
|
|
Content
|
Content | string |
Custom legal notice content. |
|
|
Language
|
Language | string |
A country's 2-letter ISO code (ISO 639-1) |
Retrieve all document groups to which packages can be assigned
Retrieves all document groups to which packages can be assigned
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The document group name (or part) to search for
|
name | string |
The document group name (or part) to search for |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
DocumentGroups
|
DocumentGroups | array of object |
The list of document groups |
|
Code
|
DocumentGroups.Code | string |
The code of the document group |
|
Name
|
DocumentGroups.Name | string |
The name of the document group |
Retrieve all languages that are enabled in the application
Retrieves all languages that are enabled in the application
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
EnabledLanguages
|
EnabledLanguages | array of object |
The list of enabled languages |
|
DisplayName
|
EnabledLanguages.DisplayName | string |
The display name of the language |
|
NativeName
|
EnabledLanguages.NativeName | string |
The native name of the language |
|
IsoCultureCode
|
EnabledLanguages.IsoCultureCode | string |
The 2 letter ISO code (ISO 639-1) of the language |
Retrieve all themes that can be assigned to a package
Retrieves all themes that can be assigned to a package. Possible to page the result by providing a MaxQuantity and a continuationToken
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Token to get the next set of results
|
continuationToken | string |
Token to get the next set of results |
|
|
Maximum quantity of results to return
|
maxQuantity | integer |
Maximum quantity of results to return |
|
|
The order in which to sort the results
|
sortOrder | string |
The order in which to sort the results |
|
|
specify on which field to sort
|
sortField | string |
specify on which field to sort |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ContinuationToken
|
ContinuationToken | string |
Token for retrieving the next page of results |
|
Items
|
Items | array of object |
The list containing the Themes |
|
Code
|
Items.Code | string |
The code of the Theme |
|
Name
|
Items.Name | string |
The name of the Theme |
|
MaxQuantity
|
MaxQuantity | integer |
The maximum number of results that will be returned per request |
|
Total
|
Total | integer |
The total number of results. |
Return all signing methods that are currently configured
Returns all signing methods that are currently configured
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
only return active / inactive signing methods
|
isActive | boolean |
only return active / inactive signing methods |
Returns
- response
- array of ConfiguredSigningMethod
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 identifier of the package
|
packageId | True | string |
Unique identifier of the package |
Skip Signers
This call skips all signers that haven't finished yet and sets their status to 'Skipped', resulting in the complete package being marked as 'Finished'.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
Update a package's expiry date
Update the expiry date of a package
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier of the package
|
packageId | True | string |
Unique identifier of the package |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
A date-time value in ISO 8601 format |
Update Package Status
Updates the status of a package.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unique identifier for the package
|
packageId | True | string |
Unique identifier for the package |
|
body
|
body | True | string |
Definitions
ConfiguredSigningMethod
A configured signing method in eSignatures
| Name | Path | Type | Description |
|---|---|---|---|
|
IsActive
|
IsActive | boolean |
Whether the signingMethod can be used for creating new signing fields |
|
Name
|
Name | string |
The configured name of the signing method |
|
DisplayNames
|
DisplayNames | object |
The name per language that will be shown to a signer |
|
DisplayNamesInitiator
|
DisplayNamesInitiator | object |
The name per language that should be shown to the initiator when creating the package. |
|
Descriptions
|
Descriptions | object |
Description of the signing method per language to provide more information about the signing method during package creation. |
|
RequiredProperties
|
RequiredProperties | array of string |
The required properties for mandated signing |
|
KeyPairs
|
KeyPairs | array of KeyPair |
available KeyPairs that can be used to sign with this method |
KeyPair
representation of a signing key pair
| Name | Path | Type | Description |
|---|---|---|---|
|
Name
|
Name | string |
Name of the key pair |
|
DisplayNames
|
DisplayNames | object |
The name per language that will be shown to an initiator |
Common.Guid
Common.EmailAddress
Common.Language
Common.PhoneNumber
Common.ExternalReference
Common.AdditionalProperties
The configurable additional properties of the stakeholder
| Name | Path | Type | Description |
|---|---|---|---|
|
|
object |
The configurable additional properties of the stakeholder |
Common.DateTime
Package.Status
Package.Name
Document.Name
Document.Status
Document.DocumentOptions
Defines optional document parameters
| Name | Path | Type | Description |
|---|---|---|---|
|
TargetType
|
TargetType | string |
Will only work when the server is configured for document conversions. |
|
TargetFormat
|
PdfOptions.TargetFormat | string |
The target format defines if an extra conversion needs to be done. |
|
PdfErrorHandling
|
PdfOptions.PdfErrorHandling | string |
How to deal with PDFs containing minor flaws |
Stakeholder.FirstName
Stakeholder.LastName
Actor.Type
Type of action that will have to be performed on a package
Type of action that will have to be performed on a package
Actor.Status
Element.Type
Element.Status
Element.Location
| Name | Path | Type | Description |
|---|---|---|---|
|
Page
|
Page | integer |
Page number of the document |
|
Top
|
Top | number |
Top position in pixels |
|
Left
|
Left | number |
Left position in pixels |
Element.Dimensions
| Name | Path | Type | Description |
|---|---|---|---|
|
Width
|
Width | number |
Width of the element |
|
Height
|
Height | number |
Height of the element |
Response.Package.Get
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
Id | Common.Guid |
A globally unique identifier |
|
Name
|
Name | Package.Name |
Name of the package |
|
Initiator
|
Initiator | Common.EmailAddress |
An email address |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
External reference for the package |
|
CreationDate
|
CreationDate | Common.DateTime |
A date-time value in ISO 8601 format |
|
Status
|
Status | Package.Status |
The status of the package |
|
ExpiryDate
|
ExpiryDate | Common.DateTime |
A date-time value in ISO 8601 format |
|
Documents
|
Documents | array of Response.Document | |
|
Stakeholders
|
Stakeholders | array of Response.Stakeholder |
Response.Document
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
Id | Common.Guid |
A globally unique identifier |
|
Status
|
Status | Document.Status |
The status of a document |
|
DocumentOptions
|
DocumentOptions | Document.DocumentOptions |
Defines optional document parameters |
|
Name
|
Name | Document.Name |
Name of the document |
|
Language
|
Language | Common.Language |
A country's 2-letter ISO code (ISO 639-1) |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
External reference for the package |
|
ProofCorrelationId
|
ProofCorrelationId | Common.Guid |
A globally unique identifier |
Response.Stakeholder
| Name | Path | Type | Description |
|---|---|---|---|
|
Type
|
Type | string |
The type of stakeholder |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
External reference for the package |
|
Id
|
Id | Common.Guid |
A globally unique identifier |
|
Language
|
Language | Common.Language |
A country's 2-letter ISO code (ISO 639-1) |
|
FirstName
|
FirstName | Stakeholder.FirstName |
First name of the stakeholder |
|
LastName
|
LastName | Stakeholder.LastName |
Last name of the stakeholder |
|
EmailAddress
|
EmailAddress | Common.EmailAddress |
An email address |
|
BirthDate
|
BirthDate | date | |
|
PhoneNumber
|
PhoneNumber | Common.PhoneNumber |
A phone number |
|
AdditionalProperties
|
AdditionalProperties | Common.AdditionalProperties |
The configurable additional properties of the stakeholder |
|
Actors
|
Actors | array of Response.Actor |
Response.Actor
| Name | Path | Type | Description |
|---|---|---|---|
|
Type
|
Type | Actor.Type |
Type of action that will have to be performed on a package |
|
Id
|
Id | Common.Guid |
A globally unique identifier |
|
StakeholderId
|
StakeholderId | Common.Guid |
A globally unique identifier |
|
Status
|
Status | Actor.Status |
The status of an actor |
|
SuppressNotifications
|
SuppressNotifications | boolean |
Suppress notifications for the actor |
|
RedirectUrl
|
RedirectUrl | url |
Redirect URL after the actor's action is completed |
|
Elements
|
Elements | array of Response.Element |
Response.Element
| Name | Path | Type | Description |
|---|---|---|---|
|
Type
|
Type | Element.Type |
The type of element |
|
Id
|
Id | Common.Guid |
A globally unique identifier |
|
ActorId
|
ActorId | Common.Guid |
A globally unique identifier |
|
DocumentId
|
DocumentId | integer |
Identifier of the document in the package |
|
Status
|
Status | Element.Status |
The status of an element |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
External reference for the package |
|
Location
|
Location | Element.Location | |
|
Dimensions
|
Dimensions | Element.Dimensions | |
|
SigningMethods
|
SigningMethods | array of string | |
|
UsedSigningMethod
|
UsedSigningMethod | string |
The used signing method |
Response.Package.Status
| Name | Path | Type | Description |
|---|---|---|---|
|
Status
|
Status | Package.Status |
The status of the package |
binary
This is the basic data type 'binary'.