| id |
UUID |
The unique identifier of the signer. |
[default to null] |
| email |
String |
The signer's email address. |
[default to null] |
| name |
String |
The signer's display name. |
[default to null] |
| type |
String |
The signer's role. One of: Signer, CarbonCopy, Approver, CertifiedDelivery, InPersonSigner. |
[default to null] |
| routingOrder |
Integer |
The signer's position in the signing sequence (1-based). |
[default to null] |
| status |
String |
The signer's current status. One of: Pending, Sent, Viewed, InProgress, Completed, Declined, Voided. |
[default to null] |
| authMethod |
String |
The primary authentication method configured for this signer. One of: Email, AccessCode, Sms, Kba, IdVerification. |
[default to null] |
| isEmbedded |
Boolean |
True if this signer was created with a ClientUserId for embedded signing (no email notifications sent). |
[default to null] |
| signingGroupId |
UUID |
The signing group GUID if this signer belongs to a signing group; otherwise null. |
[default to null] |
| phoneForSms |
String |
The phone number on file for SMS-based authentication, if applicable. |
[default to null] |
| roleName |
String |
The display role name shown in the signing ceremony UI (e.g., "Buyer", "Seller"). |
[default to null] |
| viewedOn |
Date |
When the signer first viewed the signing ceremony. Null if not yet viewed. |
[default to null] |
| completedOn |
Date |
When the signer completed signing. Null if not yet completed. |
[default to null] |
| createdOn |
Date |
When the signer record was created. |
[default to null] |
| declinedOn |
Date |
When the signer declined to sign. Null if the signer has not declined. |
[optional] [default to null] |
| declineReason |
String |
The reason the signer provided when declining. Null if the signer has not declined. |
[optional] [default to null] |
| remindersSentCount |
Integer |
The total number of reminder emails sent to this signer. |
[optional] [default to 0] |
| lastReminderSentOn |
Date |
When the most recent reminder email was sent. Null if no reminders have been sent. |
[optional] [default to null] |
| isPayer |
Boolean |
True if this signer is required to make a payment before signing. |
[optional] [default to false] |
| paymentAmount |
Double |
The payment amount this signer must pay, in the package's payment currency. |
[optional] [default to null] |
| paymentDescription |
String |
The payment description shown to the signer on the payment screen. |
[optional] [default to null] |
| paymentTaxCodeId |
String |
|
[optional] [default to null] |
| maxKbaAttempts |
Integer |
The maximum number of KBA quiz attempts allowed. Null if KBA is not configured. |
[optional] [default to null] |
| kbaStatus |
String |
The KBA authentication status. One of: Pending, Passed, Failed, Exhausted. Null if KBA is not configured. |
[optional] [default to null] |
| kbaAttemptsUsed |
Integer |
The number of KBA quiz attempts the signer has used so far. |
[optional] [default to null] |
| kbaExhausted |
Boolean |
True if the signer has exhausted all allowed KBA attempts and is locked out. |
[optional] [default to false] |
| idvStatus |
String |
The ID verification status. One of: Pending, Passed, Failed, Exhausted. Null if IDV is not configured. |
[optional] [default to null] |
| idvAttemptCount |
Integer |
The number of ID verification attempts the signer has made. |
[optional] [default to null] |
| idvPassedAt |
Date |
When ID verification was successfully passed. Null if not yet passed. |
[optional] [default to null] |
| idvVerifiedNameOnId |
String |
The full name as read from the signer's verified government ID. |
[optional] [default to null] |
| idvVerifiedDocumentType |
String |
The type of government ID document that was verified (e.g., "Passport", "DriversLicense"). |
[optional] [default to null] |
| idvVerifiedDocumentNumberLast4 |
String |
The last 4 characters of the verified government ID document number. |
[optional] [default to null] |
| idvVerifiedIssuingAuthority |
String |
The issuing authority of the verified government ID (e.g., state, country). |
[optional] [default to null] |
| idvVerifiedExpiration |
String |
The expiration date of the verified government ID. |
[optional] [default to null] |
| idvVerifiedSelfieMatch |
Boolean |
Whether the selfie matched the photo on the government ID. Null if selfie check was not performed. |
[optional] [default to null] |
| idvVerifiedCountry |
String |
The country code from the verified government ID (ISO 3166-1 alpha-2). |
[optional] [default to null] |
| idvVerifiedSubdivision |
String |
The state or subdivision code from the verified government ID (ISO 3166-2). |
[optional] [default to null] |
| idvNameMismatch |
Boolean |
True if the name on the government ID does not match the signer's name on the package. |
[optional] [default to false] |
| idvMaxAttempts |
Integer |
The maximum number of ID verification attempts allowed before lockout. |
[optional] [default to 1] |
| accessCodeFailedAttempts |
Integer |
The number of failed access code entry attempts. |
[optional] [default to 0] |
| accessCodeMaxAttempts |
Integer |
The maximum number of access code attempts allowed before lockout. |
[optional] [default to 5] |
| accessCodeLocked |
Boolean |
True if the signer is locked out due to exceeding the maximum access code attempts. |
[optional] [default to false] |
| smsOtpSendCount |
Integer |
The number of SMS one-time-password messages sent to this signer. |
[optional] [default to 0] |
| smsOtpTotalFailedAttempts |
Integer |
The total number of failed SMS OTP verification attempts. |
[optional] [default to 0] |
| requiredAuthMethods |
List |
The list of authentication methods this signer must complete in order (stacked auth). Null if single-method auth is used. |
[optional] [default to null] |
| completedAuthMethods |
List |
The list of authentication methods this signer has already completed. Null or empty if none completed yet. |
[optional] [default to null] |
| externalReferenceId |
String |
|
[optional] [default to null] |
| metadata |
String |
|
[optional] [default to null] |
| modifiedOn |
Date |
|
[optional] [default to null] |
