Creating a Record

Prev Next

The Create record action generates a new object within OneSpan Sign. When you choose transaction as the type of record, this action initiates a new OneSpan Sign transaction.

Transaction Information

Input field

Description

Transaction name

Required. The display name of the transaction as seen by senders and recipients.

Status

Required. Sets the initial status (DRAFT or SENT) and determines whether the transaction is sent immediately or saved as a draft.

Documents

A collection of documents included in the transaction. Each document must contain the following fields:

Input field

Description

Document ID

Required. Unique identifier for the document.

Document name

Required. Name of the document as it appears in OneSpan Sign.

Document index

Optional. Determines document order within the signing process.

Base64 content

Required. Base64‑encoded file content.

Roles

Roles represent the participants in the transaction, including signers and other recipients. Each role supports the following fields:

Input field

Description

Role ID

Required. Unique identifier for the role.

Role name

Required. Display name of the participant.

Signer first name

Required. First name of the signer.

Signer last name

Required. Last name of the signer.

Signer email

Required. Email address of the signer.

Role index

Optional. Defines the signer’s position in the workflow.

Email message content

Optional. Custom message included in the email sent to this signer.

Auth scheme

Optional. Identity‑verification method (e.g., NONE, SMS, ID_VERIFICATION).

Auth challenge

Optional. Challenge information required by the selected authentication method.

Signer company

Optional. Company name of the signer.

Signer title

Optional. Job title or role of the signer.

Attachment requirements

Optional. Additional documents the signer must upload.

Settings

Settings allow you to configure the behavior and appearance of the transaction.

Setting

Description

In Person

Optional. Indicates that this is an in‑person signing session.

Font Size

Optional. Default font size used during signing.

Default Time‑Based Expiry

Optional. Number of days before the transaction expires.

Message to All Recipients

Optional. A message displayed to all transaction participants.

Timezone

Optional. Time zone applied to the transaction (e.g., America/Toronto).

Language

Optional. Language code for emails and the signing ceremony (e.g., en, fr, zh-CN).

Review Before Completion

Optional. Requires sender review before marking the transaction complete.

Maximum number of files per attachment

Optional. Limits how many files may be uploaded for each attachment requirement.

Sender Visible

Optional. Determines whether the sender appears in the signer list.

Data

Use these fields to attach metadata to the transaction.

Field

Description

Workato Data

Optional. Contextual information used for Workato integrations and troubleshooting.

Custom Fields

Optional. Additional metadata such as internal reference numbers.

Sender

If provided, sender details override the connected user.

Field

Description

Sender first name

Optional. First name of the sender.

Sender last name

Optional. Last name of the sender.

Sender email

Required if sender details are provided. Email address of the sender.

Field availability may change as the connector evolves.

Output

Output field

Description

Package ID

The unique ID of the OneSpan Sign transaction. Use this value in subsequent steps to retrieve, update, or track the transaction.