SigninghubClient

Attributes

FieldsAutoAssignFieldInput module-attribute

FieldsAutoAssignFieldInput = List['AssignFieldRequest']

WorkflowWorkflowAddGroupInput module-attribute

WorkflowWorkflowAddGroupInput = List['WorflowGroupRequest']

WorkflowWorkflowAddPlaceholderInput module-attribute

WorkflowWorkflowAddPlaceholderInput = List['PlaceholderRequest']

WorkflowWorkflowAddUserInput module-attribute

WorkflowWorkflowAddUserInput = List['WorflowUserRequest']

ECCLevelAPI module-attribute

ECCLevelAPI = Literal['L', 'M', 'Q', 'H', 'Default']

EciModeAPI module-attribute

EciModeAPI = Literal['Default', 'Iso8859_1', 'Iso8859_2', 'Utf8']

ValidationRule module-attribute

ValidationRule = Literal['OPTIONAL', 'MANDATORY']

TextboxType module-attribute

TextboxType = Literal['TEXT', 'NAME', 'EMAIL', 'COMPANY', 'JOBTITLE', 'DATE']

FieldType module-attribute

FieldType = Literal['Number', 'Text']

DeliveryMethod module-attribute

DeliveryMethod = Literal['EMAIL', 'SMS', 'EMAIL_AND_SMS']

WorkflowType module-attribute

WorkflowType = Literal['SERIAL', 'INDIVIDUAL', 'PARALLEL', 'CUSTOM']

CertifyPermission module-attribute

CertifyPermission = Literal['NO_CHANGES_ALLOWED', 'FORM_FILLING_ALLOWED', 'FORM_FILLING_WITH_ANNOTATIONS_ALLOWED']

DocumentPackageStatus module-attribute

DocumentPackageStatus = Literal['ALL', 'DRAFT', 'INPROGRESS', 'PENDING', 'SIGNED', 'COMPLETED', 'REVIEWED', 'DECLINED', 'EDITED', 'EXPIRING_IN_SEVEN_DAYS']

DocumentType module-attribute

DocumentType = Literal['ALL', 'PDF', 'DOCX', 'XML']

DocumentOwnedBy module-attribute

DocumentOwnedBy = Literal['ME_OTHERS', 'ME', 'OTHERS']

TemplateSortBy module-attribute

TemplateSortBy = Literal['CREATED_ON', 'NAME', 'DESCRIPTION', 'READ_ONLY', 'IS_PUBLIC']

WorkflowModes module-attribute

WorkflowModes = Literal['ME_AND_OTHERS', 'ONLY_OTHERS', 'ONLY_ME']

CollaboratorRole module-attribute

CollaboratorRole = Literal['SIGNER', 'REVIEWER', 'EDITOR', 'INPERSON_HOST', 'CARBON_COPY', 'ELECTRONIC_SEAL']

WorkflowMode module-attribute

WorkflowMode = Literal['ME_AND_OTHERS', 'ONLY_OTHERS', 'ONLY_ME']

FolderItemSortBy module-attribute

FolderItemSortBy = Literal['TITLE', 'WORKFLOW_TYPE', 'DATE_CREATED', 'LAST_MODIFIED', 'OWNER', 'LOCATION', 'STATUS']

HandSignature module-attribute

HandSignature = Literal[0, 1, 2, 3, 4]

ApiBulkSignAction module-attribute

ApiBulkSignAction = Literal['SHARE', 'SIGN']

ContactSortBy module-attribute

ContactSortBy = Literal['CREATEDON', 'NAME', 'EMAIL']

WorkflowCollaboratorRole module-attribute

WorkflowCollaboratorRole = Literal['SIGNER', 'REVIEWER', 'EDITOR', 'INPERSON_HOST', 'CARBON_COPY']

Classes

EmptyResponse dataclass

EmptyResponse(additional_properties: Dict[str, Any] = dict())

Response for Delete Attachment

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

AttachmentDownloadAttachmentResponse dataclass

AttachmentDownloadAttachmentResponse(additional_properties: Dict[str, Any] = dict())

Response for Download Attachment

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetAttachmentResponse dataclass

GetAttachmentResponse(attachment_id: Optional[int] = None, attachment_name: Optional[str] = None)

Response for Get Attachments

Attributes

attachment_id class-attribute instance-attribute

attachment_id: Optional[int] = None

Attachment id

attachment_name class-attribute instance-attribute

attachment_name: Optional[str] = None

Attachment name

AddAttachmentResponse dataclass

AddAttachmentResponse(attachment_id: Optional[int] = None)

Response for Upload Attachment

Attributes

attachment_id class-attribute instance-attribute

attachment_id: Optional[int] = None

Attachment id

AddFieldResponse dataclass

AddFieldResponse(field_name: Optional[str] = None, created_on: Optional[str] = None)

Response for Add CheckBox Field

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field created in the document.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

Date and time of field creation.

ContactResponse dataclass

ContactResponse(id: Optional[int] = None, user_name: Optional[str] = None, user_email: Optional[str] = None, mobile_number: Optional[str] = None, enterprise: Optional[bool] = None, user_national_id: Optional[str] = None, created_on: Optional[str] = None)

Response for Get Contacts

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

id of the contact.

user_name class-attribute instance-attribute

user_name: Optional[str] = None

User name of the contact.

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email address of the contact.

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number of the contact.

enterprise class-attribute instance-attribute

enterprise: Optional[bool] = None

True, if contact is enterprise.

user_national_id class-attribute instance-attribute

user_national_id: Optional[str] = None

National identity number of the contact

created_on class-attribute instance-attribute

created_on: Optional[str] = None

DateTime when contact is added.

DocumentResponse dataclass

DocumentResponse(package_name: Optional[str] = None)

Response for Delete Document

Attributes

package_name class-attribute instance-attribute

package_name: Optional[str] = None

Document Package name

DocumentsDownloadDocumentBytesResponse dataclass

DocumentsDownloadDocumentBytesResponse(additional_properties: Dict[str, Any] = dict())

Response for Download Document

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

CertifyPolicyResponse dataclass

CertifyPolicyResponse(certify: Optional[CertifyPermissionResponse] = None, lock_form_fields: Optional[bool] = None)

Response for Get Certify Policy for a document

Attributes

lock_form_fields class-attribute instance-attribute

lock_form_fields: Optional[bool] = None

True if forms fields are to be locked in the PDF after the last digital signature on the current document.

DocumentDetailsResponse dataclass

DocumentDetailsResponse(document_id: Optional[int] = None, document_name: Optional[str] = None, document_order: Optional[int] = None, document_type: Optional[str] = None, document_width: Optional[int] = None, document_height: Optional[int] = None, document_source: Optional[str] = None, document_pages: Optional[int] = None, form_fields: Optional[bool] = None, lock_form_fields: Optional[bool] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, certify: Optional[DocumentCertifyResponse] = None, template: Optional[DocumentTemplateResponse] = None)

Response for Get Document Details

Attributes

document_id class-attribute instance-attribute

document_id: Optional[int] = None

ID of the newly created document.

document_name class-attribute instance-attribute

document_name: Optional[str] = None

The name of the document.

document_type class-attribute instance-attribute

document_type: Optional[str] = None

Type of the document e.g. "PDF".

document_width class-attribute instance-attribute

document_width: Optional[int] = None

Width of the document in PDF format.

document_height class-attribute instance-attribute

document_height: Optional[int] = None

Height of the document in PDF format.

document_source class-attribute instance-attribute

document_source: Optional[str] = None

Identifies where the document was uploaded e.g. "My App".

document_pages class-attribute instance-attribute

document_pages: Optional[int] = None

Total pages of the document.

form_fields class-attribute instance-attribute

form_fields: Optional[bool] = None

True if document has form fields.

lock_form_fields class-attribute instance-attribute

lock_form_fields: Optional[bool] = None

True if locking of form fields with the last signature is enabled.

uploaded_on class-attribute instance-attribute

uploaded_on: Optional[str] = None

The date and time when the document was uploaded.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = None

The date and time when the document was last modified.

UploadDocumentLibraryResponse dataclass

UploadDocumentLibraryResponse(document_id: Optional[int] = None, document_name: Optional[str] = None, document_size: Optional[int] = None, document_order: Optional[int] = None, document_type: Optional[str] = None, document_source: Optional[str] = None, document_width: Optional[int] = None, document_height: Optional[int] = None, document_pages: Optional[int] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, form_fields: Optional[bool] = None, lock_form_fields: Optional[bool] = None, certify: Optional[UploadDocumentLibraryCertifyResponse] = None, template: Optional[UploadDocumentLibraryTemplateResponse] = None, package_name: Optional[str] = None, metadata: Optional[UploadDocumentMetaInfoDetail] = None)

Response for Add or Update Document from Library

Attributes

document_id class-attribute instance-attribute

document_id: Optional[int] = None

ID of the newly created document.

document_name class-attribute instance-attribute

document_name: Optional[str] = None

The name of the document.

document_size class-attribute instance-attribute

document_size: Optional[int] = None

Uploaded document size in bytes

document_order class-attribute instance-attribute

document_order: Optional[int] = None

Order of the document

document_type class-attribute instance-attribute

document_type: Optional[str] = None

Type of the document e.g. "PDF".

document_source class-attribute instance-attribute

document_source: Optional[str] = None

Identifies where the document was uploaded e.g. "My App".

document_width class-attribute instance-attribute

document_width: Optional[int] = None

Width of the document in PDF format.

document_height class-attribute instance-attribute

document_height: Optional[int] = None

Height of the document in PDF format.

document_pages class-attribute instance-attribute

document_pages: Optional[int] = None

Total pages of the document.

uploaded_on class-attribute instance-attribute

uploaded_on: Optional[str] = None

The date and time when the document was uploaded.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = None

The date and time when the document was last modified.

form_fields class-attribute instance-attribute

form_fields: Optional[bool] = None

True if document has form fields.

lock_form_fields class-attribute instance-attribute

lock_form_fields: Optional[bool] = None

True if locking of form fields with the last signature is enabled.

package_name class-attribute instance-attribute

package_name: Optional[str] = None

Package name

UploadDocument dataclass

UploadDocument(document_id_2: Optional[int] = None, documentid: Optional[int] = None, document_id: Optional[int] = None, document_name: Optional[str] = None, document_order: Optional[int] = None, document_type: Optional[str] = None, document_source: Optional[str] = None, document_width: Optional[int] = None, document_height: Optional[int] = None, document_pages: Optional[int] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, lock_form_fields: Optional[bool] = None, certify: Optional[CertifyPermissionResponse] = None, document_size: Optional[int] = None, metadata: Optional[UploadDocumentMetaInfoDetail] = None, package_name: Optional[str] = None)

Response for Upload Document

Attributes

document_id_2 class-attribute instance-attribute

document_id_2: Optional[int] = field(default=None, metadata={'wire_name': 'documentId'})

This property is retained for backward compatibility and will be removed in later versions. Use document_id instead.

documentid class-attribute instance-attribute

documentid: Optional[int] = None

The document ID to be used later to share, download and get status of the document. will be removed later document_id will be used

document_id class-attribute instance-attribute

document_id: Optional[int] = None

The document ID to be used later to share, download and get status of the document.

document_name class-attribute instance-attribute

document_name: Optional[str] = None

The name of the document.

document_order class-attribute instance-attribute

document_order: Optional[int] = None

Document order in package

document_type class-attribute instance-attribute

document_type: Optional[str] = None

Type of the document e.g. "PDF".

document_source class-attribute instance-attribute

document_source: Optional[str] = None

Identifies where the document was uploaded e.g. "My App".

document_width class-attribute instance-attribute

document_width: Optional[int] = None

Width of the document in PDF format.

document_height class-attribute instance-attribute

document_height: Optional[int] = None

Height of the document in PDF format.

document_pages class-attribute instance-attribute

document_pages: Optional[int] = None

Total pages of the document.

uploaded_on class-attribute instance-attribute

uploaded_on: Optional[str] = None

The date and time when the document was uploaded.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = None

The date and time when the document was last modified.

lock_form_fields class-attribute instance-attribute

lock_form_fields: Optional[bool] = None

True if locking of form fields with the last signature is enabled.

document_size class-attribute instance-attribute

document_size: Optional[int] = None

Uploaded document size in bytes

package_name class-attribute instance-attribute

package_name: Optional[str] = None

The document package name

EnterpriseAccessResponse dataclass

EnterpriseAccessResponse(authentication: Optional[EnterpriseAuthenticationResponse] = None, authentication_signing: Optional[EnterpriseAuthenticationSigningResponse] = None, access_duration: Optional[PermissionAccessDurationResponse] = None)

Response for Get Workflow User Authentication (Document Opening) of Enterprise Package

AutoPlaceFieldsResponse dataclass

AutoPlaceFieldsResponse(field_name: Optional[str] = None)

Response for AutoPlace Fields

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field that was auto generated by the API.

FieldsResponse dataclass

FieldsResponse(signature: Optional[List[DigitalSignatureFieldResponse]] = None, hand_signature: Optional[List[HandSignatureFieldResponse]] = None, electronic_signature: Optional[List[ElectronicSignatureFieldResponse]] = None, initials: Optional[List[InitialFieldResponse]] = None, in_person_signature: Optional[List[Dict[str, Any]]] = None, text: Optional[List[TextFieldResponse]] = None, radio: Optional[List[RadioFieldResponse]] = None, checkbox: Optional[List[CheckboxFieldResponse]] = None, dropdown: Optional[List[DropdownFieldResponse]] = None, listbox: Optional[List[ListBoxFieldResponse]] = None, qrcode: Optional[List[QrCodeResponse]] = None, attachment: Optional[List[AttachmentFieldResponse]] = None, comment: Optional[List[CommentFieldResponse]] = None, unique_identifier: Optional[List[UniqueIdentifierFieldResponse]] = None)

Response for Get Document Fields

Attributes

signature class-attribute instance-attribute

signature: Optional[List[DigitalSignatureFieldResponse]] = None

A list of all digital signatures in the document.

AddPackageResponse dataclass

AddPackageResponse(package_id: Optional[int] = None, workflow_mode: Optional[str] = None, workflow_type: Optional[str] = None)

Response for Add Package

Attributes

package_id class-attribute instance-attribute

package_id: Optional[int] = None

The package ID to be used later to share, download and get status of the document.

workflow_mode class-attribute instance-attribute

workflow_mode: Optional[str] = None

The workflow mode that is set while adding package.

workflow_type class-attribute instance-attribute

workflow_type: Optional[str] = None

Type of the workflow. Possible values are "SERIAL", "PARALLEL", "INDIVIDUAL" and "CUSTOM".

PackageDownloadPackageBytesResponse dataclass

PackageDownloadPackageBytesResponse(additional_properties: Dict[str, Any] = dict())

Response for Download Package

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

GetPackagesResponse dataclass

GetPackagesResponse(package_id: Optional[int] = None, package_name: Optional[str] = None, package_owner: Optional[str] = None, owner_name: Optional[str] = None, shared_package: Optional[bool] = None, gatekeeper_package: Optional[bool] = None, package_status: Optional[str] = None, extension: Optional[str] = None, workflow_mode: Optional[str] = None, folder: Optional[str] = None, folder_id: Optional[int] = None, unread: Optional[bool] = None, next_signer: Optional[str] = None, next_signer_email: Optional[List[NextSignerEmail]] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, access_duration: Optional[RecipientAccessDurationDetails] = None, decline: Optional[RecipientDeclineDetails] = None, size: Optional[int] = None)

Response for Get Packages

Attributes

package_id class-attribute instance-attribute

package_id: Optional[int] = None

Package ID of the document package.

package_name class-attribute instance-attribute

package_name: Optional[str] = None

Name of the document package.

package_owner class-attribute instance-attribute

package_owner: Optional[str] = None

Email address of the document package owner.

owner_name class-attribute instance-attribute

owner_name: Optional[str] = None

Name of the document package owner.

shared_package class-attribute instance-attribute

shared_package: Optional[bool] = None

Shared Package

gatekeeper_package class-attribute instance-attribute

gatekeeper_package: Optional[bool] = None

Gatekeeper Package

package_status class-attribute instance-attribute

package_status: Optional[str] = None

Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", or "COMPLETED".

extension class-attribute instance-attribute

extension: Optional[str] = None

Document Package extension

workflow_mode class-attribute instance-attribute

workflow_mode: Optional[str] = None

Workflow Mode

folder class-attribute instance-attribute

folder: Optional[str] = None

Name of the folder which contains the document package.

folder_id class-attribute instance-attribute

folder_id: Optional[int] = None

Id of the folder which contains the document package.

unread class-attribute instance-attribute

unread: Optional[bool] = None

True, if the document is not read by the recipient yet.

next_signer class-attribute instance-attribute

next_signer: Optional[str] = None

The name of the next signer if the document is in shared state.

next_signer_email class-attribute instance-attribute

next_signer_email: Optional[List[NextSignerEmail]] = None

An object containing next signers username and email address. In case of group signer it will have a list of email addresses of all the group members.

uploaded_on class-attribute instance-attribute

uploaded_on: Optional[str] = None

Date and time when the document was uploaded.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = None

Date and time when the document was last modified.

size class-attribute instance-attribute

size: Optional[int] = None

Size of the document in bytes.

GetPackageDetailsResponse dataclass

GetPackageDetailsResponse(name: Optional[str] = None, owner: Optional[DocumentOwner] = None, read_only: Optional[bool] = None, document_status: Optional[str] = None, documents: Optional[List[DocumentDetails]] = None)

Response for Get Package Details

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of the document package.

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True if the applied template is read only. User will not be able to make any changes if a read only template is applied.

document_status class-attribute instance-attribute

document_status: Optional[str] = None

Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", or "COMPLETED".

AddQrCodeResponse dataclass

AddQrCodeResponse(data: Optional[str] = None, field_name: Optional[str] = None, value: Optional[str] = None)

Response for Add QR Code

Attributes

data class-attribute instance-attribute

data: Optional[str] = None

QR Code generated data

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field created in the document.

value class-attribute instance-attribute

value: Optional[str] = None

Value will be the base64 of QrCode image

UpdateQrCodeResponse dataclass

UpdateQrCodeResponse(value: Optional[str] = None)

Response for Update QR Code

Attributes

value class-attribute instance-attribute

value: Optional[str] = None

Value will be the base64 of QrCode image

TemplateResponse dataclass

TemplateResponse(template_id: Optional[int] = None, template_name: Optional[str] = None, template_public: Optional[bool] = None, read_only: Optional[bool] = None, created_on: Optional[str] = None, description: Optional[str] = None, enterprise: Optional[bool] = None, documents: Optional[List[TemplateDocumentResponse]] = None, smart_form: Optional[TemplateSmartFormResponse] = None)

Response for Get Templates

Attributes

template_id class-attribute instance-attribute

template_id: Optional[int] = None

Id of the template is returned here

template_name class-attribute instance-attribute

template_name: Optional[str] = None

Name of the template.

template_public class-attribute instance-attribute

template_public: Optional[bool] = None

Response is "true" if enterprise template is marked as public. Otherwise "false" would be returned

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

Response of "true" if the template is read only, and user cannot make any changes to the workflow after applying this template. Otherwise "false".

created_on class-attribute instance-attribute

created_on: Optional[str] = None

Date and time when the template was created

description class-attribute instance-attribute

description: Optional[str] = None

Description of the template

enterprise class-attribute instance-attribute

enterprise: Optional[bool] = None

True, if user belong to an enterprise.

SignatureFieldResponse dataclass

SignatureFieldResponse(field_name: Optional[str] = None, created_on: Optional[str] = None)

Response for Add Digital Signature Field

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field created in the document.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

Date and time of field creation.

BulkSignResponse dataclass

BulkSignResponse(status: Optional[str] = None, transaction_id: Optional[str] = None)

Response for Bulk Sign Packages

BulkSignStatusResponse dataclass

BulkSignStatusResponse(status: Optional[str] = None, packages: Optional[List[BulkSignPackagesStatus]] = None)

Response for Bulk Signing Status

SignDocumentResponse dataclass

SignDocumentResponse(field_name: Optional[str] = None, status: Optional[str] = None, transaction_id: Optional[str] = None, verification: Optional[VerificationResponse] = None, authentication_access_token: Optional[str] = None)

Response for Sign Document

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field for which the verification was requested.

status class-attribute instance-attribute

status: Optional[str] = None

Returns the status of signature field. Values are SIGNED, PENDING. Status helps in eIDAS enabled remote authorized signing. If sign request is sent to mobile the status is pending.

transaction_id class-attribute instance-attribute

transaction_id: Optional[str] = None

This parameter is used while RAS signing

authentication_access_token class-attribute instance-attribute

authentication_access_token: Optional[str] = None

It will contain the OIDC id_token when user is authenticated via OIDC

EnterpriseTemplateResponse dataclass

EnterpriseTemplateResponse(id: Optional[int] = None, name: Optional[str] = None, public: Optional[bool] = None, read_only: Optional[bool] = None, description: Optional[str] = None, created_on: Optional[str] = None, roles: Optional[List[EnterpriseTemplateRole]] = None, documents: Optional[List[TemplateDocumentResponse]] = None)

Response for Get Enterprise Templates

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

Id of the template

name class-attribute instance-attribute

name: Optional[str] = None

Name of the template.

public class-attribute instance-attribute

public: Optional[bool] = None

Response is "true" if enterprise template is marked as public. Otherwise "false" would be returned

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

Response of "true" if the template is read only, and user cannot make any changes to the workflow after applying this template. Otherwise "false".

description class-attribute instance-attribute

