Package

string

Unique identifier for the package.

string

Unique identifier for the organization that owns the package.

string

Identifier for the member who created/owns the package.

string

nullable

Team identifier associated with the package. (optional)

string

nullable

Folder identifier where the package is stored. (optional)

boolean

Set to true if the package is shared.

string

nullable

Current scheduled meeting ID for the package (if applicable).

string

nullable

ID of the template the package was created from (if applicable).

string

nullable

ID of the form the package was created from (if applicable).

string

nullable

ID of the API key used to create the package (if created via API key).

string

Display name of the package.

string

nullable

Category for the package. (optional)

string

nullable

Client reference number. (optional)

string

nullable

Matter reference number. (optional)

string

nullable

Description of the package. (optional)

string

nullable

Message included when the package was sent. (optional)

string

nullable

Message explaining why the package was rescinded. (optional)

string

nullable

Reminder message for signers. (optional)

string

Creation time (ISO 8601 date-time).

string

nullable

Reminder time (ISO 8601 date-time).

string

nullable

Retention expiry time (ISO 8601 date-time).

string

nullable

Time the package was rescinded (ISO 8601).

string

nullable

Time the package was deleted (ISO 8601).

string

Deadline for signing (ISO 8601 date-time).

string

Last modification time (ISO 8601 date-time).

object

Package options.

Show properties

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.

boolean

Set to true if the package is protected by a security passphrase.

string

Language/locale for the package.

string

Time zone for package date/time presentation.

object

Formatting options for dates and presentation.

Show properties

string

nullable

Locale code used for formatting. (optional)

Inherits from the package locale if not specified.

number

Number of signed revisions across package documents.

number

Total number of revisions across package documents.

string

nullable

Restriction type applied to the package. (optional)

boolean

Set to true if the package was created via the API.

string

Package type identifier.

Show values

Value	Description
concurrent	Concurrent: Allows multiple signers to sign the document simultaneously.
Sequential	Sequential: Requires signers to sign the document in a specific order.
Counterpart	Group Send: Enables group signing, where all signers receive the document at the same time.
video_closing_room	Video Signing Room: A virtual room for signing documents via video conference.
Live Session	In Person: An in-person signing session with all parties present.

Even though the signing workflow names have evolved, the constants used to identify them have remained the same.

The package type constants are case-sensitive. Ensure that you use the exact casing as shown in the table above when specifying package types in your API requests.

string

Current state of the package.

Show values

New package states may be added in future releases. It is recommended that you always validate your integration against the sandbox before new releases are deployed into production.

Release 4.0 introduces two new package states, executed and expired. In 3.6 both executed and expired packages were in an open state.

Value	Version	Description
draft	1.0	Package will be added in a draft state. Notifications will not be sent to the signer(s). You must call the send API, or the package owner must manually send the package from within iinked Sign.
open	1.0	The package will be ready for signing, and notifications will be sent to the signer(s) if enabled.
executed	4.0	The package has been fully executed by all signers.
expired	4.0	The package was not signed by the sign by date and has now expired. VSR packages will expire 7 days after their scheduled meeting date.
rescinded	3.5	The package was rescinded and is no longer available for signing.
select	3.6	Use the select state only when the package will be opened in the embedded package editor and you want the workflow to prompt the user to choose a package type. Packages in the select state will be automatically deleted if not converted to draft or open within 24 hours.
add	2.9	Use the add state only when the package will be opened in the embedded package editor and you want the workflow to function as if you’re creating a new package, rather than editing an existing one. Packages in the add state will be automatically deleted if not converted to draft or open within 24 hours.

Map<string, object>

nullable

Arbitrary external data attached to the package.

string

Package version or timestamp (ISO 8601).

object

nullable

If the package is scheduled for a meeting, the meeting details.

Show properties

string

Unique identifier for the meeting.

string

Organization associated with the meeting.

string

Package associated with the meeting.

string

Meeting start time (ISO 8601 date-time).

string

Meeting duration (ISO 8601 duration string).

boolean

Set to true if the meeting is private.

string

Meeting type identifier.

string

Current state of the meeting.

Show values

Value	Description
scheduled	Scheduled meeting.
rescheduled	Rescheduled meeting.
cancelled	Cancelled meeting.

object[]

Documents that belong to the package.

Show properties

string

Unique identifier for the document.

string

Identifier of the package this document belongs to.

string

Unique identifier for the file associated with the document.

string

nullable

Auto-template identifier (if created from an auto-template).

string

nullable

Auto-template document identifier (if applicable).

string

nullable

External identifier for the document. (optional)

number

Order/index of the document within the package.

string

