Package options

boolean

Enable embedded signing mode.

object

Embed options used to customize the embedded package editor. 2.8

Show properties

boolean

User can only save changes to draft packages; the user will not be able to send it.

boolean

User will not be allowed to modify package properties.

boolean

User will not be allowed to modify package verification properties.

boolean

User will not be allowed to modify package signers.

boolean

User will not be allowed to modify package documents.

boolean

User will not be allowed to modify package properties, verification properties, signers, or documents. They will still be allowed to template each document.

boolean

The first document will be focused when the package editor is loaded instead of the package properties.

string

User will be redirected back to the returnUrl when they are done editing the package.

string

Will be included in a state query string parameter appended to the returnUrl.

string

Show custom brand when signing package. 1.10

boolean

Add document identifier to each page (QR code).

boolean

Allow VSR participants to review documents before a meeting via a Review Documents link added to email meeting invitation. 2.6

boolean

Allow signers to forward the signing to another email address. 4.0

boolean

Enabled to not share email addresses between signers. 2.11

Supported in the following package types:

Concurrent (concurrent)
Sequential (Sequential)
Group Send (Counterparts)

boolean

Do not allow signers to fill AcroForm fields during signing. 3.3

boolean

Do not allow signers to modify AcroForm fields during signing. 3.6

string

Control how Acroform fields are flattened after signing a document. 2.6

Hide values

Value	Description
none	Do not flatten fields
filled	Flatten only fields filled by signer
all	Flatten all fields `default`

string

Override the default ink color #0000FF for Ink to Sign signatures and initials with a valid #-hexadecimal RGB color value. 2.10

string

Set preferred default mark type. 4.0

Hide values

Value	Description
touch_to_sign	iink It
type_to_sign	Type It
click_to_sign	Accept It

string

Add a retention period to the package to prevent deletion. (ISO 8601 duration) 1.11

Map<string, object>

Override system messages by message key. Each value contains an optional default string and an optional locale map of locale codes to strings. Values are limited to 1,024 characters and cannot contain website domains or email addresses.3.6

Map<string, object>

Add custom consent notice text by consent type: signing, verification, or video_recording. Each value contains an optional default string and an optional locale map of locale codes to strings. Custom text is appended to the system notice, supports locale fallback, is limited to 1,024 characters, and cannot contain website domains or email addresses.4.2

boolean

Parse document for templating tags. Defaults to true.

boolean

Parse merger data templating tags. Defaults to false. 4.0

string

Control how unused signer tags are handled. 2.6

Hide values

Value	Description
keep	Leave unused tags in document
hide	Move unused tags to hidden layer
remove	Remove unused tags `default`

string

Control which document(s) within a package have the CAC page appended to them. 3.2

Hide values

Value	Description
document_all	Append to all documents in package
document_first	Append to first document in package
document_last	Append to last document in package

boolean

When enabled will add a signer identification placeholder for each signer on the CAC page. 3.2

string

Add a custom disclaimer to the top of the Compliance Audit Certificate. 1.10

boolean

Enabled 2FA security code.

All signers will require a valid mobile phone number to enable mobile MFA.

boolean

Enabled 2FA security passphrase.

You must also set a passphrase as part of add or update request to enabled 2FA security passphrase.

{
    "options": {
        "securityPassphrase": true,
        ...
    },
    "securityPassphrase": "mySecretPassphrase"
}

boolean

Enable all mark types.

boolean

Enabled click to sign Accept It.

boolean

Enabled type to sign Type It.

boolean

Enabled touch to sign Ink It.

boolean

Allows signer to use desktop mouse to draw signature via touch to sign.

boolean

Allow signers to apply their last used iink signature during a signing session. Defaults to false. 4.1

boolean

Automatically starts video recording after host starts meeting and first attendee joins.

boolean

Disables video recording feature preventing host from recording signing session.

string

Add a retention period to all package videos to prevent deletion. (ISO 8601 duration) 1.11

Share meeting details and videos with guest signers via MasterFile.

boolean

Prevent all package notifications from being sent to signers. This option will override other notify options. This option will not prevent Document Accessed (notifyAccessed) notifications if enabled. 1.10.4

boolean

Set to false to not include signed documents as attachments in executed email notifications. 2.5

boolean

Send email notification to owner to confirm package was created.

boolean

Send email notification to owner whenever a signer opens a document (limited to once every hour).

boolean

