HomeGuidesRecipesAPI
HomeGuidesAPILog In

OneSpan Connector

๐Ÿšง

OneSpan Module

Contact your sales representative if you are interested in obtaining a license for the OneSpan module for your SmartIQ instance.

Overview

SmartIQ integrates with OneSpan Sign to provide the option of electronically signing documents for end to end digital transactions.

Actions

The connector consists of the following Actions

Connector Settings

  1. Obtain a license for the OneSpan Module and open the SmartIQ Manage application and log in as an Administrator with Change settings permission.
  2. Configure the default values in Settings > OneSpan.
749749

Setting

Description

Name

Specify a name.

Base URL

Specify the URL of the OneSpan Sign environment.

API Auth Client Id

Enter the OneSpan Client Id that will be used for authentication.

API Auth Client Secret

Enter the OneSpan Client Secret that will be used for authentication.

Debug

If enabled, will log additional information that can be found in Manage > Management.

  1. For multiple OneSpan accounts, click the New Set button to create additional accounts. For example, Sandbox and Production.

  2. Click Save.

OneSpan Create Package Action

OneSpan Create Package Action supports sending OneSpan packages with multiple documents for one or more users to sign. This action also provides the ability to specify the order of signage. For example, the Manager (1) signs then the Executive (2) signs and then the CEO (3), etc.

The packages can be sent via "Draft or Sent" mode, with the ability to require signatures via either:

  • Positional Placement โ€“ Add a signature input using a page number as well as left and top co-ordinates on where the signature will be placed. For example, page 2, left 100, top 200. For more information, refer to this article.

  • Text Anchors โ€“ Add a signature input using an instance of an anchor keyword. For example, Add a signature after the text "Please sign here". For more information, refer to this article.

  • Text Tags โ€“ A OneSpan convention to populate the document with signature inputs using the convention {{esl:roleName:fieldType}}. For more information, refer to this article.

  • Accept Only โ€“ No specific signature input needed on the document but the user needs to click the "Accept" button to accept the whole document.

Creating the OneSpan Package

  1. In Design, open a project and create a form.

  2. Drag and drop the OneSpan Create Package action onto the finish section.

๐Ÿ“˜

Note

If the OneSpan Create Package action is not in the list of available actions, contact your sales representative to obtain a license for your SmartIQ instance.

12141214
  1. Once added, configure the default action inputs.
360360

Action Inputs

Input

Description

Package

The following inputs are required to send a OneSpan package:

  • Name (Required)
  • Mode (Required)
  • Default Signing Method
  • Sender email

They are detailed below.

  • Mode (Required)

There are two values available:

  • DRAFT โ€“ Keeps the package in draft mode to enable further editing via the OneSpan web interface before sending.
  • SENT โ€“ Sends the package directly to the signers.
  • Name (Required)

Package name

  • Default Signing Method

Use if you do not explicitly specify signatures within documents as inputs.
The action will default to ACCEPT_ONLY if there are no signatures specified within the documents as well as no default signing method defined.
The are two values available:

  • ACCEPT_ONLY โ€“ A signer only needs to click the Accept button without the need for a signature.
  • TEXT_TAGS โ€“ Any documents without signatures will use the text tags extraction method and expect at least one signature text tag within the document. For example, {{esl:Signer1:Signature}} or {{esl:Signer1:Initials}}.
  • Sender Email

The email address of the OneSpan Sender account that the recipients will see as the sender of the emails. If left blank, the sender will default to the owner account.

Reminders

Set package reminders for the users to sign if they haven't. Reminders are optional. If configuring Reminders, OneSpan needs all Action Inputs to be provided. If an Action Input is not provided, the default value will be sent to OneSpan.

  • Send Reminder in x days

Waits a certain amount of days before sending the first reminder. Defaults to 1.

  • Repeat Reminder x times

Number of times the reminder will be repeated after the initial reminder. Defaults to 0 with a maximum of 5.

  • Repeat Reminder every x days

Frequency of the reminders. Defaults to 1.

Signer
(At least one signer required)

Each signer is required to provide the following:

  • First Name
  • Last Name
  • Email

Note: Repeat Type and value option will only be available if a repeating section is used.

  • Signer Id

Use if there is a text-tag document with specific roles defined. Otherwise, leave this option blank and the signers will be created as Signer1, Signer2, Signer3,...

  • Signing Order

