| email |
String |
The signer's email address. Used for notifications and as the signing identity. |
[default to null] |
| name |
String |
The signer's display name as it will appear in the signing ceremony and audit trail. |
[default to null] |
| phone |
String |
The signer's phone number in E.164 format (e.g., "+15125551234"). Required when AuthMethod is Sms. |
[optional] [default to null] |
| type |
String |
The signer's role in the package. Valid values: `Signer` (default), `CarbonCopy` (receives a copy but does not sign), `Approver` (must approve before signers proceed; their denial is terminal — sender clones the package to retry), `CertifiedDelivery` (must acknowledge receipt; no fields), `InPersonSigner` (signs in person using a shared device). |
[optional] [default to null] |
| routingOrder |
Integer |
The signer's position in the signing sequence (1-based). When the package has `EnforceSigningOrder` enabled, signers with lower routing orders are notified first. Signers sharing the same routing order are notified simultaneously. Defaults to 1. |
[optional] [default to null] |
| authMethod |
String |
The primary authentication method the signer must pass before signing. Valid values: `Email` (default, link-based), `AccessCode` (shared secret), `Sms` (one-time code via SMS), `Kba` (knowledge-based authentication quiz, consumes auth credits), `IdVerification` (government ID + selfie verification, consumes auth credits). |
[optional] [default to null] |
| accessCode |
String |
A shared secret the signer must enter to access the signing ceremony. Required when AuthMethod is `AccessCode`. You must communicate this code to the signer out-of-band. |
[optional] [default to null] |
| clientUserId |
String |
An identifier from your system that marks this signer for embedded signing. When set, the signer will NOT receive email notifications; instead, use the `GetSigningUrl` endpoint to generate a URL you present in your own UI. The value can be any string unique within this package (e.g., your internal user ID). |
[optional] [default to null] |
| signingGroupId |
UUID |
The GUID of a signing group to associate this signer with. Signing groups allow any member of the group to sign on behalf of the group. The group must be created separately via the signing groups API. |
[optional] [default to null] |
| paymentAmount |
Double |
The payment amount this signer must pay before signing, in the package's payment currency. Only applicable when the package has `RequiresPayment` enabled. The amount is collected via Stripe during the signing ceremony. |
[optional] [default to null] |
| paymentDescription |
String |
A description of what the payment is for, displayed to the signer on the payment screen (e.g., "Document processing fee"). |
[optional] [default to null] |
| paymentTaxCodeId |
String |
|
[optional] [default to null] |
| maxKbaAttempts |
Integer |
Maximum number of KBA quiz attempts allowed before the signer is locked out. Each attempt consumes one auth credit. When null, the system default is used. Only applicable when AuthMethod is `Kba` or `RequiredAuthMethods` includes `Kba`. |
[optional] [default to null] |
| requiredAuthMethods |
List |
A list of authentication methods the signer must complete sequentially (stacked authentication). Each method in the list is verified one after another during the signing ceremony. Valid values per entry: `Email`, `AccessCode`, `Sms`, `Kba`, `IdVerification`. When specified, this overrides the single `AuthMethod` field. Credit-consuming methods (Kba, IdVerification) each consume credits independently. |
[optional] [default to null] |
| externalReferenceId |
String |
|
[optional] [default to null] |
| metadata |
String |
|
[optional] [default to null] |