description: Optional[str] = None

Description of the template

created_on class-attribute instance-attribute

created_on: Optional[str] = None

Date and time when the template was created

WorkflowEvidenceReportDownloadBytesResponse dataclass

WorkflowEvidenceReportDownloadBytesResponse(additional_properties: Dict[str, Any] = dict())

Response for Get Process Evidence Report

Attributes

additional_properties class-attribute instance-attribute

additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

WorkflowDetailsResponse dataclass

WorkflowDetailsResponse(package_id: Optional[int] = None, package_name: Optional[str] = None, shared_package: Optional[bool] = None, package_owner: Optional[str] = None, owner_name: Optional[str] = None, package_status: Optional[str] = None, folder: Optional[str] = None, folder_id: Optional[int] = None, gatekeeper: Optional[bool] = None, next_signer: Optional[str] = None, next_signer_email: Optional[List[NextSignerEmail]] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, workflow: Optional[WorkflowResponse] = None, documents: Optional[List[WorkflowDocumentsResponse]] = None, users: Optional[List[WorkflowUserResponse]] = None)

Response for Get Workflow Details

Attributes

package_id class-attribute instance-attribute

package_id: Optional[int] = None

Package ID of the document package.

package_name class-attribute instance-attribute

package_name: Optional[str] = None

Name of the document package.

shared_package class-attribute instance-attribute

shared_package: Optional[bool] = None

shared package

package_owner class-attribute instance-attribute

package_owner: Optional[str] = None

Email address of the document package owner.

owner_name class-attribute instance-attribute

owner_name: Optional[str] = None

Name of the document package owner.

package_status class-attribute instance-attribute

package_status: Optional[str] = None

Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" or "COMPLETED".

folder class-attribute instance-attribute

folder: Optional[str] = None

Name of the folder which contains the document package.

folder_id class-attribute instance-attribute

folder_id: Optional[int] = None

ID of the folder which contains the document package.

next_signer class-attribute instance-attribute

next_signer: Optional[str] = None

The name of the next signer if the document is in shared state.

next_signer_email class-attribute instance-attribute

next_signer_email: Optional[List[NextSignerEmail]] = None

An object containing next signers username and email address. In case of group signer it will have a list of email addresses of all the group members.

uploaded_on class-attribute instance-attribute

uploaded_on: Optional[str] = None

Date and time when the document was uploaded.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = None

Date and time when the document was last modified.

documents class-attribute instance-attribute

documents: Optional[List[WorkflowDocumentsResponse]] = None

List of documents that are uploaded in the package.

users class-attribute instance-attribute

users: Optional[List[WorkflowUserResponse]] = None

Recipients list for the workflow.

WorkflowHistoryResponse dataclass

WorkflowHistoryResponse(package_id: Optional[int] = None, package_name: Optional[str] = None, package_owner: Optional[str] = None, owner_name: Optional[str] = None, package_status: Optional[str] = None, next_signer: Optional[str] = None, next_signer_email: Optional[List[NextSignerEmail]] = None, documents: Optional[List[WorkflowDocumentsResponse]] = None, actions: Optional[List[DocumentLogsActions]] = None)

Response for Get Workflow History

Attributes

package_id class-attribute instance-attribute

package_id: Optional[int] = None

ID of the package for which the workflow history is requested.

package_owner class-attribute instance-attribute

package_owner: Optional[str] = None

Email address of the package owner.

owner_name class-attribute instance-attribute

owner_name: Optional[str] = None

Name of the package owner.

package_status class-attribute instance-attribute

package_status: Optional[str] = None

Status of the package/document with the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" or "COMPLETED".

next_signer class-attribute instance-attribute

next_signer: Optional[str] = None

Name of the next recipient.

next_signer_email class-attribute instance-attribute

next_signer_email: Optional[List[NextSignerEmail]] = None

Object having name and email address of the next recipient.

ReminderResponse dataclass

ReminderResponse(enabled: Optional[bool] = None, frequency: Optional[str] = None, remind_after: Optional[int] = None, repeat: Optional[ReminderRepeat] = None)

Response for Get Workflow Reminder

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if reminders are enabled for the recipient

frequency class-attribute instance-attribute

frequency: Optional[str] = None

Reminder Frequency. Possible Values are DAYS | HOURS.

remind_after class-attribute instance-attribute

remind_after: Optional[int] = None

The number of days after which the first reminder would be sent to workflow user.

WorkflowRecipient dataclass

WorkflowRecipient(order: Optional[int] = None, user_email: Optional[str] = None, user_name: Optional[str] = None, mobile_number: Optional[str] = None, delivery_method: Optional[str] = None, user_photo_url: Optional[str] = None, group_name: Optional[str] = None, group_members: Optional[List[GroupMemberResponse]] = None, delegatee: Optional[str] = None, delegatee_name: Optional[str] = None, role: Optional[str] = None, reason: Optional[str] = None, process_status: Optional[str] = None, processed_on: Optional[str] = None, processed_as: Optional[str] = None, processed_by: Optional[str] = None, placeholder: Optional[str] = None, signing_order: Optional[int] = None, user_national_id: Optional[str] = None, guest_user: Optional[bool] = None, email_language_code: Optional[str] = None, electronic_seal: Optional[ElectronicSealRecipient] = None, gatekeepers: Optional[WorkflowGatekeeperResponse] = None)

Response for Get Workflow Users

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient in the workflow.

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email address of the recipient if user is not a group.

user_name class-attribute instance-attribute

user_name: Optional[str] = None

Name of the recipient if user is not a group.

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number

delivery_method class-attribute instance-attribute

delivery_method: Optional[str] = None

Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS

user_photo_url class-attribute instance-attribute

user_photo_url: Optional[str] = None

API endpoint to access the resource, This will be provided only for main signers. e.g it will be null for group/delegator/gatekeeper etc. This URL does not make sure that signer image is exist. If image exist it will be provided by hitting the defined url otherwise it will be an empty string.

group_name class-attribute instance-attribute

group_name: Optional[str] = None

Group name of the recipient if recipient is a group.

group_members class-attribute instance-attribute

group_members: Optional[List[GroupMemberResponse]] = None

A list of email addresses of the group members if recipient is a group.

delegatee class-attribute instance-attribute

delegatee: Optional[str] = None

Delegatee email address, if recipient is not a group.

delegatee_name class-attribute instance-attribute

delegatee_name: Optional[str] = None

Name of the delegatee user, if recipient is not a group.

role class-attribute instance-attribute

role: Optional[str] = None

Workflow role in which the recipient was added. This role is not the enterprise role. Possible values are "SIGNER", "REVIEWER","CARBON_COPY" and "EDITOR".

reason class-attribute instance-attribute

reason: Optional[str] = None

Reason provided by the user when declining, approving or submitting a document.

process_status class-attribute instance-attribute

process_status: Optional[str] = None

Document processing status for the recipient. Possible values are "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".

processed_on class-attribute instance-attribute

processed_on: Optional[str] = None

Date and time on which the document was processed.

processed_as class-attribute instance-attribute

processed_as: Optional[str] = None

User may processed the field as COLLABORATOR , DELEGATOR, GROUP_MEMBER or OWNER.

processed_by class-attribute instance-attribute

processed_by: Optional[str] = None

Email address of the user who processed the document.

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

Placeholder text if the recipient is a placeholder

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

user_national_id class-attribute instance-attribute

user_national_id: Optional[str] = None

National identity number of the user. This helps to identify user in the workflow

guest_user class-attribute instance-attribute

guest_user: Optional[bool] = None

Gest user

email_language_code class-attribute instance-attribute

email_language_code: Optional[str] = None

email language code

WorkflowPermissionResponse dataclass

WorkflowPermissionResponse(print: Optional[bool] = None, download: Optional[bool] = None, add_text: Optional[bool] = None, change_recipients: Optional[bool] = None, add_attachment: Optional[bool] = None, legal_notice: Optional[PermissionLegalNoticeResponse] = None, attachment: Optional[AttachmentPermissionResponse] = None)

Response for Get Workflow User Permissions

Attributes

print class-attribute instance-attribute

print: Optional[bool] = None

True, if printing is allowed for this recipient.

download class-attribute instance-attribute

download: Optional[bool] = None

True, if download is allowed.

add_text class-attribute instance-attribute

add_text: Optional[bool] = None

True, if add text annotation on the document is allowed.

change_recipients class-attribute instance-attribute

change_recipients: Optional[bool] = None

True, if the recipient on the current order can change other recipients in the workflow after workflow is shared.

add_attachment class-attribute instance-attribute

add_attachment: Optional[bool] = None

True, if attachments and merging of PDF documents is allowed.

StartWorkflowResponse dataclass

StartWorkflowResponse(package_id: Optional[int] = None, documents: Optional[List[int]] = None)

Response for Share Document Package

Attributes

package_id class-attribute instance-attribute

package_id: Optional[int] = None

Package ID of the package just shared. Incase of individual sharing, more then one packages are created and shared with the recipients. API returns an array of packages along with IDs of newly created documents.

documents class-attribute instance-attribute

documents: Optional[List[int]] = None

Array of document IDs which were part of the package before sharing.

CollaboratorGroupResponse dataclass

CollaboratorGroupResponse(permission: Optional[WorkflowPermissionResponse] = None, reminder: Optional[ReminderResponse] = None, signing_order: Optional[int] = None)

Response for Add Groups to Workflow

Attributes

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Signing order

CollaboratorPlaceholderResponse dataclass

CollaboratorPlaceholderResponse(permission: Optional[WorkflowPermissionResponse] = None, reminder: Optional[ReminderResponse] = None, signing_order: Optional[int] = None)

Response for Add Placeholder to Workflow

Attributes

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Signing order

CollaboratorResponse dataclass

CollaboratorResponse(user_email: Optional[str] = None, signing_order: Optional[int] = None, guest_user: Optional[bool] = None, email_language_code: Optional[str] = None, permission: Optional[WorkflowPermissionResponse] = None, reminder: Optional[ReminderResponse] = None)

Response for Add Users to Workflow

Attributes

user_email class-attribute instance-attribute

user_email: Optional[str] = None

User email

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Signing order

guest_user class-attribute instance-attribute

guest_user: Optional[bool] = None

Is guest user

email_language_code class-attribute instance-attribute

email_language_code: Optional[str] = None

Email language code

UpdateCollaboratorResponse dataclass

UpdateCollaboratorResponse(user_email: Optional[str] = None, signing_order: Optional[int] = None, guest_user: Optional[bool] = None, email_language_code: Optional[str] = None)

Response for Update Workflow User

Attributes

user_email class-attribute instance-attribute

user_email: Optional[str] = None

User email

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Signing order

guest_user class-attribute instance-attribute

guest_user: Optional[bool] = None

Is guest user

email_language_code class-attribute instance-attribute

email_language_code: Optional[str] = None

Email language code

WorkSpaceResponse dataclass

WorkSpaceResponse(id: Optional[int] = None, name: Optional[str] = None, owner: Optional[WorkSpaceOwner] = None, members: Optional[List[WorkSpaceMembers]] = None)

Response for Get Shared Space

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

Id of shared space

name class-attribute instance-attribute

name: Optional[str] = None

Name of shared space

members class-attribute instance-attribute

members: Optional[List[WorkSpaceMembers]] = None

Members of shared space

ErrorWithDescriptionResponse dataclass

ErrorWithDescriptionResponse(error: Optional[str] = None, error_description: Optional[str] = None)

Definition: ErrorWithDescriptionResponse

Attributes

error class-attribute instance-attribute

error: Optional[str] = None

Error key to identify the error in programming and applications can respond based on the different error keys.

error_description class-attribute instance-attribute

error_description: Optional[str] = None

Error message against the error key returned. Client applications can present this error as it is or send their own error message.

Response dataclass

Response(message: Optional[str] = None)

Definition: Response

Attributes

message class-attribute instance-attribute

message: Optional[str] = field(default=None, metadata={'wire_name': 'Message'})

The service-specific error message returned by the API. This message provides useful information about why the service has returned an error response.

DetailedResponse dataclass

DetailedResponse(error: Optional[str] = None, message: Optional[str] = None)

Definition: DetailedResponse

Attributes

error class-attribute instance-attribute

error: Optional[str] = field(default=None, metadata={'wire_name': 'Error'})

Custom error code

message class-attribute instance-attribute

message: Optional[str] = field(default=None, metadata={'wire_name': 'Message'})

The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.

AuthenticationRequest dataclass

AuthenticationRequest(client_id: Optional[str] = None, client_secret: Optional[str] = None, profile_name: Optional[str] = None)

Definition: AuthenticationRequest

Attributes

client_id class-attribute instance-attribute

client_id: Optional[str] = None

Application Name that you have configured in your Enterprise Account when configuring the integration options.

client_secret class-attribute instance-attribute

client_secret: Optional[str] = None

API Key that you generated in your Enterprise Account when configuring the integration options.

ElectronicSealRecipient dataclass

ElectronicSealRecipient(name: Optional[str] = None, level_of_assurance: Optional[str] = None)

Definition: ElectronicSealRecipient

PermissionLegalNoticeResponse dataclass

PermissionLegalNoticeResponse(enabled: Optional[bool] = None, allowed_notices: Optional[List[LegalNoticeResponse]] = None, default_notice: Optional[List[LegalNoticeResponse]] = None)

Definition: PermissionLegalNoticeResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if legal notice is enabled and configured for the recipient.

allowed_notices class-attribute instance-attribute

allowed_notices: Optional[List[LegalNoticeResponse]] = None

List of legal notices allowed to the document owner from which he can select one for the recipient.

default_notice class-attribute instance-attribute

default_notice: Optional[List[LegalNoticeResponse]] = None

Default or selected legal notice for the recipient.

LegalNoticeResponse dataclass

LegalNoticeResponse(legal_notice_id: Optional[int] = None, legal_notice_name: Optional[str] = None, legal_notice_html: Optional[str] = None)

Definition: LegalNoticeResponse

Attributes

legal_notice_name class-attribute instance-attribute

legal_notice_name: Optional[str] = None

LegalNoticeResponse

legal_notice_html class-attribute instance-attribute

legal_notice_html: Optional[str] = None

HTML content of the legal notice.

AccessResponse dataclass

AccessResponse(authentication: Optional[AuthenticationResponse] = None, authentication_signing: Optional[AuthenticationSigningResponse] = None, access_duration: Optional[PermissionAccessDurationResponse] = None)

Definition: AccessResponse

AuthenticationResponse dataclass

AuthenticationResponse(enabled: Optional[bool] = None, password: Optional[AccessSecurityPasswordResponse] = None, sms_otp: Optional[AccessSecuritySmsOtpResponse] = None, totp: Optional[TotpPermissionResponse] = None)

Definition: AuthenticationResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if authentication is enabled for the package.

AccessSecurityPasswordResponse dataclass

AccessSecurityPasswordResponse(enabled: Optional[bool] = None, user_password: Optional[str] = None)

Definition: AccessSecurityPasswordResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if password authentication is enabled for the package.

user_password class-attribute instance-attribute

user_password: Optional[str] = None

Authentication password for document access.

AccessSecuritySmsOtpResponse dataclass

AccessSecuritySmsOtpResponse(enabled: Optional[bool] = None, otp_length: Optional[int] = None, retry_duration: Optional[int] = None, mobile_number: Optional[str] = None, methods: Optional[List[str]] = None)

Definition: AccessSecuritySmsOtpResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if SMS OTP authentication is enabled for the package.

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.

methods class-attribute instance-attribute

methods: Optional[List[str]] = None

Allowed OTP Methods

TotpPermissionResponse dataclass

TotpPermissionResponse(enabled: Optional[bool] = None)

Definition: TotpPermissionResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

Enabled

AuthenticationSigningResponse dataclass

AuthenticationSigningResponse(enabled: Optional[bool] = None, sms_otp: Optional[AuthenticationSigningSmsOtpResponse] = None, totp: Optional[TotpPermissionResponse] = None)

Definition: AuthenticationSigningResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if authentication is enabled for the package.

AuthenticationSigningSmsOtpResponse dataclass

AuthenticationSigningSmsOtpResponse(otp_length: Optional[int] = None, retry_duration: Optional[int] = None, mobile_number: Optional[str] = None, methods: Optional[List[str]] = None)

Definition: AuthenticationSigningSmsOtpResponse

Attributes

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.

methods class-attribute instance-attribute

methods: Optional[List[str]] = None

Allowed OTP Methods

PermissionAccessDurationResponse dataclass

PermissionAccessDurationResponse(enabled: Optional[bool] = None, duration_by_date: Optional[AccessDurationByDateResponse] = None, duration_by_days: Optional[AccessDurationByDaysResponse] = None)

Definition: PermissionAccessDurationResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if access duration security is enabled for the package.

AccessDurationByDateResponse dataclass

AccessDurationByDateResponse(enabled: Optional[bool] = None, accessible: Optional[bool] = None, duration: Optional[DurationByDateResponse] = None)

Definition: AccessDurationByDateResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True if access security is enabled for a duration by date and time.

DurationByDateResponse dataclass

DurationByDateResponse(start_date_time: Optional[str] = None, end_date_time: Optional[str] = None)

Definition: DurationByDateResponse

Attributes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = None

Date and time from where the package will be accessible to the recipient.

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = None

Date and time after which the package will not be accessible to the recipient.

AccessDurationByDaysResponse dataclass

AccessDurationByDaysResponse(enabled: Optional[bool] = None, accessible: Optional[bool] = None, duration: Optional[DurationByDaysResponse] = None)

Definition: AccessDurationByDaysResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if access security is enabled for a duration by number of days.

DurationByDaysResponse dataclass

DurationByDaysResponse(total_days: Optional[int] = None)

Definition: DurationByDaysResponse

Attributes

total_days class-attribute instance-attribute

total_days: Optional[int] = None

Total number of days for which the package will be accessible to the recipient after receiving the package.

ReminderRepeat dataclass

ReminderRepeat(enabled: Optional[bool] = None, frequency: Optional[str] = None, keep_reminding_after: Optional[int] = None, total_reminders: Optional[int] = None)

Definition: ReminderRepeat

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if subsequent reminders are enabled.

frequency class-attribute instance-attribute

frequency: Optional[str] = None

Repeat Reminder Frequency. Possible Values are DAYS | HOURS.

keep_reminding_after class-attribute instance-attribute

keep_reminding_after: Optional[int] = None

The number of days after which the subsequent reminders would be sent to workflow recipient.

total_reminders class-attribute instance-attribute

total_reminders: Optional[int] = None

The number of subsequent reminders to be sent to workflow user.

AccessUpdateRequest dataclass

AccessUpdateRequest(apply_to_all: Optional[bool] = None, authentication: Optional[AccessAuthentication] = None, authentication_signing: Optional[SigningAuthentication] = None, access_duration: Optional[PermissionAccessDuration] = None)

Definition: AccessUpdateRequest

Attributes

apply_to_all class-attribute instance-attribute

apply_to_all: Optional[bool] = None

True, if the access security or authentications are to be applied on all the recipients in the workflow.

AccessAuthentication dataclass

AccessAuthentication(enabled: Optional[bool] = None, password: Optional[AuthenticationPassword] = None, sms_otp: Optional[AuthenticationSmsOtp] = None, totp: Optional[TotpPermissionResponse] = None)

Definition: AccessAuthentication

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if authentication is enabled for the package.

AuthenticationPassword dataclass

AuthenticationPassword(enabled: Optional[bool] = None, user_password: Optional[str] = None)

Definition: AuthenticationPassword

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if password authentication is enabled for the package.

user_password class-attribute instance-attribute

user_password: Optional[str] = None

Password string if password field is enabled. If a password is already set and owner do not wish to change it, remove the field from the response, or send null.

AuthenticationSmsOtp dataclass

AuthenticationSmsOtp(enabled: Optional[bool] = None, mobile_number: Optional[str] = None)

Definition: AuthenticationSmsOtp

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if SMS OTP authentication is enabled for the package.

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.

SigningAuthentication dataclass

SigningAuthentication(enabled: Optional[bool] = None, sms_otp: Optional[AuthenticationSigningSmsOtp] = None, totp: Optional[TotpPermissionResponse] = None)

Definition: SigningAuthentication

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if authentication is enabled for the package.

AuthenticationSigningSmsOtp dataclass

AuthenticationSigningSmsOtp(mobile_number: Optional[str] = None)

Definition: AuthenticationSigningSmsOtp

Attributes

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.

PermissionAccessDuration dataclass

PermissionAccessDuration(enabled: Optional[bool] = None, duration_by_date: Optional[AccessDurationByDate] = None, duration_by_days: Optional[AccessDurationByDays] = None)

Definition: PermissionAccessDuration

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if access duration security is enabled for the package.

AccessDurationByDate dataclass

AccessDurationByDate(enabled: Optional[bool] = None, duration: Optional[DurationByDate] = None)

Definition: AccessDurationByDate

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True if access security is enabled for a duration by date and time.

DurationByDate dataclass

DurationByDate(start_date_time: Optional[str] = None, end_date_time: Optional[str] = None)

Definition: DurationByDate

Attributes

start_date_time class-attribute instance-attribute

start_date_time: Optional[str] = None

Date and time from where the package will be accessible to the recipient.

end_date_time class-attribute instance-attribute

end_date_time: Optional[str] = None

Date and time after which the package will not be accessible to the recipient.

AccessDurationByDays dataclass

AccessDurationByDays(enabled: Optional[bool] = None, duration: Optional[DurationByDays] = None)

Definition: AccessDurationByDays

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if access security is enabled for a duration by number of days.

