Skip to content

Latest commit

 

History

History
154 lines (118 loc) · 5.24 KB

File metadata and controls

154 lines (118 loc) · 5.24 KB

DocumentSignerDetails

Properties

Name Type Description Notes
id String [optional]
signerName String [optional]
signerRole String [optional]
signerEmail String [optional]
status StatusEnum [optional]
enableAccessCode Boolean [optional]
isAuthenticationFailed Boolean [optional]
enableEmailOTP Boolean [optional]
authenticationType AuthenticationTypeEnum [optional]
isDeliveryFailed Boolean [optional]
isViewed Boolean [optional]
order Integer [optional]
signerType SignerTypeEnum [optional]
hostEmail String [optional]
hostName String [optional]
isReassigned Boolean [optional]
privateMessage String [optional]
allowFieldConfiguration Boolean [optional]
formFields List<DocumentFormFields> [optional]
language LanguageEnum <p>Description:</p><ul><li><i>0</i> - None</li><li><i>1</i> - English</li><li><i>2</i> - Spanish</li><li><i>3</i> - German</li><li><i>4</i> - French</li><li><i>5</i> - Romanian</li><li><i>6</i> - Norwegian</li><li><i>7</i> - Bulgarian</li><li><i>8</i> - Italian</li><li><i>9</i> - Danish</li><li><i>10</i> - Polish</li><li><i>11</i> - Portuguese</li><li><i>12</i> - Czech</li><li><i>13</i> - Dutch</li><li><i>14</i> - Swedish</li><li><i>15</i> - Russian</li><li><i>16</i> - Japanese</li><li><i>17</i> - Thai</li><li><i>18</i> - SimplifiedChinese</li><li><i>19</i> - TraditionalChinese</li><li><i>20</i> - Korean</li></ul> [optional]
locale LocaleEnum [optional]
signType SignTypeEnum [optional]
groupId String [optional]
phoneNumber PhoneNumber [optional]
idVerification IdVerificationDetails [optional]
recipientNotificationSettings RecipientNotificationSettings [optional]
authenticationRetryCount Integer [optional]
enableQes Boolean [optional]
deliveryMode DeliveryModeEnum [optional]
authenticationSettings SignerAuthenticationSettings [optional]
groupSigners List<GroupSigner> [optional]

Enum: StatusEnum

Name Value
NONE "None"
NOT_COMPLETED "NotCompleted"
COMPLETED "Completed"
DECLINED "Declined"
REVOKED "Revoked"
EXPIRED "Expired"

Enum: AuthenticationTypeEnum

Name Value
NONE "None"
EMAIL_OTP "EmailOTP"
ACCESS_CODE "AccessCode"
SMSOTP "SMSOTP"
ID_VERIFICATION "IdVerification"

Enum: SignerTypeEnum

Name Value
SIGNER "Signer"
REVIEWER "Reviewer"
IN_PERSON_SIGNER "InPersonSigner"

Enum: LanguageEnum

Name Value
NUMBER_0 0
NUMBER_1 1
NUMBER_2 2
NUMBER_3 3
NUMBER_4 4
NUMBER_5 5
NUMBER_6 6
NUMBER_7 7
NUMBER_8 8
NUMBER_9 9
NUMBER_10 10
NUMBER_11 11
NUMBER_12 12
NUMBER_13 13
NUMBER_14 14
NUMBER_15 15
NUMBER_16 16
NUMBER_17 17
NUMBER_18 18
NUMBER_19 19
NUMBER_20 20

Enum: LocaleEnum

Name Value
EN "EN"
NO "NO"
FR "FR"
DE "DE"
ES "ES"
BG "BG"
CS "CS"
DA "DA"
IT "IT"
NL "NL"
PL "PL"
PT "PT"
RO "RO"
RU "RU"
SV "SV"
DEFAULT "Default"
JA "JA"
TH "TH"
ZH_CN "ZH_CN"
ZH_TW "ZH_TW"
KO "KO"

Enum: SignTypeEnum

Name Value
SINGLE "Single"
GROUP "Group"

Enum: DeliveryModeEnum

Name Value
EMAIL "Email"
SMS "SMS"
EMAIL_AND_SMS "EmailAndSMS"
WHATS_APP "WhatsApp"