string
Unique identifier for the package.
string
Unique identifier for the organization.
string
Unique identifier for the member who owns the package.
string
Name of the package.
string
Date by which the package should be signed (ISO 8601 format).
string
Type of the package.
Show values
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
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. |
object
External data associated with the package.
boolean
Set to
true if all documents have been signed by all signers.object[]
List of documents in the package.
Show properties
Show properties
string
Unique identifier for the package.
string
Unique identifier for the document.
string
Unique identifier for the file associated with the document.
string
External system identifier for the document, if available.
string
Name of the document.
string
File name of the document.
number
Order of the document in the package.
boolean
Set to
true if document has been signed by all signers.object[]
List of revisions for the document.
Show Properties
Show Properties
string
Unique identifier for the package.
string
Unique identifier for the document.
string
Unique identifier for the revision.
string
Unique identifier for the signer.
string
Link for signer to sign their revision of document.
boolean
Set to
true if signer is next signer in sequential signing.boolean
Set to
true if signer has signed their revision of document.object[]
List of signers for the package.
Show properties
Show properties
string
Unique identifier for the signer.
string
First name of the signer.
string
Last name of the signer.
string
Email address of the signer.
string
Mobile number of the signer.
number
Order of the signer in the signing process.
object[]
List of signing links for the signer.
Show properties
Show properties
string
Token for the signing link.
string
Unique identifier for the package.
string
Unique identifier for the document.
string
Unique identifier for the revision.
string
Name of document.
string
Link for signer to sign their revision of document.
string
Time link expires (ISO 8601 format).
string
Link type.
boolean
Set to
true if signer is next signer in sequential signing.boolean
Set to
true if signer has signed their revision of document.