UpdateSignerApiRequest

Properties

Name Type Description Notes
email String The signer's updated email address. Null to keep the current value. [optional] [default to null]
name String The signer's updated display name. Null to keep the current value. [optional] [default to null]
phone String The signer's updated phone number in E.164 format. Required if switching AuthMethod to Sms. [optional] [default to null]
type String The signer's updated role. Valid values: `Signer`, `CarbonCopy`, `Approver`, `CertifiedDelivery`, `InPersonSigner`. Null to keep the current value. [optional] [default to null]
routingOrder Integer The signer's updated routing order position. Null to keep the current value. [optional] [default to null]
authMethod String The signer's updated authentication method. Valid values: `Email`, `AccessCode`, `Sms`, `Kba`, `IdVerification`. Null to keep the current value. [optional] [default to null]
accessCode String The updated access code for AccessCode authentication. Null to keep the current value. [optional] [default to null]
clientUserId String An identifier from your system for embedded signing. See CreateSignerApiRequest.ClientUserId for details. [optional] [default to null]
signingGroupId UUID The updated signing group GUID. Null leaves the current value unchanged; `Guid.Empty` (00000000-0000-0000-0000-000000000000) clears the group assignment (use when switching a group signer back to an individual signer). [optional] [default to null]
paymentAmount Double The updated payment amount for this signer. Null to keep the current value. [optional] [default to null]
paymentDescription String The updated payment description. Null to keep the current value. [optional] [default to null]
paymentTaxCodeId String [optional] [default to null]
maxKbaAttempts Integer The updated maximum KBA attempts. Null to keep the current value. See CreateSignerApiRequest.MaxKbaAttempts for details. [optional] [default to null]
requiredAuthMethods List The updated list of stacked authentication methods. See CreateSignerApiRequest.RequiredAuthMethods for details. [optional] [default to null]
externalReferenceId String [optional] [default to null]
metadata String [optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]