DurationByDays dataclass

DurationByDays(total_days: Optional[int] = None)

Definition: DurationByDays

Attributes

total_days class-attribute instance-attribute

total_days: Optional[int] = None

Total number of days for which the package will be accessible to the recipient after receiving the package.

QrCodeRequest dataclass

QrCodeRequest(page_no: Optional[int] = None, field_name: Optional[str] = None, dimensions: Optional[FieldDimension] = None, data: Optional[str] = None, options: Optional[QrCodeOptions] = None, color: Optional[QrCodeColor] = None, logo: Optional[QrCodeLogo] = None)

Definition: QrCodeRequest

Attributes

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.

data class-attribute instance-attribute

data: Optional[str] = None

The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id}

FieldDimension dataclass

FieldDimension(x: Optional[float] = None, y: Optional[float] = None, width: Optional[float] = None, height: Optional[float] = None)

Definition: FieldDimension

Attributes

x class-attribute instance-attribute

x: Optional[float] = None

Left location of the field in pixel.

y class-attribute instance-attribute

y: Optional[float] = None

Top location of the field in pixel.

width class-attribute instance-attribute

width: Optional[float] = None

Width of the field in pixel.

height class-attribute instance-attribute

height: Optional[float] = None

Height of the field in pixel.

QrCodeOptions dataclass

QrCodeOptions(error_correction_level: Optional[ECCLevelAPI] = None, encoding: Optional[EciModeAPI] = None, pixels_per_module: Optional[int] = None, add_margins: Optional[bool] = None)

Definition: QrCodeOptions

Attributes

pixels_per_module class-attribute instance-attribute

pixels_per_module: Optional[int] = None

Specifies the number of pixels per module in the QR code. A higher number results in a larger and more detailed QR code. Default is "20" Possible Values are : 20 | 30 | 40 | 50

add_margins class-attribute instance-attribute

add_margins: Optional[bool] = None

Indicates whether quiet zones (margins) should be drawn around the QR code. Quiet zones help scanners to detect and decode the QR code more accurately. Default is "true"

QrCodeColor dataclass

QrCodeColor(dots: Optional[str] = None, background: Optional[str] = None)

Definition: QrCodeColor

Attributes

dots class-attribute instance-attribute

dots: Optional[str] = None

Represents the dark color used for the dots in the QR code. Default is "black". e.g. "#000000"

background class-attribute instance-attribute

background: Optional[str] = None

Represents the light color used for the background of the QR code. Default is "white". e.g. "#ffffff"

QrCodeLogo dataclass

QrCodeLogo(base64: Optional[str] = None, hide_background_dots: Optional[bool] = None, size: Optional[int] = None)

Definition: QrCodeLogo

Attributes

base64 class-attribute instance-attribute

base64: Optional[str] = None

An optional icon (base64) to place in the center of the QR code.

hide_background_dots class-attribute instance-attribute

hide_background_dots: Optional[bool] = None

The background color behind the icon, if an icon is provided. If color is not provided transparent background is implemented.

size class-attribute instance-attribute

size: Optional[int] = None

The size of the icon as a percentage of the QR code's size, if an icon is provided. Default is "15". Possible Values are : 10 | 15 | 20 | 25 | 30 | 35 | 40

SignatureFieldAuthentication dataclass

SignatureFieldAuthentication(enabled: Optional[bool] = None, otp: Optional[SignatureFieldAuthenticationOtp] = None, totp: Optional[SignatureFieldAuthenticationTotp] = None)

Definition: SignatureFieldAuthentication

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if authentication is enabled for the field. False otherwise.

SignatureFieldAuthenticationOtp dataclass

SignatureFieldAuthenticationOtp(enabled: Optional[bool] = None, mobile_number: Optional[str] = None)

Definition: SignatureFieldAuthenticationOtp

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if SMS/Email OTP authentication is enabled for the field. False otherwise.

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number of the recipient to which the field is assigned.

SignatureFieldAuthenticationTotp dataclass

SignatureFieldAuthenticationTotp(enabled: Optional[bool] = None)

Definition: SignatureFieldAuthenticationTotp

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if TOTP authentication is enabled for the field. False otherwise.

UpdateQrCodeRequest dataclass

UpdateQrCodeRequest(field_name: Optional[str] = None, renamed_as: Optional[str] = None, page_no: Optional[int] = None, dimensions: Optional[FieldDimension] = None, data: Optional[str] = None, options: Optional[QrCodeOptions] = None, color: Optional[QrCodeColor] = None, logo: Optional[QrCodeLogo] = None)

Definition: UpdateQrCodeRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Current name of the field, that is to be updated.

renamed_as class-attribute instance-attribute

renamed_as: Optional[str] = None

Updated name of the field if renaming is intended.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number for which field is need to be updated

data class-attribute instance-attribute

data: Optional[str] = None

The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id}

FieldValidationValue dataclass

FieldValidationValue(required: Optional[bool] = None, rules: Optional[List[FieldValidationValueRule]] = None)

Definition: FieldValidationValue

FieldValidationValueRule dataclass

FieldValidationValueRule(type_: Optional[str] = None, value: Optional[str] = None)

Definition: FieldValidationValueRule

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Specifies the type of validation rule, which is currently always set to EQUALS for text field.

value class-attribute instance-attribute

value: Optional[str] = None

Represents the value used for validation.

PostProcessResponse dataclass

PostProcessResponse(enabled: Optional[bool] = None, contacts: Optional[List[str]] = None, recipients: Optional[List[PostProcessRecipientResponse]] = None, message: Optional[str] = None, google_drive: Optional[bool] = None, one_drive: Optional[bool] = None, dropbox: Optional[bool] = None, workflow_recipients: Optional[bool] = None, document_processing_report: Optional[bool] = None)

Definition: PostProcessResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if post processing is enabled for the package.

contacts class-attribute instance-attribute

contacts: Optional[List[str]] = None

List of email addresses to which the email will be sent when the workflow is completed.

recipients class-attribute instance-attribute

recipients: Optional[List[PostProcessRecipientResponse]] = None

List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion.

message class-attribute instance-attribute

message: Optional[str] = None

Any custom string message that is to be sent to the contacts when the workflow is completed.

google_drive class-attribute instance-attribute

google_drive: Optional[bool] = None

True, if google drive uploading is turned on for the package. Documents will be uploaded to google drive when the workflow is completed.

one_drive class-attribute instance-attribute

one_drive: Optional[bool] = None

True, if one drive uploading is turned on for the package. Documents will be uploaded to one drive when the workflow is completed.

dropbox class-attribute instance-attribute

dropbox: Optional[bool] = None

True, if dropbox uploading is turned on for the package. Documents will be uploaded to google drive when the workflow is completed.

workflow_recipients class-attribute instance-attribute

workflow_recipients: Optional[bool] = None

True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false.

document_processing_report class-attribute instance-attribute

document_processing_report: Optional[bool] = None

True, if Send the document processing report (XML) is to be enabled to for the workflow

PostProcessRecipientResponse dataclass

PostProcessRecipientResponse(name: Optional[str] = None, email: Optional[str] = None)

Definition: PostProcessRecipientResponse

CertifyResponse dataclass

CertifyResponse(enabled: Optional[bool] = None, allowed_permissions: Optional[List[str]] = None, default_permission: Optional[str] = None)

Definition: CertifyResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if certify signature settings are enabled for the document.

allowed_permissions class-attribute instance-attribute

allowed_permissions: Optional[List[str]] = None

Certify permission level set for the document with certify signature settings.

GroupMemberResponse dataclass

GroupMemberResponse(user_email: Optional[str] = None, user_name: Optional[str] = None)

Definition: GroupMemberResponse

Attributes

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email address of the group member

user_name class-attribute instance-attribute

user_name: Optional[str] = None

User name of the group member

AttachmentPermissionResponse dataclass

AttachmentPermissionResponse(enabled: Optional[bool] = None)

Definition: AttachmentPermissionResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

Enabled

PostProcessRecipientRequest dataclass

PostProcessRecipientRequest(name: Optional[str] = None, email: Optional[str] = None)

Definition: PostProcessRecipientRequest

UpdateCertifyPolicyRequest dataclass

UpdateCertifyPolicyRequest(certify: Optional[CertifyPolicyRequest] = None, lock_form_fields: Optional[bool] = None)

Definition: UpdateCertifyPolicyRequest

Attributes

lock_form_fields class-attribute instance-attribute

lock_form_fields: Optional[bool] = None

True if form fields are to be locked after the last signature on the current document.

CertifyPolicyRequest dataclass

CertifyPolicyRequest(enabled: Optional[bool] = None, permission: Optional[CertifyPermission] = None)

Definition: CertifyPolicyRequest

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True if certify settings are to be enabled for the document.

DeleteDocumentFieldRequest dataclass

DeleteDocumentFieldRequest(field_name: Optional[str] = None)

Definition: DeleteDocumentFieldRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field to be deleted.

EnterpriseTemplateRole dataclass

EnterpriseTemplateRole(name: Optional[str] = None, id: Optional[int] = None)

Definition: EnterpriseTemplateRole

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of the enterprise role assigned to the user.

id class-attribute instance-attribute

id: Optional[int] = None

Id of the enterprise role assigned to the user.

TemplateDocumentResponse dataclass

TemplateDocumentResponse(id: Optional[int] = None, name: Optional[str] = None)

Definition: TemplateDocumentResponse

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

Id of the template document

name class-attribute instance-attribute

name: Optional[str] = None

Name of the template document.

NextSignerEmail dataclass

NextSignerEmail(user_email: Optional[str] = None, user_name: Optional[str] = None)

Definition: Next_signer_email

Attributes

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email address of the next signer.

user_name class-attribute instance-attribute

user_name: Optional[str] = None

Name of the next signer.

WorkflowGatekeeperResponse dataclass

WorkflowGatekeeperResponse(emails: Optional[List[WorkflowGatekeeperUserResponse]] = None)

Definition: WorkflowGatekeeperResponse

Attributes

emails class-attribute instance-attribute

emails: Optional[List[WorkflowGatekeeperUserResponse]] = None

Getekeepers

WorkflowGatekeeperUserResponse dataclass

WorkflowGatekeeperUserResponse(user_email: Optional[str] = None)

Definition: WorkflowGatekeeperUserResponse

EnterpriseAuthenticationResponse dataclass

EnterpriseAuthenticationResponse(enabled: Optional[bool] = None, password: Optional[AccessSecurityPasswordResponse] = None, sms_otp: Optional[EnterpriseAccessSecuritySmsOtpResponse] = None, totp: Optional[TotpPermissionResponse] = None)

Definition: EnterpriseAuthenticationResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if authentication is enabled for the package.

EnterpriseAccessSecuritySmsOtpResponse dataclass

EnterpriseAccessSecuritySmsOtpResponse(enabled: Optional[bool] = None, otp_length: Optional[int] = None, retry_duration: Optional[int] = None, mobile_number: Optional[str] = None)

Definition: EnterpriseAccessSecuritySmsOtpResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if SMS OTP authentication is enabled for the package.

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.

EnterpriseAuthenticationSigningResponse dataclass

EnterpriseAuthenticationSigningResponse(enabled: Optional[bool] = None, sms_otp: Optional[EnterpriseAuthenticationSigningSmsOtpResponse] = None, totp: Optional[TotpPermissionResponse] = None)

Definition: EnterpriseAuthenticationSigningResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if authentication is enabled for the package.

EnterpriseAuthenticationSigningSmsOtpResponse dataclass

EnterpriseAuthenticationSigningSmsOtpResponse(otp_length: Optional[int] = None, retry_duration: Optional[int] = None, mobile_number: Optional[str] = None)

Definition: EnterpriseAuthenticationSigningSmsOtpResponse

Attributes

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.

DocumentOwner dataclass

DocumentOwner(name: Optional[str] = None, email: Optional[str] = None)

Definition: DocumentOwner

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of the document package owner.

email class-attribute instance-attribute

email: Optional[str] = None

Email of the document package owner.

DocumentDetails dataclass

DocumentDetails(id: Optional[int] = None, name: Optional[str] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, size: Optional[int] = None, type_: Optional[str] = None, source: Optional[str] = None)

Definition: DocumentDetails

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

ID of the newly created document.

name class-attribute instance-attribute

name: Optional[str] = None

The name of the document.

uploaded_on class-attribute instance-attribute

uploaded_on: Optional[str] = None

Date and time when the document was uploaded.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = None

Date and time when the document was last modified.

size class-attribute instance-attribute

size: Optional[int] = None

Size of the document in bytes.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the document e.g. "PDF".

source class-attribute instance-attribute

source: Optional[str] = None

Identifies where the document was uploaded e.g. "My App".

ChangeServicePlanRequest dataclass

ChangeServicePlanRequest(user_email: Optional[str] = None, service_plan: Optional[str] = None)

Definition: ChangeServicePlanRequest

Attributes

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email address of the account owner.

service_plan class-attribute instance-attribute

service_plan: Optional[str] = None

New Service Plan name, which is to be assigned to the user.

TemplateSmartFormResponse dataclass

TemplateSmartFormResponse(active_count: Optional[int] = None, total_count: Optional[int] = None)

Definition: TemplateSmartFormResponse

Attributes

active_count class-attribute instance-attribute

active_count: Optional[int] = None

Active count

total_count class-attribute instance-attribute

total_count: Optional[int] = None

Total

ServicePlanLevelOfAssurance dataclass

ServicePlanLevelOfAssurance(allowed: Optional[List[str]] = None, default: Optional[List[str]] = None)

Definition: ServicePlanLevelOfAssurance

Attributes

allowed class-attribute instance-attribute

allowed: Optional[List[str]] = None

Allowed level of assurances, Possible values are: ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE, ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SEAL, QUALIFIED_ELECTRONIC_SEAL, ELECTRONIC_SIGNATURE

default class-attribute instance-attribute

default: Optional[List[str]] = None

Default level of assurances, Possible values are: ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE, ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SEAL, QUALIFIED_ELECTRONIC_SEAL, ELECTRONIC_SIGNATURE

ServicePlanCertifyOption dataclass

ServicePlanCertifyOption(allowed: Optional[List[str]] = None, default: Optional[str] = None)

Definition: ServicePlanCertifyOption

Attributes

allowed class-attribute instance-attribute

allowed: Optional[List[str]] = None

Allowed document certify options, Possible values are: NO_CHANGES_ALLOWED, FORM_FILLING_ALLOWED, FORM_FILLING_WITH_ANNOTATIONS_ALLOWED

default class-attribute instance-attribute

default: Optional[str] = None

Default document certify options, Possible values are: NO_CHANGES_ALLOWED, FORM_FILLING_ALLOWED, FORM_FILLING_WITH_ANNOTATIONS_ALLOWED

ServicePlanAutoDeleteDocument dataclass

ServicePlanAutoDeleteDocument(enabled: Optional[bool] = None, duration: Optional[int] = None, notify: Optional[NotifyUnUsedDeleteDocument] = None, email_document: Optional[EmailDeletedDocument] = None)

Definition: ServicePlanAutoDeleteDocument

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, If auto deletion of the unused documents is enabled.

duration class-attribute instance-attribute

duration: Optional[int] = None

Total number of unused days.

NotifyUnUsedDeleteDocument dataclass

NotifyUnUsedDeleteDocument(enabled: Optional[bool] = None, duration: Optional[int] = None)

Definition: NotifyUnUsedDeleteDocument

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, If notify the user before days to deleting unused documents.

duration class-attribute instance-attribute

duration: Optional[int] = None

Total number of days before notifying the user.

EmailDeletedDocument dataclass

EmailDeletedDocument(enabled: Optional[bool] = None, workflow_evidence_report: Optional[bool] = None)

Definition: EmailDeletedDocument

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, If deleted document as attachment is enabled

workflow_evidence_report class-attribute instance-attribute

workflow_evidence_report: Optional[bool] = None

True, Email the workflow evidence report as an attachment of the completed document is enabled

ServicePlanSigningServer dataclass

ServicePlanSigningServer(key_location: Optional[str] = None, order: Optional[int] = None, signing_profile: Optional[ServicePlanProfile] = None, electronic_seal: Optional[SigningServerCapacity] = None, advanced_electronic_seal: Optional[SigningServerCapacity] = None, qualified_electronic_seal: Optional[SigningServerCapacity] = None, advanced_electronic_signature: Optional[SigningServerCapacity] = None, high_trust_advanced_signature: Optional[SigningServerCapacity] = None, qualified_electronic_signature: Optional[SigningServerCapacity] = None, signature_appearances: Optional[SigningServerSignatureAppearance] = None, csp: Optional[SigningServerCsp] = None)

Definition: ServicePlanSigningServer

Attributes

key_location class-attribute instance-attribute

key_location: Optional[str] = None

Key location of the signing server, possible values are SERVER, LOCAL

order class-attribute instance-attribute

order: Optional[int] = None

Signing server order

ServicePlanProfile dataclass

ServicePlanProfile(id: Optional[int] = None, name: Optional[str] = None)

Definition: ServicePlanProfile

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

ID of the profile

name class-attribute instance-attribute

name: Optional[str] = None

Name of the profile

SigningServerCapacity dataclass

SigningServerCapacity(enabled: Optional[bool] = None, capacities: Optional[List[ServicePlanCapacity]] = None)

Definition: SigningServerCapacity

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, If to add the Signing Capacities.

capacities class-attribute instance-attribute

capacities: Optional[List[ServicePlanCapacity]] = None

Total number of Signing Capacities added are signing server.

ServicePlanCapacity dataclass

ServicePlanCapacity(id: Optional[int] = None, name: Optional[str] = None, level_of_assurance: Optional[str] = None, key_protection: Optional[str] = None)

Definition: ServicePlanCapacity

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

Id of the Capacity

name class-attribute instance-attribute

name: Optional[str] = None

Name of the Capacity

level_of_assurance class-attribute instance-attribute

level_of_assurance: Optional[str] = None

Level of assurance of the capacity, possible values are ADVANCED_ELECTRONIC_SIGNATURE, HIGH_TRUST_ADVANCED, QUALIFIED_ELECTRONIC_SIGNATURE, ELECTRONIC_SEAL, ADVANCED_ELECTRONIC_SEAL, QUALIFIED_ELECTRONIC_SEAL.

key_protection class-attribute instance-attribute

key_protection: Optional[str] = None

Key protection option of the capacity, possible values are NO_PASSWORD, USER_PASSWORD, SYSTEM_PASSWORD, REMOTE_AUTHORISATION.

SigningServerSignatureAppearance dataclass

SigningServerSignatureAppearance(signature_appearance: Optional[str] = None, signature_appearance_logo: Optional[str] = None)

Definition: SigningServerSignatureAppearance

Attributes

signature_appearance class-attribute instance-attribute

signature_appearance: Optional[str] = None

Appearances of the signature, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE

signature_appearance_logo class-attribute instance-attribute

signature_appearance_logo: Optional[str] = None

Logo of the signature appearance

SigningServerCsp dataclass

SigningServerCsp(enabled: Optional[bool] = None, virtual_profile: Optional[ServicePlanProfile] = None, auto_delete_certificates: Optional[bool] = None)

Definition: SigningServerCsp

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, If to add Push Certificates to CSP.

auto_delete_certificates class-attribute instance-attribute

auto_delete_certificates: Optional[bool] = None

True, If Automatically delete certificates and users from CSP when user is removed.

ServicePlanElectronicSealServer dataclass

ServicePlanElectronicSealServer(electronic_seal_profile: Optional[ServicePlanProfile] = None, electronic_seal: Optional[SigningServerCapacity] = None, advanced_electronic_seal: Optional[SigningServerCapacity] = None, qualified_electronic_seal: Optional[SigningServerCapacity] = None)

Definition: ServicePlanElectronicSealServer

ServicePlanAuthenticationProfile dataclass

ServicePlanAuthenticationProfile(allowed: Optional[List[ServicePlanProfile]] = None, default: Optional[ServicePlanProfile] = None)

Definition: ServicePlanAuthenticationProfile

Attributes

allowed class-attribute instance-attribute

allowed: Optional[List[ServicePlanProfile]] = None

Allowed authentication profile in service plan

ServicePlanEvidenceReport dataclass

ServicePlanEvidenceReport(type_: Optional[str] = None, delete_document_logs: Optional[bool] = None)

Definition: ServicePlanEvidenceReport

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of workflow evidence recording, Possible values are "BASIC", "DETAILED"

delete_document_logs class-attribute instance-attribute

delete_document_logs: Optional[bool] = None

True, If enable to delete document logs on generation of Workflow Evidence Report.

ServicePlanOneTimePassword dataclass

ServicePlanOneTimePassword(email_otp: Optional[ServicePlanEmailOtp] = None, sms_otp: Optional[ServicePlanSmsOtp] = None, otp_length: Optional[int] = None, otp_expiry: Optional[int] = None, otp_retry_interval: Optional[int] = None)

Definition: ServicePlanOneTimePassword

Attributes

otp_length class-attribute instance-attribute

otp_length: Optional[int] = None

Character count of OTP to be generated for authentication.

otp_expiry class-attribute instance-attribute

otp_expiry: Optional[int] = None

OTP expiry duration in seconds

otp_retry_interval class-attribute instance-attribute

otp_retry_interval: Optional[int] = None

OTP retry interval duration in seconds

ServicePlanEmailOtp dataclass

ServicePlanEmailOtp(enabled: Optional[bool] = None)

Definition: ServicePlanEmailOtp

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if Email OTP are enabled for the service plan.

ServicePlanSmsOtp dataclass