Use if the signing ceremony has be done in sequential order. For example, if the signing order has been set as Signer1=1 and Signer2=2,
Signer1 signs first and Signer2 will only receive the notification to sign after Signer 1 has finished.

If the signing order has been set as Signer1=1, Signer2=1 and Signer3=2, Signer3 will only receive the notification to sign after Signer1 and Signer 2 have finished.

  • Email Message

Use to add more content to the message that gets sent with the email.

  • Email Signed Documents

If true, will email the signed documents as an attachment after the signing ceremony have completed. If false or not specified, will email the signer with a link to view or download the documents.

Document

Use only if there is a need to define specific signatures.
If the Default singing method of Accept Only or Text Tags is used, this option does not need to be configured.

  • Document Signing Method

Used if you don't explicitly specify signatures within this document and have specified text tags in the document or just want to offer the signer the ACCEPT_ONLY option for this document.

Use if you do not explicitly specify signatures within this document as inputs.
The action will default to ACCEPT_ONLY if there are no signatures specified within this document.
The are two values available:

  • ACCEPT_ONLY โ€“ A signer only needs to click the Accept button without the need for a signature.
  • TEXT_TAGS โ€“ Any documents without signatures will use the text tags extraction method and expect at least one signature text tag within the document. For example, {{esl:Signer1:Signature}} or {{esl:Signer1:Initials}}.
  • Name

Document name

Signature

A signature input is required if you want to define the signature.

  • Signature Type

Required, if defining a signature.

  • FULLNAME โ€“ Gives the signer a Click To Sign option.
  • CAPTURE โ€“ Gives the signer a Capture box to draw a signature.
  • INITIALS โ€“ Gives the signer a Click To Initial option.
  • Position Details

Use to define signature locations on a position.

  • Position Page Number โ€“ Defaults to the first page if not supplied.

Note: OneSpan documentation uses 0 to mean the first page. However the connector uses 1 to display as the first page.

  • Position Left โ€“ Defaults to 0, the amount of pixels from the left of the position, to put the signature.
  • Position Top โ€“ Defaults to 0, the amount of pixels from the top of the position, to put the signature.
  • Position Width โ€“ Defaults to 200, the width of the signature box.
  • Positional Height โ€“ Defaults to 50, the height of the signature box.
  • Anchor Details
  • Anchor Text โ€“ Required if using Anchor Details.

Note: The text is case sensitive and the action will fail if the document is unable to find the specified text.

  • Anchor Point โ€“ Where to place the signature in relation to the anchor text:
    • TOPLEFT
    • BOTTOMLEFT
    • TOPRIGHT
    • BOTTOMRIGHT
  • Anchor Index โ€“ Defaults to 0. The zero-based instance of the anchor text to find. For example, if you want to place a signature against the second instance of "Sign Here" then set this to 1.
  • Anchor Character Index โ€“ Defaults to 0. The zero-based instance of the character within the anchor text to place the signature box. For example, if you want to place a signature above the 4th character in "Sign Here" then set this to 3.
  • Anchor Width โ€“ Defaults to 200, the width of the signature box.
  • Anchor Height โ€“ Defaults to 50, the height of the signature box.
  • Anchor Left Offset โ€“ Where to place the signature box. Positive numbers move to the right, negative numbers move to the left.
  • Anchor Top Offset โ€“ Where to place the signature box. Positive numbers move to the bottom, negative numbers move to the top.

OneSpan Create Signing Url

The OneSpan Create Signing Url Action takes a created OneSpan package and returns a Uri, which can be used with the SmartIQ Redirect Action to take the end user from the SmartIQ submission page, directly into the package signing ceremony for the given signer id.

Using the Action

  1. Create a form with the OneSpan Package.

  2. Drag and drop the OneSpan Create Signing Url Action onto the finish section.

  3. Add the following inputs:

Input

Descriptions

Package Id

The signing ceremony unique identifier, usually mapped from the OneSpan Create Package Action Package Id Output

Signer Id

Unique identifier of the signer who the url is being retrieved for. The OneSpan Create Signing Url Action will check if the Signer Id is valid for the given package prior to attempting to retrieve the signing url.

12181218
  1. Optionally, Add a Redirect Action] and map the URL to the Signing Url Output.
12171217
  1. Save the project.