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.
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.
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. |