ServicePlanSmsOtp(enabled: Optional[bool] = None, server: Optional[str] = None)

Definition: ServicePlanSmsOtp

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if SMS OTP are enabled for the service plan.

server class-attribute instance-attribute

server: Optional[str] = None

SMS OTP server

ServicePlanSmtpServer dataclass

ServicePlanSmtpServer(enabled: Optional[bool] = None, server: Optional[str] = None)

Definition: ServicePlanSmtpServer

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if SMTP Server is enabled for the service plan.

server class-attribute instance-attribute

server: Optional[str] = field(default=None, metadata={'wire_name': 'Server'})

SMTP Server

ServicePlanSmsNotification dataclass

ServicePlanSmsNotification(enabled: Optional[bool] = None, server: Optional[str] = None)

Definition: ServicePlanSmsNotification

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if SMS notification gateway is enabled for the service plan.

server class-attribute instance-attribute

server: Optional[str] = field(default=None, metadata={'wire_name': 'Server'})

SMS Gateway

ServicePlanAutoDeleteUser dataclass

ServicePlanAutoDeleteUser(enabled: Optional[bool] = None, inactive_days: Optional[int] = None, notify: Optional[NotifyInactiveDeleteUser] = None)

Definition: ServicePlanAutoDeleteUser

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, If auto deletion of the inactive users is enabled.

inactive_days class-attribute instance-attribute

inactive_days: Optional[int] = None

Total number of inactive days.

NotifyInactiveDeleteUser dataclass

NotifyInactiveDeleteUser(enabled: Optional[bool] = None, duration: Optional[int] = None)

Definition: NotifyInactiveDeleteUser

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, If notify the user before days to deleting inactive users.

duration class-attribute instance-attribute

duration: Optional[int] = None

Total number of days before notifying the user.

ServicePlanCapacityRequest dataclass

ServicePlanCapacityRequest(name: Optional[str] = None)

Definition: ServicePlanCapacityRequest

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of the Capacity

WorkflowDetailUpdateRequest dataclass

WorkflowDetailUpdateRequest(workflow_type: Optional[WorkflowType] = None, workflow_mode: Optional[WorkflowModes] = None, continue_on_decline: Optional[bool] = None, message: Optional[str] = None, comments: Optional[bool] = None)

Definition: WorkflowDetailUpdateRequest

Attributes

continue_on_decline class-attribute instance-attribute

continue_on_decline: Optional[bool] = None

True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained.

message class-attribute instance-attribute

message: Optional[str] = None

A custom string message from the document owner to every recipient, this message appears in the sharing email as well as on the screen. If no value is provided, old value will be retained.

comments class-attribute instance-attribute

comments: Optional[bool] = None

Allow comments

PostProcessUpdateRequest dataclass

PostProcessUpdateRequest(enabled: Optional[bool] = None, contacts: Optional[List[str]] = None, recipients: Optional[List[PostProcessRecipientRequest]] = None, message: Optional[str] = None, google_drive: Optional[bool] = None, dropbox: Optional[bool] = None, onedrive: Optional[bool] = None, workflow_recipients: Optional[bool] = None, document_processing_report: Optional[bool] = None)

Definition: PostProcessUpdateRequest

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if post processing is turned on for the package.

recipients class-attribute instance-attribute

recipients: Optional[List[PostProcessRecipientRequest]] = None

List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion.

message class-attribute instance-attribute

message: Optional[str] = None

A custom string message for all the contacts. Message becomes part of the email sent to the contacts.

google_drive class-attribute instance-attribute

google_drive: Optional[bool] = None

True, if document is to be uploaded to the provided google account after the workflow completion.

dropbox class-attribute instance-attribute

dropbox: Optional[bool] = None

True, if document is to be uploaded to the provided dropbox account after the workflow completion.

onedrive class-attribute instance-attribute

onedrive: Optional[bool] = None

True, if document is to be uploaded to the provided oneDrive account after the workflow completion.

workflow_recipients class-attribute instance-attribute

workflow_recipients: Optional[bool] = None

True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false.

document_processing_report class-attribute instance-attribute

document_processing_report: Optional[bool] = None

True, if Send the document processing report (XML) is to be enabled to for the workflow

WorflowUserRequest dataclass

WorflowUserRequest(user_email: Optional[str] = None, user_name: Optional[str] = None, user_national_id: Optional[str] = None, email_notification: Optional[bool] = None, role: Optional[CollaboratorRole] = None, signing_order: Optional[int] = None, delivery_method: Optional[DeliveryMethod] = None, mobile_number: Optional[str] = None)

Definition: WorflowUserRequest

Attributes

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email address of the user to be added in the workflow.

user_name class-attribute instance-attribute

user_name: Optional[str] = None

Name of the recipient to be added in the workflow.

user_national_id class-attribute instance-attribute

user_national_id: Optional[str] = None

User national id of the recipient

email_notification class-attribute instance-attribute

email_notification: Optional[bool] = None

If set as true, SigningHub will send notifications to the user via email as per the document owner and user notification settings. A value of false means no notifications will be sent to user throughout the workflow.

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Order of the recipient in the workflow. This signing order is mandatory when workflow type is "CUSTOM".

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile Number

WorkflowResponse dataclass

WorkflowResponse(workflow_type: Optional[str] = None, continue_on_decline: Optional[bool] = None, workflow_status: Optional[str] = None, workflow_mode: Optional[str] = None, message: Optional[str] = None, read_only: Optional[bool] = None, post_process: Optional[PostProcessResponse] = None, comments: Optional[bool] = None)

Definition: WorkflowResponse

Attributes

workflow_type class-attribute instance-attribute

workflow_type: Optional[str] = None

Type of the workflow, there are four types of workflows supported in the application. Possible values are "SERIAL", "PARALLEL", "INDIVIDUAL" and "CUSTOM".

continue_on_decline class-attribute instance-attribute

continue_on_decline: Optional[bool] = None

True, if workflow needs to be continued even after a recipient declines at his turn.

workflow_status class-attribute instance-attribute

workflow_status: Optional[str] = None

Processing status of the workflow, possible values are "DRAFT", "IN_PRGORESS" and "COMPLETED".

workflow_mode class-attribute instance-attribute

workflow_mode: Optional[str] = None

Mode of the workflow, there are three types of workflow modes supported in application. Possible values are "ONLY_ME", "ME_AND_OTHERS" and "ONLY_OTHERS"

message class-attribute instance-attribute

message: Optional[str] = None

Any custom string message that is to be sent to all the recipient of the workflow by the document owner.

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

If any template applied on the documents in this workflow is read only or locked template then the workflow is read only. SigningHub will not allow the end users to make any changes to this workflow in draft state and this workflow is to be shared as it is.

comments class-attribute instance-attribute

comments: Optional[bool] = None

Comments

WorkflowDocumentsResponse dataclass

WorkflowDocumentsResponse(document_id: Optional[int] = None, document_name: Optional[str] = None, document_type: Optional[str] = None, document_order: Optional[int] = None, document_source: Optional[str] = None, update_required: Optional[bool] = None, document_height: Optional[int] = None, document_width: Optional[int] = None, document_pages: Optional[int] = None, created_on: Optional[str] = None, modified_on: Optional[str] = None, form_fields: Optional[bool] = None, template: Optional[DocumentsTemplateResponse] = None, certify: Optional[CertifyResponse] = None, lock_form_fields: Optional[bool] = None, locked: Optional[bool] = None, has_signed_signature_fields: Optional[bool] = None, attachments: Optional[bool] = None, conformance_level: Optional[str] = None, document_size: Optional[int] = None, formatted: Optional[bool] = None)

Definition: WorkflowDocumentsResponse

Attributes

document_id class-attribute instance-attribute

document_id: Optional[int] = None

ID of the document.

document_name class-attribute instance-attribute

document_name: Optional[str] = None

Name of the document.

document_type class-attribute instance-attribute

document_type: Optional[str] = None

Original document extension when the document was uploaded before conversion to the PDF.

document_order class-attribute instance-attribute

document_order: Optional[int] = None

Order of the document in the document package.

document_source class-attribute instance-attribute

document_source: Optional[str] = None

Source of the document from where the document was uploaded.

update_required class-attribute instance-attribute

update_required: Optional[bool] = None

True if document is required to update

document_height class-attribute instance-attribute

document_height: Optional[int] = None

Height of the PDF document.

document_width class-attribute instance-attribute

document_width: Optional[int] = None

Width of the PDF document.

document_pages class-attribute instance-attribute

document_pages: Optional[int] = None

Total number of pages in the document.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

The date and time on which the document was uploaded.

modified_on class-attribute instance-attribute

modified_on: Optional[str] = None

The date and time on which the document was last modified.

form_fields class-attribute instance-attribute

form_fields: Optional[bool] = None

True, if document has form fields.

lock_form_fields class-attribute instance-attribute

lock_form_fields: Optional[bool] = None

True, if document is set to lock the form fields with the last digital signature on the document.

has_signed_signature_fields class-attribute instance-attribute

has_signed_signature_fields: Optional[bool] = None

Pdf document meta info: true if pdf document have signed signature fields

attachments class-attribute instance-attribute

attachments: Optional[bool] = None

True, if document has attachments.

conformance_level class-attribute instance-attribute

conformance_level: Optional[str] = None

Document conformance level

document_size class-attribute instance-attribute

document_size: Optional[int] = None

Size of document.

formatted class-attribute instance-attribute

formatted: Optional[bool] = None

This property is for XML document, that either its formatted or not

DocumentsTemplateResponse dataclass

DocumentsTemplateResponse(template_id: Optional[int] = None, template_name: Optional[str] = None, read_only: Optional[bool] = None)

Definition: DocumentsTemplateResponse

Attributes

template_id class-attribute instance-attribute

template_id: Optional[int] = None

ID of the template applied to the document.

template_name class-attribute instance-attribute

template_name: Optional[str] = None

Name of the template applied to the document.

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True, if template is configured as read only. No changes to the workflow should be made after a read only template is applied.

WorkflowUserResponse dataclass

WorkflowUserResponse(order: Optional[int] = None, user_name: Optional[str] = None, user_email: Optional[str] = None, mobile_number: Optional[str] = None, delivery_method: Optional[str] = None, user_photo_url: Optional[str] = None, group_name: Optional[str] = None, group_members: Optional[List[str]] = None, delegator: Optional[str] = None, gatekeeper: Optional[str] = None, gatekeepers: Optional[WorkflowGatekeeperResponse] = None, role: Optional[str] = None, process_status: Optional[str] = None, processed_on: Optional[str] = None, processed_as: Optional[str] = None, processed_by: Optional[str] = None, reason: Optional[str] = None, placeholder: Optional[str] = None, permission: Optional[WorkflowPermissionResponse] = None, authentications: Optional[AccessResponse] = None, reminder: Optional[ReminderResponse] = None, signing_order: Optional[int] = None, user_national_id: Optional[str] = None, guest_user: Optional[bool] = None, email_language_code: Optional[str] = None, electronic_seal: Optional[ElectronicSealRecipient] = None)

Definition: WorkflowUserResponse

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient in the workflow.

user_name class-attribute instance-attribute

user_name: Optional[str] = None

Name of the recipient if recipient is not a group. If recipient is a placeholder it will contain the name of the placeholder.

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email address of the recipient if recipient is not a group or placeholder.

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number

delivery_method class-attribute instance-attribute

delivery_method: Optional[str] = None

Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS

user_photo_url class-attribute instance-attribute

user_photo_url: Optional[str] = None

API endpoint to access the resource, This will be provided only for main signers. e.g it will be null for group/delegator/gatekeeper etc. This URL does not make sure that signer image is exist. If image exist it will be provided by hitting the defined url otherwise it will be an empty string.

group_name class-attribute instance-attribute

group_name: Optional[str] = None

Name of the group if recipient is a group.

group_members class-attribute instance-attribute

group_members: Optional[List[str]] = None

List of all the email addresses and names of the users.

delegator class-attribute instance-attribute

delegator: Optional[str] = None

Email address of the user who is delegator to this recipient.

gatekeeper class-attribute instance-attribute

gatekeeper: Optional[str] = None

Email address of the user who is gatekeeper to this recipient.

role class-attribute instance-attribute

role: Optional[str] = None

Role of the recipient i.e., "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" or "INPERSON_HOST".

process_status class-attribute instance-attribute

process_status: Optional[str] = None

Document processing status for the recipient. Possible values are "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".

processed_on class-attribute instance-attribute

processed_on: Optional[str] = None

Date and time on which the document was processed.

processed_as class-attribute instance-attribute

processed_as: Optional[str] = None

User may processed the field as COLLABORATOR, DELEGATOR, GROUP_MEMBER or OWNER.

processed_by class-attribute instance-attribute

processed_by: Optional[str] = None

Email address of the user who processed the document.

reason class-attribute instance-attribute

reason: Optional[str] = None

Reason provided by the user when declining, approving or submitting a document.

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

Placeholder text if the recipient is a placeholder.

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

user_national_id class-attribute instance-attribute

user_national_id: Optional[str] = None

National identity number of the user. This helps to identify user in the workflow

guest_user class-attribute instance-attribute

guest_user: Optional[bool] = None

Gest user

email_language_code class-attribute instance-attribute

email_language_code: Optional[str] = None

Email language code

DocumentCertifyResponse dataclass

DocumentCertifyResponse(enabled: Optional[bool] = None, permission: Optional[str] = None)

Definition: DocumentCertifyResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True if certify signature is enabled for the document.

permission class-attribute instance-attribute

permission: Optional[str] = None

It is the certify permissions to be applied on the PDF document when the first signature is created. The possible values are "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" and "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".

DocumentTemplateResponse dataclass

DocumentTemplateResponse(template_name: Optional[str] = None, read_only: Optional[bool] = None)

Definition: DocumentTemplateResponse

Attributes

template_name class-attribute instance-attribute

template_name: Optional[str] = None

Name of the template applied on the document.

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True if the applied template is read only. User will not be able to make any changes if a read only template is applied.

ApplyTemplateRequest dataclass

ApplyTemplateRequest(template_name: Optional[str] = None, apply_to_all: Optional[bool] = None)

Definition: ApplyTemplateRequest

Attributes

template_name class-attribute instance-attribute

template_name: Optional[str] = None

Name of template to be applied on the document.

apply_to_all class-attribute instance-attribute

apply_to_all: Optional[bool] = None

True, if template is to be applied on all the documents in the package.

AddDocumentPackageRequest dataclass

AddDocumentPackageRequest(package_name: Optional[str] = None, workflow_mode: Optional[WorkflowMode] = None, folder_name: Optional[str] = None)

Definition: AddDocumentPackageRequest

Attributes

package_name class-attribute instance-attribute

package_name: Optional[str] = None

The name of the package. Default package name is always "Untitled" if the package_name is not provided.

folder_name class-attribute instance-attribute

folder_name: Optional[str] = None

The name of the folder. It will be used to upload package in any folder of the user, either it is a custom folder or a shared folder.

ApproveRequest dataclass

ApproveRequest(reason: Optional[str] = None)

Definition: ApproveRequest

Attributes

reason class-attribute instance-attribute

reason: Optional[str] = None

The reason for approving a package.

DeclineRequest dataclass

DeclineRequest(reason: Optional[str] = None)

Definition: DeclineRequest

Attributes

reason class-attribute instance-attribute

reason: Optional[str] = None

Reason provided by the user for declining.

RenameDocumentPackageRequest dataclass

RenameDocumentPackageRequest(package_name: Optional[str] = None)

Definition: RenameDocumentPackageRequest

Attributes

package_name class-attribute instance-attribute

package_name: Optional[str] = None

New name of the document package.

RecipientAccessDurationDetails dataclass

RecipientAccessDurationDetails(date_from: Optional[str] = None, date_to: Optional[str] = None)

Definition: RecipientAccessDurationDetails

Attributes

date_from class-attribute instance-attribute

date_from: Optional[str] = None

Start date/time for a recipient to access the document

date_to class-attribute instance-attribute

date_to: Optional[str] = None

End date/time for a recipient to access the document

RecipientDeclineDetails dataclass

RecipientDeclineDetails(reason: Optional[str] = None, auto_decline: Optional[bool] = None, declined_by: Optional[DeclineByDetails] = None)

Definition: RecipientDeclineDetails

Attributes

reason class-attribute instance-attribute

reason: Optional[str] = None

Define reason of document decline

auto_decline class-attribute instance-attribute

auto_decline: Optional[bool] = None

Indication of document is manually/auto declined

DeclineByDetails dataclass

DeclineByDetails(user_name: Optional[str] = None, user_email: Optional[str] = None)

Definition: DeclineByDetails

Attributes

user_name class-attribute instance-attribute

user_name: Optional[str] = None

Name of user who have declined the workflow

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email of user who have declined the workflow

CertifyPermissionResponse dataclass

CertifyPermissionResponse(enabled: Optional[bool] = None, allowed_permissions: Optional[List[str]] = None, default_permission: Optional[str] = None)

Definition: CertifyPermissionResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True if certify signature is enabled for the document.

allowed_permissions class-attribute instance-attribute

allowed_permissions: Optional[List[str]] = None

Set of allowed certify permission levels for the document.

default_permission class-attribute instance-attribute

default_permission: Optional[str] = None

Selected permission level for the certify signature settings.

UploadDocumentMetaInfoDetail dataclass

UploadDocumentMetaInfoDetail(attachments: Optional[bool] = None, form_fields: Optional[bool] = None, blank_signatures: Optional[bool] = None, signed_signatures: Optional[bool] = None, conformance: Optional[str] = None, locked: Optional[bool] = None, certify: Optional[str] = None, qr_code: Optional[bool] = None)

Definition: UploadDocumentMetaInfoDetail

Attributes

attachments class-attribute instance-attribute

attachments: Optional[bool] = None

true if pdf document has any attachment

form_fields class-attribute instance-attribute

form_fields: Optional[bool] = None

true if pdf document has any form field

blank_signatures class-attribute instance-attribute

blank_signatures: Optional[bool] = None

true if pdf document has any blank signature field

signed_signatures class-attribute instance-attribute

signed_signatures: Optional[bool] = None

true if pdf document has any signed signature field

conformance class-attribute instance-attribute

conformance: Optional[str] = None

null/empty if document does not contains any conformance level otherwise contains formation like 1A, 1B etc

locked class-attribute instance-attribute

locked: Optional[bool] = None

true if pdf document is locked

certify class-attribute instance-attribute

certify: Optional[str] = None

CertifyLevel of pdf document. Possible values NotCertified, NoChangesAllowed, FormFilling, FormFillingAndAnnotations

qr_code class-attribute instance-attribute

qr_code: Optional[bool] = None

true if pdf document has any Qr Code, otherwise its false

RenameDocumentRequest dataclass

RenameDocumentRequest(document_name: Optional[str] = None)

Definition: RenameDocumentRequest

Attributes

document_name class-attribute instance-attribute

document_name: Optional[str] = None

New name of the document.

VerificationResponse dataclass

VerificationResponse(field_name: Optional[str] = None, signer_name: Optional[str] = None, signature_status: Optional[str] = None, signing_reason: Optional[str] = None, signing_location: Optional[str] = None, contact_information: Optional[str] = None, signing_time: Optional[str] = None, ltv: Optional[bool] = None, qualified: Optional[bool] = None, certified: Optional[bool] = None, certify_permission: Optional[str] = None, timestamp_at: Optional[str] = None, timestamp_authority: Optional[str] = None, subject_dn: Optional[str] = None, issuer_dn: Optional[str] = None, cert_valid_from: Optional[str] = None, cert_valid_to: Optional[str] = None, signature_type: Optional[str] = None, signature_algorithm: Optional[str] = None, signature_application: Optional[str] = None, signature_policy_id: Optional[int] = None, signature_policy_uri: Optional[str] = None, signer_photo: Optional[str] = None, signer_photo_url: Optional[str] = None, signed_hash: Optional[str] = None, display: Optional[str] = None, page_number: Optional[int] = None, lei_number: Optional[str] = None, lei_role: Optional[str] = None, error_message: Optional[str] = None)

Definition: VerificationResponse

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field for which the verification was requested.

signer_name class-attribute instance-attribute

signer_name: Optional[str] = None

Name of the signer.

signature_status class-attribute instance-attribute

signature_status: Optional[str] = None

If the overall status of the signature is valid or not. Possible values are "VALID" or "INVALID".

signing_reason class-attribute instance-attribute

signing_reason: Optional[str] = None

Reason provided by the user while signing the field. In case of witness signing, custom signing reason would be set

signing_location class-attribute instance-attribute

signing_location: Optional[str] = None

Location entered by the user while signing the field.

contact_information class-attribute instance-attribute

contact_information: Optional[str] = None

Contact information entered by the user while signing the field.

signing_time class-attribute instance-attribute

signing_time: Optional[str] = None

Date and time of signing in 8601 format. Default timezone from SH Admin is followed the the time.

ltv class-attribute instance-attribute

ltv: Optional[bool] = None

True, if signature is LTV.

qualified class-attribute instance-attribute

qualified: Optional[bool] = None

True, if signatures are qualified.

certified class-attribute instance-attribute

certified: Optional[bool] = None

True, if signatures are certified.

certify_permission class-attribute instance-attribute

certify_permission: Optional[str] = None

Permission level for certified digital signature.

timestamp_at class-attribute instance-attribute

timestamp_at: Optional[str] = None

Date and time when signature was time-stamped.

timestamp_authority class-attribute instance-attribute

timestamp_authority: Optional[str] = None

Authority by which the signature was time-stamped.

subject_dn class-attribute instance-attribute

