curl --request GET \
--url https://sandbox.syngrafii.com/api/v1/packages/{packageId} \
--header 'api_key: <api-key>'{
"packageId": "<string>",
"organizationId": "<string>",
"memberId": "<string>",
"teamId": "<string>",
"folderId": "<string>",
"shared": true,
"meetingId": "<string>",
"templateId": "<string>",
"formId": "<string>",
"keyId": "<string>",
"name": "<string>",
"category": "<string>",
"clientNumber": "<string>",
"matterNumber": "<string>",
"description": "<string>",
"message": "<string>",
"rescindMessage": "<string>",
"reminderMessage": "<string>",
"timeCreated": "<string>",
"timeReminder": "<string>",
"timeRetention": "<string>",
"timeRescinded": "<string>",
"timeDeleted": "<string>",
"timeSignBy": "<string>",
"timeLastModified": "<string>",
"options": {},
"hasSecurityPassphrase": true,
"locale": "<string>",
"timeZone": "<string>",
"format": {
"locale": "<string>"
},
"revisionsSigned": 123,
"revisionsCount": 123,
"restrictedType": "<string>",
"api": true,
"type": "<string>",
"state": "<string>",
"externalData": {},
"version": "<string>",
"meeting": {
"meetingId": "<string>",
"organizationId": "<string>",
"packageId": "<string>",
"timeStart": "<string>",
"duration": "<string>",
"isPrivate": true,
"type": "<string>",
"state": "<string>"
},
"documents": [
{
"documentId": "<string>",
"packageId": "<string>",
"fileId": "<string>",
"autoTemplateId": "<string>",
"autoTemplateDocumentId": "<string>",
"externalId": "<string>",
"index": 123,
"name": "<string>",
"fileName": "<string>",
"fileType": "<string>",
"fileSize": 123,
"numberPages": 123,
"timeUploaded": "<string>",
"timeLastModified": "<string>",
"revisionsSigned": 123,
"revisionsCount": 123,
"description": "<string>",
"cac": true,
"cacPages": 123,
"state": "<string>",
"revisions": [
{
"documentId": "<string>",
"revisionId": "<string>",
"revisionNumber": 123,
"revisionBeforeId": "<string>",
"timeLastOpened": "<string>",
"signerId": "<string>",
"isSigned": true,
"timeSigned": "<string>",
"address": "<string>",
"latitude": "<string>",
"longitude": "<string>",
"state": "<string>"
}
],
"signers": [
{
"signerId": "<string>",
"signerKey": "<string>",
"name": "<string>",
"initials": "<string>",
"email": "<string>",
"mobileNumber": "<string>",
"hasSigned": true,
"isNext": true,
"templateRole": "<string>"
}
]
}
],
"signers": [
{
"signerId": "<string>",
"packageId": "<string>",
"memberId": "<string>",
"signerTag": "<string>",
"timeCreated": "<string>",
"timeDeclined": "<string>",
"timeUpdated": "<string>",
"index": 123,
"locale": "<string>",
"signCac": true,
"verify": true,
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumberCountryCode": "<string>",
"mobileNumberOriginal": "<string>",
"mobileNumber": "<string>",
"declineMessage": "<string>",
"declineReason": "<string>",
"next": true,
"revisionsSigned": 123,
"revisionsCount": 123,
"role": "<string>",
"type": "<string>",
"state": "<string>",
"verification": {
"verificationId": "<string>",
"signerId": "<string>",
"canSign": true,
"canJoin": true,
"canRetry": true,
"hasSigned": true,
"isLocked": true,
"attempts": 123,
"errors": 123,
"continue": true,
"continueOnError": true,
"error": "<string>",
"state": "<string>"
}
}
],
"recipients": [
{
"recipientId": "<string>",
"packageId": "<string>",
"timeCreated": "<string>",
"timeUpdated": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumberCountryCode": "<string>",
"mobileNumberOriginal": "<string>",
"mobileNumber": "<string>",
"locale": "<string>",
"type": "<string>",
"state": "<string>"
}
],
"verifications": [
{
"verificationId": "<string>",
"signerId": "<string>",
"canSign": true,
"canJoin": true,
"canRetry": true,
"hasSigned": true,
"isLocked": true,
"attempts": 123,
"errors": 123,
"continue": true,
"continueOnError": true,
"error": "<string>",
"state": "<string>"
}
]
}/packages/{packageId} endpoint allows you to retrieve detailed information about a specific package by its unique identifier.
GET /packages/{packageId}
true if the package is shared.Show properties
Show properties
state query string parameter appended to the returnUrl.concurrent)Sequential)Counterparts)Hide values
| Value | Description |
|---|---|
| none | Do not flatten fields |
| filled | Flatten only fields filled by signer |
| all | Flatten all fields default |
#0000FF for Ink to Sign signatures and initials with a valid #-hexadecimal RGB color value.
2.10Hide values
| Value | Description |
|---|---|
| touch_to_sign | iink It |
| type_to_sign | Type It |
| click_to_sign | Accept It |
Hide values
| Value | Description |
|---|---|
| keep | Leave unused tags in document |
| hide | Move unused tags to hidden layer |
| remove | Remove unused tags default |
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 |
{
"options": {
"securityPassphrase": true,
...
},
"securityPassphrase": "mySecretPassphrase"
}
Accept It.Type It.Ink It.Counterparts Send document executed notification TO package owner and CC signer.
1.10Show properties
Show properties
required must also be set to true)required must also be set to true)required must also be set to true)required must also be set to true)Show properties
Show properties
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 |
true if the package is protected by a security passphrase.Show properties
true if the package was created via the API.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. |
Show values
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. |
Show properties
true if the meeting is private.Show values
| Value | Description |
|---|---|
| scheduled | Scheduled meeting. |
| rescheduled | Rescheduled meeting. |
| cancelled | Cancelled meeting. |
Show properties
true if a CAC (Compliance Audit Certificate) has been appended to the document.cac is true.Show values
| Values | Description |
|---|---|
| open | The document is open and can be interacted with. |
| failed | The document failed to process and cannot be signed. |
Show properties
true if this revision has been signed.Show properties
true if the signer has signed this document.true if this signer is next in the signing order for this document.Show properties
true if signer requires CAC signing.true if signer requires identity verification before signing.true if this signer is next in signing order across the package.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 |
Show values
| Value | Description |
|---|---|
| signer | Signer |
| guest | Signer that was added by the host during VSR or In Person signing session |
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. |
Show properties
true if the signer is can sign documents after verification.true if the signer can join VSR after verification.true if the signer may retry verification on failure.true if the signer has successfully signed after verification.true if the verification is currently locked.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. |
Show properties
Show properties
true if the signer is can sign documents after verification.true if the signer can join VSR after verification.true if the signer may retry verification on failure.true if the signer has successfully signed after verification.true if the verification is currently locked.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. |
curl --request GET \
--url https://sandbox.syngrafii.com/api/v1/packages/{packageId} \
--header 'api_key: <api-key>'{
"packageId": "<string>",
"organizationId": "<string>",
"memberId": "<string>",
"teamId": "<string>",
"folderId": "<string>",
"shared": true,
"meetingId": "<string>",
"templateId": "<string>",
"formId": "<string>",
"keyId": "<string>",
"name": "<string>",
"category": "<string>",
"clientNumber": "<string>",
"matterNumber": "<string>",
"description": "<string>",
"message": "<string>",
"rescindMessage": "<string>",
"reminderMessage": "<string>",
"timeCreated": "<string>",
"timeReminder": "<string>",
"timeRetention": "<string>",
"timeRescinded": "<string>",
"timeDeleted": "<string>",
"timeSignBy": "<string>",
"timeLastModified": "<string>",
"options": {},
"hasSecurityPassphrase": true,
"locale": "<string>",
"timeZone": "<string>",
"format": {
"locale": "<string>"
},
"revisionsSigned": 123,
"revisionsCount": 123,
"restrictedType": "<string>",
"api": true,
"type": "<string>",
"state": "<string>",
"externalData": {},
"version": "<string>",
"meeting": {
"meetingId": "<string>",
"organizationId": "<string>",
"packageId": "<string>",
"timeStart": "<string>",
"duration": "<string>",
"isPrivate": true,
"type": "<string>",
"state": "<string>"
},
"documents": [
{
"documentId": "<string>",
"packageId": "<string>",
"fileId": "<string>",
"autoTemplateId": "<string>",
"autoTemplateDocumentId": "<string>",
"externalId": "<string>",
"index": 123,
"name": "<string>",
"fileName": "<string>",
"fileType": "<string>",
"fileSize": 123,
"numberPages": 123,
"timeUploaded": "<string>",
"timeLastModified": "<string>",
"revisionsSigned": 123,
"revisionsCount": 123,
"description": "<string>",
"cac": true,
"cacPages": 123,
"state": "<string>",
"revisions": [
{
"documentId": "<string>",
"revisionId": "<string>",
"revisionNumber": 123,
"revisionBeforeId": "<string>",
"timeLastOpened": "<string>",
"signerId": "<string>",
"isSigned": true,
"timeSigned": "<string>",
"address": "<string>",
"latitude": "<string>",
"longitude": "<string>",
"state": "<string>"
}
],
"signers": [
{
"signerId": "<string>",
"signerKey": "<string>",
"name": "<string>",
"initials": "<string>",
"email": "<string>",
"mobileNumber": "<string>",
"hasSigned": true,
"isNext": true,
"templateRole": "<string>"
}
]
}
],
"signers": [
{
"signerId": "<string>",
"packageId": "<string>",
"memberId": "<string>",
"signerTag": "<string>",
"timeCreated": "<string>",
"timeDeclined": "<string>",
"timeUpdated": "<string>",
"index": 123,
"locale": "<string>",
"signCac": true,
"verify": true,
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumberCountryCode": "<string>",
"mobileNumberOriginal": "<string>",
"mobileNumber": "<string>",
"declineMessage": "<string>",
"declineReason": "<string>",
"next": true,
"revisionsSigned": 123,
"revisionsCount": 123,
"role": "<string>",
"type": "<string>",
"state": "<string>",
"verification": {
"verificationId": "<string>",
"signerId": "<string>",
"canSign": true,
"canJoin": true,
"canRetry": true,
"hasSigned": true,
"isLocked": true,
"attempts": 123,
"errors": 123,
"continue": true,
"continueOnError": true,
"error": "<string>",
"state": "<string>"
}
}
],
"recipients": [
{
"recipientId": "<string>",
"packageId": "<string>",
"timeCreated": "<string>",
"timeUpdated": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"mobileNumberCountryCode": "<string>",
"mobileNumberOriginal": "<string>",
"mobileNumber": "<string>",
"locale": "<string>",
"type": "<string>",
"state": "<string>"
}
],
"verifications": [
{
"verificationId": "<string>",
"signerId": "<string>",
"canSign": true,
"canJoin": true,
"canRetry": true,
"hasSigned": true,
"isLocked": true,
"attempts": 123,
"errors": 123,
"continue": true,
"continueOnError": true,
"error": "<string>",
"state": "<string>"
}
]
}