Document display name.

string

Original filename uploaded.

string

File extension or type identifier.

number

Size of the file in bytes.

number

Number of pages in the document.

string

Upload time (ISO 8601 date-time).

string

Last modified time (ISO 8601 date-time).

number

Number of signed revisions for this document.

number

Total number of revisions for this document.

string

nullable

Description of the document. (optional)

boolean

Set to true if a CAC (Compliance Audit Certificate) has been appended to the document.

number

Number of CAC pages if cac is true.

string

Current state of the document.

Show values

Most document states are used internally. All documents included in a returned package will always be in the open state.

Values	Description
open	The document is open and can be interacted with.
failed	The document failed to process and cannot be signed.

object[]

Revision history for the document. Typically includes one revision per signer.

Show properties

string

ID of the document this revision belongs to.

string

Unique identifier for the revision.

number

Revision number (incrementing integer).

string

nullable

Identifier of the previous revision this revision replaced. (optional)

string

nullable

Last opened time for the revision (ISO 8601).

string

Signer who is associated with this revision.

boolean

Set to true if this revision has been signed.

string

nullable

Time the revision was signed (ISO 8601).

string

nullable

Address metadata captured on sign. (optional)

string

nullable

Latitude coordinate captured on sign. (optional)

string

nullable

Longitude coordinate captured on sign. (optional)

string

State of the revision (for example: signed, pending).

object[]

Signers associated with this document.

Show properties

string

Identifier for the signer associated with the document.

string

Internal signer key used to map fields/tags.

string

Full name for the signer on this document.

string

Signer initials.

string

Email for the signer on this document.

string

nullable

Mobile number for the signer on this document. (optional)

boolean

Set to true if the signer has signed this document.

boolean

Set to true if this signer is next in the signing order for this document.

string

nullable

Template role name if the signer was created from a template role. (optional)

object[]

Signers for the package.

Show properties

string

Unique identifier for the signer.

string

Package identifier the signer belongs to.

string

nullable

Member identifier when the signer is an organization member. (optional)

string

Tag associated with the signer. (optional)

string

When the signer record was created (ISO 8601).

string

nullable

Time the signer declined (if applicable).

string

Last update time for the signer record.

number

Signing order index.

string

nullable

Locale for the signer. (optional)

boolean

Set to true if signer requires CAC signing.

boolean

Set to true if signer requires identity verification before signing.

string

First name of the signer.

string

Last name of the signer.

string

Email address for the signer.

string

nullable

Country code for the mobile number. (optional)

string

nullable

Original mobile number provided.

string

nullable

Normalized mobile number (E.164) when available.

string

nullable

Message left by the signer when declining (if any).

string

nullable

Reason code for decline (if applicable).

boolean

Set to true if this signer is next in signing order across the package.

number

Number of revisions the signer has signed.

number

Number of revisions assigned to the signer.

string

Role of the signer.

Show values

Value	Description
signer	Signer
guest	Guest of VSR or In Person signing that is not a signer of any documents
host	Host of VSR or In Person signing

string

Type of signer.

Show values

Value	Description
signer	Signer
guest	Signer that was added by the host during VSR or In Person signing session

string

Current state of the signer.

Show values

Value	Description
active	Signer that is actively participating in the signing process.
declined	Signer that has declined to participate in the signing process.
deleted	Signer that has been removed from the package.

object

nullable

Signer verification status. (if any)

Show properties

string

Identifier for the verification record.

string

Signer identifier associated with this verification.

boolean

Set to true if the signer is can sign documents after verification.

boolean

Set to true if the signer can join VSR after verification.

boolean

Set to true if the signer may retry verification on failure.

boolean

Set to true if the signer has successfully signed after verification.

boolean

Set to true if the verification is currently locked.

number

Number of verification attempts made.

number

Number of errors encountered during verification.

boolean

Whether the verification flow should continue to next step.

boolean

Whether to continue the flow when verification errors occur.

string

nullable

Current verification error code (if any).

string

Current state of the verification.

Show values

State	Description
not_started	Signer has not started identity verification.
start	Signer is on start step.
consent	Signer is on consent step.
consent_processing	Server is processing consent.
identity	Signer is on identity verification step.
identity_processing	Server is processing identity verification.
kba	Signer is on KBA verification step.
kba_processing	Server is processing KBA verification.
document	Signer is on document verification step.
document_processing	Server is processing document verification.
end	Server is finalizing identity verification result.
passed	Identity verification has passed.
failed	Identity verification has failed and can be retried by signer.
failed_reset	Identity verification has failed and must be reset by package owner for signer to retry.
failed_locked	Identity verification has failed and is now locked and can no longer be reset by package owner.
error	A server error has occurred and can be retried by signer.
error_reset	A server error has occurred and must be reset by package owner for signer to retry.
error_locked	A server error has occurred and can no longer be reset by package owner.
cancelled	Identity verification has been cancelled.
cancelled_reset	Identity verification has been cancelled due to package owner resetting signer’s verification.
invalid	Identity verification is in an invalid state and cannot be processed.