subject_dn: Optional[str] = None

Subject DN from the certificate used while signing the field.

issuer_dn class-attribute instance-attribute

issuer_dn: Optional[str] = None

Issuers DN from the certificate used while signing the field.

cert_valid_from class-attribute instance-attribute

cert_valid_from: Optional[str] = None

Date and time from which the certificate is valid.

cert_valid_to class-attribute instance-attribute

cert_valid_to: Optional[str] = None

Date and time to which the certificate is valid.

signature_type class-attribute instance-attribute

signature_type: Optional[str] = None

Type of signatures, possible values are "PADES_PART2" or "PADES_PART4".

signature_algorithm class-attribute instance-attribute

signature_algorithm: Optional[str] = None

Signature algorithm used while signing the field.

signature_application class-attribute instance-attribute

signature_application: Optional[str] = None

Application name from where the field was signed.

signature_policy_id class-attribute instance-attribute

signature_policy_id: Optional[int] = None

Signature policy ID.

signature_policy_uri class-attribute instance-attribute

signature_policy_uri: Optional[str] = None

Signature policy URI.

signer_photo class-attribute instance-attribute

signer_photo: Optional[str] = None

Base64 image of the signer's avatar.

signed_hash class-attribute instance-attribute

signed_hash: Optional[str] = None

Hash of the document that was signed in respective signature.

page_number class-attribute instance-attribute

page_number: Optional[int] = None

Page number of the signature field

lei_number class-attribute instance-attribute

lei_number: Optional[str] = None

LEI number if availbale in certificate

lei_role class-attribute instance-attribute

lei_role: Optional[str] = None

LEI role if available in certificate

error_message class-attribute instance-attribute

error_message: Optional[str] = None

An error message returns in case the application unable to get verification results.

BulkSignRequest dataclass

BulkSignRequest(ids: Optional[List[int]] = None, hand_signature_initials_image: Optional[str] = None, hand_signature_initials_method: Optional[HandSignature] = None, hand_signature_image: Optional[str] = None, hand_signature_method: Optional[HandSignature] = None, signing_reason: Optional[str] = None, signing_location: Optional[str] = None, contact_information: Optional[str] = None, appearance_design: Optional[str] = None, signing_server: Optional[str] = None, signing_capacity: Optional[str] = None, authentication: Optional[BulkSignAuthentication] = None, transaction_id: Optional[str] = None)

Definition: BulkSignRequest

Attributes

ids class-attribute instance-attribute

ids: Optional[List[int]] = None

An array of the document package ids that are selected for bulk signing.

hand_signature_initials_image class-attribute instance-attribute

hand_signature_initials_image: Optional[str] = None

Base64 image used for the filling of the initials

hand_signature_image class-attribute instance-attribute

hand_signature_image: Optional[str] = None

Base64 encoded string image of the visible signature appearance

signing_reason class-attribute instance-attribute

signing_reason: Optional[str] = None

Reason of signing provided by the recipient.

signing_location class-attribute instance-attribute

signing_location: Optional[str] = None

Locale of the signer provided by the recipient

contact_information class-attribute instance-attribute

contact_information: Optional[str] = None

Contact information of the signer provided by the recipient

appearance_design class-attribute instance-attribute

appearance_design: Optional[str] = None

Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"

signing_server class-attribute instance-attribute

signing_server: Optional[str] = None

Name of signing server using which the document is to be signed

signing_capacity class-attribute instance-attribute

signing_capacity: Optional[str] = None

Name of certification profile/signing capacity using which the document is to be signed

transaction_id class-attribute instance-attribute

transaction_id: Optional[str] = None

re-initiated signing process transaction id

BulkSignAuthentication dataclass

BulkSignAuthentication(mechanism: Optional[str] = None, password: Optional[str] = None, token: Optional[str] = None, user_identifier: Optional[str] = None, id: Optional[str] = None, code_verifier: Optional[str] = None, nonce: Optional[str] = None)

Definition: BulkSignAuthentication

Attributes

mechanism class-attribute instance-attribute

mechanism: Optional[str] = None

Mechanism of the authentication. Possible values for mechanism are: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC

password class-attribute instance-attribute

password: Optional[str] = None

It is an optional parameter, but it's only required when using 'AUTHENTICATION_PASSWORD' as a parameter value under 'mechanism'

token class-attribute instance-attribute

token: Optional[str] = None

It is an optional parameter that will be received from third party server, but it's only required when using either 'AUTHENTICATION_AZURE_ACTIVE_DIRECTORY', 'AUTHENTICATION_OFFICE_365', 'AUTHENTICATION_OAUTH2' 'AUTHENTICATION_OIDC' 'AUTHENTICATION_GOOGLE' 'AUTHENTICATION_LINKED_IN' 'AUTHENTICATION_SALES_FORCE' as a parameter value under 'mechanism'

user_identifier class-attribute instance-attribute

user_identifier: Optional[str] = None

It is an optional parameter, but it's only required when using 'AUTHENTICATION_ACTIVE_DIRECTORY' or 'AUTHENTICATION_SAML' as a parameter value under 'mechanism'

id class-attribute instance-attribute

id: Optional[str] = None

It is an optional parameter, but it's only required when using 'AUTHENTICATION_SALES_FORCE' or 'AUTHENTICATION_IDFY' as a parameter value under 'mechanism'. For 'AUTHENTICATION_IDFY' it's requestId

code_verifier class-attribute instance-attribute

code_verifier: Optional[str] = None

Code Verifier if PKCE is enabled for the client.

nonce class-attribute instance-attribute

nonce: Optional[str] = None

Nonce value if it is enabled for the client.

BulkSignPackagesStatus dataclass

BulkSignPackagesStatus(id: Optional[int] = None, name: Optional[str] = None, status: Optional[str] = None, action: Optional[str] = None, error: Optional[str] = None, percentage: Optional[int] = None, documents: Optional[List[BulkSignActionDocumentModel]] = None)

Definition: BulkSignPackagesStatus

Attributes

action class-attribute instance-attribute

action: Optional[str] = None

Required action key if any

documents class-attribute instance-attribute

documents: Optional[List[BulkSignActionDocumentModel]] = None

Documents in the current package

BulkSignActionDocumentModel dataclass

BulkSignActionDocumentModel(id: Optional[int] = None, fields: Optional[List[BulkSignActionFieldModel]] = None)

Definition: BulkSignActionDocumentModel

BulkSignActionFieldModel dataclass

BulkSignActionFieldModel(name: Optional[str] = None, hash: Optional[str] = None, hashing_algo: Optional[str] = None)

Definition: BulkSignActionFieldModel

BulkSignStatusRequest dataclass

BulkSignStatusRequest(transaction_id: Optional[str] = None)

Definition: BulkSignStatusRequest

Attributes

transaction_id class-attribute instance-attribute

transaction_id: Optional[str] = None

The identification number of the bulk signing transaction

SignDocumentRequest dataclass

SignDocumentRequest(field_name: Optional[str] = None, hand_signature_image: Optional[str] = None, hand_signature_method: Optional[HandSignature] = None, signing_reason: Optional[str] = None, signing_location: Optional[str] = None, contact_information: Optional[str] = None, user_name: Optional[str] = None, user_password: Optional[str] = None, appearance_design: Optional[str] = None, signing_capacity: Optional[str] = None, skip_verification: Optional[bool] = None, signing_server: Optional[str] = None, authentication: Optional[Authentication] = None)

Definition: SignDocumentRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the signature field in the document.

hand_signature_image class-attribute instance-attribute

hand_signature_image: Optional[str] = None

Base64 encoded string image of the visible signature appearance, which is placed onto the document. Note this can be retrieved from the user's personal settings using this call. (The response is binary, so the business application must then Base64 encode it before submitting in this API call.)

signing_reason class-attribute instance-attribute

signing_reason: Optional[str] = None

Reason of signing provided by the recipient. Note: Commitment type indication for XML documents

signing_location class-attribute instance-attribute

signing_location: Optional[str] = None

Locale of the signer provided by the recipient.

contact_information class-attribute instance-attribute

contact_information: Optional[str] = None

Contact information of the signer provided by the recipient.

user_name class-attribute instance-attribute

user_name: Optional[str] = None

Name of the signer provided by the recipient. Note this applies to in-person signing operations only.

user_password class-attribute instance-attribute

user_password: Optional[str] = None

Password provided by the user subject to user's signature settings.

appearance_design class-attribute instance-attribute

appearance_design: Optional[str] = None

Name of the signature appearance provided by user for signing. In case no appearance name is provided then default selected appearance would be used. Possible values are "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE"

signing_capacity class-attribute instance-attribute

signing_capacity: Optional[str] = None

Name of certification profile/signing capacity using which the document is to be signed. If not provided the default capacity will be used to sign. Provided name must be exactly same as of the actual profile due to case sensitivity.

skip_verification class-attribute instance-attribute

skip_verification: Optional[bool] = None

No signature verification returns in response body when it is set as true. Default value for this parameter set to false.

signing_server class-attribute instance-attribute

signing_server: Optional[str] = None

Name of signing server using which the document is to be signed.

Authentication dataclass

Authentication(mechanism: Optional[str] = None, password: Optional[str] = None, token: Optional[str] = None, user_identifier: Optional[str] = None, id: Optional[str] = None, code_verifier: Optional[str] = None, nonce: Optional[str] = None)

Definition: Authentication

Attributes

mechanism class-attribute instance-attribute

mechanism: Optional[str] = None

Mechanism of the authentication. Possible values for mechanism are: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC

password class-attribute instance-attribute

password: Optional[str] = None

It is an optional parameter, but it's only required when using 'AUTHENTICATION_PASSWORD' as a parameter value under 'mechanism'

token class-attribute instance-attribute

token: Optional[str] = None

It is an optional parameter that will be received from third party server, but it's only required when using either 'AUTHENTICATION_AZURE_ACTIVE_DIRECTORY', 'AUTHENTICATION_OFFICE_365', 'AUTHENTICATION_OAUTH2' 'AUTHENTICATION_OIDC' 'AUTHENTICATION_GOOGLE' 'AUTHENTICATION_LINKED_IN' 'AUTHENTICATION_SALES_FORCE' as a parameter value under 'mechanism'

user_identifier class-attribute instance-attribute

user_identifier: Optional[str] = None

It is an optional parameter, but it's only required when using 'AUTHENTICATION_ACTIVE_DIRECTORY' or 'AUTHENTICATION_SAML' as a parameter value under 'mechanism'

id class-attribute instance-attribute

id: Optional[str] = None

It is an optional parameter, but it's only required when using 'AUTHENTICATION_SALES_FORCE' or 'AUTHENTICATION_IDFY' as a parameter value under 'mechanism'. For 'AUTHENTICATION_IDFY' it's requestId

code_verifier class-attribute instance-attribute

code_verifier: Optional[str] = None

Code Verifier if PKCE is enabled for the client.

nonce class-attribute instance-attribute

nonce: Optional[str] = None

Nonce value if it is enabled for the client.

AutoPlaceFieldRequest dataclass

AutoPlaceFieldRequest(search_text: Optional[str] = None, order: Optional[int] = None, placement: Optional[str] = None, field_type: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, dimensions: Optional[FieldDimension] = None, placeholder: Optional[str] = None, radio_group_name: Optional[str] = None, format: Optional[str] = None, value: Optional[str] = None, max_length: Optional[int] = None, validation_rule: Optional[str] = None, validation: Optional[FieldValidationValue] = None, font: Optional[Font] = None, multiline: Optional[bool] = None)

Definition: AutoPlaceFieldRequest

Attributes

search_text class-attribute instance-attribute

search_text: Optional[str] = None

Word that needs to be searched in the document.

order class-attribute instance-attribute

order: Optional[int] = None

Order of the user to which the fields will be assigned automatically. Workflow in SigningHub orders recipients. This list begins with "1" for the first designated signer.

placement class-attribute instance-attribute

placement: Optional[str] = None

If the text is found, fields are to be placed in the document. Placement of the field can be mentioned in this attribute. Possible values of placement of a field are LEFT, RIGHT, TOP, BOTTOM. If no value is provided the default value will be LEFT.

field_type class-attribute instance-attribute

field_type: Optional[str] = None

Type of field to be created in the document. Possible values are "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER" ,"NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"

level_of_assurance class-attribute instance-attribute

level_of_assurance: Optional[List[str]] = None

Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

Provide note in the case of Mandatory Attachment

radio_group_name class-attribute instance-attribute

radio_group_name: Optional[str] = None

The group name required only when adding a Radio Box type field to group multiple Radio boxes together.

format class-attribute instance-attribute

format: Optional[str] = None

Text format of the field. Used for the date type field only. Possible values are

• m/d
• m/d/yy
• m/d/yyyy
• mm/dd/yy
• mm/dd/yyyy
• mm/yy
• mm/yyyy
• d-mmm
• d-mmm-yy
• d-mmm-yyyy
• dd-mmm-yy
• dd-mmm-yyyy
• yy-mm-dd
• yyyy-mm-dd
• mmm-yy
• mmm-yyyy
• mmmm-yy
• mmmm-yyyy
• mmmm d, yyyy
• dd/mm/yy
• ddmmmyyyy

value class-attribute instance-attribute

value: Optional[str] = None

Value that user want to show in the field.

max_length class-attribute instance-attribute

max_length: Optional[int] = None

Maximum length of the value allowed in the field. Must between 1 - 9999

validation_rule class-attribute instance-attribute

validation_rule: Optional[str] = None

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

multiline class-attribute instance-attribute

multiline: Optional[bool] = None

This belongs to Text Area field type and If set to true, text area field would be created with multi line option.

Font dataclass

Font(name: Optional[str] = None, size: Optional[str] = None, embedded_size: Optional[str] = None)

Definition: Font

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of the font selected for the text field. Possible values are "COURIER", "HELVETICA".

size class-attribute instance-attribute

size: Optional[str] = None

Size of the font selected for the text field. Possible values are 8, 10, 12, 14, 16, 18, 20

embedded_size class-attribute instance-attribute

embedded_size: Optional[str] = None

Size of the font in the original PDF document.

FormFillingRequest dataclass

FormFillingRequest(auto_save: Optional[bool] = None, text: Optional[List[TextFormFillingRequest]] = None, radio: Optional[List[RadioFormFillingRequest]] = None, checkbox: Optional[List[CheckBoxFormFillingRequest]] = None, dropdown: Optional[List[DropDownFormFillingRequest]] = None, listbox: Optional[List[ListBoxFormFillingRequest]] = None)

Definition: FormFillingRequest

Attributes

auto_save class-attribute instance-attribute

auto_save: Optional[bool] = None

Default value is false. True, if the form fields are being saved without user intervention e.g., while closing the document or pressing back. For Signing, Initials, In-persons, Reviewing, Submit actions the value is false.

text class-attribute instance-attribute

text: Optional[List[TextFormFillingRequest]] = None

It has the list of textboxes data to save

radio class-attribute instance-attribute

radio: Optional[List[RadioFormFillingRequest]] = None

It has the list of radios value to save

checkbox class-attribute instance-attribute

checkbox: Optional[List[CheckBoxFormFillingRequest]] = None

It has the list of checkboxes value to save

dropdown class-attribute instance-attribute

dropdown: Optional[List[DropDownFormFillingRequest]] = None

It has the list of dropdowns value to save

listbox class-attribute instance-attribute

listbox: Optional[List[ListBoxFormFillingRequest]] = None

It has the list of listboxes value to save

TextFormFillingRequest dataclass

TextFormFillingRequest(field_name: Optional[str] = None, value: Optional[str] = None)

Definition: TextFormFillingRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field in the document.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field to be saved in the document.

RadioFormFillingRequest dataclass

RadioFormFillingRequest(field_name: Optional[str] = None, radio_group_name: Optional[str] = None, value: Optional[bool] = None)

Definition: RadioFormFillingRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field in the document.

radio_group_name class-attribute instance-attribute

radio_group_name: Optional[str] = None

Group name to which the radio button belongs.

value class-attribute instance-attribute

value: Optional[bool] = None

Value of the field to be saved in the document.

CheckBoxFormFillingRequest dataclass

CheckBoxFormFillingRequest(field_name: Optional[str] = None, value: Optional[bool] = None)

Definition: CheckBoxFormFillingRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field in the document.

value class-attribute instance-attribute

value: Optional[bool] = None

Value of the field to be saved in the document.

DropDownFormFillingRequest dataclass

DropDownFormFillingRequest(field_name: Optional[str] = None, value: Optional[str] = None)

Definition: DropDownFormFillingRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field in the document.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field to be saved in the document.

ListBoxFormFillingRequest dataclass

ListBoxFormFillingRequest(field_name: Optional[str] = None, value: Optional[str] = None)

Definition: ListBoxFormFillingRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field in the document.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field to be saved in the document.

InitialFieldRequest dataclass

InitialFieldRequest(order: Optional[int] = None, page_no: Optional[int] = None, field_name: Optional[str] = None, dimensions: Optional[FieldDimension] = None)

Definition: InitialFieldRequest

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

The order of the user in workflow for which the field is being added.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

InitialFillingRequest dataclass

InitialFillingRequest(field_name: Optional[str] = None, image: Optional[str] = None, method: Optional[HandSignature] = None, apply_to_all: Optional[bool] = None)

Definition: InitialFillingRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field in the document.

image class-attribute instance-attribute

image: Optional[str] = None

Base64 image used for the filling of the initials.

apply_to_all class-attribute instance-attribute

apply_to_all: Optional[bool] = None

True if all initials are to be filled.

UpdateInitialFieldRequest dataclass

UpdateInitialFieldRequest(field_name: Optional[str] = None, renamed_as: Optional[str] = None, page_no: Optional[int] = None, dimensions: Optional[FieldDimension] = None)

Definition: UpdateInitialFieldRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Current name of the field, that is to be updated.

renamed_as class-attribute instance-attribute

renamed_as: Optional[str] = None

Updated name of the field if renaming is intended.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

InPersonFieldRequest dataclass

InPersonFieldRequest(order: Optional[int] = None, page_no: Optional[int] = None, field_name: Optional[str] = None, placeholder: Optional[str] = None, dimensions: Optional[FieldDimension] = None, display: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, authentication_signing: Optional[SignatureFieldAuthentication] = None)

Definition: InPersonFieldRequest

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

The order of the user in workflow for which the field is being added.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

String identifier for the inperson field, it can be Customer, Jack, CEO etc.

display class-attribute instance-attribute

display: Optional[str] = None

Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE"

level_of_assurance class-attribute instance-attribute

level_of_assurance: Optional[List[str]] = None

Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"

UpdateInPersonFieldRequest dataclass

UpdateInPersonFieldRequest(field_name: Optional[str] = None, renamed_as: Optional[str] = None, page_no: Optional[int] = None, placeholder: Optional[str] = None, dimensions: Optional[FieldDimension] = None, display: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, authentication_signing: Optional[SignatureFieldAuthentication] = None)

Definition: UpdateInPersonFieldRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Current name of the field, that is to be updated.

renamed_as class-attribute instance-attribute

renamed_as: Optional[str] = None

updated name of the field, if renaming is intended.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

String identifier for the in-person field, it can be Customer, Jack, CEO etc.

display class-attribute instance-attribute

display: Optional[str] = None

Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE"

level_of_assurance class-attribute instance-attribute

level_of_assurance: Optional[List[str]] = None

Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"

DigitalSignatureFieldRequest dataclass

DigitalSignatureFieldRequest(order: Optional[int] = None, page_no: Optional[int] = None, field_name: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, dimensions: Optional[FieldDimension] = None, display: Optional[str] = None, authentication_signing: Optional[SignatureFieldAuthentication] = None)

Definition: DigitalSignatureFieldRequest

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient for which the field is being created.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number at which the field is about to be created.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

level_of_assurance class-attribute instance-attribute

level_of_assurance: Optional[List[str]] = None

Level Of Assurance to be added. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

display class-attribute instance-attribute

display: Optional[str] = None

Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE"

UpdateDigitalSignatureFieldRequest dataclass

UpdateDigitalSignatureFieldRequest(field_name: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, renamed_as: Optional[str] = None, page_no: Optional[int] = None, dimensions: Optional[FieldDimension] = None, display: Optional[str] = None, authentication_signing: Optional[SignatureFieldAuthentication] = None)

Definition: UpdateDigitalSignatureFieldRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Current name of the field, which is to be updated.

level_of_assurance class-attribute instance-attribute

level_of_assurance: Optional[List[str]] = None

Level Of Assurance to be updated. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

renamed_as class-attribute instance-attribute

renamed_as: Optional[str] = None

Updated name of the field if renaming of the field is intended.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

display class-attribute instance-attribute

display: Optional[str] = None

Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE"

CheckBoxFieldRequest dataclass

CheckBoxFieldRequest(order: Optional[int] = None, page_no: Optional[int] = None, field_name: Optional[str] = None, value: Optional[str] = None, dimensions: Optional[FieldDimension] = None, validation_rule: Optional[str] = None)

Definition: CheckBoxFieldRequest

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

The order of the user in workflow for which the field is being added.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field. Possible values are "true" or "false"

validation_rule class-attribute instance-attribute

validation_rule: Optional[str] = None

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

UpdateCheckBoxFieldRequest dataclass

UpdateCheckBoxFieldRequest(field_name: Optional[str] = None, renamed_as: Optional[str] = None, page_no: Optional[int] = None, value: Optional[str] = None, dimensions: Optional[FieldDimension] = None, validation_rule: Optional[str] = None)

Definition: UpdateCheckBoxFieldRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Current name of the field, that is to be updated.

