module:model/SealSign

module:model/SealSign

new module:model/SealSign()

Source:

Constructs a new SealSign.
Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow. Example: json \"recipients\": { \"seals\": [ { \"recipientId\": \"1\", \"routingOrder\" : 1, \"recipientSignatureProviders\": [ { \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\" } ] } ] }, . . . For more information about Electronic Seals, see Apply Electronic Seals to Your Documents.

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) accessCodeMetadata :module:model/PropertyMetadata

Source:

Not applicable.

Type:

(inner) addAccessCodeToEmail :String

Source:

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.

Type:
  • String

(inner) allowSystemOverrideForLockedRecipient :String

Source:
Type:
  • String

(inner) autoRespondedReason :String

Source:
Type:
  • String

(inner) bulkSendV2Recipient :String

Source:
Type:
  • String

(inner) clientUserId :String

Source:

Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Note that if the ClientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.

Type:
  • String

(inner) completedCount :String

Source:
Type:
  • String

(inner) customFields :Array.<String>

Source:

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

Type:
  • Array.<String>

(inner) declinedDateTime :String

Source:

The date and time the recipient declined the document.

Type:
  • String

(inner) declinedReason :String

Source:

The reason the recipient declined the document.

Type:
  • String

(inner) deliveredDateTime :String

Source:

Reserved: For DocuSign use only.

Type:
  • String

(inner) deliveryMethod :String

Source:

Reserved: For DocuSign use only.

Type:
  • String

(inner) deliveryMethodMetadata :module:model/PropertyMetadata

Source:

Reserved for DocuSign.

Type:

(inner) designatorId :String

Source:
Type:
  • String

(inner) designatorIdGuid :String

Source:
Type:
  • String

(inner) documentVisibility :Array.<module:model/DocumentVisibility>

Source:
Type:

(inner) emailNotification :module:model/RecipientEmailNotification

Source:

A complex type that contains information sets the language of the recipient's email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and EmailBlurb property settings.

Type:

(inner) embeddedRecipientStartURL :String

Source:

Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

Type:
  • String

(inner) errorDetails :module:model/ErrorDetails

Source:

Array or errors.

Type:

(inner) faxNumber :String

Source:

Reserved:

Type:
  • String

(inner) faxNumberMetadata :module:model/PropertyMetadata

Source:

Reserved for DocuSign.

Type:

(inner) idCheckConfigurationName :String

Source:

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node.

Type:
  • String

(inner) idCheckConfigurationNameMetadata :module:model/PropertyMetadata

Source:

Not applicable.

Type:

(inner) idCheckInformationInput :module:model/IdCheckInformationInput

Source:

Not applicable.

Type:

(inner) identityVerification :module:model/RecipientIdentityVerification

Source:

Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other recipient authentication methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).

Type:

(inner) inheritEmailNotificationConfiguration :String

Source:

When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.

Type:
  • String

(inner) lockedRecipientPhoneAuthEditable :String

Source:
Type:
  • String

(inner) lockedRecipientSmsEditable :String

Source:
Type:
  • String

(inner) name :String

Source:
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) noteMetadata :module:model/PropertyMetadata

Source:

Not applicable.

Type:

(inner) phoneAuthentication :module:model/RecipientPhoneAuthentication

Source:

Not applicable.

Type:

(inner) recipientAttachments :Array.<module:model/RecipientAttachment>

Source:

Reserved:

Type:

(inner) recipientAuthenticationStatus :module:model/AuthenticationStatus

Source:

Not applicable.

Type:

(inner) recipientFeatureMetadata :Array.<module:model/FeatureAvailableMetadata>

Source:
Type:

(inner) recipientId :String

Source:

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Type:
  • String

(inner) recipientIdGuid :String

Source:
Type:
  • String

(inner) recipientSignatureProviders :Array.<module:model/RecipientSignatureProvider>

Source:
Type:

(inner) recipientType :String

Source:
Type:
  • String

(inner) recipientTypeMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the recipientType property is editable. This property is read-only.

Type:

(inner) requireIdLookup :String

Source:

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

Type:
  • String

(inner) requireIdLookupMetadata :module:model/PropertyMetadata

Source:

Not applicable.

Type:

(inner) roleName :String

Source:

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

Type:
  • String

(inner) routingOrder :String

Source:

Specifies the routing order of the recipient in the envelope.

Type:
  • String

(inner) routingOrderMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the routingOrder property is editable. This property is read-only.

Type:

(inner) sentDateTime :String

Source:

The date and time the envelope was sent.

Type:
  • String

(inner) signedDateTime :String

Source:

Reserved: For DocuSign use only.

Type:
  • String

(inner) smsAuthentication :module:model/RecipientSMSAuthentication

Source:

Not applicable.

Type:

(inner) socialAuthentications :Array.<module:model/SocialAuthentication>

Source:

Lists the social ID type that can be used for recipient authentication.

Type:

(inner) status :String

Source:

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Type:
  • String

(inner) statusCode :String

Source:
Type:
  • String

(inner) suppressEmails :String

Source:
Type:
  • String

(inner) tabs :module:model/Tabs

Source:

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

Type:

(inner) templateLocked :String

Source:

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

Type:
  • String

(inner) templateRequired :String

Source:

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

Type:
  • String

(inner) totalTabCount :String

Source:
Type:
  • String

(inner) userId :String

Source:
Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/SealSign}

Source:

Constructs a SealSign 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/SealSign

Optional instance to populate.
Returns:

The populated SealSign instance.

Type
module:model/SealSign