> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iinkedsign.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Add
The `/packages/add` endpoint allows you to create a new package within the application.
A package typically contains one or more documents and signers who are required to review and sign those documents.
In production it is recommended to upload files using the [Files upload API](/v4/api/files/upload) and reference them by `fileId` when adding your documents to a package.
## Request
```http Request highlight={4} theme={null}
POST /packages/add
{
"name": "New Package",
"type": "concurrent",
"signers": [
{
"firstName": "Signer",
"lastName": "One",
"email": "signer.one@example.com"
}
],
"documents": [
{
"fileName": "agreement.pdf",
"fileId": "d29e25e0-624b-4adb-b118-19c4d0125e5e"
}
]
}
```
```http Request highlight={4} theme={null}
POST /packages/add
{
"name": "New Package",
"type": "Sequential",
"signers": [
{
"firstName": "Signer",
"lastName": "One",
"email": "signer.one@example.com"
},
{
"firstName": "Signer",
"lastName": "Two",
"email": "signer.two@example.com"
}
],
"documents": [
{
"fileName": "agreement.pdf",
"fileId": "d29e25e0-624b-4adb-b118-19c4d0125e5e"
}
]
}
```
```http Request highlight={4,6-7,14} theme={null}
POST /packages/add
{
"name": "New Package",
"type": "video_closing_room",
"meeting": {
"timeStart": "2024-12-01T15:00:00Z",
"duration": "PT1H"
},
"signers": [
{
"firstName": "Host",
"lastName": "One",
"email": "host.one@example.com",
"role": "host"
},
{
"firstName": "Signer",
"lastName": "One",
"email": "signer.one@example.com",
"role": "signer"
}
{
"firstName": "Signer",
"lastName": "Two",
"email": "signer.two@example.com",
"role": "signer"
}
],
"documents": [
{
"fileName": "agreement.pdf",
"fileId": "d29e25e0-624b-4adb-b118-19c4d0125e5e"
}
]
}
```
When using templating tags in a document for a video signing room the host should be referenced as `{{signer_host:signature_1}}`, and the first signer will be referenced as `{{signer_1:signature_1}}`.
See the [Package options guide](/v4/guides/package-options#video-signing-room) for more information.
```http Request highlight={4,10} theme={null}
POST /packages/add
{
"name": "New Package",
"type": "Live Session",
"signers": [
{
"firstName": "Signer",
"lastName": "Host",
"email": "signer.host@example.com",
"role": "host"
},
{
"firstName": "Signer",
"lastName": "One",
"email": "signer.one@example.com"
}
{
"firstName": "Signer",
"lastName": "Two",
"email": "signer.two@example.com"
}
],
"documents": [
{
"fileName": "agreement.pdf",
"fileId": "d29e25e0-624b-4adb-b118-19c4d0125e5e"
}
]
}
```
When creating an In Person package you need to specify which signer is the host. The host will be the only signer that will receive a notification to sign the package.
### Body
Name of the package.
Description of the package.
Message to be shared with all signers.
Type of package signing workflow.
| 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.
State of the package.
| Value | Description |
| :----- | :------------------------------------------------------------------------------------------------ |
| open | Package is ready for signing, notifications will be sent to signers (if enabled). `default` |
| draft | Package is not ready to be sent and will appear under Drafts. |
| add | Use when embedding the package editor to provide an experience similar to creating a new package. |
| select | Use when embedding the package editor to let users choose a signing workflow type. |
Category of the package.
Client number associated with the package.
Matter number associated with the package.
Date by which the document should be signed. After this date, the package will expire and can no longer be signed unless extended.
If not specified, the default value is 7 days from the current date.
The date should be in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
Details about the meeting associated with the package.
This is only applicable for packages with the `video_closing_room` signing workflow type.
Start time of the meeting in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
Duration of the meeting in ISO 8601 format: `PT1H30M`.
Locale to create the package in.
If not provided, the package will be created in the organization's default locale.
| Value | Description |
| :---- | :---------- |
| en | English |
| fr | français |
| de | Deutsch |
| es | Español |
Member ID to create the package under.
If not provided, the package will be created under the current member.
You require `Sign Editor` or `Package Editor` role to create a package on behalf of another member.
Team ID to create the package under.
If not provided, the package will be created under the given member, or under the current member if none is provided.
Folder ID to create the package under.
If not provided, the package will be created in the root folder.
Set to `true` to return links for integrating document signing workflows.
See the [Embed signing guide](/v4/guides/embed-signing) for more information.
Set to `true` to return a link for integrating document editing workflows.
See the [Embed editor guide](/v4/guides/embed-editor) for more information.
Additional options for the package.
Enable embedded signing mode.
Embed options used to customize the embedded package editor.
2.8
User can only save changes to draft packages; the user will not be able to send it.
User will not be allowed to modify package properties.
User will not be allowed to modify package verification properties.
User will not be allowed to modify package signers.
User will not be allowed to modify package documents.
User will not be allowed to modify package properties, verification properties, signers, or documents. They will still be allowed to template each document.
The first document will be focused when the package editor is loaded instead of the package properties.
User will be redirected back to the returnUrl when they are done editing the package.
Will be included in a `state` query string parameter appended to the `returnUrl`.
Show custom brand when signing package.
1.10
Add document identifier to each page (QR code).
Allow VSR participants to review documents before a meeting via a Review Documents link added to email meeting invitation.
2.6
Allow signers to forward the signing to another email address.
4.0
Enabled to not share email addresses between signers.
2.11
Supported in the following package types:
* Concurrent (`concurrent`)
* Sequential (`Sequential`)
* Group Send (`Counterparts`)
Do not allow signers to fill AcroForm fields during signing.
3.3
Do not allow signers to modify AcroForm fields during signing.
3.6
Control how Acroform fields are flattened after signing a document.
2.6
| Value | Description |
| :----- | :----------------------------------- |
| none | Do not flatten fields |
| filled | Flatten only fields filled by signer |
| all | Flatten all fields `default` |
Override the default ink color `#0000FF` for Ink to Sign signatures and initials with a valid #-hexadecimal RGB color value.
2.10
Set preferred default mark type.
4.0
| Value | Description |
| :-------------- | :---------- |
| touch\_to\_sign | iink It |
| type\_to\_sign | Type It |
| click\_to\_sign | Accept It |
Add a retention period to the package to prevent deletion. (ISO 8601 duration)
1.11
Parse document for templating tags. Defaults to true.
Parse merger data templating tags. Defaults to false.
4.0
Control how unused signer tags are handled.
2.6
| Value | Description |
| :----- | :------------------------------- |
| keep | Leave unused tags in document |
| hide | Move unused tags to hidden layer |
| remove | Remove unused tags `default` |
Control which document(s) within a package have the CAC page appended to them.
3.2
| 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 |
When enabled will add a signer identification placeholder for each signer on the CAC page.
3.2
Add a custom disclaimer to the top of the Compliance Audit Certificate.
1.10
Enabled 2FA security code.
All signers will require a valid mobile phone number to enable mobile MFA.
Enabled 2FA security passphrase.
You must also set a passphrase as part of add or update request to enabled 2FA security passphrase.
```json theme={null}
{
"options": {
"securityPassphrase": true,
...
},
"securityPassphrase": "mySecretPassphrase"
}
```
Enable all mark types.
Enabled click to sign `Accept It`.
Enabled type to sign `Type It`.
Enabled touch to sign `Ink It`.
Allows signer to use desktop mouse to draw signature via touch to sign.
Automatically starts video recording after host starts meeting and first attendee joins.
Disables video recording feature preventing host from recording signing session.
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.
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
Set to false to not include signed documents as attachments in executed email notifications.
2.5
Send email notification to owner to confirm package was created.
Send email notification to owner whenever a signer opens a document (limited to once every hour).
Send email notification to each signer when it is their turn to sign.
Send email notification to each signer to notify them that they are waiting their turn to sign.
Send email notification to each signer when Video Signing Room meeting is scheduled.
Include ICS compatible meeting invitation with email notification to schedule meeting date and time in recipients' calendar.
Send email notification to signer after they sign each document.
2.5
For Sequential packages, the next signer notification is only sent after the current signer has signed all of their documents.
3.3
Send email to owner to notify them when all signers have signed each document.
Don't send document executed email until all documents in the package have been fully signed.
3.3
`Counterparts` Send document executed notification TO package owner and CC signer.
1.10
Send signers fully executed document with CAC page appended to end of document.
1.10
Send signers fully executed document without CAC page appended to end of document.
1.10
Send signers separated CAC page as an additional attachment.
1.10
Allow signer to add additional fields while signing documents. Customize signerTools to control what fields the signer can add.
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
Customize signer toolbar options.
Enable sign.
Enable annotations (ink) on mobile devices.
Enable annotations (ink) on desktop.
Enable text.
Enable note.
Enable forms.
Auto highlight form fields.
Enable image.
Request Signers Geolocation while signing documents, joining VSR meetings, performing IDV, and connecting to a mobile signature pad.
Customize how Geolocation is collected.
3.6
Require geolocation to be shared before allowing the signer to continue.
Require geolocation to be shared before the signer can sign documents.
(`required` must also be set to `true`)
Require geolocation to be shared before the signer can use signature pad.
(`required` must also be set to `true`)
Require geolocation to be shared before the signer can join VSR meetings.
(`required` must also be set to `true`)
Require geolocation to be shared before the signer can verify their identity.
(`required` must also be set to `true`)
Enable custom PDF security options.
2.10
Customize PDF security options.
2.10
Allow PDF merge operations.
Allow copying PDF content.
Allow only degraded PDF printing.
Allow PDF AcroForms fields to be filled in (when formFlattening option is not set to "all").
Allow PDF annotations.
Allow PDF editing.
Allow PDF printing.
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.
Set identity verification options.
3.2
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.)
The code of one of our standard Identity Verification Policy to use during signer identity verification.
| 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.
Set package `Remind Me Later` options.
4.0
Number of days, from today, to send a reminder notification to the package owner.
Message that will be sent with the reminder notification to package owner.
List of signers for the package.
Signer's first name.
Signer's last name.
Signer's email. (used to send notifications)
Signer's mobile number. (used for 2FA and mobile signatures)
Role of signer.
| 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 |
Set to `true` to request signer identity verification.
Requires a verification policy to be assigned to package.
Set to `true` to include the signer in the CAC page.
List of recipients for the package.
Recipient's first name.
Recipient's last name.
Recipient's email. (used to send notifications)
Recipient's mobile number. (used for 2FA if enabled)
Type of recipient.
| Value | Description |
| :---- | :------------------------------------------------------------- |
| cc | Recipient that will be **CC** on package email notifications. |
| bcc | Recipient that will be **BCC** on package email notifications. |
List of documents for the package.
Friendly file name shown to signers. (defaults to `fileName` if not specified)
Filename including extension.
Base64 encoding of file.
URL of file. (must be https and publicly accessible)
Unique file ID of an existing file added via [Files upload API](/v4/api/files/upload.mdx).
Either `fileData`, `fileUrl`, or `fileId` is required. We recommend using `fileId` to avoid exceeding per request size limits.
The template collection that will be searched to automatically apply any matching templates.
Use this when you want to utilize auto-templates but do not know the specific template or document to apply. This will look for any matching auto-templates in the specified collection.
The full auto-template code `{templateCode}:{documentCode}` that will be used to automatically apply an existing auto-template document.
Use this when you know the specific auto-template and document you want to apply.
The template document ID to apply to this document.
Use this when you want to apply a specific document template from the template passed via `templateId` in the parent object.
Set of key/value pairs of data used to pre-populate templated fields with. The key must match a unique data ID assigned to a template field.
```json theme={null}
...
"templateData": {
"field1": "value1",
"field2": "value2"
},
...
```
## Response
Unique identifier for the package.
Full package object, returned when `returnPackage` is set to `true` on the request.
Unique identifier for the package.
Unique identifier for the organization that owns the package.
Identifier for the member who created/owns the package.
Team identifier associated with the package. (optional)
Folder identifier where the package is stored. (optional)
Set to `true` if the package is shared.
Current scheduled meeting ID for the package (if applicable).
ID of the template the package was created from (if applicable).
ID of the form the package was created from (if applicable).
ID of the API key used to create the package (if created via API key).
Display name of the package.
Category for the package. (optional)
Client reference number. (optional)
Matter reference number. (optional)
Description of the package. (optional)
Message included when the package was sent. (optional)
Message explaining why the package was rescinded. (optional)
Reminder message for signers. (optional)
Creation time (ISO 8601 date-time).
Reminder time (ISO 8601 date-time).
Retention expiry time (ISO 8601 date-time).
Time the package was rescinded (ISO 8601).
Time the package was deleted (ISO 8601).
Deadline for signing (ISO 8601 date-time).
Last modification time (ISO 8601 date-time).
Package options.
Enable embedded signing mode.
Embed options used to customize the embedded package editor.
2.8
User can only save changes to draft packages; the user will not be able to send it.
User will not be allowed to modify package properties.
User will not be allowed to modify package verification properties.
User will not be allowed to modify package signers.
User will not be allowed to modify package documents.
User will not be allowed to modify package properties, verification properties, signers, or documents. They will still be allowed to template each document.
The first document will be focused when the package editor is loaded instead of the package properties.
User will be redirected back to the returnUrl when they are done editing the package.
Will be included in a `state` query string parameter appended to the `returnUrl`.
Show custom brand when signing package.
1.10
Add document identifier to each page (QR code).
Allow VSR participants to review documents before a meeting via a Review Documents link added to email meeting invitation.
2.6
Allow signers to forward the signing to another email address.
4.0
Enabled to not share email addresses between signers.
2.11
Supported in the following package types:
* Concurrent (`concurrent`)
* Sequential (`Sequential`)
* Group Send (`Counterparts`)
Do not allow signers to fill AcroForm fields during signing.
3.3
Do not allow signers to modify AcroForm fields during signing.
3.6
Control how Acroform fields are flattened after signing a document.
2.6
| Value | Description |
| :----- | :----------------------------------- |
| none | Do not flatten fields |
| filled | Flatten only fields filled by signer |
| all | Flatten all fields `default` |
Override the default ink color `#0000FF` for Ink to Sign signatures and initials with a valid #-hexadecimal RGB color value.
2.10
Set preferred default mark type.
4.0
| Value | Description |
| :-------------- | :---------- |
| touch\_to\_sign | iink It |
| type\_to\_sign | Type It |
| click\_to\_sign | Accept It |
Add a retention period to the package to prevent deletion. (ISO 8601 duration)
1.11
Parse document for templating tags. Defaults to true.
Parse merger data templating tags. Defaults to false.
4.0
Control how unused signer tags are handled.
2.6
| Value | Description |
| :----- | :------------------------------- |
| keep | Leave unused tags in document |
| hide | Move unused tags to hidden layer |
| remove | Remove unused tags `default` |
Control which document(s) within a package have the CAC page appended to them.
3.2
| 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 |
When enabled will add a signer identification placeholder for each signer on the CAC page.
3.2
Add a custom disclaimer to the top of the Compliance Audit Certificate.
1.10
Enabled 2FA security code.
All signers will require a valid mobile phone number to enable mobile MFA.
Enabled 2FA security passphrase.
You must also set a passphrase as part of add or update request to enabled 2FA security passphrase.
```json theme={null}
{
"options": {
"securityPassphrase": true,
...
},
"securityPassphrase": "mySecretPassphrase"
}
```
Enable all mark types.
Enabled click to sign `Accept It`.
Enabled type to sign `Type It`.
Enabled touch to sign `Ink It`.
Allows signer to use desktop mouse to draw signature via touch to sign.
Automatically starts video recording after host starts meeting and first attendee joins.
Disables video recording feature preventing host from recording signing session.
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.
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
Set to false to not include signed documents as attachments in executed email notifications.
2.5
Send email notification to owner to confirm package was created.
Send email notification to owner whenever a signer opens a document (limited to once every hour).
Send email notification to each signer when it is their turn to sign.
Send email notification to each signer to notify them that they are waiting their turn to sign.
Send email notification to each signer when Video Signing Room meeting is scheduled.
Include ICS compatible meeting invitation with email notification to schedule meeting date and time in recipients' calendar.
Send email notification to signer after they sign each document.
2.5
For Sequential packages, the next signer notification is only sent after the current signer has signed all of their documents.
3.3
Send email to owner to notify them when all signers have signed each document.
Don't send document executed email until all documents in the package have been fully signed.
3.3
`Counterparts` Send document executed notification TO package owner and CC signer.
1.10
Send signers fully executed document with CAC page appended to end of document.
1.10
Send signers fully executed document without CAC page appended to end of document.
1.10
Send signers separated CAC page as an additional attachment.
1.10
Allow signer to add additional fields while signing documents. Customize signerTools to control what fields the signer can add.
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
Customize signer toolbar options.
Enable sign.
Enable annotations (ink) on mobile devices.
Enable annotations (ink) on desktop.
Enable text.
Enable note.
Enable forms.
Auto highlight form fields.
Enable image.
Request Signers Geolocation while signing documents, joining VSR meetings, performing IDV, and connecting to a mobile signature pad.
Customize how Geolocation is collected.
3.6
Require geolocation to be shared before allowing the signer to continue.
Require geolocation to be shared before the signer can sign documents.
(`required` must also be set to `true`)
Require geolocation to be shared before the signer can use signature pad.
(`required` must also be set to `true`)
Require geolocation to be shared before the signer can join VSR meetings.
(`required` must also be set to `true`)
Require geolocation to be shared before the signer can verify their identity.
(`required` must also be set to `true`)
Enable custom PDF security options.
2.10
Customize PDF security options.
2.10
Allow PDF merge operations.
Allow copying PDF content.
Allow only degraded PDF printing.
Allow PDF AcroForms fields to be filled in (when formFlattening option is not set to "all").
Allow PDF annotations.
Allow PDF editing.
Allow PDF printing.
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.
Set identity verification options.
3.2
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.)
The code of one of our standard Identity Verification Policy to use during signer identity verification.
| 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.
Set package `Remind Me Later` options.
4.0
Number of days, from today, to send a reminder notification to the package owner.
Message that will be sent with the reminder notification to package owner.
Set to `true` if the package is protected by a security passphrase.
Language/locale for the package.
Time zone for package date/time presentation.
Formatting options for dates and presentation.
Locale code used for formatting. (optional)
Inherits from the package locale if not specified.
Number of signed revisions across package documents.
Total number of revisions across package documents.
Restriction type applied to the package. (optional)
Set to `true` if the package was created via the API.
Package type identifier.
| 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.
Current state of the package.
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. |
Arbitrary external data attached to the package.
Package version or timestamp (ISO 8601).
If the package is scheduled for a meeting, the meeting details.
Unique identifier for the meeting.
Organization associated with the meeting.
Package associated with the meeting.
Meeting start time (ISO 8601 date-time).
Meeting duration (ISO 8601 duration string).
Set to `true` if the meeting is private.
Meeting type identifier.
Current state of the meeting.
| Value | Description |
| :---------- | :------------------- |
| scheduled | Scheduled meeting. |
| rescheduled | Rescheduled meeting. |
| cancelled | Cancelled meeting. |
Documents that belong to the package.
Unique identifier for the document.
Identifier of the package this document belongs to.
Unique identifier for the file associated with the document.
Auto-template identifier (if created from an auto-template).
Auto-template document identifier (if applicable).
External identifier for the document. (optional)
Order/index of the document within the package.
Document display name.
Original filename uploaded.
File extension or type identifier.
Size of the file in bytes.
Number of pages in the document.
Upload time (ISO 8601 date-time).
Last modified time (ISO 8601 date-time).
Number of signed revisions for this document.
Total number of revisions for this document.
Description of the document. (optional)
Set to `true` if a CAC (Compliance Audit Certificate) has been appended to the document.
Number of CAC pages if `cac` is `true`.
Current state of the document.
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. |
Revision history for the document. Typically includes one revision per signer.
ID of the document this revision belongs to.
Unique identifier for the revision.
Revision number (incrementing integer).
Identifier of the previous revision this revision replaced. (optional)
Last opened time for the revision (ISO 8601).
Signer who is associated with this revision.
Set to `true` if this revision has been signed.
Time the revision was signed (ISO 8601).
Address metadata captured on sign. (optional)
Latitude coordinate captured on sign. (optional)
Longitude coordinate captured on sign. (optional)
State of the revision (for example: signed, pending).
Signers associated with this document.
Identifier for the signer associated with the document.
Internal signer key used to map fields/tags.
Full name for the signer on this document.
Signer initials.
Email for the signer on this document.
Mobile number for the signer on this document. (optional)
Set to `true` if the signer has signed this document.
Set to `true` if this signer is next in the signing order for this document.
Template role name if the signer was created from a template role. (optional)
Signers for the package.
Unique identifier for the signer.
Package identifier the signer belongs to.
Member identifier when the signer is an organization member. (optional)
Tag associated with the signer. (optional)
When the signer record was created (ISO 8601).
Time the signer declined (if applicable).
Last update time for the signer record.
Signing order index.
Locale for the signer. (optional)
Set to `true` if signer requires CAC signing.
Set to `true` if signer requires identity verification before signing.
First name of the signer.
Last name of the signer.
Email address for the signer.
Country code for the mobile number. (optional)
Original mobile number provided.
Normalized mobile number (E.164) when available.
Message left by the signer when declining (if any).
Reason code for decline (if applicable).
Set to `true` if this signer is next in signing order across the package.
Number of revisions the signer has signed.
Number of revisions assigned to the signer.
Role of the signer.
| 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 |
Type of signer.
| Value | Description |
| :----- | :------------------------------------------------------------------------ |
| signer | Signer |
| guest | Signer that was added by the host during VSR or In Person signing session |
Current state of the signer.
| 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. |
Signer verification status. (if any)
Identifier for the verification record.
Signer identifier associated with this verification.
Set to `true` if the signer is can sign documents after verification.
Set to `true` if the signer can join VSR after verification.
Set to `true` if the signer may retry verification on failure.
Set to `true` if the signer has successfully signed after verification.
Set to `true` if the verification is currently locked.
Number of verification attempts made.
Number of errors encountered during verification.
Whether the verification flow should continue to next step.
Whether to continue the flow when verification errors occur.
Current verification error code (if any).
Current state of the verification.
| 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. |
Recipients related to the package (additional recipients beyond signers).
Unique identifier for the recipient.
Identifier of the package the recipient belongs to.
Creation time for the recipient record (ISO 8601).
Last update time for the recipient record (ISO 8601).
Recipient first name.
Recipient last name.
Recipient email address.
Recipient mobile number country code. (optional)
Original recipient mobile number provided.
Normalized recipient mobile number. (optional)
Recipient locale. (optional)
Recipient type.
Current state of the recipient record.
Verification records associated with the package.
Identifier for the verification record.
Signer identifier associated with this verification.
Set to `true` if the signer is can sign documents after verification.
Set to `true` if the signer can join VSR after verification.
Set to `true` if the signer may retry verification on failure.
Set to `true` if the signer has successfully signed after verification.
Set to `true` if the verification is currently locked.
Number of verification attempts made.
Number of errors encountered during verification.
Whether the verification flow should continue to next step.
Whether to continue the flow when verification errors occur.
Current verification error code (if any).
Current state of the verification.
| 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. |
List of contacts created during package creation, returned when `addSignersToContacts` is set to `true` on the request.