renamed_as class-attribute instance-attribute

renamed_as: Optional[str] = None

Updated name of the field if renaming is intended.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field. Possible values are "true" or "false"

validation_rule class-attribute instance-attribute

validation_rule: Optional[str] = None

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

TextBoxFieldRequest dataclass

TextBoxFieldRequest(order: Optional[int] = None, page_no: Optional[int] = None, type_: Optional[TextboxType] = None, value: Optional[str] = None, placeholder: Optional[str] = None, max_length: Optional[int] = None, format: Optional[str] = None, field_name: Optional[str] = None, field_type: Optional[FieldType] = None, validation_rule: Optional[ValidationRule] = None, validation: Optional[FieldValidationValue] = None, font: Optional[Font] = None, dimensions: Optional[FieldDimension] = None, multiline: Optional[bool] = None)

Definition: TextBoxFieldRequest

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

The order of the user in workflow for which the field is being added.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

Placeholder text for the text field. For name, email, company, job title and date, placeholder value can be "NAME", "EMAIL", "COMPANY", "JOBTITLE", "DATE". Developers can send their own placeholders to overwrite the default values. For "TEXT" developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.

max_length class-attribute instance-attribute

max_length: Optional[int] = None

Maximum length of the value allowed in the field. Must between 1 - 9999

format class-attribute instance-attribute

format: Optional[str] = None

Text format of the field. Used for the date type field only. Possible values are

• m/d
• m/d/yy
• m/d/yyyy
• mm/dd/yy
• mm/dd/yyyy
• mm/yy
• mm/yyyy
• d-mmm
• d-mmm-yy
• d-mmm-yyyy
• dd-mmm-yy
• dd-mmm-yyyy
• yy-mm-dd
• yyyy-mm-dd
• mmm-yy
• mmm-yyyy
• mmmm-yy
• mmmm-yyyy
• mmmm d, yyyy
• dd/mm/yy
• ddmmmyyyy

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.

multiline class-attribute instance-attribute

multiline: Optional[bool] = None

If set to true, text area field would be created

UpdateTextBoxFieldRequest dataclass

UpdateTextBoxFieldRequest(field_name: Optional[str] = None, renamed_as: Optional[str] = None, page_no: Optional[int] = None, value: Optional[str] = None, max_length: Optional[int] = None, field_type: Optional[FieldType] = None, validation_rule: Optional[ValidationRule] = None, font: Optional[Font] = None, dimensions: Optional[FieldDimension] = None, placeholder: Optional[str] = None, format: Optional[str] = None, validation: Optional[FieldValidationValue] = None)

Definition: UpdateTextBoxFieldRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Current name of the field, that is to be updated.

renamed_as class-attribute instance-attribute

renamed_as: Optional[str] = None

Updated name of the field if renaming is intended.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field. For type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.

max_length class-attribute instance-attribute

max_length: Optional[int] = None

Maximum length of the value allowed in the field. Must between 1 - 9999

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.

format class-attribute instance-attribute

format: Optional[str] = None

Text format of the field. Used for the date type field only. Possible values are

• m/d
• m/d/yy
• m/d/yyyy
• mm/dd/yy
• mm/dd/yyyy
• mm/yy
• mm/yyyy
• d-mmm
• d-mmm-yy
• d-mmm-yyyy
• dd-mmm-yy
• dd-mmm-yyyy
• yy-mm-dd
• yyyy-mm-dd
• mmm-yy
• mmm-yyyy
• mmmm-yy
• mmmm-yyyy
• mmmm d, yyyy
• dd/mm/yy
• ddmmmyyyy

RadioBoxFieldRequest dataclass

RadioBoxFieldRequest(order: Optional[int] = None, page_no: Optional[int] = None, field_name: Optional[str] = None, value: Optional[str] = None, validation_rule: Optional[ValidationRule] = None, radio_group_name: Optional[str] = None, dimensions: Optional[FieldDimension] = None)

Definition: RadioBoxFieldRequest

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

The order of the user in workflow for which the field is being added.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field. Possible values are "true" or "false"

UpdateRadioBoxFieldRequest dataclass

UpdateRadioBoxFieldRequest(field_name: Optional[str] = None, renamed_as: Optional[str] = None, page_no: Optional[int] = None, value: Optional[str] = None, validation_rule: Optional[ValidationRule] = None, radio_group_name: Optional[str] = None, dimensions: Optional[FieldDimension] = None)

Definition: UpdateRadioBoxFieldRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Current name of the field, that is to be updated.

renamed_as class-attribute instance-attribute

renamed_as: Optional[str] = None

Updated name of the field if renaming is intended.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number on which the field is to be created.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field. Possible values are "true" or "false"

radio_group_name class-attribute instance-attribute

radio_group_name: Optional[str] = None

The group name to which the field belongs.

WorkSpaceMembers dataclass

WorkSpaceMembers(name: Optional[str] = None, email: Optional[str] = None)

Definition: WorkSpaceMembers

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of work space member

email class-attribute instance-attribute

email: Optional[str] = None

Email Address of work space member

WorkSpaceOwner dataclass

WorkSpaceOwner(name: Optional[str] = None, email: Optional[str] = None)

Definition: WorkSpaceOwner

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of work space owner

email class-attribute instance-attribute

email: Optional[str] = None

Email Address of work space owner

UploadDocumentLibraryCertifyResponse dataclass

UploadDocumentLibraryCertifyResponse(enabled: Optional[bool] = None, allowed_permissions: Optional[List[str]] = None, default_permission: Optional[str] = None, permission: Optional[str] = None)

Definition: UploadDocumentLibraryCertifyResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True if certify signature is enabled for the document.

allowed_permissions class-attribute instance-attribute

allowed_permissions: Optional[List[str]] = None

Set of allowed certify permission levels for the document.

default_permission class-attribute instance-attribute

default_permission: Optional[str] = None

Selected permission level for the certify signature settings.

permission class-attribute instance-attribute

permission: Optional[str] = None

It is the certify permissions to be applied on the PDF document when the first signature is created. The possible values are "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" and "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED".

UploadDocumentLibraryTemplateResponse dataclass

UploadDocumentLibraryTemplateResponse(template_name: Optional[str] = None, read_only: Optional[bool] = None)

Definition: UploadDocumentLibraryTemplateResponse

Attributes

template_name class-attribute instance-attribute

template_name: Optional[str] = None

Name of the template applied on the document.

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True if the applied template is read only. User will not be able to make any changes if a read only template is applied.

WorkflowPermissionsUpdateRequest dataclass

WorkflowPermissionsUpdateRequest(apply_to_all: Optional[bool] = None, permissions: Optional[WorkflowPermission] = None)

Definition: WorkflowPermissionsUpdateRequest

Attributes

apply_to_all class-attribute instance-attribute

apply_to_all: Optional[bool] = None

True, if the permissions are to be applied on all the recipients in the workflow.

WorkflowPermission dataclass

WorkflowPermission(print: Optional[bool] = None, download: Optional[bool] = None, add_text: Optional[bool] = None, change_recipients: Optional[bool] = None, add_attachment: Optional[bool] = None, legal_notice: Optional[PermissionLegalNotice] = None, attachment: Optional[AttachmentPermissionRequest] = None)

Definition: WorkflowPermission

Attributes

print class-attribute instance-attribute

print: Optional[bool] = None

It defines whether recipient is allowed to print the document.

download class-attribute instance-attribute

download: Optional[bool] = None

It defines whether recipient is allowed to download the document.

add_text class-attribute instance-attribute

add_text: Optional[bool] = None

It defines whether recipient is allowed to add text fields in the document.

change_recipients class-attribute instance-attribute

change_recipients: Optional[bool] = None

It allows the user to change any recipient who has not signed yet.

add_attachment class-attribute instance-attribute

add_attachment: Optional[bool] = None

It defines whether recipient is allowed to add attachments in the PDF document.

AttachmentPermissionRequest dataclass

AttachmentPermissionRequest(enabled: Optional[bool] = None)

Definition: AttachmentPermissionRequest

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

Enabled

PermissionLegalNotice dataclass

PermissionLegalNotice(enabled: Optional[bool] = None, legal_notice_name: Optional[str] = None)

Definition: PermissionLegalNotice

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if legal notice is enabled.

legal_notice_name class-attribute instance-attribute

legal_notice_name: Optional[str] = None

Name of the legal notice selected for the recipient.

DocumentLogsActions dataclass

DocumentLogsActions(log_id: Optional[int] = None, date_time: Optional[str] = None, action_type: Optional[str] = None, user_email: Optional[str] = None, user_name: Optional[str] = None, enterprise_name: Optional[str] = None, information: Optional[DocumentLogsActionsInformation] = None)

Definition: DocumentLogsActions

Attributes

log_id class-attribute instance-attribute

log_id: Optional[int] = None

ID of an action performed on the document.

date_time class-attribute instance-attribute

date_time: Optional[str] = None

Date and time when the action was performed.

user_email class-attribute instance-attribute

user_email: Optional[str] = None

Email of the user who performed the action.

user_name class-attribute instance-attribute

user_name: Optional[str] = None

Name of the user who performed the action.

enterprise_name class-attribute instance-attribute

enterprise_name: Optional[str] = None

The name of Enterprise to which the user belongs. If the user doesn't belong to an enterprise, then this element is not present.

DocumentLogsActionsInformation dataclass

DocumentLogsActionsInformation(type_: Optional[str] = None, value: Optional[str] = None)

Definition: DocumentLogsActionsInformation

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type of extra information about the action e.g. "SIGNING_METHOD" which means what signing method user used to sign the document.

value class-attribute instance-attribute

value: Optional[str] = None

The value of the extra information about the action e.g. "LOCAL" which means user signed the document using locally held credentials.

WorkflowUserUpdateRequest dataclass

WorkflowUserUpdateRequest(user_email: Optional[str] = None, user_name: Optional[str] = None, email_notification: Optional[bool] = None, mobile_number: Optional[str] = None, role: Optional[WorkflowCollaboratorRole] = None, signing_order: Optional[int] = None, email_language_code: Optional[str] = None, delivery_method: Optional[DeliveryMethod] = None)

Definition: WorkflowUserUpdateRequest

Attributes

user_email class-attribute instance-attribute

user_email: Optional[str] = None

The email address of the new user to be updated in workflow. If no value is provided, old value will be retained.

user_name class-attribute instance-attribute

user_name: Optional[str] = None

Name of the recipient to be updated. If no value is provided, old value will be retained.

email_notification class-attribute instance-attribute

email_notification: Optional[bool] = None

Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained.

mobile_number class-attribute instance-attribute

mobile_number: Optional[str] = None

Mobile number. If no value is provided, old value will be retained.

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

email_language_code class-attribute instance-attribute

email_language_code: Optional[str] = None

email language code

WorkflowUserReorderRequest dataclass

WorkflowUserReorderRequest(order: Optional[int] = None)

Definition: WorkflowUserReorderRequest

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

The order of the recipient which is to be updated.

UpdateReminderRequest dataclass

UpdateReminderRequest(apply_to_all: Optional[bool] = None, enabled: Optional[bool] = None, frequency: Optional[str] = None, remind_after: Optional[int] = None, repeat: Optional[RepeatRequest] = None)

Definition: UpdateReminderRequest

Attributes

apply_to_all class-attribute instance-attribute

apply_to_all: Optional[bool] = None

True, if reminder settings are to be applied on all the recipients in the workflow.

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if reminder settings are to be enabled.

frequency class-attribute instance-attribute

frequency: Optional[str] = None

Reminder Frequency. Possible Values are DAYS | HOURS.

remind_after class-attribute instance-attribute

remind_after: Optional[int] = None

Required, in case of enabled property will true. The number of days after which the first reminder would be sent to workflow user.

RepeatRequest dataclass

RepeatRequest(enabled: Optional[bool] = None, frequency: Optional[str] = None, keep_reminding_after: Optional[int] = None, total_reminders: Optional[int] = None)

Definition: RepeatRequest

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if subsequent reminders are enabled.

frequency class-attribute instance-attribute

frequency: Optional[str] = None

Repeat Reminder Frequency. Possible Values are DAYS | HOURS.

keep_reminding_after class-attribute instance-attribute

keep_reminding_after: Optional[int] = None

Required, in case of enabled property will true. The number of days after which the subsequent reminders would be sent to workflow user.

total_reminders class-attribute instance-attribute

total_reminders: Optional[int] = None

Required, in case of enabled property will true. The number of subsequent reminders would be sent to workflow user.

WorflowGroupRequest dataclass

WorflowGroupRequest(group_name: Optional[str] = None, email_notification: Optional[bool] = None, role: Optional[CollaboratorRole] = None, signing_order: Optional[int] = None)

Definition: WorflowGroupRequest

Attributes

group_name class-attribute instance-attribute

group_name: Optional[str] = None

The name of the new group to be added in workflow.

email_notification class-attribute instance-attribute

email_notification: Optional[bool] = None

Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, default value of "true" will be set.

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

PlaceholderRequest dataclass

PlaceholderRequest(placeholder: Optional[str] = None, email_notification: Optional[bool] = None, role: Optional[CollaboratorRole] = None, signing_order: Optional[int] = None)

Definition: PlaceholderRequest

Attributes

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

The name of the new placeholder to be added in workflow.

email_notification class-attribute instance-attribute

email_notification: Optional[bool] = None

Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn.

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

WorkflowPlaceholderUpdateRequest dataclass

WorkflowPlaceholderUpdateRequest(placeholder: Optional[str] = None, email_notification: Optional[bool] = None, role: Optional[WorkflowCollaboratorRole] = None, signing_order: Optional[int] = None)

Definition: WorkflowPlaceholderUpdateRequest

Attributes

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained.

email_notification class-attribute instance-attribute

email_notification: Optional[bool] = None

Setting its value to "true" sends an email notification to the user when its turn arrives in workflow. Setting its value to "false" does not send the email notification to the user on its turn. If no value is provided, old value will be retained.

signing_order class-attribute instance-attribute

signing_order: Optional[int] = None

Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".

UpdateWorkSpaceRequest dataclass

UpdateWorkSpaceRequest(name: Optional[str] = None, members: Optional[List[WorkSpaceMembers]] = None)

Definition: UpdateWorkSpaceRequest

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name of shared space

members class-attribute instance-attribute

members: Optional[List[WorkSpaceMembers]] = None

Members of shared space

MoveToRequest dataclass

MoveToRequest(folder_name: Optional[str] = None)

Definition: MoveToRequest

Attributes

folder_name class-attribute instance-attribute

folder_name: Optional[str] = None

Target folder name in which package need to move

DigitalSignatureFieldResponse dataclass

DigitalSignatureFieldResponse(order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, type_: Optional[str] = None, process_status: Optional[str] = None, processed_on: Optional[str] = None, processed_as: Optional[str] = None, created_on: Optional[str] = None, processed_by: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse] = None, verification: Optional[VerificationResponse] = None, nid: Optional[str] = None, display: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, authentication: Optional[FieldAuthentication] = None)

Definition: DigitalSignatureFieldResponse

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.

process_status class-attribute instance-attribute

process_status: Optional[str] = None

Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.

processed_on class-attribute instance-attribute

processed_on: Optional[str] = None

Date time on which the document is processed.

processed_as class-attribute instance-attribute

processed_as: Optional[str] = None

User who processed the field as COLLABORATOR, DELEGATEE, GROUP_MEMBER or OWNER.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

Date time on which the field is added

processed_by class-attribute instance-attribute

processed_by: Optional[str] = None

Email address of the user who processed the field.

display class-attribute instance-attribute

display: Optional[str] = None

Returns the visibility value of the digital signature field, possible values are "VISIBLE" and "INVISIBLE".

FieldDimenssionResponse dataclass

FieldDimenssionResponse(field: Optional[FieldResponse] = None, page: Optional[PageResponse] = None)

Definition: FieldDimenssionResponse

FieldResponse dataclass

FieldResponse(x: Optional[float] = None, y: Optional[float] = None, width: Optional[float] = None, height: Optional[float] = None)

Definition: FieldResponse

Attributes

x class-attribute instance-attribute

x: Optional[float] = None

Left location of the field in pixel.

y class-attribute instance-attribute

y: Optional[float] = None

Top location of the field in pixel.

width class-attribute instance-attribute

width: Optional[float] = None

Width of the field in pixel.

height class-attribute instance-attribute

height: Optional[float] = None

Height of the field in pixel.

PageResponse dataclass

PageResponse(width: Optional[float] = None, height: Optional[float] = None)

Definition: PageResponse

Attributes

width class-attribute instance-attribute

width: Optional[float] = None

Width of the page where field is placed in the PDF.

height class-attribute instance-attribute

height: Optional[float] = None

Height of the page where field is placed in the PDF.

FieldAuthentication dataclass

FieldAuthentication(enabled: Optional[bool] = None, sms_otp: Optional[AccessSecuritySmsOtpResponse] = None, totp: Optional[AccessSecurityTOTPResponse] = None)

Definition: FieldAuthentication

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if authentications are enabled for the electronic signature fields.

AccessSecurityTOTPResponse dataclass

AccessSecurityTOTPResponse(enabled: Optional[bool] = None)

Definition: AccessSecurityTOTPResponse

Attributes

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True, if TOTP authentication is enabled for the package.

HandSignatureFieldResponse dataclass

HandSignatureFieldResponse(order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, type_: Optional[str] = None, process_status: Optional[str] = None, processed_on: Optional[str] = None, processed_as: Optional[str] = None, processed_by: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse] = None, nid: Optional[str] = None)

Definition: HandSignatureFieldResponse

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.

process_status class-attribute instance-attribute

process_status: Optional[str] = None

Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.

processed_on class-attribute instance-attribute

processed_on: Optional[str] = None

Date time on which the document is processed.

processed_as class-attribute instance-attribute

processed_as: Optional[str] = None

User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.

processed_by class-attribute instance-attribute

processed_by: Optional[str] = None

Email address of the user who processed the field.

ElectronicSignatureFieldResponse dataclass

ElectronicSignatureFieldResponse(order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, type_: Optional[str] = None, process_status: Optional[str] = None, processed_on: Optional[str] = None, processed_as: Optional[str] = None, processed_by: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse] = None, signature_sub_type: Optional[str] = None, authentication: Optional[FieldAuthentication] = None, verification: Optional[VerificationResponse] = None, nid: Optional[str] = None, display: Optional[str] = None)

Definition: ElectronicSignatureFieldResponse

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Email address of the user who processed the field.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.

process_status class-attribute instance-attribute

process_status: Optional[str] = None

Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.

processed_on class-attribute instance-attribute

processed_on: Optional[str] = None

Date time on which the document is processed.

processed_as class-attribute instance-attribute

processed_as: Optional[str] = None

User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.

processed_by class-attribute instance-attribute

processed_by: Optional[str] = None

Email address of the user who processed the field.

signature_sub_type class-attribute instance-attribute

signature_sub_type: Optional[str] = None

The signature sub-type can be a WITNESS signature. If witness signatures are enabled in service plan, E-Signature fields are signed with a common certificate shared by all the users in the service plan. Possible values are WITNESS or NONE.

display class-attribute instance-attribute

display: Optional[str] = None

Returns the visibility value of the electronic signature field, possible values are "VISIBLE" and "INVISIBLE".

InitialFieldResponse dataclass

InitialFieldResponse(order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, process_status: Optional[str] = None, processed_on: Optional[str] = None, processed_as: Optional[str] = None, processed_by: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse] = None, embedded: Optional[bool] = None)

Definition: InitialFieldResponse

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

process_status class-attribute instance-attribute

process_status: Optional[str] = None

Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.

processed_on class-attribute instance-attribute

processed_on: Optional[str] = None

Date time on which the document is processed.

processed_as class-attribute instance-attribute

processed_as: Optional[str] = None

User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.

processed_by class-attribute instance-attribute

processed_by: Optional[str] = None

Email address of the user who processed the field.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

InPersonFieldResponse dataclass

InPersonFieldResponse(order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, type_: Optional[str] = None, process_status: Optional[str] = None, processed_on: Optional[str] = None, processed_as: Optional[str] = None, processed_by: Optional[str] = None, placeholder: Optional[str] = None, signature_sub_type: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse] = None, verification: Optional[VerificationResponse] = None, display: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, authentication: Optional[FieldAuthentication] = None)

Definition: InPersonFieldResponse

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

process_status class-attribute instance-attribute

process_status: Optional[str] = None

Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.

processed_on class-attribute instance-attribute

processed_on: Optional[str] = None

Date time on which the document is processed.

processed_as class-attribute instance-attribute

processed_as: Optional[str] = None

User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.

processed_by class-attribute instance-attribute

processed_by: Optional[str] = None

Email address of the user who processed the field.

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

Name of the in-person signer or placeholder e.g., Customer, Sales Representative etc.

signature_sub_type class-attribute instance-attribute

signature_sub_type: Optional[str] = None

The signature sub-type for in-person signatures can be a WITNESS signature. If witness signatures are enabled in service plan, In-person fields are signed with a common certificate shared by all the users in the service plan. Possible values are WITNESS or NONE.

display class-attribute instance-attribute

display: Optional[str] = None

Returns the visibility value of the inperson field, possible values are "VISIBLE" and "INVISIBLE".

level_of_assurance class-attribute instance-attribute

level_of_assurance: Optional[List[str]] = None

In Person selected level of assurances

TextFieldResponse dataclass