object[]

Recipients related to the package (additional recipients beyond signers).

Show properties

string

Unique identifier for the recipient.

string

Identifier of the package the recipient belongs to.

string

Creation time for the recipient record (ISO 8601).

string

nullable

Last update time for the recipient record (ISO 8601).

string

Recipient first name.

string

Recipient last name.

string

Recipient email address.

string

nullable

Recipient mobile number country code. (optional)

string

nullable

Original recipient mobile number provided.

string

nullable

Normalized recipient mobile number. (optional)

string

nullable

Recipient locale. (optional)

string

Recipient type.

string

Current state of the recipient record.

object[]

Verification records associated with the package.

Show properties

string

Identifier for the verification record.

string

Signer identifier associated with this verification.

boolean

Set to true if the signer is can sign documents after verification.

boolean

Set to true if the signer can join VSR after verification.

boolean

Set to true if the signer may retry verification on failure.

boolean

Set to true if the signer has successfully signed after verification.

boolean

Set to true if the verification is currently locked.

number

Number of verification attempts made.

number

Number of errors encountered during verification.

boolean

Whether the verification flow should continue to next step.

boolean

Whether to continue the flow when verification errors occur.

string

nullable

Current verification error code (if any).

string

Current state of the verification.

Show values

State	Description
not_started	Signer has not started identity verification.
start	Signer is on start step.
consent	Signer is on consent step.
consent_processing	Server is processing consent.
identity	Signer is on identity verification step.
identity_processing	Server is processing identity verification.
kba	Signer is on KBA verification step.
kba_processing	Server is processing KBA verification.
document	Signer is on document verification step.
document_processing	Server is processing document verification.
end	Server is finalizing identity verification result.
passed	Identity verification has passed.
failed	Identity verification has failed and can be retried by signer.
failed_reset	Identity verification has failed and must be reset by package owner for signer to retry.
failed_locked	Identity verification has failed and is now locked and can no longer be reset by package owner.
error	A server error has occurred and can be retried by signer.
error_reset	A server error has occurred and must be reset by package owner for signer to retry.
error_locked	A server error has occurred and can no longer be reset by package owner.
cancelled	Identity verification has been cancelled.
cancelled_reset	Identity verification has been cancelled due to package owner resetting signer’s verification.
invalid	Identity verification is in an invalid state and cannot be processed.

object[]

Consent records associated with the package.4.2

Show properties

Unique identifier for the consent record.

Consent record reused by an automatic acceptance.

string

Organization that owns the consent record.

string

nullable

Member associated with the consent.

string

nullable

Package associated with the consent.

string

nullable

Signer associated with the consent.

string

nullable

Identity verification associated with the consent.

string

nullable

Signing session associated with the consent.

string

nullable

Time the consent was accepted (ISO 8601 date-time).

string

nullable

Time the consent was declined (ISO 8601 date-time).

string

nullable

Time the consent was revoked (ISO 8601 date-time).

string

nullable

IP address from which consent was recorded.

string

Action used to record the consent.

Show values

Value	Version	Description
`auto`	4.2	Consent was reused automatically under the configured policy.
`clicked_consent_button`	4.2	The signer accepted by selecting the consent button.
`clicked_decline_button`	4.2	The signer declined by selecting the decline button.
`checked_consent_checkbox`	4.2	The signer accepted by selecting the consent checkbox.
`on_behalf_of`	4.2	Consent was recorded on behalf of the signer.

string

Base64-encoded SHA-256 version of the consent notice.

object

nullable

Notice presented when consent was recorded.

Show properties

string

nullable

Default notice text.

Map<string, string>

nullable

Notice text keyed by locale code.

string

Consent type.

Show values

Value	Version	Description
`signing`	4.2	Consent to sign documents.
`verification`	4.2	Consent to complete identity verification.
`video_recording`	4.2	Consent to record a Video Signing Room session.

string

Current consent state.

Show values

Value	Version	Description
`required`	4.2	Consent is required and has not yet been accepted or declined.
`accepted`	4.2	Consent was accepted.
`declined`	4.2	Consent was declined.
`revoked`	4.2	Previously accepted consent was revoked.

Getting started

Guides

API

Webhooks

Reference