Send email notification to each signer when it is their turn to sign.

boolean

Send email notification to each signer to notify them that they are waiting their turn to sign.

boolean

Send email notification to each signer when Video Signing Room meeting is scheduled.

boolean

Include ICS compatible meeting invitation with email notification to schedule meeting date and time in recipients’ calendar.

boolean

Send email notification to signer after they sign each document. 2.5

boolean

For Sequential packages, the next signer notification is only sent after the current signer has signed all of their documents. 3.3

boolean

Send email to owner to notify them when all signers have signed each document.

boolean

Don’t send document executed email until all documents in the package have been fully signed. 3.3

boolean

Counterparts Send document executed notification TO package owner and CC signer. 1.10

boolean

Send signers fully executed document with CAC page appended to end of document. 1.10

boolean

Send signers fully executed document without CAC page appended to end of document. 1.10

boolean

Send signers separated CAC page as an additional attachment. 1.10

boolean

Allow signer to add additional fields while signing documents. Customize signerTools to control what fields the signer can add.

boolean

Allow signer to delete any templated fields while signing a document. This is default behavior for VSR and In Person package types. It is recommended to use optional fields instead for Concurrent, Sequential, and Group Send package types. 2.10

object

Customize signer toolbar options.

Show properties

boolean

Enable sign.

boolean

Enable annotations (ink) on mobile devices.

boolean

Enable annotations (ink) on desktop.

boolean

Enable text.

boolean

Enable note.

boolean

Enable forms.

boolean

Auto highlight form fields.

boolean

Enable image.

boolean

Request Signers Geolocation while signing documents, joining VSR meetings, performing IDV, and connecting to a mobile signature pad.

object

Customize how Geolocation is collected. 3.6

Show properties

boolean

Require geolocation to be shared before allowing the signer to continue.

boolean

Require geolocation to be shared before the signer can sign documents. (required must also be set to true)

boolean

Require geolocation to be shared before the signer can use signature pad. (required must also be set to true)

boolean

Require geolocation to be shared before the signer can join VSR meetings. (required must also be set to true)

boolean

Require geolocation to be shared before the signer can verify their identity. (required must also be set to true)

boolean

Enable custom PDF security options. 2.10

object

Customize PDF security options. 2.10

Show properties

boolean

Allow PDF merge operations.

boolean

Allow copying PDF content.

boolean

Allow only degraded PDF printing.

boolean

Allow PDF AcroForms fields to be filled in (when formFlattening option is not set to “all”).

boolean

Allow PDF annotations.

boolean

Allow PDF editing.

boolean

Allow PDF printing.

boolean

Allow screen readers.

PDF security options are enforced only when the PDF is opened in a PDF viewer that supports the PDF security settings. Not all PDF viewers support these settings.

Configure consent requirements and automatic reuse. 4.2

Show properties

boolean

Require the signer to provide consent before completing a configured consent action. Defaults to false.

boolean

Require consent before signing. Defaults to true.

boolean

Require consent before video recording in a Video Signing Room package. Defaults to false.

number

Reuse a member’s previously accepted consent when the consent type and notice version match and the acceptance occurred within this number of days. Defaults to 90. Set to 0 to disable automatic reuse.

object

Set identity verification options. 3.2

Show properties

string

The policy ID of the custom Identity Verification Policy to use during signer identity verification. (Custom IDV policies currently must be created by our Support Team for your organization.)

string

The code of one of our standard Identity Verification Policy to use during signer identity verification.

Show Verification policies

Policy Code	Pass-To-Sign	Region	Retries
trulioo3_document	false	Any	2
trulioo3_document_required	true	Any	2
trulioo3_document_ca_strict	false	CA	2
trulioo3_document_ca_strict_required	true	CA	2

Pass-To-Sign indicates whether the signer must successfully complete identity verification before they can sign their documents.

object

Configure the digital signature types and providers available to signers. 4.2

Show properties

Map<string, string[]>

Map each enabled digital signature type to an ordered list of provider names.

Signature type	Description
`qes`	Qualified Electronic Signature

Show QES providers

Value	Provider
`digidentity`	Digidentity

Provider availability depends on your subscription and organization configuration.

object

Set package Remind Me Later options. 4.0

Show properties

number

Number of days, from today, to send a reminder notification to the package owner.

string

Message that will be sent with the reminder notification to package owner.

Getting started

Guides

API

Webhooks

Reference