TextFieldResponse(required: Optional[bool] = None, order: Optional[int] = None, tab_order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, type_: Optional[str] = None, value: Optional[str] = None, read_only: Optional[bool] = None, validation_rule: Optional[str] = None, validation: Optional[FieldValidationValue] = None, visible: Optional[bool] = None, multiline: Optional[bool] = None, font: Optional[FontResponse] = None, max_length: Optional[int] = None, format_type: Optional[str] = None, placeholder: Optional[str] = None, format: Optional[str] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None, field_rotation: Optional[int] = None, align: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse] = None)

Definition: TextFieldResponse

Attributes

required class-attribute instance-attribute

required: Optional[bool] = None

True if field required in pdf

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

tab_order class-attribute instance-attribute

tab_order: Optional[int] = None

Tab order in the PDF document

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the text field, possible values are "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE".

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field. For type = DATE or format_type = DATE, the value is expected to follow ISO 8601 format.Following the format YYYY-MM-DD hh:mm:ss +00. As the values are for date fields client applications can send YYYY-MM-DD and ignore hh:mm:ss +00. If value is not in proper format an error will be returned.

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True, if the field is marked read only in the PDF document.

validation_rule class-attribute instance-attribute

validation_rule: Optional[str] = None

One or more rules for validation of the fields, possible values are "MANDATORY" or "OPTIONAL".

visible class-attribute instance-attribute

visible: Optional[bool] = None

True, if the field is not hidden in the PDF document.

multiline class-attribute instance-attribute

multiline: Optional[bool] = None

True, if the field is multi line in the PDF document.

max_length class-attribute instance-attribute

max_length: Optional[int] = None

Maximum content length allowed to be filled in the field.

format_type class-attribute instance-attribute

format_type: Optional[str] = None

If field is a textbox it can follow different input types. Possible values are ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME or DATE.

placeholder class-attribute instance-attribute

placeholder: Optional[str] = None

Placeholder text for the textbox field.

format class-attribute instance-attribute

format: Optional[str] = None

Text format of the field. Used for the date type field only. Possible values are

• m/d
• m/d/yy
• m/d/yyyy
• mm/dd/yy
• mm/dd/yyyy
• mm/yy
• mm/yyyy
• d-mmm
• d-mmm-yy
• d-mmm-yyyy
• dd-mmm-yy
• dd-mmm-yyyy
• yy-mm-dd
• yyyy-mm-dd
• mmm-yy
• mmm-yyyy
• mmmm-yy
• mmmm-yyyy
• mmmm d, yyyy
• dd/mm/yy
• ddmmmyyyy

color class-attribute instance-attribute

color: Optional[str] = None

Color of the text in the form fields.

border_color class-attribute instance-attribute

border_color: Optional[str] = None

Border color of the form field.

tooltip class-attribute instance-attribute

tooltip: Optional[str] = None

tooltip of the form field.

field_rotation class-attribute instance-attribute

field_rotation: Optional[int] = None

Field Rotation

align class-attribute instance-attribute

align: Optional[str] = None

Text alignment for the form field. Possible values are "RIGHT", "LEFT", "CENTER" or "JUSTIFY"

RadioFieldResponse dataclass

RadioFieldResponse(required: Optional[bool] = None, order: Optional[int] = None, tab_order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, type_: Optional[str] = None, value: Optional[bool] = None, read_only: Optional[bool] = None, validation_rule: Optional[str] = None, radio_group_name: Optional[str] = None, checked: Optional[bool] = None, visible: Optional[bool] = None, dimensions: Optional[FieldDimenssionResponse] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None, field_rotation: Optional[int] = None)

Definition: RadioFieldResponse

Attributes

required class-attribute instance-attribute

required: Optional[bool] = None

True if field required in pdf

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

tab_order class-attribute instance-attribute

tab_order: Optional[int] = None

Tab order in the PDF document.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

value class-attribute instance-attribute

value: Optional[bool] = None

Value of the field.

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True, if the field is marked readonly in the PDF document.

validation_rule class-attribute instance-attribute

validation_rule: Optional[str] = None

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

radio_group_name class-attribute instance-attribute

radio_group_name: Optional[str] = None

The group name to which the field belongs.

checked class-attribute instance-attribute

checked: Optional[bool] = None

True, if the field is selected

visible class-attribute instance-attribute

visible: Optional[bool] = None

True if the field is not hidden in the PDF document.

color class-attribute instance-attribute

color: Optional[str] = None

Color of the text in the form fields.

border_color class-attribute instance-attribute

border_color: Optional[str] = None

Border color of the form field.

tooltip class-attribute instance-attribute

tooltip: Optional[str] = None

tooltip of the form field.

field_rotation class-attribute instance-attribute

field_rotation: Optional[int] = None

Field Rotation

CheckboxFieldResponse dataclass

CheckboxFieldResponse(required: Optional[bool] = None, order: Optional[int] = None, tab_order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, type_: Optional[str] = None, value: Optional[bool] = None, read_only: Optional[bool] = None, checked: Optional[bool] = None, visible: Optional[bool] = None, validation_rule: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None, field_rotation: Optional[int] = None)

Definition: CheckboxFieldResponse

Attributes

required class-attribute instance-attribute

required: Optional[bool] = None

True if field required in pdf

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

tab_order class-attribute instance-attribute

tab_order: Optional[int] = None

Tab order in the PDF document

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

value class-attribute instance-attribute

value: Optional[bool] = None

Value of the field.

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True, if the field is marked read only in the PDF document.

checked class-attribute instance-attribute

checked: Optional[bool] = None

True if the field is selected.

visible class-attribute instance-attribute

visible: Optional[bool] = None

True if the field is not hidden in the PDF document.

validation_rule class-attribute instance-attribute

validation_rule: Optional[str] = None

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

color class-attribute instance-attribute

color: Optional[str] = None

Color of the text in the form fields.

border_color class-attribute instance-attribute

border_color: Optional[str] = None

Border color of the form field.

tooltip class-attribute instance-attribute

tooltip: Optional[str] = None

tooltip of the form field.

field_rotation class-attribute instance-attribute

field_rotation: Optional[int] = None

Field Rotation

DropdownFieldResponse dataclass

DropdownFieldResponse(required: Optional[bool] = None, order: Optional[int] = None, tab_order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, validation_rule: Optional[str] = None, read_only: Optional[bool] = None, value: Optional[str] = None, choices: Optional[List[str]] = None, visible: Optional[bool] = None, dimensions: Optional[FieldDimenssionResponse] = None, font: Optional[FontResponse] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None, field_rotation: Optional[int] = None)

Definition: DropdownFieldResponse

Attributes

required class-attribute instance-attribute

required: Optional[bool] = None

True if field required in pdf

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

tab_order class-attribute instance-attribute

tab_order: Optional[int] = None

Tab order in the PDF document.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

validation_rule class-attribute instance-attribute

validation_rule: Optional[str] = None

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True, if the field is marked read only in the PDF document.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field .

choices class-attribute instance-attribute

choices: Optional[List[str]] = None

Choices available for the dropdown to choose a value from.

visible class-attribute instance-attribute

visible: Optional[bool] = None

True, if the field is not hidden in the PDF document.

color class-attribute instance-attribute

color: Optional[str] = None

Color of the text in the form fields.

border_color class-attribute instance-attribute

border_color: Optional[str] = None

Border color of the form field.

tooltip class-attribute instance-attribute

tooltip: Optional[str] = None

tooltip of the form field.

field_rotation class-attribute instance-attribute

field_rotation: Optional[int] = None

Field Rotation

ListBoxFieldResponse dataclass

ListBoxFieldResponse(order: Optional[int] = None, tab_order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, embedded: Optional[bool] = None, validation_rule: Optional[str] = None, read_only: Optional[bool] = None, value: Optional[str] = None, choices: Optional[List[str]] = None, visible: Optional[bool] = None, dimensions: Optional[FieldDimenssionResponse] = None, font: Optional[FontResponse] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None, field_rotation: Optional[int] = None)

Definition: ListBoxFieldResponse

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.

tab_order class-attribute instance-attribute

tab_order: Optional[int] = None

Tab order in the PDF document.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

embedded class-attribute instance-attribute

embedded: Optional[bool] = None

True, if field is part of the PDF document.

validation_rule class-attribute instance-attribute

validation_rule: Optional[str] = None

One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".

read_only class-attribute instance-attribute

read_only: Optional[bool] = None

True, if the field is marked read only in the PDF document.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field.

choices class-attribute instance-attribute

choices: Optional[List[str]] = None

Choices available for the dropdown to choose a value from.

visible class-attribute instance-attribute

visible: Optional[bool] = None

True, if the field is not hidden in the PDF document.

color class-attribute instance-attribute

color: Optional[str] = None

Color of the text in the form fields.

border_color class-attribute instance-attribute

border_color: Optional[str] = None

Border color of the form field.

tooltip class-attribute instance-attribute

tooltip: Optional[str] = None

tooltip of the form field.

field_rotation class-attribute instance-attribute

field_rotation: Optional[int] = None

Field Rotation

FontResponse dataclass

FontResponse(name: Optional[str] = None, size: Optional[int] = None, embedded_size: Optional[float] = None)

Definition: FontResponse

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Font name for the text field. For user defined fields SigningHub only support "COURIER", "HELVETICA". In case of existing fields in a PDF file, font value can be anything that is set in the PDF.

size class-attribute instance-attribute

size: Optional[int] = None

Font size for the text field.

embedded_size class-attribute instance-attribute

embedded_size: Optional[float] = None

Size of the font in the original PDF document.

QrCodeResponse dataclass

QrCodeResponse(field_name: Optional[str] = None, type_: Optional[str] = None, page_no: Optional[int] = None, value: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse] = None, data: Optional[str] = None, options: Optional[QrCodeOptions] = None, color: Optional[QrCodeColor] = None, logo: Optional[QrCodeLogo] = None)

Definition: QrCodeResponse

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Field Type PDF_FIELD_TYPE like QR

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

value class-attribute instance-attribute

value: Optional[str] = None

QrCode generated base64 will be provided inly in draft mode

data class-attribute instance-attribute

data: Optional[str] = None

The plain text data to be encoded in the QR code. Default is URL generated to access the related document. e.g. {base_url}/document/{document_unique_id}

AttachmentFieldResponse dataclass

AttachmentFieldResponse(order: Optional[int] = None, display_order: Optional[int] = None, field_name: Optional[str] = None, page_no: Optional[int] = None, process_status: Optional[str] = None, processed_on: Optional[str] = None, processed_as: Optional[str] = None, processed_by: Optional[str] = None, attachment_ref_id: Optional[int] = None, note: Optional[str] = None, validation_rule: Optional[ValidationRule] = None, dimensions: Optional[FieldDimenssionResponse] = None)

Definition: AttachmentFieldResponse

Attributes

order class-attribute instance-attribute

order: Optional[int] = None

Order of the recipient to whom this field is assigned.

display_order class-attribute instance-attribute

display_order: Optional[int] = None

Display order according to the SigningHub viewer.

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

process_status class-attribute instance-attribute

process_status: Optional[str] = None

Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.

processed_on class-attribute instance-attribute

processed_on: Optional[str] = None

Date time on which the document is processed.

processed_as class-attribute instance-attribute

processed_as: Optional[str] = None

User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.

processed_by class-attribute instance-attribute

processed_by: Optional[str] = None

Email address of the user who processed the field.

attachment_ref_id class-attribute instance-attribute

attachment_ref_id: Optional[int] = field(default=None, metadata={'wire_name': 'attachmentRefId'})

Attachmet ref id

note class-attribute instance-attribute

note: Optional[str] = None

Attachmet note Only in case of "MANDATORY" attachment rule

CommentFieldResponse dataclass

CommentFieldResponse(id: Optional[int] = None, page_no: Optional[int] = None, unread_count: Optional[int] = None, private: Optional[bool] = None, recipients: Optional[List[CommentFieldRecipientResponse]] = None, dimensions: Optional[FieldDimenssionResponse] = None)

Definition: CommentFieldResponse

Attributes

id class-attribute instance-attribute

id: Optional[int] = None

Comment field id

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

unread_count class-attribute instance-attribute

unread_count: Optional[int] = None

Unread comments

private class-attribute instance-attribute

private: Optional[bool] = None

Private

recipients class-attribute instance-attribute

recipients: Optional[List[CommentFieldRecipientResponse]] = None

Recipients

UniqueIdentifierFieldResponse dataclass

UniqueIdentifierFieldResponse(field_name: Optional[str] = None, value: Optional[str] = None, page_no: Optional[int] = None, font: Optional[FontResponse] = None, dimensions: Optional[FieldDimenssionResponse] = None)

Definition: UniqueIdentifierFieldResponse

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Unique identifier of the field.

value class-attribute instance-attribute

value: Optional[str] = None

Value of the field.

page_no class-attribute instance-attribute

page_no: Optional[int] = None

Page number of the document on which the field exists.

CommentFieldRecipientResponse dataclass

CommentFieldRecipientResponse(user_name: Optional[str] = None, user_email: Optional[str] = None)

Definition: CommentFieldRecipientResponse

Attributes

user_name class-attribute instance-attribute

user_name: Optional[str] = None

User name

user_email class-attribute instance-attribute

user_email: Optional[str] = None

User email

AssignFieldRequest dataclass

AssignFieldRequest(field_name: Optional[str] = None, radio_group_name: Optional[str] = None, order: Optional[int] = None, level_of_assurance: Optional[List[str]] = None)

Definition: AssignFieldRequest

Attributes

field_name class-attribute instance-attribute

field_name: Optional[str] = None

Name of the signature field that is to be assigned.

radio_group_name class-attribute instance-attribute

radio_group_name: Optional[str] = None

provide group name for radio box

order class-attribute instance-attribute

order: Optional[int] = None

The order of the user in workflow, to which the field is being assigned.

level_of_assurance class-attribute instance-attribute

level_of_assurance: Optional[List[str]] = None

Level Of Assurance to be added. Possible Values are "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

SigninghubClient

SigninghubClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for signinghub connector.

Initialize a SigninghubClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

attachment_delete_attachment_async async

attachment_delete_attachment_async(package_id: int, document_id: int, attachment_id: int) -> dict[str, Any] | None

Delete Attachment

Business applications can use this service API to delete the attachment of a document.

attachment_download_attachment_async async

attachment_download_attachment_async(package_id: int, document_id: int, attachment_id: int) -> dict[str, Any] | None

Download Attachment

Business applications can use this service API to download the attachment of a document.

attachment_get_attachments_async async

attachment_get_attachments_async(package_id: int, document_id: int) -> dict[str, Any] | None

Get Attachments

Business applications can use this service API to get the attachments of a document.

attachment_upload_attachment_async async

attachment_upload_attachment_async(input: bytes, package_id: int, document_id: int) -> dict[str, Any] | None

Upload Attachment

Business applications can use this service API to upload a attachment in a document.

checkbox_add_check_box_async async

