Skip to main content

emSigner Data Types

This page describes all the Object types defined and used by emSigner Activities.

DocumentWorkflowData

Properties

PropertyTypeDescription
DocumentsList<DocumentData>List of documents that must be signed.
AttachmentsList<Attachment>List of supporting documents.

FlexiformWorkflowData

Properties

PropertyTypeDescription
SignatoriesList<Signatory>List of signatories who must sign this document.
FormDataList<FormField>List of form fields.
AttachmentsList<Attachment>List of supporting documents.

DocumentData

Properties

PropertyTypeDescription
FilePathStringThe document file path.
FileNameStringOptionally specify the display name for this document.
SignatoriesList<SignatoryData>List of signatories who must sign this document.

Document

Properties

PropertyTypeDescription
FilePathStringThe document file path.
FileNameStringOptionally specify the display name for this document.

SignatoryData

Properties

PropertyTypeDescription
SignerTypeSignerTypeThe type of signatory.
NameStringThe name of the signatory.
EmailStringThe email of the signatory.
ModeOfSignatureModesOfSignatureThe mode of signature. Currently, the eSignature option is supported.
ContactNumberStringThe contact number of the signatory.
SigningOrderInt32In case of multiple signatories, specify the signing order for this signatory. This is applicable in the case of the Serial workflow type.
SignaturesList<CoordinateInfo>List of signature placeholders for this signatory inside the document.

Signatory

Properties

PropertyTypeDescription
NameStringThe name of the signatory.
EmailStringThe email of the signatory.
ModeOfSignatureModesOfSignatureThe mode of signature. Currently, the eSignature option is supported.
ContactNumberStringThe contact number of the signatory.
SigningOrderInt32In case of multiple signatories, specify the signing order for this signatory. This is applicable in the case of the Serial workflow type.

Attachment

Properties

PropertyTypeDescription
FilePathStringThe attachment file path.
DescriptionStringThe description for this attachment.

CoordinateInfo

Properties

PropertyTypeDescription
PageStringThe page number enclosed within double quotes.
LeftInt32The relative distance from the document's leftmost position.
BottomInt32The relative distance from the document's bottom-most position.
HeightInt32Optionally, specify the height of the signature box.
WidthInt32Optionally, specify the width of the signature box.

FormField

Properties

PropertyTypeDescription
TagNameStringThe name of the field.
ValueStringThe value to be assigned to this field.

ModesOfSignature

OptionDescription
eSignatureSelect this for eSignature.

SignerType

OptionDescription
ReviewerSelect this if the signatory is a reviewer. The reviewer will not be able to sign the document.
SignerSelect this if the signatory is a signer. Signer can sign the document at one or more locations inside the document.