Condividi tramite

Lex Power Sign (Preview)

  • Reference

Lex Persona is a European qualified trust services provider offering a range of electronic signature solutions. With Lex Enterprise, you have access to all the eIDAS signature levels, along with a large number of signer authentication methods. Your signature books are embedded in digital workflows. Automate connections between Lex Enterprise and all your tools to eliminate repetitive tasks, gain efficiency, and accelerate your business.

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 Lex Persona support
URL https://support.lex-persona.com
Email support@lex-persona.com
Connector Metadata
Publisher Lex Persona
Website https://www.lex-persona.com
Privacy policy https://www.lex-persona.com/politique-de-confidentialite/
Categories AI;Website

Lex Persona is an European qualified trust services provider offering a range of electronic signature solutions. With this connector, you can easily add the electronic signature capability to your Microsoft based application (PowerApp, .NET based web app, Dynamics...) and environment (Outlook, Sharepoint, Teams...). The connector is backed by our Lex Enterprise Workflow manager. You can create electronc signature workflows composed of different types of steps that can execute in sequence and/or in parallel. The connector supports all the eIDAS signature levels and offers a wide range of signer authentication methods (OTP, SSO, France Connect, Identité Numérique La Poste, hardware tokens...)

Prerequisites

You will need to have the following in order to proceed:

  • Lex Enterprise subscription. Use the trial plan to test

The environment requirements are:

  • A Microsoft Power Apps or Power Automate plan with custom connector feature
  • The Power platform CLI tools

How to get credentials

Please contact our sales representatives at commercial@lex-persona.com to get a Lex Enteprise subscription or an account on our trial systems.

Connect to the Lex Enterprise portal with your account, and generate an API Key.

Get started with your connector

First, create a connection for the connector. Set the authentication method to API key, provide your API key ("Bearer act_XXXXXXX") and specify that the API key must be placed in the Autrorization header of the API calls.

The steps to create a simple signature workflow are the following :

  • right after your tigger, retrieve the connected Lex Enterprise user Id (this Id is needed to create a workflow) with the Retrieve Me action
  • search consent pages with the Search consent pages action_. You can use the text parameter to search consent pages by name (consent pages define the signature level and are preconfigured in your Lex Enterprise environment)
  • create a signature workflow with the Create workflow action. In this step, you must provide signers' information.
  • search signature profiles with the Search signature profiles action. You can use the text parameter to search signature profiles by name (signature profiles control somes aspects of the consent pages behavior. Force the signer to scroll to the bottom of the document before signing for example)
  • Retrieve a document from your environment (Sharepoint, Outlook, OneDrive...)
  • add the document to the workflow with the Create part action, setting the createDocument parameter to true
  • start the workflow with the Update workflow action, setting the Workflow Status to started

Please note: The connector is paired with our trial server by default. If you want to pair the connector with your own tenant, you must change the host url in the security definition of the connector or in the apiDefinitions.json file:

-   "host": "yourtenant.lexpersona.com",

Know issues and limitations

The Create document action accepts a list of document parts int its payload. However, if you provide multiple parts, only the first one will be taken into account (this is due to a bug in our API. It will be fixed in the connector next release).

Consequently, if you want to add multiple documents to a workflow, it is necessary to perform a call to Create part with the createDocument parameter set to true for each document.

Common errors and remedies

