new module:model/BulkRecipient()
- Source:
Constructs a new BulkRecipient.
Members
(inner) accessCode :String
- Source:
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer accessCode property is set in the envelope, then that value is used. If blank and the signer accessCode property is not set, then the access code is not required.
Type:
- String
(inner) email :String
- Source:
Specifies the recipient's email address. Maximum length: 100 characters.
Type:
- String
(inner) errorDetails :Array.<module:model/ErrorDetails>
- Source:
Array or errors.
Type:
- Array.<module:model/ErrorDetails>
(inner) identification :String
- Source:
Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field. The acceptable values are: * KBA: Enables the normal ID check authentication set up for your account. * Phone: Enables phone authentication. * SMS: Enables SMS authentication.
Type:
- String
(inner) name :String
- Source:
Specifies the recipient's name. Maximum length: 50 characters.
Type:
- String
(inner) note :String
- Source:
Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
Type:
- String
(inner) phoneNumber :String
- Source:
This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number. If usersupplied is used, the signer supplies his or her own telephone number.
Type:
- String
(inner) recipientSignatureProviderInfo :Array.<module:model/BulkRecipientSignatureProvider>
- Source:
Type:
(inner) rowNumber :String
- Source:
Type:
- String
(inner) tabLabels :Array.<module:model/BulkRecipientTabLabel>
- Source:
Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of tabLabel columns can be added to the bulk recipient file. The information used in the bulk recipient file header must be the same as the tabLabel for the tab. The values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row. Note that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.
Type:
Methods
(static) constructFromObject(data, obj) → {module:model/BulkRecipient}
- Source:
Constructs a BulkRecipient from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/BulkRecipient | Optional instance to populate. |
Returns:
The populated BulkRecipient instance.