checkbox_add_check_box_async(input: CheckBoxFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Add CheckBox Field

Business applications can use this service API to add a checkbox to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.

checkbox_update_check_box_async async

checkbox_update_check_box_async(input: UpdateCheckBoxFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Update CheckBox Field

Business applications can use this service API to update a checkbox field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface. It's width and height cannot be updated. They will remain the same as when they were added.

contacts_get_async async

contacts_get_async(record_per_page: int, page_no: int, sort_by: Optional[str] = None, asc: Optional[bool] = None) -> dict[str, Any] | None

Get Contacts

Business applications can use this service API to retieve contacts from both personal and enterprise contacts for the current user. It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's specific contacts or that of the enterprise to which the user belongs. The search response information contains the user email address and respective user name.

documents_delete_document_async async

documents_delete_document_async(package_id: int, document_id: int) -> dict[str, Any] | None

Delete Document

Business applications can use this service API to delete a document in a package.

documents_download_document_bytes_async async

documents_download_document_bytes_async(package_id: int, document_id: int) -> dict[str, Any] | None

Download Document

Business applications can use this service API to download the document bytes. The package ID and document ID is provided in the resource URL.

documents_get_certify_policy_async async

documents_get_certify_policy_async(package_id: int, document_id: int) -> dict[str, Any] | None

Get Certify Policy for a document

Business applications can use this service API to get certify signature settings of a document in a package.

documents_get_document_details_async async

documents_get_document_details_async(package_id: int, document_id: int) -> dict[str, Any] | None

Get Document Details

Business applications can use this service API to get the document details. The document ID is provided in the URL as "{document_id}".

documents_rename_document_async async

documents_rename_document_async(input: RenameDocumentRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Rename Document

Business applications can use this service API to rename a document in a package.

documents_update_certify_policy_async async

documents_update_certify_policy_async(input: UpdateCertifyPolicyRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Update Certify Policy for a document

Business applications can use this service API to update certify signature settings for a document in a package.

documents_upload_from_library_async async

documents_upload_from_library_async(package_id: int, document_id: int) -> dict[str, Any] | None

Add or Update Document from Library

Business applications can use this service API to add a document from the user's library to a package. Package ID is provided in the URL, the ID of the document should also be provided as "document_id" in the resource URL to identify the library document to be copied. Note a package must already exist before you can add a document using this call.

documents_upload_stream_async async

documents_upload_stream_async(input: bytes, package_id: int) -> dict[str, Any] | None

Upload Document

Business applications can use this service API to add a document to a document package linked to an enterprise user's account. The document information is sent in the HTTP request header and document bytes are sent in the HTTP request body. Note SigningHub will convert supported document formats to PDF if the header "x-convert-document" is set to a value of "true". The only case supported where this value is set to "false" is to retain Word format and XML documents. SigningHub supports a wide variety of document formats, each of which can be converted to PDF format upon upload.Click here for the full list. Note PDF documents are not altered upon upload to the system. Note a package must already exist before you can add a document using this call.

enterprise_documents_get_enterprise_workflow_access_async async

enterprise_documents_get_enterprise_workflow_access_async(package_id: int, order: int) -> dict[str, Any] | None

Get Workflow User Authentication (Document Opening) of Enterprise Package

Business applications can use this service API to get the access security settings enabled for the package. Recipients for whom the security is configured are identified by the order in the URL. Package ID is also identified in the request URL. Recipients will not be able to access document package outside the scope of this duration if the access security is enabled. Document owner can also configure authentication based security of the package for a recipient.

enterprise_documents_update_enterprise_workflow_access_async async

enterprise_documents_update_enterprise_workflow_access_async(input: AccessUpdateRequest, package_id: int, order: int) -> dict[str, Any] | None

Update Workflow User Authentication (Document Opening) of Enterprise Package

Business applications can use this service API to update the package authentications and access duration for the recipients. This API can also be used by the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request

fields_auto_assign_field_async async

fields_auto_assign_field_async(input: FieldsAutoAssignFieldInput, package_id: int, document_id: int) -> dict[str, Any] | None

Assign Document Field

Business applications can use this service API to assign users to input fields, e.g. signature fields, and hence define the signing order. The fields must already be present in the document and the users must be present in the workflow. The ID of the workflow document is provided in the resource URL, along with the package identifier. When recipients are in a workflow they are numbered, beginning at one and counting up for each extra one.Therefore, if there are three users in a workflow they are numbered "1", "2", and "3" respectfully.This API call allows you to assign a user by their workflow order number, to an input field on the document.

fields_auto_place_async async

fields_auto_place_async(input: AutoPlaceFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

AutoPlace Fields

Business applications can call this API to add signature or user defined form fields to a document based upon the search criterion supplied. The placement options are: to the left, to the right, top and bottom. The document is search and all instances of the search criteria met are processed. This allows you to add multiple fields with one call. For example, upload a document and automatically place a signature field to the right of all instances of the word "Sign here:". This saves time and ensures no signatures are missed from the workflow. The API call supports all types of fields; namely electronic, digital, in-person, initials, and text field etc. In addition, the API call supports the "order" variable.This means you can assign a set of signature fields automatically to a single user.Hence, the call can be repeated to place and assign signature fields to more than one user in the workflow. At least one user must exist in a workflow before signature fields can be added to the document in this way.The order number corresponds to the recipient in the workflow. Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. This API call can be used multiple times on the same document.The reason for doing so is to cater for multiple signatories on a document.The recipient or signatory is identified by the "order" variable passed in the call. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

fields_delete_document_field_async async

fields_delete_document_field_async(input: DeleteDocumentFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Delete Document Field

Business applications can use this service API to delete a field of document in a package.

fields_fill_form_fields_async async

fields_fill_form_fields_async(input: FormFillingRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Fill Form Fields

Business applications can use this service API to fill one or more form fields in a document by a specified user in the order.

fields_get_all_document_fields_async async

fields_get_all_document_fields_async(package_id: int, document_id: int, page_no: int) -> dict[str, Any] | None

Get Document Fields

Business applications can use this service API to get document fields i.e., initials, in-persons, signature fields or form fields.

folder_move_package_async async

folder_move_package_async(input: MoveToRequest, package_id: int) -> dict[str, Any] | None

Move Package to Custom or Shared Space folder

Business applications can use this service API to move the document package to a shared space or user's custom folder.

initials_add_initial_async async

initials_add_initial_async(input: InitialFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Add Initial Field

Business applications can use this service API to add an initials field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

initials_fill_async async

initials_fill_async(input: InitialFillingRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Fill Initials

Business applications can use this service API to fill an initials field in a document by a specified user in the order.

initials_update_initial_async async

initials_update_initial_async(input: UpdateInitialFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Update Initial Field

Business applications can use this service API to update an initials field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

in_person_add_in_person_async async

in_person_add_in_person_async(input: InPersonFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Add In-person Field

Business applications can use this service API to an add in-person signature field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. In order to host an in-person meeting a SigningHub user must be part of the workflow.They must either be added with Role "INPERSON_HOST" or "SIGNER". For the host option they do not require a signature or input field on the document, and the in-person signature field can be signed by the non-SigningHub registered user. Note this is a special workflow scenario whereby it is expected that the SigningHub user and recipient would be in the same location.This type of signature is not intended for use whereby a document is shared with recipients over email link in the normal loose integration method.

in_person_update_in_person_async async

in_person_update_in_person_async(input: UpdateInPersonFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Update In-person Field

Business applications can use this service API to update an in-person signature field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

package_add_package_async async

package_add_package_async(input: AddDocumentPackageRequest) -> dict[str, Any] | None

Add Package

This service API is used to add/create a document package to hold one or more documents. This package can then be used to add documents and recipients in order to start a new workflow. As previously stated, this call is mandatory if you wish to work with documents. A package must exist before you can upload or add documents to SigningHub.. Even a single document is a part of a package: a package containing one document. Note: A package can be renamed if required once created.

package_approve_async async

package_approve_async(input: ApproveRequest, package_id: int) -> dict[str, Any] | None

Approve Document

Business applications can use this service API to approve a document by a specified user in the order.

package_decline_async async

package_decline_async(input: DeclineRequest, package_id: int) -> dict[str, Any] | None

Decline Document

Business applications can use this service API to decline a document by a specified user in the order.

package_delete_package_async async

package_delete_package_async(package_id_bulk_action: int) -> dict[str, Any] | None

Delete Package

Business applications can use this service API to delete a document from the user inbox. The package ID is provided in the resource URL as "{package_id}". If the document status is PENDING, then it is automatically declined as result of delete operation. If the document status is SHARED, then the document is automatically recalled and workflow is stopped before the document is deleted.

package_download_package_bytes_async async

package_download_package_bytes_async(package_id_bulk_action: int, document_ids: Optional[List[int]] = None) -> dict[str, Any] | None

Download Package

Business applications can use this service API to download the document package in binary format. The package ID is provided in the resource URL. If the package contains only one document, the download is the binary PDF document. Alternatively, if the package has more than one document, the download is the binary zip file of all documents. The x-password and x-otp headers are optional. They are required if the document owner set them during the workflow creation phase.

package_finish_async async

package_finish_async(package_id: int) -> dict[str, Any] | None

Finish Processing

Business applications can use this service API to finish the document processing after signing all the signature fields. This method is primarily used by native SigningHub mobile apps for iOS and Android, and mobile web use cases. General business applications employing tight integration into their respective portal do not need to call this method. However, when using the Sign Document API (and hence the user is not presented with a visual representation of the document they are requested to sign) calling this API is required in order to ensure the respective workflow continues or completes. For example, once all signatures have been applied using the "blind" Sign Document API call the document will not show as status "Completed" to the owner until this API is invoked. The document owner will see a status of "In Progress" until this API is called. Within native SigningHub mobile apps and mobile web use cases, this call is necessary to ensure that each user completes their respective actions with respect to SigningHub.For example, after a signatory has signed a document in SigningHub App, this method is invoked by the application to ensure the workflow continues to process and the next signatory is notified, and the document status is available via the configured call-back URL.

package_gatekeeper_approve_async async

package_gatekeeper_approve_async(input: ApproveRequest, package_id: int) -> dict[str, Any] | None

Gatekeeper Approve Document

Business applications can use this service API to gatekeeper approve a document by a specified user in the order.

package_gatekeeper_decline_async async

package_gatekeeper_decline_async(input: DeclineRequest, package_id: int) -> dict[str, Any] | None

Gatekeeper Decline Document

Business applications can use this service API to gatekeeper decline a document by a specified user in the order.

package_get_all_packages_async async

package_get_all_packages_async(document_status: str, page_no: int, record_per_page: int, package_name: Optional[str] = None, package_id: Optional[int] = None, recipient_from: Optional[str] = None, recipient_to: Optional[str] = None, document_id: Optional[int] = None, expiry: Optional[int] = None, modified_from: Optional[str] = None, modified_to: Optional[str] = None, size_from: Optional[int] = None, size_to: Optional[int] = None, certified_documents: Optional[bool] = None, form_fields: Optional[bool] = None, attachments: Optional[bool] = None, document_type: Optional[str] = None, sort_by: Optional[str] = None, asc: Optional[bool] = None, document_statuses: Optional[List[str]] = None, owned_by: Optional[str] = None, smart_form: Optional[str] = None) -> dict[str, Any] | None

Get Packages

Business applications can use this service API to get a list of documents filtered by different statuses. Users can divide the records into pages by providing a number of records per page.

package_get_package_details_async async

package_get_package_details_async(package_id: int) -> dict[str, Any] | None

Get Package Details

Business applications can use this service API to get the details of an package. This API can also be used by the business application to perform action on behalf of the enterprise user via "Scope Authentication".

package_rename_package_async async

package_rename_package_async(input: RenameDocumentPackageRequest, package_id_bulk_action: int) -> dict[str, Any] | None

Rename Package

This service API is used to rename a document package. The document package is identified by its unique identifier in the URL of the call.

package_submit_async async

package_submit_async(package_id: int) -> dict[str, Any] | None

Submit Document

One of the SigningHub roles is called "Editor". This allows a recipient to edit input fields on a document, but does not require a signature. Once completed the recipient submits their changes. The button used in the GUI is called "Submit". This is the equivalent operation for an editor to submit their changes via an API call. Click SigningHub Roles for a description of all available workflow recipient roles.

qr_add_qr_code_async async

qr_add_qr_code_async(input: QrCodeRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Add QR Code

Business applications can use this service API to add a QR Code to a document in a package.

qr_update_qr_code_async async

qr_update_qr_code_async(input: UpdateQrCodeRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Update QR Code

Business applications can use this service API to update a QR Code of a document in a package.

radio_add_radio_box_async async

radio_add_radio_box_async(input: RadioBoxFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Add RadioBox Field

Business applications can use this service API to add a checkbox to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users. If width and height parameters are not provided, a default size of 10x10 will be assigned. If either width or height (or both) is provided, the system will compare these provided values with each other. The larger value between width and height will be assigned to both dimensions.

radio_update_radio_box_async async

radio_update_radio_box_async(input: UpdateRadioBoxFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Update RadioBox Field

Business applications can use this service API to update a radio button of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface. It's width and height cannot be updated. They will remain the same as when they were added.

settings_get_templates_async async

settings_get_templates_async(record_per_page: int, page_no: int, sort_by: Optional[str] = None, asc: Optional[bool] = None) -> dict[str, Any] | None

Get Templates

Business applications can use this service API to get list of templates for the current user. It is possible to search based upon the criterion supplied under the "x-search-text" header.Furthermore, it is possible to search a user's personal templates or the enterprise templates as allowed against their user role by their enterprise admin.

signature_add_signature_async async

signature_add_signature_async(input: DigitalSignatureFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Add Digital Signature Field

Business applications can use this service API to add a digital signature field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information.Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

signature_update_signature_async async

signature_update_signature_async(input: UpdateDigitalSignatureFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Update Digital Signature Field

Business applications can use this service API to update a digital signature field of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged.You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields.The latter can be used when a template was applied or the document was created using the GUI interface.

signing_bulk_sign_documents_async async

signing_bulk_sign_documents_async(input: BulkSignRequest, package_id_bulk_action: str) -> dict[str, Any] | None

Bulk Sign Packages

Business applications can use this API to sign/share/sign and share multiple documents (both electronic and digital) without displaying the documents to the end user. This API needs information from the business application about document packages and the details of signatures, in-person and initials fields. On the successful completion of bulk signing transaction, the API will return the statuses and transaction ids of the document packages. Unlike the Sign Document API, this API not only signs a document package but also marks it as approved and reviewed based on whether the recipient is a Signer, Editor or Reviewer. Any document package for which the status returns as COMPLETED has been signed, approved or reviewed by this API. Bulk Signing works with all the signing-time authentication methods. If SIGN is passed as bulk_action and package is in Draft state, Sign and Share will be performed automatically. You must call this API after the Pre Bulk Sign Documents API. In case you need to make changes in any of the document before signing, the Fill Form Fields API should be called before calling the Pre Bulk Sign Document API. Remember, any mandatory input fields on a document require completing before this API will successfully complete; whereas, the auto-populated fields (like Name, Email, Date, Job Title, etc.) will be automatically filled. The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication. Once document is signed, the verification response can be seen from the Bulk Signing Status API. First or Second Factor OTP Usage for Authentication In case OTP authentication is turned on for the server side signing operation, the client applications will need to generate an OTP for the mobile number using the Bulk Sign Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.

signing_bulk_sign_status_async async

signing_bulk_sign_status_async(input: BulkSignStatusRequest, bulk_action: str) -> dict[str, Any] | None

Bulk Signing Status

Business applications can use this API to get the status of a specific bulk signing transaction along with the details of document packages that were processed by the Bulk Signing Packages API. You must call this API after the Bulk Signing Packages API. The signatory is identified by the access token presented in the call. Therefore, authentication of the signatory is required prior to making this call. You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user. The access token must be issued to the signatory as a result of direct authentication. For RAS signing, the ACTION property will be REMOTE_AUTHORIZATION_REQURIED and the STATUS property will be PENDING, indicating that the request needs to be authorized using the mobile device. If the signing process fails in some document due to different levels of assurance configured and the user wants to re-initiate the signing process to complete the signing process on failed documents, the ACTION property will be REINITIATE_SIGNING_PROCESS, and the STATUS property will be PENDING.

signing_sign_document_async async

signing_sign_document_async(input: SignDocumentRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Sign Document

Business applications can use this service API to sign a document (both electronic and digital) without displaying the document to the end user using SigningHub. For example, a business application may have another method to display the document to the user, and only the signing functionality of SigningHub is required, or for bulk operations it may be justified to sign without requiring the user to view and approve every document individually. If there are changes to be saved in the document before signing, Fill Form Fields API should be called before calling the Sign Document API. Note any mandatory input fields on a document require completing before this API will successfully complete. The signatory is identified by the access token presented in the call.Therefore, authentication of the signatory is required prior to making this call.You cannot authenticate as an Enterprise Admin with the scope variable, and sign a document on behalf of a user.The access token must be issued to the signatory as a result of direct authentication. When this call completes it is important that if the signatory was the last signer for a document that the Finish Document API call is invoked.The reason is because without calling that API the document will remain in a status of "In Progress" to the document owner. Once the API has been called, the status will change to "Completed" for the document owner. Once document is signed, the verification response can be seen from Get Document Verification API. First or Second Factor OTP Usage for Authentication If OTP authentication is turned on for the server side signing operation, client applications will need to generate a OTP for the mobile number using Signer Authentication via OTP API call. Respective business applications must retrieve the OTP from the use and submit it when making the API call. This is done using the "x-otp" header in the request.

template_get_enterprise_templates_async async

template_get_enterprise_templates_async(record_per_page: int, page_no: int, sort_by: Optional[str] = None, asc: Optional[bool] = None, id: Optional[List[int]] = None) -> dict[str, Any] | None

Get Enterprise Templates

Business applications can use this service API to get list of enterprise templates of the current user. This means the enterprise administrator or the enterprise user if the "scope" variable was used in the authentication request. It is possible to search based upon the criterion supplied under the "x-search-text" header.

text_box_add_text_box_async async

text_box_add_text_box_async(input: TextBoxFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Add TextBox Field

Business applications can use this service API to add a text input field to a document in a package. At least one user must exist in a workflow before fields(input and signature) can be added to the document in this way.The order number corresponds to the recipient in the workflow.Therefore, this number must be equal or less than the total number of users in the workflow. The below example assigns this new signature field to the first person in the workflow. See Add Users to Workflow for more information. Note if you have a document with a template applied, or have applied one using the APIs, then the workflow will already contain users.

text_box_update_text_box_async async

text_box_update_text_box_async(input: UpdateTextBoxFieldRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Update TextBox Field

Business applications can use this service API to update a text box of a document in a package. Note all of the input parameters can be changed.Where you wish to retain the current setting submit it in the call unchanged. You can therefore use the same parameters as when you added the input field, or the information as returned by Get Document Fields. The latter can be used when a template was applied or the document was created using the GUI interface.

workflow_apply_template_async async

workflow_apply_template_async(input: ApplyTemplateRequest, package_id: int, document_id: int) -> dict[str, Any] | None

Apply Workflow Template

Business applications can use this service API to apply a workflow template to a document. The document ID on which template has to be applied is provided in the resource URL. When document ID is set to 0 then template will be applied to to all of the doucments in a pacakge. While applying the template it is important to remember these two important points: Point 1 - If the template being applied is created using a PDF which already contained form fields then ensure that the document on which this template is now being applied must contain these form fields in advance and SigningHub will NOT create those form fields via the template rather only apply the form data and assign to the respective users. Point 2 - If the template being applied is created where form fields are manually added (hence not present in the PDF originally) via SigningHub e.g. signature field, initial, in-person signature, check boxes, radio buttons, text fields etc. then on applying such a template, these form fields will be created on the target document even if these form fields were already present in the document.

workflow_evidence_report_download_bytes_async async

workflow_evidence_report_download_bytes_async(package_id: int) -> dict[str, Any] | None

Get Process Evidence Report

Business applications can use this service API to download the workflow process evidence report of a document.

workflow_get_workflow_detail_async async

workflow_get_workflow_detail_async(package_id: int) -> dict[str, Any] | None

Get Workflow Details

Business applications can use this service API to get workflow details for the package.

workflow_get_workflow_history_async async

workflow_get_workflow_history_async(package_id: int, page_no: int, records_per_page: int) -> dict[str, Any] | None

Get Workflow History

Business applications can utilize this service API to retrieve the list of actions performed on a document. The package ID is provided in the resource URL. The search field (x-search-text header) is intended for email, document name, action, infokey, and infovalue.

workflow_get_workflow_reminder_async async

workflow_get_workflow_reminder_async(package_id: int, order: int) -> dict[str, Any] | None

Get Workflow Reminder

Business applications can use this service API to update the reminders for the recipients that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the reminders settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow.

workflow_get_workflow_users_async async

workflow_get_workflow_users_async(package_id: int) -> dict[str, Any] | None

Get Workflow Users

Business applications can use this service API to get workflow details for the package.

workflow_mark_workflow_completed_async async

workflow_mark_workflow_completed_async(package_id: int) -> dict[str, Any] | None

Complete Workflow in the Middle (Terminate Workflow)

Business applications can mark the workflow completed even in the middle of the workflow. Use this service API to change the status of the workflow to completed. If there are recipients who have not signed the document yet. Their signature will not be required any more and they will not be able to see the document in their inbox any further. Bearer token should belong to document owner or enterprise admin can use scope variable to get the access token on behalf of document owner to perform this action.

workflow_permission_get_workflow_permissions_async async

workflow_permission_get_workflow_permissions_async(package_id: int, order: int) -> dict[str, Any] | None

Get Workflow User Permissions

Business applications can use this service API to get document permissions for a recipient. Recipient is identified by the order in the workflow. The ID of the package is provided in the resource URL.

workflow_permission_update_workflow_permissions_async async

workflow_permission_update_workflow_permissions_async(input: WorkflowPermissionsUpdateRequest, package_id: int, order: int) -> dict[str, Any] | None

Update Workflow User Permissions

Business applications can use this service API to update the workflow permissions for a user that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the permissions within the workflow. The ID of the document package is provided in the resource URL, and the workflow user is identified by the order at which it is added to the workflow.

workflow_recall_workflow_async async

workflow_recall_workflow_async(package_id: int) -> dict[str, Any] | None

Recall Document

Business applications can use this service API to stop a workflow in progress. The document ID is provided in the resource URL. After recall the document status automatically changes to "DRAFT".

workflow_start_workflow_async async

workflow_start_workflow_async(package_id: int) -> dict[str, Any] | None

Share Document Package

Business applications can use this service API to share a document package with the signers and start a new workflow. The document should already have been prepared by applying a template and optionally updating the users and actions defined in template. The package ID to be shared is provided in the resource URL.

workflow_update_workflow_async async

workflow_update_workflow_async(input: WorkflowDetailUpdateRequest, package_id: int) -> dict[str, Any] | None

Update Workflow Details

Business applications can use this service API to update the workflow details. Normally this call is useful after a template has been applied to a document, but business applications wants to override the certify permission or post processing details. The package ID is provided in the resource URL.

workflow_update_workflow_post_process_async async

workflow_update_workflow_post_process_async(input: PostProcessUpdateRequest, package_id: int) -> dict[str, Any] | None

Update Post Processing

Business applications can use this service API to add placeholder to a workflow a document in a package.

workflow_update_workflow_reminder_async async

workflow_update_workflow_reminder_async(input: UpdateReminderRequest, package_id: int, order: int) -> dict[str, Any] | None

Update Workflow Reminders

Business applications can use this service API to update the workflow reminders for a recipient that has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications want to override the reminders settings within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow.

workflow_workflow_add_group_async async

workflow_workflow_add_group_async(input: WorkflowWorkflowAddGroupInput, package_id: int) -> dict[str, Any] | None

Add Groups to Workflow

Business applications can use this service API to add groups as a recipient to a workflow. A SigningHub group means any member of the group can perform the action, i.e. sign, on behalf of all members of the group. Note the group will be added as the last user/group in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

workflow_workflow_add_placeholder_async async

workflow_workflow_add_placeholder_async(input: WorkflowWorkflowAddPlaceholderInput, package_id: int) -> dict[str, Any] | None

Add Placeholder to Workflow

Business applications can use this service API to add placeholder to a workflow in a package. A place holder is required when you do not know the identity of the intended recipient in a workflow. Note the placeholder will be added as the last user in the workflow.Hence further work may be required to remove a current user/group, already present in the workflow. Adding a place holder allows you to proceed and add signature and/or input fields to the document, which can then be assigned to individual users at a later stage. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

workflow_workflow_add_user_async async

workflow_workflow_add_user_async(input: WorkflowWorkflowAddUserInput, package_id: int) -> dict[str, Any] | None

Add Users to Workflow

Business applications can use this service API to add recipients to a workflow. This call will only add a recipient to the workflow. That is, no fields currently on the document will be automatically assigned to the new recipient(s), nor will this create any new fields. Note the recipient(s) will be added as the last person in the workflow.Hence further work may be required to remove a current recipient(s) already present in the workflow. At least one user must exist in a workflow before fields (input and signature) can be added to the document. Note the input accepts one or more users in a single call. In this specific call the user is a known natural person. However, the same rules apply to Groups and Placeholders. In either of these cases the recipient becomes a Group of users whereby any member of the group can sign the document, or a Placeholder.The latter case is used when you do not know the identity of the intended signatory. Note SigningHub workflow signing order starts at "1". Hence, adding a user to workflow with no current recipient(s) begins a new signing order count.The "signing_order" parameter is mandatory if the workflow type is "custom". Important, using this API call may affect the workflow type.If there are current recipients in a sequential workflow and a new one is added with the same signing order as a current recipient, then that part of the workflow changes automatically from sequential to parallel.Hence, the workflow overall is now of type custom as opposed to purely sequential. Adding a recipient with the same signing order as two or parallel recipients does not change the workflow.There are merely, three or more recipients at that particular point of the workflow; all in parallel order. Note, while XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

workflow_workflow_delete_user_async async

workflow_workflow_delete_user_async(package_id: int, order: int) -> dict[str, Any] | None

Delete Workflow User

Business applications can use this service API to delete workflow recipient.

workflow_workflow_update_placeholder_async async

workflow_workflow_update_placeholder_async(input: WorkflowPlaceholderUpdateRequest, package_id: int, order: int) -> dict[str, Any] | None

Update Placeholder

Business applications can use this service API to update a placeholder in the workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific place holder within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow place holder is identified by the order at which it is added to the workflow. While XML type document preparation, only supported role types are "SIGNER", "REVIEWER" and "CARBON_COPY"

workflow_workflow_user_update_async async

workflow_workflow_user_update_async(input: WorkflowUserUpdateRequest, package_id: int, order: int) -> dict[str, Any] | None

Update Workflow User

Business applications can use this service API to update the details of a recipient, group or place holder who has already been added to a workflow. Normally this call is useful after a template has been applied to a document and business applications wants to override the details of a specific user within the workflow. The ID of the workflow document is provided in the resource URL, and the workflow recipient is identified by the order at which it is added to the workflow. Note, while XML type document preparation, only supports role types "SIGNER", "REVIEWER" and "CARBON_COPY".

workflow_workflow_user_update_order_async async

workflow_workflow_user_update_order_async(input: WorkflowUserReorderRequest, package_id: int, order: int) -> dict[str, Any] | None

Update Workflow Users Order

Business applications can use this service API to update order of the recipient in the workflow.

work_space_delete_shared_space_async async

work_space_delete_shared_space_async(id: int) -> dict[str, Any] | None

Delete Shared Space

Business applications can use this service API to delete shared space. The availability of deleting shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the 'Manage Shared Space' option in Roles>Document Settings.

work_space_get_shared_space_async async

work_space_get_shared_space_async(id: int) -> dict[str, Any] | None

Get Shared Space

Business applications can use this service API to get a specific shared space. This API returns information about shared space, its owner and collaborator.

work_space_update_shared_space_async async

work_space_update_shared_space_async(input: UpdateWorkSpaceRequest, id: int) -> dict[str, Any] | None

Update Shared Space

Business applications can use this service API to update shared space. The availability of updating shared spaces is subject to the assigned enterprise user role. To allow this provision Enterprise Admin will enable the 'Manage Shared Space' option in Roles>Document Settings.