TuID
Introduction
The purpose of this guide is to explain how to configure and integrate Qflow with TuID. The connector integrates Qflow with TuID’s electronic signature platform to start and manage PDF document signatures within your processes.
TuID has the following actions:
Prerequisites
You must contract the TuID service and obtain the provider data to connect to the server.
Application parameter
To establish the connection, you need at least one application parameter (see Application Parameters) that allows communication between Qflow and TuID. This field is used to configure the connector in a Service Task in Qflow (see Connector Configuration from a Service Task).
To connect with TuID, you need the following provider data:
Host: URL of the TuID service host.
API key: API key generated in TuID to access its services.
Authentication server: URL of the authentication server for TuID services.
Actions
You can perform the following actions with TuID:
Create signing process
This action lets you select a document and send it to TuID to generate a signing process. The input parameters configure the signature styles (optional) and the document. The output parameters return information about the created process, specifically the process ID and the signing URL.
Input parameters
Input |
Description |
|---|---|
Document |
Required. PDF document (under 50 MB) to be signed. |
Event on signing |
Catch signal event that triggers when the signature is completed. If selected, the process automatically continues when it reaches that event and the document has been signed. |
Add visual signature representation |
If selected, the signature will be visible in the PDF. Its position and other visual parameters can be configured. By default, it is placed in the bottom-right corner of the last page. The default page for the signature location is the last page. |
Horizontal (Signature position) |
Distance from the signature field to the left edge of the page. Default value: 450. |
Vertical (Signature position) |
Distance from the signature field to the bottom edge of the page. Default value: 50. |
Width (Signature position) |
Signature field width in pixels. Default value: 100. |
Height (Signature position) |
Signature field height in pixels. Default value: 100. |
Page (Signature position) |
Page number where the signature field must be placed. Examples: |
Name (Font) |
Font name for the signature text. Examples: |
Size (Font) |
Font size for the signature text. |
Style (Font) |
Font style for the signature text. Examples: |
Contact information (Signer data) |
Contact information to include with the signature. |
Reason (Signer data) |
Reason for signing the document. |
Signature field JSON (Advanced) |
JSON configuration for the signature field properties. If completed, all optional signature style parameters are ignored. |
Signature field JSON (Advanced)
This parameter allows you to configure the visual representation (appearance) of the signature in the PDF document through a JSON object. This functionality is based on the “Signature representation (appearance)” section of the TuID API documentation (section 1.2.3.5.2).
When this JSON parameter is provided, all individual signature style parameters configured previously (horizontal and vertical position, width, height, page, font properties, contact information and reason) are ignored. The JSON must contain all necessary properties to completely define the signature field appearance in the document, allowing for more precise and complete configuration according to TuID API specifications.
For specific technical details about the structure and properties of the JSON object, consult the official TuID API documentation.
Output parameters
Output |
Description |
|---|---|
Signing process URL |
Required. URL of the created signing process. It must be associated with a text-type application datum to access the signing link. |
Signing process ID |
Required. Unique process identifier. It is used to check status, get document or delete the process. |
Get document
This action lets you retrieve a signed PDF from TuID. You must first run the “Create signing process” action to obtain the process identifier.
You must enter a signing process ID and the name of the PDF to generate. Based on that, it retrieves the PDF, which must be associated with an application datum of type “Document”.
Input parameters
Input |
Description |
|---|---|
Signing process ID |
Required. Unique signing process identifier. To obtain this identifier, you must use the create signing process step. |
Output document name |
Name that will be used for the signed document. |
Output parameters
Output |
Description |
|---|---|
Signed document |
Document retrieved from TuID with the applied signature. It is returned only if the document was signed and the signing process exists; otherwise an error message is shown. |
Get signing process status
This action lets you check the status of a signing process to confirm whether the document was signed. You must first run the “Create signing process” action to obtain the process identifier.
Input parameters
Input |
Description |
|---|---|
Signing process ID |
Required. Unique signing process identifier. To obtain this identifier, you must use the create signing process step. |
Output parameters
Output |
Description |
|---|---|
Process status |
Required. Text that represents the status of the signing process. Possible values: |
Delete signing process
This action lets you delete a signing process. You must first run the “Create signing process” action to obtain the process identifier.
Input parameters
Input |
Description |
|---|---|
Signing process ID |
Required. Unique signing process identifier. To obtain this identifier, you must use the create signing process step. |