In case of an API call failure, the API call response contains a comprehensive error message that is displayed in the run history of the connector. The message contains also a log ID, so that if you need more information on the error, you can connect to the Lex Enteprise portal and consult the server log file. Alternativley, you can set up a Postman request to search our servers logs (plase consult the documentation: https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html#search-logs).

The more common HTTP error codes returned by our API are the following:

  • Error 400 - Bad request. There is something wrong in your request paylod. Consult the log to find information about the cause of the error
  • Error 401 - Unauthorized. Yo do not have the access rights to perform this operation. Check your Lex Persona user access rights
  • Error 403 - Forbidden. Your API key is invlaid or disabled
  • Error 404 - Not found. There is an error in your request Url

You can also check our documentation for more details on each API call possible error codes (https://sgs-demo-test01.sunnystamp.com/wm-docs/api.html)

FAQ

What are the documents formats supported by the connector

The documents that you can send for signature can have the pdf, docx, pptx, and xlsx formats. The connector will convert the documents to pdf if needed and the signatures will have the PAdES format.

It is also possible to sign XML documents. In this case, no conversion will be applied and the signatures will have the XAdES format.

It is also possible to upload zip files. The connector will unzip the archive and add each document to the workflow.

You can also add attachments to signatures workflows. The attachment are not signed and can have any format.

Can a document have multiple signers

Yes. The number of signers of a document is unlimited.

Is it possible to sign multiple documents at once

Yes. You can add multiple documents to a workflow, and all the documents will be signed simultaneously. Note however that in this case, the set of documents will be juridically linked and that the system will produce a unique evidences file.

You can also create mutlpiple workglows coantaining the same signer. At signature time, the list of documents will be presented to the signer, and the signer will have the opportunity to select the documents she whishes to sign. In this case, the documents will be juridically independent, ans an evidences file will be produced for each document.

Is it possible to sign a document offline

No. An intenet connection is needed to access the consent pages.

Is it possible to send automatic signature remiders to signers

Yes. You can configure the reminder period and the maximum number of reminders to send.

Is it possible to modify an already started signature workflow

Yes. Before any signature, you can modify anything in the workflow. After the first signature, it is impossible to modifiy the documents but you can still modifiy the workflow steps.

What is the validity duration of the One Time Passwords

The One Time Passwords validity duration is two minutes (a countdow is displayed ont the consent pages).

Is it possible to verify an electronic signature validity

You can use the Signatures pane of Adobe Acrobat to check the validity of the signatures contained in a pdf document. Alternatively, you can use a trusted signature validation web service (https://ec.europa.eu/digital-building-blocks/DSS/webapp-demo/validation for example)

What are the Lex Persona document storage conditions

By default, we keep the documents ans evidences files in our servers. Tou can search and download documents at any time. If requested, we can however priodically delete your documents from our servers.

Does Lex Persona keep the timestamps tokens

No. We do not keep the timestamps tokens. If needed, you can extracxt these tokens from the signed documents.

Is there a withdrawal period for a signed document

Yes. The withdrawal periond depends on the legal conditions that apply to the document.

Is it possible to cancel a signature workflow

Yes. An authoriezd user can cancel a started signature workflow at any time. No evicences file will be produced and if the document was already signed by one or many signers, the sgnatures will be voided.

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
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create contact

Add a contact to the current user's contacts list
Create document

Create a document from previouly created parts
Create metadata layout

Create a metadata layout
Create part

Create a document part
Create signature profile

Create a signature profile
Create workflow

Create a workflow
Delete contact

Remove contact from the current user's contects list
Delete document

Delete a document
Delete workflow

Delete a workflow
Download a workflow documents

Download the workflow documents
Download evidences file

Download the workflow evidences file
Retrieve consent page

Retrieve consent page information from consent page id
Retrieve constent page url

Create and retrieve the consent page url for a recipient
Retrieve contact

Retrieve contact information from contact id
Retrieve document

Retrieve a document
Retrieve me

Retrieve the connected user Id
Retrieve metadata layout

Retrieve a workflow layout
Retrieve metadata mapping

Retrieve the metadata mapping of the specified tenant
Retrieve signature profile

Retrieve a signature profile
Retrieve workflow

Retrieve workflow from workflow id
Search consent pages

Search consent pages
Search contacts

Search contacts
Search documents

Search documents
Search metadata layouts

Search workflow layouts
Search signature profiles

Search signature profiles
Search workflows

Search workflows
Update contact

Modify an existing contact information
Update document

Update a document
Update metadata layout

Update a metadata layout
Update signature profile

Update a signature profile
Update workflow

Update a workflow

Create contact

Operation ID:
CreateContact

Add a contact to the current user's contacts list

Parameters

Name Key Required Type Description
User Id
 userId True string

User to whom the contact belongs
Content type
 Content-Type True string

Content-Type
Contact email
 email True string

Contact email
Contatct phone Number
 phoneNumber string

phoneNumber
Contact first Name
 firstName True string

firstName
Contact last Name
 lastName True string

lastName
Contact country
 country string

country

Returns

Body
contact

Create document

Operation ID:
CreateDocument

Create a document from previouly created parts

Parameters

Name Key Required Type Description
Workflow Id
 workflowId True string

Id of the concerned workflow
Content type
 Content-Type True string

Content-Type
contentType
 contentType string

contentType
filename
 filename string

filename
hash
 hash string

hash
size
 size integer

size
signatureProfileId
 signatureProfileId string

The signature profile for this document

Returns

Body
document

Create metadata layout

Operation ID:
CreateLayout

Create a metadata layout

Parameters

Name Key Required Type Description
Tenant Id
 tenantId True string

Id of the layout
Content type
 Content-Type True string

Content-Type
Name
 name True string

The layout name
Is disabled
 isDisabled boolean

If set to true the layout will be disabled
slot
 slot string

Metadata item (data1 to data8)
default
 default string

Metadata default value in this layout
optional
 optional boolean

If true, providing a value is not mandatory
readonly
 readonly boolean

Wether the value can be overriden
rememberLastValue
 rememberLastValue boolean

If set to true, the value persists accross workflows

Returns

Metadata layout

Body
layout

Create part

Operation ID:
CreatePart

Create a document part

Parameters

Name Key Required Type Description
Workflow Id
 workflowId True string

Id of the concerned workflow
Content type
 Content-Type True string

Content-Type
Cotent Disposition
 Content-Disposition True string

Content-Dispotion
Create Document
 createDocuments string

Create a document from this part
Ignore attachments
 ignoreAttachments string

Attachments will be ignored
Signature profile Id
 signatureProfileId string

Part considered as an attachment if omitted
Unzip
 unzip string

Unzip files
Pdf to PdfA
 pdf2pdfa string

Convert pdf to pdf/A
Document
 document True binary

The uploaded file data

Returns

Name Path Type Description
documents
 documents array of document

Created documents
ignoredAttachments
 ignoredAttachments integer

ignoredAttachments
parts
 parts array of part

parts

Create signature profile

Operation ID:
CreateSignatureProfile

Create a signature profile

Parameters

Name Key Required Type Description
Tenant Id
 tenantId True string

Id of the tenant
Content type
 Content-Type True string

Content-Type
Is Default
 isDefault True string

Makes this signature profile the default one
Is Disabled
 isDisabled string

Disable this signature profile
Name
 name True string

The signature profile name
Document Type
 documentType True string

pdf, xml, word, excel, powerpoint, other
Signature type
 signatureType True string

pades,xades,xadesDetached,xadesDetachedManifest,cades,helios
Force to scroll to the bottom of the document
 forceScrollDocument True boolean

Force the signer to scroll to the bottom of the document
Visible signature mode
 pdfVisibleSignatureMode string

Visible signature mode (allowed, disabled, noImage)
Signature text
 pdfSignatureImageText string

Text displayed in signatures pads
Signature text color
 pdfSignatureImageTextColor string

Color of the text displayed in the singatures pads
Signature text size
 pdfSignatureImageTextSize number

Size of the text displayed in the singatures pads

Returns

Body
signatureProfile

Create workflow

Operation ID:
CreateWorkflow

Create a workflow

Parameters

Name Key Required Type Description
User Id
 userId True string

User id of the workflow ownner
Content type
 Content-Type string

Content type
Name
 name True string

Name of the workflow
Description
 description string

Description of the workflow
id
 id string

step Id
stepType
 stepType string

signature or approval
consentPageId
 consentPageId True string

Id of the consent page (signature level) associated to this recipient
email
 email True string

recipient's email
userId
 userId string

reference a LE user instead of creating a recipient on the fly
phoneNumber
 phoneNumber string

reicpient's cell phone number
firstName
 firstName string

recipient's first name
lastName
 lastName string

recipient's last name
country
 country string

recipient's country code
preferredLocale
 preferredLocale string

recipient's locale code
organizationId
 organizationId string

Id of the LE organization of the recipient
requiredRecipients
 requiredRecipients number

minimum number of signers who must sign to take the next step
validityPeriod
 validityPeriod number

step validity duration
inviteperiod
 inviteperiod number

signature reminders frequency
maxInvites
 maxInvites number

maximum number of signature reminders
sendDownloadLink
 sendDownloadLink boolean

controls the delivery of the signed document to signers
allowComments
 allowComments boolean

allows/forbids comments on this step
hideAttachments
 hideAttachments boolean

controls the display of attachments to signers
hideWorkflowRecipients
 hideWorkflowRecipients boolean

controls the display of other signers to the signer
Notified Events
 notifiedEvents array of string

Notified workflow events
userId
 userId string

User id of the watcher
notifiedEvents
 notifiedEvents array of string

Workflow events that will be notified to this watcher
email
 email string

Email of the watcher
Template Id
 templateId string

Id of the template from which the workflow derives
Layout Id
 layoutId string

Metadata layout used by the worklow
data1
 data1 string

First metadata
data2
 data2 string

Second metadata
data3
 data3 string

Third metadata
data4
 data4 string

Fourth metadata
data5
 data5 string

Fifth metadata
data6
 data6 string

Sixth metadata
data7
 data7 string

Seventh metadata
data8
 data8 string

Heighth metadata

Returns

Body
workflow

Delete contact

Operation ID:
DeleteContact

Remove contact from the current user's contects list

Parameters

Name Key Required Type Description
Contact Id
 contactId True string

Id of the contact
Content type
 Content-Type True string

Content-Type

Returns

Body
contact

Delete document

Operation ID:
DeleteDocument

Delete a document

Parameters

Name Key Required Type Description
Document Id
 documentId True string

Id of the document

Returns

Body
document

Delete workflow

Operation ID:
DeleteWorkflow

Delete a workflow

Parameters

Name Key Required Type Description
Workflow Id
 workflowId True string

Id of the workflow to delete

Returns

Body
workflow

Download a workflow documents

Operation ID:
DownloadDocuments

Download the workflow documents

Parameters

Name Key Required Type Description
Workflow Id
 workflowId True string

Id of the workflow

Returns

response
binary

Download evidences file

Operation ID:
WorkflowEvidences

Download the workflow evidences file

Parameters

Name Key Required Type Description
Workflow Id
 workflowId True string

Id of the workflow
Accept
 Accept True string

Accept

Returns

response
binary

Retrieve consent page

Operation ID:
RetrieveConsentPage

Retrieve consent page information from consent page id

Parameters

Name Key Required Type Description
Consent page Id
 cpId True string

Id of the consent page
Content type
 Content-Type True string

Content-Type

Returns

Body
consentPage

Retrieve constent page url

Operation ID:
WorkflowInvite

Create and retrieve the consent page url for a recipient

Parameters

Name Key Required Type Description
Workflow Id
 workflowId True string

Id of the workflow
Recipient Email
 recipientEmail string

Email of the concerned recipient

Returns

Name Path Type Description
The consent page url for the concerned recipient
 inviteUrl string

The consent page url for the concerned recipient

Retrieve contact

Operation ID:
RetrieveContact

Retrieve contact information from contact id

Parameters

Name Key Required Type Description
Contact Id
 contactId True string

Id of the contact
Content type
 Content-Type True string

Content-Type

Returns

Body
contact

Retrieve document

Operation ID:
RetrieveDocument

Retrieve a document

Parameters

Name Key Required Type Description
Document Id
 documentId True string

Id of the document

Returns

Body
document

Retrieve me

Operation ID:
RetrieveMe

Retrieve the connected user Id

Returns

Body
user

Retrieve metadata layout

Operation ID:
RetrieveLayout

Retrieve a workflow layout

Parameters

Name Key Required Type Description
Layout Id
 layoutId True string

Id of the layout

Returns

Metadata layout

Body
layout

Retrieve metadata mapping

Operation ID:
getDataMapping

Retrieve the metadata mapping of the specified tenant

Parameters

Name Key Required Type Description
Tenant Id
 tenantId True string

Id of the tenant

Returns

Body
dataMapping

Retrieve signature profile

Operation ID:
RetrieveSignatureProfile

Retrieve a signature profile

Parameters

Name Key Required Type Description
Signature profile Id
 spId True string

Id of the signature profile

Returns

Body
signatureProfile

Retrieve workflow

Operation ID:
RetrieveWorkflow

Retrieve workflow from workflow id

Parameters

Name Key Required Type Description
Workflow Id
 workflowId True string

Id of the workflow

Returns

Body
workflow
Operation ID:
SearchConsentPages

Search consent pages

Parameters

Name Key Required Type Description
Search text
 text string

Search text
Search default
 items.isDefault string

Search for default consent page
Search disabled
 items.isDisabled string

Search for disabled consent pages
Search name
 items.name string

Search by consent page name
Search step type
 items.stepType string

Search by step type
Search client id
 items.clientId string

Search by client Id
Search creation date
 items.created string

Search by creation date
Search update date
 items.updated string

Search by last update date
Sort by
 sortBy string

The field on which to sort the search result
Sort order
 sortOrder string

The direction of the sorting
Items per page
 itemsPerPage string

Number of items per page in the response
Page index
 pageIndex string

Index of the returned page

Returns

Body
consentPages

Search contacts

Operation ID:
SearchContacts

Search contacts

Parameters

Name Key Required Type Description
Search text
 text string

Search by text
Search email
 items.email string

Search by email
Search phone number
 items.phoneNumber string

Search by phone number
Search first name
 items.fisrtName string

Search by first name
Search last name
 items.lastName string

Search by last name
Search country
 items.country string

Search by country
Items per page
 itemsPerPage number

Number of items per page in the response
Page index
 pageIndex number

Index of the returned page

Returns

Body
contacts

Search documents

Operation ID:
SearchDocuments

Search documents

Parameters

Name Key Required Type Description
Search text
 text string

Search text
Search metadata layout
 items.layoutId string

Search by metadata layout
Search group
 items.groupId string

Search by users group
Search user
 items.userId string

Search by owner
Search workflow id
 items.workflowId string

Search by workflow Id
Search workflow name
 items.workflowName string

Search by workflow name
Search metadata 1
 items.data1 string

Search by value of metadata 1
Search metadata 2
 items.data2 string

Search by value of metadata 2
Search metadata 3
 items.data3 string

Search by value of metadata 3
Search metadata 4
 items.data4 string

Search by value of metadata 4
Search metadata 5
 items.data5 string

Search by value of metadata 5
Search metadata 6
 items.data6 string

Search by value of metadata 6
Search metadata 7
 items.data7 string

Search by value of metadata 7
Search metadata 8
 items.data8 string

Search by value of metadata 8
Search signature profile
 items.signatureProfileId string

Search by signature profile
Search creation date
 items.created string

Search by creation date
Search update date
 items.updated string

Search by last update date
Sort by
 sortBy string

The field used to sort the search result
Sort order
 sortOrder string

The direction of the sorting
Items per page
 itemsPerPage string

Number of items per page in the response
Page index
 pageIndex string

Index of the returned page

Returns

Name Path Type Description
items
 items documents

Search metadata layouts

Operation ID:
SearchLayouts

Search workflow layouts

Parameters

Name Key Required Type Description
Search text
 text string

Search text
Search disabled
 items.isDisabled string

Search for disabled layouts
Search name
 items.name string

Search by layout name
Search metadata
 items.dataConfigurations.slot string

Search by presence of metadata
Search creation date
 items.created string

Search by creation date
Search update date
 items.updated string

Search by last update date
Sort by
 sortBy string

The field used to sort the search result
Sort order
 sortOrder string

The direction of the sorting
Items per page
 itemsPerPage string

Number of items per page in the response
Page index
 pageIndex string

Index of the returned page

Returns

Name Path Type Description
items
 items layouts

Search signature profiles

Operation ID:
SearchSignatureProfiles

Search signature profiles

Parameters

Name Key Required Type Description
Search text
 text string

Search text
Search default
 items.isDefault string

Search for default signature profiles
Search disabled
 items.isDisabled string

Search for disabled signature profiles
Search name
 items.name string

Search by signature profile name
Search doc. type
 items.documentType string

Search by document type
Search signature type
 items.signatureType string

Search by signature type
Search creation date
 items.created string

Search by creation date
Search update date
 items.updated string

Search by last update date
Sort by
 sortBy string

The field used to sort the search result
Sort order
 sortOrder string

The direction of the sorting
Items per page
 itemsPerPage string

Number of items per page in the response
Page index
 pageIndex string

Index of the returned page

Returns

Body
signatureProfiles

Search workflows

Operation ID:
SearchWorkflows

Search workflows

Parameters

Name Key Required Type Description
Accept
 Accept string

Accept
Search text
 text string

Search text
Search metadata layout
 items.layoutId string

Search by metadata layout
Search template
 items.templateId string

Search by workflow template
Search group
 items.groupId string

Search by users group
Search user
 items.userId string

Search by owner
Search email
 items.email string

Search by owner's email
Search first name
 items.firstname string

Search by owner's first name
Search last name
 items.lastname string

Search by owner's last name
Search status
 items.workflowStatus string

Search by workflow status
Search metadata 1
 items.data1 string

Search by value of metadata 1
Search metadata 2
 items.data2 string

Search by value of metadata 2
Search metadata 3
 items.data3 string

Search by value of metadata 3
Search metadata 4
 items.data4 string

Search by value of metadata 4
Search metadata 5
 items.data5 string

Search by value of metadata 5
Search metadata 6
 items.data6 string

Search by value of metadata 6
Search metadata 7
 items.data7 string

Search by value of metadata 7
Search metadata 8
 items.data8 string

Search by value of metadata 8
Search creation date
 items.created string

Search by creation date
Search update date
 items.updated string

Search by last update date
Search start date
 items.started string

Search by start date
Sort by
 sortBy string

The field used to sort the search result
Sort order
 sortOrder string

The direction of the sorting
Items per page
 itemsPerPage string

Number of items per page in the response
Page index
 pageIndex string

Index of the returned page

Returns

Body
workflows

Update contact

Operation ID:
UpdateContact

Modify an existing contact information

Parameters

Name Key Required Type Description
Contact Id
 contactId True string

Id of the contact
Content type
 Content-Type True string

Content-Type
Email of the contact
 email string

Email of the contact
Phone Number of the contact
 phoneNumber string

Phone Number of the contact
First Name of the contact
 firstName string

First Name of the contact
Last Name of the contact
 lastName string

Last Name of the contact
Country of the contact
 country string

Country of the contact

Returns

Body
contact

Update document

Operation ID:
UpdateDocument

Update a document

Parameters

Name Key Required Type Description
Document Id
 documentId True string

Id of the document
Content type
 Content-Type True string

Content-Type
signatureProfileId
 signatureProfileId string

The signature profile to aply to this document
imageHeight
 imageHeight float

imageHeight
imagePage
 imagePage float

imagePage
imageWidth
 imageWidth float

imageWidth
imageX
 imageX float

imageX
imageY
 imageY float

imageY

Returns

Body
document

Update metadata layout

Operation ID:
UpdateLayout

Update a metadata layout

Parameters

Name Key Required Type Description
Tenant Id
 layoutId True string

Id of the layout
Content type
 Content-Type True string

Content-Type
Name
 name True string

The layout name
Is disabled
 isDisabled boolean

If set to true the layout will be disabled
slot
 slot string

Metadata item (data1 to data8)
default
 default string

Metadata default value in this layout
optional
 optional boolean

If true, providing a value is not mandatory
readonly
 readonly boolean

Wether the value can be overriden
rememberLastValue
 rememberLastValue boolean

If set to true, the value persists accross workflows

Returns

Metadata layout

Body
layout

Update signature profile

Operation ID:
UpdateSignatureProfile

Update a signature profile

Parameters

Name Key Required Type Description
Signature profile Id
 spId True string

Id of the signature profile
Content type
 Content-Type True string

Content-Type
Is Default
 isDefault string

Makes this signature profile the default one
Is Disabled
 isDisabled string

Disable this signature profile
Name
 name string

The signature profile name
Signature type
 signatureType string

pades,xades,xadesDetached,xadesDetachedManifest,cades,helios
Force to scroll to the bottom of the document
 forceScrollDocument boolean

Force the signer to scroll to the bottom of the document
Visible signature mode
 pdfVisibleSignatureMode string

Visible signature mode (allowed, disabled, noImage)
Signature text
 pdfSignatureImageText string

Text displayed in signatures pads
Signature text color
 pdfSignatureImageTextColor string

Color of the text displayed in the singatures pads
Signature text size
 pdfSignatureImageTextSize number

Size of the text displayed in the singatures pads

Returns

Body
signatureProfile

Update workflow

Operation ID:
UpdateWorkflow

Update a workflow

Parameters

Name Key Required Type Description
Workflow Id
 workflowId True string

Id of the workflow to update
Content type
 Content-Type string

Content type
User Id
 userId string

Id of the workflow owner
Name
 name string

Name of the workflow
Description
 description string

Description of the workflow
id
 id string

step Id
stepType
 stepType string

signature or approval
consentPageId
 consentPageId True string

Id of the consent page (signature level) associated to this recipient
email
 email True string

recipient's email
userId
 userId string

reference a LE user instead of creating a recipient on the fly
phoneNumber
 phoneNumber string

reicpient's cell phone number
firstName
 firstName string

recipient's first name
lastName
 lastName string

recipient's last name
country
 country string

recipient's country code
preferredLocale
 preferredLocale string

recipient's locale code
organizationId
 organizationId string

Id of the LE organization of the recipient
requiredRecipients
 requiredRecipients number

minimum number of signers who must sign to take the next step
validityPeriod
 validityPeriod number

step validity duration
inviteperiod
 inviteperiod number

signature reminders frequency
maxInvites
 maxInvites number

maximum number of signature reminders
sendDownloadLink
 sendDownloadLink boolean

controls the delivery of the signed document to signers
allowComments
 allowComments boolean

allows/forbids comments on this step
hideAttachments
 hideAttachments boolean

controls the display of attachments to signers
hideWorkflowRecipients
 hideWorkflowRecipients boolean

controls the display of other signers to the signer
Notified Events
 notifiedEvents array of string

Notified workflow events
userId
 userId string

Watcher user Id
notifiedEvents
 notifiedEvents array of string

Workflow events that will be notified to this watcher
email
 email string

email
Workflow Status
 workflowStatus string

Current status of the workflow
data1
 data1 string

first metadata
data2
 data2 string

second metadata
data3
 data3 string

third metadata
data4
 data4 string

fourth metadata
data5
 data5 string

fifth metadata
data6
 data6 string

sixth metadata
data7
 data7 string

seventh metadata
data8
 data8 string

heighth metadata

Returns

Body
workflow

Definitions

consentPage

Name Path Type Description
allowOrganization
 allowOrganization boolean

Allows the use of organizations
authenticateUser
 authenticateUser boolean

Imposes signer authentication
clientId
 clientId string

Client Id
created
 created number

Creation date
emUrl
 emUrl string

Evidences manager Url
hideDownloads
 hideDownloads boolean

Documents download links are not diplayed on consent pages
hideMobileQrCode
 hideMobileQrCode boolean

Hides the QR codes on constent pages
id
 id string

The consent page Id
isCountryRequired
 isCountryRequired boolean

Makes country mandatory in signers information
isDisabled
 isDisabled boolean

Consent page is disabled
logoResourceId
 logoResourceId string

Id of the consent page logo resource
name
 name string

The consent page name
primaryColor
 primaryColor string

Consent page primary color
secondaryColor
 secondaryColor string

Consent page secondary color
sharedPassphrase
 sharedPassphrase string

Shared passphrase
signing mode
 signing mode string

Signing mode (local or server)
stepType
 stepType string

step type (signature or approval)
tenantId
 tenantId string

Tenant Id
tsaUrl
 tsaUrl string

Timestamp authority Url
updated
 updated number

Last modification date
verifyEmail
 verifyEmail boolean

If set to tue, signers will receive OTPs by emails
verifyPhoneNumber
 verifyPhoneNumber boolean

If set to true, signers will receive OTPs by text messages

consentPages

Name Path Type Description
items
 items array of consentPage

items
itemsPerPage
 itemsPerPage integer

itemsPerPage
pageIndex
 pageIndex integer

pageIndex
totalItems
 totalItems integer

totalItems

contact

Name Path Type Description
country
 country string

Contact country
created
 created integer

Contact creation date
email
 email string

Contact email
firstName
 firstName string

Contact firstName
id
 id string

Contact id
lastName
 lastName string

Contact lastName
name
 name string

Contact name (firts name + last name))
phoneNumber
 phoneNumber string

Contact phone number
tenantId
 tenantId string

Tenant Id
updated
 updated integer

Contact last modification date
userId
 userId string

Id of the contact owner

contacts

Name Path Type Description
items
 items array of contact

items
itemsPerPage
 itemsPerPage integer

itemsPerPage
pageIndex
 pageIndex integer

pageIndex
totalItems
 totalItems integer

totalItems

dataMapping

Name Path Type Description
description
 data1.description string

Metadata description
name
 data1.name string

Metadata name
pattern
 data1.pattern string

Metadata pattern
options
 data1.options array of object

options
value
 data1.options.value string

Metadata value
type
 data1.type string

type
description
 data2.description string

Metadata description
name
 data2.name string

Metadata name
pattern
 data2.pattern string

Metadata pattern
options
 data2.options array of object

options
value
 data2.options.value string

Metadata value
type
 data2.type string

type
description
 data3.description string

Metadata description
name
 data3.name string

Metadata name
pattern
 data3.pattern string

Metadata pattern
options
 data3.options array of object

options
value
 data3.options.value string

Metadata value
type
 data3.type string

type
description
 data4.description string

Metadata description
name
 data4.name string

Metadata name
pattern
 data4.pattern string

Metadata pattern
options
 data4.options array of object

options
value
 data4.options.value string

Metadata value
type
 data4.type string

type
description
 data5.description string

Metadata description
name
 data5.name string

Metadata name
pattern
 data5.pattern string

Metadata pattern
options
 data5.options array of object

options
value
 data5.options.value string

Metadata value
type
 data5.type string

type
description
 data6.description string

Metadata description
name
 data6.name string

Metadata name
pattern
 data6.pattern string

Metadata pattern
options
 data6.options array of object

options
value
 data6.options.value string

Metadata value
type
 data6.type string

type
description
 data7.description string

Metadata description
name
 data7.name string

Metadataname
pattern
 data7.pattern string

Metadata pattern
options
 data7.options array of object

options
value
 data7.options.value string

Metadatavalue
type
 data7.type string

type
description
 data8.description string

Metadata description
name
 data8.name string

Metadata name
pattern
 data8.pattern string

Metadata pattern
options
 data8.options array of object

options
value
 data8.options.value string

Metadata value
type
 data8.type string

type

document

Name Path Type Description
created
 created integer

Creation date
groupId
 groupId string

Id fo the document owner's group
id
 id string

Id of the document
parts
 parts array of part

parts
pdfSignatureFields
 pdfSignatureFields array of pdfSigField

pdfSignatureFields
signatureProfileId
 signatureProfileId string

Id of the signature profile of the document
tenantId
 tenantId string

Tenant id
updated
 updated integer

Last modification date
userId
 userId string

Document owner user Id
viewAuthorizedGroups
 viewAuthorizedGroups array of string

List of groups allowed to view the document
viewAuthorizedUsers
 viewAuthorizedUsers array of string

List of users allowzd to view the document
workflowId
 workflowId string

Id of the workflow to which the document belongs
workflowName
 workflowName string

Name of the workflow to which the document belongs

documents

Name Path Type Description
items
 items array of document

items
itemsPerPage
 itemsPerPage integer

itemsPerPage
pageIndex
 pageIndex integer

pageIndex
totalItems
 totalItems integer

totalItems

layout

Metadata layout

Name Path Type Description
created
 created number

Creation date
id
 id string

Layout Id
isDisabled
 isDisabled boolean

If set to true the layout has been disbled
name
 name string

The name of the Layout
tenantId
 tenantId string

Id of the tenant
updated
 updated number

Last modification date
dataConfigurations
 dataConfigurations array of object
slot
 dataConfigurations.slot string

Metadata item (data1 to data8)
default
 dataConfigurations.default string

Metadata default value in this layout
optional
 dataConfigurations.optional boolean

If true, providing a value for this metadata is not mandatory
readonly
 dataConfigurations.readonly boolean

Wether the value can be overriden
rememberLastValue
 dataConfigurations.rememberLastValue boolean

If set to true, the value persists accross workflows

layouts

Name Path Type Description
items
 items array of object
created
 items.created number

Creation date
dataConfigurations
 items.dataConfigurations array of layout
itemsPerPage
 itemsPerPage number

Number of items per page
pageIndex
 pageIndex number

Index of the returned page
totalItems
 totalItems number

Total number of items concerned by the request

part

Document part

Name Path Type Description
contentType
 contentType string

contentType
filename
 filename string

filename
hash
 hash string

hash
size
 size integer

size

pdfSigField

Name Path Type Description
imageHeight
 imageHeight float

imageHeight
imagePage
 imagePage float

imagePage
imageWidth
 imageWidth float

imageWidth
imageX
 imageX float

imageX
imageY
 imageY float

imageY

signatureProfile

Name Path Type Description
created
 created number

Creation date
documentType
 documentType string

Type of the documents
forceScrollDocument
 forceScrollDocument boolean

Force the signer to scroll to the bottom of the document
id
 id string

the signature profile Id
isDefault
 isDefault boolean

Makes this signature profile the default one
isDisabled
 isDisabled boolean

Disable this signature profile
name
 name string

The signature profile name
pdfSignatureImageText
 pdfSignatureImageText string

Text displayed in signatures pads
pdfSignatureImageTextColor
 pdfSignatureImageTextColor string

Color of the text displayed in the singatures pads
pdfSignatureImageTextSize
 pdfSignatureImageTextSize number

Size of the text displayed in the singatures pads
pdfVisibleSignatureMode
 pdfVisibleSignatureMode string

Visible signature mode (allowed, disabled, noImage)
Signature type
 signatureType string

pades, xades, xadesDetached, xadesDetachedManifest, cades, helios
tenantId
 tenantId string

Tenant Id
updated
 updated number

Last modification date

signatureProfiles

Name Path Type Description
items
 items array of signatureProfile
itemsPerPage
 itemsPerPage number

Number of items per page
pageIndex
 pageIndex number

Index of the returned page
totalItems
 totalItems number

Total number of items concerned by the request

user

Name Path Type Description
approveAllowed
 approveAllowed boolean

If set to true the user can approve documents
country
 country string

Country of the user
created
 created integer

Creation date
email
 email string

Email of th user
firstName
 firstName string

FirstName of the user
groupId
 groupId string

Id of the user's group
id
 id string

Id of the user
isDisabled
 isDisabled boolean

If true, the user is disabled
lastLogin
 lastLogin integer

The user's last login date
lastName
 lastName string

LastName of the user
name
 name string

Name (first name + last name) of the user
organizationTitles
 organizationTitles array of

The user's funtions in his organizations
phoneNumber
 phoneNumber string

Phone number of the user
signAllowed
 signAllowed boolean

If set to true, the user can sign documents
subject
 subject string

The user's internal subkect code
tenantId
 tenantId string

Id of the tenant
updated
 updated integer

Last modification date
viewAuthorizedGroups
 viewAuthorizedGroups array of string

List of group in which the user can act as an observer

workflow

Name Path Type Description
created
 created integer

created
currentRecipientEmails
 currentRecipientEmails array of

currentRecipientEmails
currentRecipientUsers
 currentRecipientUsers array of

currentRecipientUsers
data1
 data1 string

Metadata 1
data2
 data2 string

Metadata 2
data3
 data3 string

Metadata 3
data4
 data4 string

Metadata 4
data5
 data5 string

Metadata 5
data6
 data6 string

Metadata 6
data7
 data7 string

Metadata 7
data8
 data8 string

Metadata 8
description
 description string

Description of the workflow
email
 email string

Email of the workflow owner
firstName
 firstName string

First Name of the workflow owner
groupId
 groupId string

Id of the workflow owner's group
id
 id string

Id of the workflow
lastName
 lastName string

Last name of the workflow owner
layoutId
 layoutId string

Id of the metadata layout of the workflow
logs
 logs array of

Logs items of the wokflow
name
 name string

Name (first name + last name) of the workflow owner
notifiedEvents
 notifiedEvents array of string

Lis of events notified by the workflow
progress
 progress integer

Progress of the workflow in percents
steps
 steps array of object

steps
allowComments
 steps.allowComments boolean

Allows/forbid interactive comments ara allowed on the step
hideAttachments
 steps.hideAttachments boolean

Controls the display of attachments to signers
hideWorkflowRecipients
 steps.hideWorkflowRecipients boolean

Controls the display of other signers to the signer
id
 steps.id string

Step id
invitePeriod
 steps.invitePeriod integer

invitePeriod
isFinished
 steps.isFinished boolean

isFinished
isStarted
 steps.isStarted boolean

isStarted
logs
 steps.logs array of

logs
maxInvites
 steps.maxInvites integer

maxInvites
recipients
 steps.recipients array of object

recipients
consentPageId
 steps.recipients.consentPageId string

consentPageId
country
 steps.recipients.country string

country
email
 steps.recipients.email string

email
firstName
 steps.recipients.firstName string

firstName
lastName
 steps.recipients.lastName string

lastName
phoneNumber
 steps.recipients.phoneNumber string

phoneNumber
userId
 steps.recipients.userId string

userId
requiredRecipients
 steps.requiredRecipients integer

requiredRecipients
sendDownloadLink
 steps.sendDownloadLink boolean

sendDownloadLink
stepType
 steps.stepType string

stepType
validityPeriod
 steps.validityPeriod integer

validityPeriod
tenantId
 tenantId string

tenantId
updated
 updated integer

updated
userId
 userId string

userId
viewAuthorizedGroups
 viewAuthorizedGroups array of string

List of groups in which users can act as observers
viewAuthorizedUsers
 viewAuthorizedUsers array of string

viewAuthorizedUsers
watchers
 watchers array of object

watchers
email
 watchers.email string

email
notifiedEvents
 watchers.notifiedEvents array of string

notifiedEvents
userId
 watchers.userId string

userId
workflowStatus
 workflowStatus string

workflowStatus

workflows

Name Path Type Description
items
 items array of workflow

items
itemsPerPage
 itemsPerPage integer

itemsPerPage
pageIndex
 pageIndex integer

pageIndex
totalItems
 totalItems integer

totalItems

binary

This is the basic data type 'binary'.