SigninghubClient
Attributes
module-attribute
module-attribute
module-attribute
module-attribute
module-attribute
module-attribute
CertifyPermission = Literal['NO_CHANGES_ALLOWED', 'FORM_FILLING_ALLOWED', 'FORM_FILLING_WITH_ANNOTATIONS_ALLOWED']
module-attribute
DocumentPackageStatus = Literal['ALL', 'DRAFT', 'INPROGRESS', 'PENDING', 'SIGNED', 'COMPLETED', 'REVIEWED', 'DECLINED', 'EDITED', 'EXPIRING_IN_SEVEN_DAYS']
module-attribute
module-attribute
CollaboratorRole = Literal['SIGNER', 'REVIEWER', 'EDITOR', 'INPERSON_HOST', 'CARBON_COPY', 'ELECTRONIC_SEAL']
module-attribute
FolderItemSortBy = Literal['TITLE', 'WORKFLOW_TYPE', 'DATE_CREATED', 'LAST_MODIFIED', 'OWNER', 'LOCATION', 'STATUS']
module-attribute
Classes
dataclass
dataclass
dataclass
dataclass
dataclass
Response for Add CheckBox Field
Attributes
class-attribute
instance-attribute
Name of the field created in the document.
dataclass
ContactResponse(id: int, enterprise: bool, *, user_name: Optional[str] = None, user_email: Optional[str] = None, mobile_number: Optional[str] = None, user_national_id: Optional[str] = None, created_on: Optional[str] = None)
Response for Get Contacts
Attributes
class-attribute
instance-attribute
User name of the contact.
class-attribute
instance-attribute
Email address of the contact.
class-attribute
instance-attribute
Mobile number of the contact.
class-attribute
instance-attribute
National identity number of the contact
dataclass
dataclass
dataclass
dataclass
DocumentDetailsResponse(document_id: int, document_order: int, document_width: int, document_height: int, document_pages: int, form_fields: bool, lock_form_fields: bool, *, document_name: Optional[str] = None, document_type: Optional[str] = None, document_source: Optional[str] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, certify: Optional[DocumentCertifyResponse | Mapping[str, Any]] = None, template: Optional[DocumentTemplateResponse | Mapping[str, Any]] = None)
Response for Get Document Details
Attributes
class-attribute
instance-attribute
The name of the document.
class-attribute
instance-attribute
Type of the document e.g. "PDF".
class-attribute
instance-attribute
Identifies where the document was uploaded e.g. "My App".
instance-attribute
True if locking of form fields with the last signature is enabled.
class-attribute
instance-attribute
The date and time when the document was uploaded.
dataclass
UploadDocumentLibraryResponse(document_id: int, document_size: int, document_order: int, document_width: int, document_height: int, document_pages: int, uploaded_on: str, modified_on: str, form_fields: bool, lock_form_fields: bool, *, document_name: Optional[str] = None, document_type: Optional[str] = None, document_source: Optional[str] = None, certify: Optional[UploadDocumentLibraryCertifyResponse | Mapping[str, Any]] = None, template: Optional[UploadDocumentLibraryTemplateResponse | Mapping[str, Any]] = None, package_name: Optional[str] = None, metadata: Optional[UploadDocumentMetaInfoDetail | Mapping[str, Any]] = None)
Response for Add or Update Document from Library
Attributes
class-attribute
instance-attribute
The name of the document.
class-attribute
instance-attribute
Type of the document e.g. "PDF".
class-attribute
instance-attribute
Identifies where the document was uploaded e.g. "My App".
instance-attribute
The date and time when the document was last modified.
instance-attribute
True if locking of form fields with the last signature is enabled.
dataclass
UploadDocument(document_id_2: int, documentid: int, document_id: int, document_order: int, document_width: int, document_height: int, document_pages: int, uploaded_on: str, modified_on: str, lock_form_fields: bool, document_size: int, *, document_name: Optional[str] = None, document_type: Optional[str] = None, document_source: Optional[str] = None, certify: Optional[CertifyPermissionResponse | Mapping[str, Any]] = None, metadata: Optional[UploadDocumentMetaInfoDetail | Mapping[str, Any]] = None, package_name: Optional[str] = None)
Response for Upload Document
Attributes
class-attribute
instance-attribute
This property is retained for backward compatibility and will be removed in later versions. Use document_id instead.
instance-attribute
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
instance-attribute
The document ID to be used later to share, download and get status of the document.
class-attribute
instance-attribute
The name of the document.
class-attribute
instance-attribute
Type of the document e.g. "PDF".
class-attribute
instance-attribute
Identifies where the document was uploaded e.g. "My App".
instance-attribute
The date and time when the document was last modified.
instance-attribute
True if locking of form fields with the last signature is enabled.
dataclass
EnterpriseAccessResponse(*, authentication: Optional[EnterpriseAuthenticationResponse | Mapping[str, Any]] = None, authentication_signing: Optional[EnterpriseAuthenticationSigningResponse | Mapping[str, Any]] = None, access_duration: Optional[PermissionAccessDurationResponse | Mapping[str, Any]] = None)
Response for Get Workflow User Authentication (Document Opening) of Enterprise Package
dataclass
dataclass
FieldsResponse(*, signature: Optional[List[DigitalSignatureFieldResponse | Mapping[str, Any]]] = None, hand_signature: Optional[List[HandSignatureFieldResponse | Mapping[str, Any]]] = None, electronic_signature: Optional[List[ElectronicSignatureFieldResponse | Mapping[str, Any]]] = None, initials: Optional[List[InitialFieldResponse | Mapping[str, Any]]] = None, in_person_signature: Optional[List[Dict[str, Any]]] = None, text: Optional[List[TextFieldResponse | Mapping[str, Any]]] = None, radio: Optional[List[RadioFieldResponse | Mapping[str, Any]]] = None, checkbox: Optional[List[CheckboxFieldResponse | Mapping[str, Any]]] = None, dropdown: Optional[List[DropdownFieldResponse | Mapping[str, Any]]] = None, listbox: Optional[List[ListBoxFieldResponse | Mapping[str, Any]]] = None, qrcode: Optional[List[QrCodeResponse | Mapping[str, Any]]] = None, attachment: Optional[List[AttachmentFieldResponse | Mapping[str, Any]]] = None, comment: Optional[List[CommentFieldResponse | Mapping[str, Any]]] = None, unique_identifier: Optional[List[UniqueIdentifierFieldResponse | Mapping[str, Any]]] = None)
dataclass
AddPackageResponse(package_id: int, *, workflow_mode: Optional[str] = None, workflow_type: Optional[str] = None)
Response for Add Package
Attributes
instance-attribute
The package ID to be used later to share, download and get status of the document.
class-attribute
instance-attribute
The workflow mode that is set while adding package.
dataclass
dataclass
GetPackagesResponse(package_id: int, shared_package: bool, gatekeeper_package: bool, folder_id: int, unread: bool, size: int, *, package_name: Optional[str] = None, package_owner: Optional[str] = None, owner_name: Optional[str] = None, package_status: Optional[str] = None, extension: Optional[str] = None, workflow_mode: Optional[str] = None, folder: Optional[str] = None, next_signer: Optional[str] = None, next_signer_email: Optional[List[NextSignerEmail | Mapping[str, Any]]] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, access_duration: Optional[RecipientAccessDurationDetails | Mapping[str, Any]] = None, decline: Optional[RecipientDeclineDetails | Mapping[str, Any]] = None)
Response for Get Packages
Attributes
class-attribute
instance-attribute
Name of the document package.
class-attribute
instance-attribute
Email address of the document package owner.
class-attribute
instance-attribute
Name of the document package owner.
class-attribute
instance-attribute
Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", or "COMPLETED".
class-attribute
instance-attribute
Document Package extension
class-attribute
instance-attribute
Workflow Mode
class-attribute
instance-attribute
Name of the folder which contains the document package.
class-attribute
instance-attribute
The name of the next signer if the document is in shared state.
class-attribute
instance-attribute
next_signer_email: Optional[List[NextSignerEmail | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
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.
class-attribute
instance-attribute
Date and time when the document was uploaded.
class-attribute
instance-attribute
Date and time when the document was last modified.
dataclass
GetPackageDetailsResponse(read_only: bool, *, name: Optional[str] = None, owner: Optional[DocumentOwner | Mapping[str, Any]] = None, document_status: Optional[str] = None, documents: Optional[List[DocumentDetails | Mapping[str, Any]]] = None)
Response for Get Package Details
Attributes
class-attribute
instance-attribute
Name of the document package.
instance-attribute
True if the applied template is read only. User will not be able to make any changes if a read only template is applied.
dataclass
dataclass
dataclass
TemplateResponse(template_id: int, template_public: bool, read_only: bool, enterprise: bool, *, template_name: Optional[str] = None, created_on: Optional[str] = None, description: Optional[str] = None, documents: Optional[List[TemplateDocumentResponse | Mapping[str, Any]]] = None, smart_form: Optional[TemplateSmartFormResponse | Mapping[str, Any]] = None)
Response for Get Templates
Attributes
class-attribute
instance-attribute
Name of the template.
instance-attribute
Response is "true" if enterprise template is marked as public. Otherwise "false" would be returned
instance-attribute
Response of "true" if the template is read only, and user cannot make any changes to the workflow after applying this template. Otherwise "false".
class-attribute
instance-attribute
Date and time when the template was created
class-attribute
instance-attribute
Description of the template
dataclass
Response for Add Digital Signature Field
Attributes
class-attribute
instance-attribute
Name of the field created in the document.
dataclass
Response for Bulk Sign Packages
dataclass
BulkSignStatusResponse(*, status: Optional[str] = None, packages: Optional[List[BulkSignPackagesStatus | Mapping[str, Any]]] = None)
Response for Bulk Signing Status
dataclass
SignDocumentResponse(*, field_name: Optional[str] = None, status: Optional[str] = None, transaction_id: Optional[str] = None, verification: Optional[VerificationResponse | Mapping[str, Any]] = None, authentication_access_token: Optional[str] = None)
Response for Sign Document
Attributes
class-attribute
instance-attribute
Name of the field for which the verification was requested.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
This parameter is used while RAS signing
dataclass
EnterpriseTemplateResponse(id: int, public: bool, read_only: bool, *, name: Optional[str] = None, description: Optional[str] = None, created_on: Optional[str] = None, roles: Optional[List[EnterpriseTemplateRole | Mapping[str, Any]]] = None, documents: Optional[List[TemplateDocumentResponse | Mapping[str, Any]]] = None)
Response for Get Enterprise Templates
Attributes
class-attribute
instance-attribute
Name of the template.
instance-attribute
Response is "true" if enterprise template is marked as public. Otherwise "false" would be returned
instance-attribute
Response of "true" if the template is read only, and user cannot make any changes to the workflow after applying this template. Otherwise "false".
class-attribute
instance-attribute
Description of the template
dataclass
dataclass
WorkflowDetailsResponse(package_id: int, shared_package: bool, folder_id: int, gatekeeper: bool, *, package_name: Optional[str] = None, package_owner: Optional[str] = None, owner_name: Optional[str] = None, package_status: Optional[str] = None, folder: Optional[str] = None, next_signer: Optional[str] = None, next_signer_email: Optional[List[NextSignerEmail | Mapping[str, Any]]] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, workflow: Optional[WorkflowResponse | Mapping[str, Any]] = None, documents: Optional[List[WorkflowDocumentsResponse | Mapping[str, Any]]] = None, users: Optional[List[WorkflowUserResponse | Mapping[str, Any]]] = None)
Response for Get Workflow Details
Attributes
class-attribute
instance-attribute
Name of the document package.
class-attribute
instance-attribute
Email address of the document package owner.
class-attribute
instance-attribute
Name of the document package owner.
class-attribute
instance-attribute
Document status for the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" or "COMPLETED".
class-attribute
instance-attribute
Name of the folder which contains the document package.
class-attribute
instance-attribute
The name of the next signer if the document is in shared state.
class-attribute
instance-attribute
next_signer_email: Optional[List[NextSignerEmail | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
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.
class-attribute
instance-attribute
Date and time when the document was uploaded.
class-attribute
instance-attribute
Date and time when the document was last modified.
dataclass
WorkflowHistoryResponse(package_id: int, *, 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 | Mapping[str, Any]]] = None, documents: Optional[List[WorkflowDocumentsResponse | Mapping[str, Any]]] = None, actions: Optional[List[DocumentLogsActions | Mapping[str, Any]]] = None)
Response for Get Workflow History
Attributes
instance-attribute
ID of the package for which the workflow history is requested.
class-attribute
instance-attribute
Email address of the package owner.
class-attribute
instance-attribute
Name of the package owner.
class-attribute
instance-attribute
Status of the package/document with the current logged in user. Possible values are "DRAFT", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" or "COMPLETED".
class-attribute
instance-attribute
Name of the next recipient.
dataclass
ReminderResponse(enabled: bool, remind_after: int, *, frequency: Optional[str] = None, repeat: Optional[ReminderRepeat | Mapping[str, Any]] = None)
Response for Get Workflow Reminder
Attributes
class-attribute
instance-attribute
Reminder Frequency. Possible Values are DAYS | HOURS.
dataclass
WorkflowRecipient(order: int, signing_order: int, guest_user: bool, *, 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 | Mapping[str, Any]]] = 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, user_national_id: Optional[str] = None, email_language_code: Optional[str] = None, electronic_seal: Optional[ElectronicSealRecipient | Mapping[str, Any]] = None, gatekeepers: Optional[WorkflowGatekeeperResponse | Mapping[str, Any]] = None)
Response for Get Workflow Users
Attributes
class-attribute
instance-attribute
Email address of the recipient if user is not a group.
class-attribute
instance-attribute
Name of the recipient if user is not a group.
class-attribute
instance-attribute
Mobile number
class-attribute
instance-attribute
Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
Group name of the recipient if recipient is a group.
class-attribute
instance-attribute
group_members: Optional[List[GroupMemberResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
A list of email addresses of the group members if recipient is a group.
class-attribute
instance-attribute
Delegatee email address, if recipient is not a group.
class-attribute
instance-attribute
Name of the delegatee user, if recipient is not a group.
class-attribute
instance-attribute
Workflow role in which the recipient was added. This role is not the enterprise role. Possible values are "SIGNER", "REVIEWER","CARBON_COPY" and "EDITOR".
class-attribute
instance-attribute
Reason provided by the user when declining, approving or submitting a document.
class-attribute
instance-attribute
Document processing status for the recipient. Possible values are "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".
class-attribute
instance-attribute
Date and time on which the document was processed.
class-attribute
instance-attribute
User may processed the field as COLLABORATOR , DELEGATOR, GROUP_MEMBER or OWNER.
class-attribute
instance-attribute
Email address of the user who processed the document.
class-attribute
instance-attribute
Placeholder text if the recipient is a placeholder
instance-attribute
Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
class-attribute
instance-attribute
National identity number of the user. This helps to identify user in the workflow
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 | Mapping[str, Any]] = None, attachment: Optional[AttachmentPermissionResponse | Mapping[str, Any]] = None)
Response for Get Workflow User Permissions
Attributes
class-attribute
instance-attribute
True, if printing is allowed for this recipient.
class-attribute
instance-attribute
True, if download is allowed.
class-attribute
instance-attribute
True, if add text annotation on the document is allowed.
class-attribute
instance-attribute
True, if the recipient on the current order can change other recipients in the workflow after workflow is shared.
dataclass
Response for Share Document Package
Attributes
instance-attribute
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.
dataclass
dataclass
dataclass
CollaboratorResponse(signing_order: int, guest_user: bool, *, user_email: Optional[str] = None, email_language_code: Optional[str] = None, permission: Optional[WorkflowPermissionResponse | Mapping[str, Any]] = None, reminder: Optional[ReminderResponse | Mapping[str, Any]] = None)
Response for Add Users to Workflow
Attributes
class-attribute
instance-attribute
User email
dataclass
UpdateCollaboratorResponse(signing_order: int, guest_user: bool, *, user_email: Optional[str] = None, email_language_code: Optional[str] = None)
Response for Update Workflow User
Attributes
class-attribute
instance-attribute
User email
dataclass
dataclass
ErrorWithDescriptionResponse(*, error: Optional[str] = None, error_description: Optional[str] = None)
Definition: ErrorWithDescriptionResponse
Attributes
class-attribute
instance-attribute
Error key to identify the error in programming and applications can respond based on the different error keys.
dataclass
Definition: Response
Attributes
dataclass
Definition: DetailedResponse
Attributes
class-attribute
instance-attribute
Custom error code
dataclass
Definition: AuthenticationRequest
Attributes
instance-attribute
Application Name that you have configured in your Enterprise Account when configuring the integration options.
dataclass
Definition: ElectronicSealRecipient
dataclass
PermissionLegalNoticeResponse(enabled: bool, *, allowed_notices: Optional[List[LegalNoticeResponse | Mapping[str, Any]]] = None, default_notice: Optional[List[LegalNoticeResponse | Mapping[str, Any]]] = None)
Definition: PermissionLegalNoticeResponse
Attributes
instance-attribute
True, if legal notice is enabled and configured for the recipient.
dataclass
LegalNoticeResponse(legal_notice_id: int, *, legal_notice_name: Optional[str] = None, legal_notice_html: Optional[str] = None)
Definition: LegalNoticeResponse
Attributes
class-attribute
instance-attribute
LegalNoticeResponse
dataclass
AccessResponse(*, authentication: Optional[AuthenticationResponse | Mapping[str, Any]] = None, authentication_signing: Optional[AuthenticationSigningResponse | Mapping[str, Any]] = None, access_duration: Optional[PermissionAccessDurationResponse | Mapping[str, Any]] = None)
Definition: AccessResponse
dataclass
dataclass
Definition: AccessSecurityPasswordResponse
dataclass
AccessSecuritySmsOtpResponse(enabled: bool, otp_length: int, retry_duration: int, *, mobile_number: Optional[str] = None, methods: Optional[List[str]] = None)
Definition: AccessSecuritySmsOtpResponse
Attributes
instance-attribute
True, if SMS OTP authentication is enabled for the package.
class-attribute
instance-attribute
Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.
dataclass
dataclass
dataclass
AuthenticationSigningSmsOtpResponse(otp_length: int, retry_duration: int, *, mobile_number: Optional[str] = None, methods: Optional[List[str]] = None)
Definition: AuthenticationSigningSmsOtpResponse
Attributes
class-attribute
instance-attribute
Mobile number of the recipient. Mobile number is needed to send the SMS to the recipient for the authentication.
dataclass
dataclass
dataclass
DurationByDateResponse(*, start_date_time: Optional[str] = None, end_date_time: Optional[str] = None)
Definition: DurationByDateResponse
Attributes
class-attribute
instance-attribute
Date and time from where the package will be accessible to the recipient.
dataclass
dataclass
dataclass
ReminderRepeat(enabled: bool, keep_reminding_after: int, total_reminders: int, *, frequency: Optional[str] = None)
Definition: ReminderRepeat
Attributes
class-attribute
instance-attribute
Repeat Reminder Frequency. Possible Values are DAYS | HOURS.
instance-attribute
The number of days after which the subsequent reminders would be sent to workflow recipient.
dataclass
dataclass
dataclass
Definition: AuthenticationPassword
Attributes
instance-attribute
True, if password authentication is enabled for the package.
dataclass
Definition: AuthenticationSmsOtp
Attributes
instance-attribute
True, if SMS OTP authentication is enabled for the package.
dataclass
dataclass
dataclass
dataclass
dataclass
Definition: DurationByDate
Attributes
class-attribute
instance-attribute
Date and time from where the package will be accessible to the recipient.
dataclass
dataclass
dataclass
QrCodeRequest(page_no: int, dimensions: FieldDimension | Mapping[str, Any], *, field_name: Optional[str] = None, data: Optional[str] = None, options: Optional[QrCodeOptions | Mapping[str, Any]] = None, color: Optional[QrCodeColor | Mapping[str, Any]] = None, logo: Optional[QrCodeLogo | Mapping[str, Any]] = None)
Definition: QrCodeRequest
Attributes
class-attribute
instance-attribute
Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.
dataclass
Definition: FieldDimension
dataclass
QrCodeOptions(error_correction_level: ECCLevelAPI, encoding: EciModeAPI, pixels_per_module: int, add_margins: bool)
Definition: QrCodeOptions
Attributes
instance-attribute
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
dataclass
Definition: QrCodeColor
Attributes
class-attribute
instance-attribute
Represents the dark color used for the dots in the QR code. Default is "black". e.g. "#000000"
dataclass
Definition: QrCodeLogo
Attributes
class-attribute
instance-attribute
An optional icon (base64) to place in the center of the QR code.
instance-attribute
The background color behind the icon, if an icon is provided. If color is not provided transparent background is implemented.
dataclass
dataclass
Definition: SignatureFieldAuthenticationOtp
Attributes
instance-attribute
True, if SMS/Email OTP authentication is enabled for the field. False otherwise.
dataclass
dataclass
UpdateQrCodeRequest(field_name: str, page_no: int, dimensions: FieldDimension | Mapping[str, Any], *, renamed_as: Optional[str] = None, data: Optional[str] = None, options: Optional[QrCodeOptions | Mapping[str, Any]] = None, color: Optional[QrCodeColor | Mapping[str, Any]] = None, logo: Optional[QrCodeLogo | Mapping[str, Any]] = None)
Definition: UpdateQrCodeRequest
Attributes
class-attribute
instance-attribute
Updated name of the field if renaming is intended.
dataclass
FieldValidationValue(required: bool, *, rules: Optional[List[FieldValidationValueRule | Mapping[str, Any]]] = None)
Definition: FieldValidationValue
dataclass
Definition: FieldValidationValueRule
Attributes
class-attribute
instance-attribute
Specifies the type of validation rule, which is currently always set to EQUALS for text field.
dataclass
PostProcessResponse(enabled: bool, google_drive: bool, one_drive: bool, dropbox: bool, workflow_recipients: bool, document_processing_report: bool, *, contacts: Optional[List[str]] = None, recipients: Optional[List[PostProcessRecipientResponse | Mapping[str, Any]]] = None, message: Optional[str] = None)
Definition: PostProcessResponse
Attributes
class-attribute
instance-attribute
List of email addresses to which the email will be sent when the workflow is completed.
class-attribute
instance-attribute
recipients: Optional[List[PostProcessRecipientResponse | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion.
class-attribute
instance-attribute
Any custom string message that is to be sent to the contacts when the workflow is completed.
instance-attribute
True, if google drive uploading is turned on for the package. Documents will be uploaded to google drive when the workflow is completed.
instance-attribute
True, if one drive uploading is turned on for the package. Documents will be uploaded to one drive when the workflow is completed.
instance-attribute
True, if dropbox uploading is turned on for the package. Documents will be uploaded to google drive when the workflow is completed.
instance-attribute
True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false.
dataclass
Definition: PostProcessRecipientResponse
dataclass
CertifyResponse(enabled: bool, *, allowed_permissions: Optional[List[str]] = None, default_permission: Optional[str] = None)
Definition: CertifyResponse
Attributes
instance-attribute
True, if certify signature settings are enabled for the document.
dataclass
Definition: GroupMemberResponse
Attributes
class-attribute
instance-attribute
Email address of the group member
dataclass
dataclass
Definition: PostProcessRecipientRequest
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
Definition: Next_signer_email
Attributes
class-attribute
instance-attribute
Email address of the next signer.
dataclass
dataclass
Definition: WorkflowGatekeeperUserResponse
dataclass
dataclass
EnterpriseAccessSecuritySmsOtpResponse(enabled: bool, otp_length: int, retry_duration: int, *, mobile_number: Optional[str] = None)
Definition: EnterpriseAccessSecuritySmsOtpResponse
Attributes
instance-attribute
True, if SMS OTP authentication is enabled for the package.
dataclass
dataclass
EnterpriseAuthenticationSigningSmsOtpResponse(otp_length: int, retry_duration: int, *, mobile_number: Optional[str] = None)
Definition: EnterpriseAuthenticationSigningSmsOtpResponse
dataclass
Definition: DocumentOwner
dataclass
DocumentDetails(id: int, size: int, *, name: Optional[str] = None, uploaded_on: Optional[str] = None, modified_on: Optional[str] = None, type_: Optional[str] = None, source: Optional[str] = None)
Definition: DocumentDetails
Attributes
class-attribute
instance-attribute
The name of the document.
class-attribute
instance-attribute
Date and time when the document was uploaded.
class-attribute
instance-attribute
Date and time when the document was last modified.
class-attribute
instance-attribute
Type of the document e.g. "PDF".
dataclass
dataclass
dataclass
ServicePlanLevelOfAssurance(*, allowed: Optional[List[str]] = None, default: Optional[List[str]] = None)
Definition: ServicePlanLevelOfAssurance
Attributes
class-attribute
instance-attribute
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
class-attribute
instance-attribute
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
dataclass
Definition: ServicePlanCertifyOption
Attributes
class-attribute
instance-attribute
Allowed document certify options, Possible values are: NO_CHANGES_ALLOWED, FORM_FILLING_ALLOWED, FORM_FILLING_WITH_ANNOTATIONS_ALLOWED
dataclass
dataclass
dataclass
Definition: EmailDeletedDocument
dataclass
ServicePlanSigningServer(*, key_location: Optional[str] = None, order: Optional[int] = None, signing_profile: Optional[ServicePlanProfile | Mapping[str, Any]] = None, electronic_seal: Optional[SigningServerCapacity | Mapping[str, Any]] = None, advanced_electronic_seal: Optional[SigningServerCapacity | Mapping[str, Any]] = None, qualified_electronic_seal: Optional[SigningServerCapacity | Mapping[str, Any]] = None, advanced_electronic_signature: Optional[SigningServerCapacity | Mapping[str, Any]] = None, high_trust_advanced_signature: Optional[SigningServerCapacity | Mapping[str, Any]] = None, qualified_electronic_signature: Optional[SigningServerCapacity | Mapping[str, Any]] = None, signature_appearances: Optional[SigningServerSignatureAppearance | Mapping[str, Any]] = None, csp: Optional[SigningServerCsp | Mapping[str, Any]] = None)
Definition: ServicePlanSigningServer
Attributes
class-attribute
instance-attribute
Key location of the signing server, possible values are SERVER, LOCAL
dataclass
dataclass
SigningServerCapacity(enabled: bool, *, capacities: Optional[List[ServicePlanCapacity | Mapping[str, Any]]] = None)
Definition: SigningServerCapacity
Attributes
dataclass
ServicePlanCapacity(id: int, *, name: Optional[str] = None, level_of_assurance: Optional[str] = None, key_protection: Optional[str] = None)
Definition: ServicePlanCapacity
Attributes
class-attribute
instance-attribute
Name of the Capacity
class-attribute
instance-attribute
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.
dataclass
SigningServerSignatureAppearance(*, signature_appearance: Optional[str] = None, signature_appearance_logo: Optional[str] = None)
Definition: SigningServerSignatureAppearance
Attributes
class-attribute
instance-attribute
Appearances of the signature, possible values are COMPANY_LOGO, HAND_SIGNATURE, DETAILED_SIGNATURE
dataclass
dataclass
ServicePlanElectronicSealServer(*, electronic_seal_profile: Optional[ServicePlanProfile | Mapping[str, Any]] = None, electronic_seal: Optional[SigningServerCapacity | Mapping[str, Any]] = None, advanced_electronic_seal: Optional[SigningServerCapacity | Mapping[str, Any]] = None, qualified_electronic_seal: Optional[SigningServerCapacity | Mapping[str, Any]] = None)
Definition: ServicePlanElectronicSealServer
dataclass
dataclass
Definition: ServicePlanEvidenceReport
Attributes
class-attribute
instance-attribute
Type of workflow evidence recording, Possible values are "BASIC", "DETAILED"
dataclass
ServicePlanOneTimePassword(otp_length: int, otp_expiry: int, otp_retry_interval: int, *, email_otp: Optional[ServicePlanEmailOtp | Mapping[str, Any]] = None, sms_otp: Optional[ServicePlanSmsOtp | Mapping[str, Any]] = None)
Definition: ServicePlanOneTimePassword
dataclass
dataclass
dataclass
dataclass
Definition: ServicePlanSmsNotification
dataclass
dataclass
dataclass
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
class-attribute
instance-attribute
True, if workflow needs to continue even if any recipient declines the document. If no value is provided, old value will be retained.
class-attribute
instance-attribute
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.
dataclass
PostProcessUpdateRequest(enabled: bool, workflow_recipients: bool, document_processing_report: bool, *, contacts: Optional[List[str]] = None, recipients: Optional[List[PostProcessRecipientRequest | Mapping[str, Any]]] = None, message: Optional[str] = None, google_drive: Optional[bool] = None, dropbox: Optional[bool] = None, onedrive: Optional[bool] = None)
Definition: PostProcessUpdateRequest
Attributes
class-attribute
instance-attribute
recipients: Optional[List[PostProcessRecipientRequest | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
List of the name and email addresses to whom the emails are sent when the post processing is executed after the workflow completion.
class-attribute
instance-attribute
A custom string message for all the contacts. Message becomes part of the email sent to the contacts.
class-attribute
instance-attribute
True, if document is to be uploaded to the provided google account after the workflow completion.
class-attribute
instance-attribute
True, if document is to be uploaded to the provided dropbox account after the workflow completion.
class-attribute
instance-attribute
True, if document is to be uploaded to the provided oneDrive account after the workflow completion.
instance-attribute
True, if workflow completion report is to be sent to all recipients of the workflow when post processing is executed. Default value is false.
dataclass
WorflowUserRequest(user_name: str, email_notification: bool, role: CollaboratorRole, delivery_method: DeliveryMethod, *, user_email: Optional[str] = None, user_national_id: Optional[str] = None, signing_order: Optional[int] = None, mobile_number: Optional[str] = None)
Definition: WorflowUserRequest
Attributes
class-attribute
instance-attribute
Email address of the user to be added in the workflow.
class-attribute
instance-attribute
User national id of the recipient
instance-attribute
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.
class-attribute
instance-attribute
Order of the recipient in the workflow. This signing order is mandatory when workflow type is "CUSTOM".
dataclass
WorkflowResponse(continue_on_decline: bool, read_only: bool, comments: bool, *, workflow_type: Optional[str] = None, workflow_status: Optional[str] = None, workflow_mode: Optional[str] = None, message: Optional[str] = None, post_process: Optional[PostProcessResponse | Mapping[str, Any]] = None)
Definition: WorkflowResponse
Attributes
class-attribute
instance-attribute
Type of the workflow, there are four types of workflows supported in the application. Possible values are "SERIAL", "PARALLEL", "INDIVIDUAL" and "CUSTOM".
instance-attribute
True, if workflow needs to be continued even after a recipient declines at his turn.
class-attribute
instance-attribute
Processing status of the workflow, possible values are "DRAFT", "IN_PRGORESS" and "COMPLETED".
class-attribute
instance-attribute
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"
class-attribute
instance-attribute
Any custom string message that is to be sent to all the recipient of the workflow by the document owner.
instance-attribute
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.
dataclass
WorkflowDocumentsResponse(document_id: int, document_order: int, update_required: bool, document_height: int, document_width: int, document_pages: int, form_fields: bool, lock_form_fields: bool, locked: bool, attachments: bool, document_size: int, formatted: bool, *, document_name: Optional[str] = None, document_type: Optional[str] = None, document_source: Optional[str] = None, created_on: Optional[str] = None, modified_on: Optional[str] = None, template: Optional[DocumentsTemplateResponse | Mapping[str, Any]] = None, certify: Optional[CertifyResponse | Mapping[str, Any]] = None, has_signed_signature_fields: Optional[bool] = None, conformance_level: Optional[str] = None)
Definition: WorkflowDocumentsResponse
Attributes
class-attribute
instance-attribute
Name of the document.
class-attribute
instance-attribute
Original document extension when the document was uploaded before conversion to the PDF.
instance-attribute
Order of the document in the document package.
class-attribute
instance-attribute
Source of the document from where the document was uploaded.
class-attribute
instance-attribute
The date and time on which the document was uploaded.
class-attribute
instance-attribute
The date and time on which the document was last modified.
instance-attribute
True, if document is set to lock the form fields with the last digital signature on the document.
class-attribute
instance-attribute
Pdf document meta info: true if pdf document have signed signature fields
class-attribute
instance-attribute
Document conformance level
dataclass
DocumentsTemplateResponse(template_id: int, read_only: bool, *, template_name: Optional[str] = None)
Definition: DocumentsTemplateResponse
Attributes
class-attribute
instance-attribute
Name of the template applied to the document.
dataclass
WorkflowUserResponse(order: int, signing_order: int, guest_user: bool, *, 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 | Mapping[str, Any]] = 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 | Mapping[str, Any]] = None, authentications: Optional[AccessResponse | Mapping[str, Any]] = None, reminder: Optional[ReminderResponse | Mapping[str, Any]] = None, user_national_id: Optional[str] = None, email_language_code: Optional[str] = None, electronic_seal: Optional[ElectronicSealRecipient | Mapping[str, Any]] = None)
Definition: WorkflowUserResponse
Attributes
class-attribute
instance-attribute
Name of the recipient if recipient is not a group. If recipient is a placeholder it will contain the name of the placeholder.
class-attribute
instance-attribute
Email address of the recipient if recipient is not a group or placeholder.
class-attribute
instance-attribute
Mobile number
class-attribute
instance-attribute
Delivery method of recipient Possible values: EMAIL, SMS, or EMAIL_AND_SMS
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
Name of the group if recipient is a group.
class-attribute
instance-attribute
List of all the email addresses and names of the users.
class-attribute
instance-attribute
Email address of the user who is delegator to this recipient.
class-attribute
instance-attribute
Email address of the user who is gatekeeper to this recipient.
class-attribute
instance-attribute
Role of the recipient i.e., "SIGNER", "REVIEWER", "EDITOR","CARBON_COPY" or "INPERSON_HOST".
class-attribute
instance-attribute
Document processing status for the recipient. Possible values are "UN_PROCESSED", "IN_PROGRESS", "SIGNED", "REVIEWED", "DECLINED", "EDITED" or "INVALID".
class-attribute
instance-attribute
Date and time on which the document was processed.
class-attribute
instance-attribute
User may processed the field as COLLABORATOR, DELEGATOR, GROUP_MEMBER or OWNER.
class-attribute
instance-attribute
Email address of the user who processed the document.
class-attribute
instance-attribute
Reason provided by the user when declining, approving or submitting a document.
class-attribute
instance-attribute
Placeholder text if the recipient is a placeholder.
instance-attribute
Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
class-attribute
instance-attribute
National identity number of the user. This helps to identify user in the workflow
dataclass
Definition: DocumentCertifyResponse
Attributes
class-attribute
instance-attribute
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".
dataclass
Definition: DocumentTemplateResponse
Attributes
class-attribute
instance-attribute
Name of the template applied on the document.
dataclass
dataclass
AddDocumentPackageRequest(workflow_mode: WorkflowMode, *, package_name: Optional[str] = None, folder_name: Optional[str] = None)
Definition: AddDocumentPackageRequest
Attributes
class-attribute
instance-attribute
The name of the package. Default package name is always "Untitled" if the package_name is not provided.
dataclass
dataclass
dataclass
dataclass
Definition: RecipientAccessDurationDetails
Attributes
class-attribute
instance-attribute
Start date/time for a recipient to access the document
dataclass
dataclass
Definition: DeclineByDetails
Attributes
class-attribute
instance-attribute
Name of user who have declined the workflow
dataclass
CertifyPermissionResponse(enabled: bool, *, allowed_permissions: Optional[List[str]] = None, default_permission: Optional[str] = None)
Definition: CertifyPermissionResponse
Attributes
class-attribute
instance-attribute
Set of allowed certify permission levels for the document.
dataclass
UploadDocumentMetaInfoDetail(attachments: bool, form_fields: bool, blank_signatures: bool, signed_signatures: bool, locked: bool, qr_code: bool, *, conformance: Optional[str] = None, certify: Optional[str] = None)
Definition: UploadDocumentMetaInfoDetail
Attributes
instance-attribute
true if pdf document has any blank signature field
instance-attribute
true if pdf document has any signed signature field
class-attribute
instance-attribute
null/empty if document does not contains any conformance level otherwise contains formation like 1A, 1B etc
class-attribute
instance-attribute
CertifyLevel of pdf document. Possible values NotCertified, NoChangesAllowed, FormFilling, FormFillingAndAnnotations
dataclass
dataclass
VerificationResponse(ltv: bool, qualified: bool, certified: bool, signature_policy_id: int, page_number: int, *, 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, 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_uri: Optional[str] = None, signer_photo: Optional[str] = None, signer_photo_url: Optional[str] = None, signed_hash: Optional[str] = None, display: Optional[str] = None, lei_number: Optional[str] = None, lei_role: Optional[str] = None, error_message: Optional[str] = None)
Definition: VerificationResponse
Attributes
class-attribute
instance-attribute
Name of the field for which the verification was requested.
class-attribute
instance-attribute
Name of the signer.
class-attribute
instance-attribute
If the overall status of the signature is valid or not. Possible values are "VALID" or "INVALID".
class-attribute
instance-attribute
Reason provided by the user while signing the field. In case of witness signing, custom signing reason would be set
class-attribute
instance-attribute
Location entered by the user while signing the field.
class-attribute
instance-attribute
Contact information entered by the user while signing the field.
class-attribute
instance-attribute
Date and time of signing in 8601 format. Default timezone from SH Admin is followed the the time.
class-attribute
instance-attribute
Permission level for certified digital signature.
class-attribute
instance-attribute
Date and time when signature was time-stamped.
class-attribute
instance-attribute
Authority by which the signature was time-stamped.
class-attribute
instance-attribute
Subject DN from the certificate used while signing the field.
class-attribute
instance-attribute
Issuers DN from the certificate used while signing the field.
class-attribute
instance-attribute
Date and time from which the certificate is valid.
class-attribute
instance-attribute
Date and time to which the certificate is valid.
class-attribute
instance-attribute
Type of signatures, possible values are "PADES_PART2" or "PADES_PART4".
class-attribute
instance-attribute
Signature algorithm used while signing the field.
class-attribute
instance-attribute
Application name from where the field was signed.
class-attribute
instance-attribute
Signature policy URI.
class-attribute
instance-attribute
Base64 image of the signer's avatar.
class-attribute
instance-attribute
Hash of the document that was signed in respective signature.
class-attribute
instance-attribute
LEI number if availbale in certificate
class-attribute
instance-attribute
LEI role if available in certificate
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 | Mapping[str, Any]] = None, transaction_id: Optional[str] = None)
Definition: BulkSignRequest
Attributes
class-attribute
instance-attribute
An array of the document package ids that are selected for bulk signing.
class-attribute
instance-attribute
Base64 image used for the filling of the initials
class-attribute
instance-attribute
Base64 encoded string image of the visible signature appearance
class-attribute
instance-attribute
Reason of signing provided by the recipient.
class-attribute
instance-attribute
Locale of the signer provided by the recipient
class-attribute
instance-attribute
Contact information of the signer provided by the recipient
class-attribute
instance-attribute
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"
class-attribute
instance-attribute
Name of signing server using which the document is to be signed
class-attribute
instance-attribute
Name of certification profile/signing capacity using which the document is to be signed
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
class-attribute
instance-attribute
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
class-attribute
instance-attribute
It is an optional parameter, but it's only required when using 'AUTHENTICATION_PASSWORD' as a parameter value under 'mechanism'
class-attribute
instance-attribute
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'
class-attribute
instance-attribute
It is an optional parameter, but it's only required when using 'AUTHENTICATION_ACTIVE_DIRECTORY' or 'AUTHENTICATION_SAML' as a parameter value under 'mechanism'
class-attribute
instance-attribute
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
class-attribute
instance-attribute
Code Verifier if PKCE is enabled for the client.
dataclass
BulkSignPackagesStatus(id: int, percentage: int, *, name: Optional[str] = None, status: Optional[str] = None, action: Optional[str] = None, error: Optional[str] = None, documents: Optional[List[BulkSignActionDocumentModel | Mapping[str, Any]]] = None)
Definition: BulkSignPackagesStatus
Attributes
class-attribute
instance-attribute
Required action key if any
dataclass
BulkSignActionDocumentModel(id: int, *, fields: Optional[List[BulkSignActionFieldModel | Mapping[str, Any]]] = None)
Definition: BulkSignActionDocumentModel
dataclass
BulkSignActionFieldModel(*, name: Optional[str] = None, hash: Optional[str] = None, hashing_algo: Optional[str] = None)
Definition: BulkSignActionFieldModel
dataclass
dataclass
SignDocumentRequest(field_name: str, skip_verification: bool, *, 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, signing_server: Optional[str] = None, authentication: Optional[Authentication | Mapping[str, Any]] = None)
Definition: SignDocumentRequest
Attributes
instance-attribute
Unique identifier of the signature field in the document.
class-attribute
instance-attribute
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.)
class-attribute
instance-attribute
Reason of signing provided by the recipient. Note: Commitment type indication for XML documents
class-attribute
instance-attribute
Locale of the signer provided by the recipient.
class-attribute
instance-attribute
Contact information of the signer provided by the recipient.
class-attribute
instance-attribute
Name of the signer provided by the recipient. Note this applies to in-person signing operations only.
class-attribute
instance-attribute
Password provided by the user subject to user's signature settings.
class-attribute
instance-attribute
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"
class-attribute
instance-attribute
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.
instance-attribute
No signature verification returns in response body when it is set as true. Default value for this parameter set to false.
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
class-attribute
instance-attribute
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
class-attribute
instance-attribute
It is an optional parameter, but it's only required when using 'AUTHENTICATION_PASSWORD' as a parameter value under 'mechanism'
class-attribute
instance-attribute
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'
class-attribute
instance-attribute
It is an optional parameter, but it's only required when using 'AUTHENTICATION_ACTIVE_DIRECTORY' or 'AUTHENTICATION_SAML' as a parameter value under 'mechanism'
class-attribute
instance-attribute
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
class-attribute
instance-attribute
Code Verifier if PKCE is enabled for the client.
dataclass
AutoPlaceFieldRequest(order: int, max_length: int, multiline: bool, *, search_text: Optional[str] = None, placement: Optional[str] = None, field_type: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, dimensions: Optional[FieldDimension | Mapping[str, Any]] = None, placeholder: Optional[str] = None, radio_group_name: Optional[str] = None, format: Optional[str] = None, value: Optional[str] = None, validation_rule: Optional[str] = None, validation: Optional[FieldValidationValue | Mapping[str, Any]] = None, font: Optional[Font | Mapping[str, Any]] = None)
Definition: AutoPlaceFieldRequest
Attributes
class-attribute
instance-attribute
Word that needs to be searched in the document.
instance-attribute
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.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
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"
class-attribute
instance-attribute
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"
class-attribute
instance-attribute
Provide note in the case of Mandatory Attachment
class-attribute
instance-attribute
The group name required only when adding a Radio Box type field to group multiple Radio boxes together.
class-attribute
instance-attribute
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
class-attribute
instance-attribute
Value that user want to show in the field.
instance-attribute
Maximum length of the value allowed in the field. Must between 1 - 9999
class-attribute
instance-attribute
One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
dataclass
Font(*, name: Optional[str] = None, size: Optional[str] = None, embedded_size: Optional[str] = None)
Definition: Font
Attributes
class-attribute
instance-attribute
Name of the font selected for the text field. Possible values are "COURIER", "HELVETICA".
class-attribute
instance-attribute
Size of the font selected for the text field. Possible values are 8, 10, 12, 14, 16, 18, 20
dataclass
FormFillingRequest(auto_save: bool, *, text: Optional[List[TextFormFillingRequest | Mapping[str, Any]]] = None, radio: Optional[List[RadioFormFillingRequest | Mapping[str, Any]]] = None, checkbox: Optional[List[CheckBoxFormFillingRequest | Mapping[str, Any]]] = None, dropdown: Optional[List[DropDownFormFillingRequest | Mapping[str, Any]]] = None, listbox: Optional[List[ListBoxFormFillingRequest | Mapping[str, Any]]] = None)
Definition: FormFillingRequest
Attributes
instance-attribute
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.
class-attribute
instance-attribute
text: Optional[List[TextFormFillingRequest | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
It has the list of textboxes data to save
class-attribute
instance-attribute
radio: Optional[List[RadioFormFillingRequest | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
It has the list of radios value to save
class-attribute
instance-attribute
checkbox: Optional[List[CheckBoxFormFillingRequest | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
It has the list of checkboxes value to save
dataclass
dataclass
Definition: RadioFormFillingRequest
Attributes
class-attribute
instance-attribute
Group name to which the radio button belongs.
dataclass
dataclass
dataclass
dataclass
InitialFieldRequest(order: int, page_no: int, dimensions: FieldDimension | Mapping[str, Any], *, field_name: Optional[str] = None)
Definition: InitialFieldRequest
Attributes
instance-attribute
The order of the user in workflow for which the field is being added.
dataclass
InitialFillingRequest(field_name: str, image: str, apply_to_all: bool, *, method: Optional[HandSignature] = None)
Definition: InitialFillingRequest
dataclass
UpdateInitialFieldRequest(field_name: str, page_no: int, dimensions: FieldDimension | Mapping[str, Any], *, renamed_as: Optional[str] = None)
Definition: UpdateInitialFieldRequest
Attributes
class-attribute
instance-attribute
Updated name of the field if renaming is intended.
dataclass
InPersonFieldRequest(order: int, page_no: int, placeholder: str, dimensions: FieldDimension | Mapping[str, Any], *, field_name: Optional[str] = None, display: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, authentication_signing: Optional[SignatureFieldAuthentication | Mapping[str, Any]] = None)
Definition: InPersonFieldRequest
Attributes
instance-attribute
The order of the user in workflow for which the field is being added.
class-attribute
instance-attribute
Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.
instance-attribute
String identifier for the inperson field, it can be Customer, Jack, CEO etc.
class-attribute
instance-attribute
Visibility of the field that is to be added, possible values are "VISIBLE" and "INVISIBLE"
dataclass
UpdateInPersonFieldRequest(field_name: str, page_no: int, *, renamed_as: Optional[str] = None, placeholder: Optional[str] = None, dimensions: Optional[FieldDimension | Mapping[str, Any]] = None, display: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, authentication_signing: Optional[SignatureFieldAuthentication | Mapping[str, Any]] = None)
Definition: UpdateInPersonFieldRequest
Attributes
class-attribute
instance-attribute
updated name of the field, if renaming is intended.
class-attribute
instance-attribute
String identifier for the in-person field, it can be Customer, Jack, CEO etc.
class-attribute
instance-attribute
Visibility of the field that is to be updated, possible values are "VISIBLE" and "INVISIBLE"
dataclass
DigitalSignatureFieldRequest(order: int, page_no: int, *, field_name: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, dimensions: Optional[FieldDimension | Mapping[str, Any]] = None, display: Optional[str] = None, authentication_signing: Optional[SignatureFieldAuthentication | Mapping[str, Any]] = None)
Definition: DigitalSignatureFieldRequest
Attributes
class-attribute
instance-attribute
Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.
class-attribute
instance-attribute
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"
dataclass
UpdateDigitalSignatureFieldRequest(field_name: str, page_no: int, *, level_of_assurance: Optional[List[str]] = None, renamed_as: Optional[str] = None, dimensions: Optional[FieldDimension | Mapping[str, Any]] = None, display: Optional[str] = None, authentication_signing: Optional[SignatureFieldAuthentication | Mapping[str, Any]] = None)
Definition: UpdateDigitalSignatureFieldRequest
Attributes
class-attribute
instance-attribute
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"
class-attribute
instance-attribute
Updated name of the field if renaming of the field is intended.
dataclass
CheckBoxFieldRequest(order: int, page_no: int, dimensions: FieldDimension | Mapping[str, Any], *, field_name: Optional[str] = None, value: Optional[str] = None, validation_rule: Optional[str] = None)
Definition: CheckBoxFieldRequest
Attributes
instance-attribute
The order of the user in workflow for which the field is being added.
class-attribute
instance-attribute
Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.
class-attribute
instance-attribute
Value of the field. Possible values are "true" or "false"
dataclass
UpdateCheckBoxFieldRequest(field_name: str, page_no: int, dimensions: FieldDimension | Mapping[str, Any], *, renamed_as: Optional[str] = None, value: Optional[str] = None, validation_rule: Optional[str] = None)
Definition: UpdateCheckBoxFieldRequest
Attributes
class-attribute
instance-attribute
Updated name of the field if renaming is intended.
class-attribute
instance-attribute
Value of the field. Possible values are "true" or "false"
dataclass
TextBoxFieldRequest(order: int, page_no: int, type_: TextboxType, max_length: int, field_type: FieldType, validation_rule: ValidationRule, font: Font | Mapping[str, Any], dimensions: FieldDimension | Mapping[str, Any], multiline: bool, *, value: Optional[str] = None, placeholder: Optional[str] = None, format: Optional[str] = None, field_name: Optional[str] = None, validation: Optional[FieldValidationValue | Mapping[str, Any]] = None)
Definition: TextBoxFieldRequest
Attributes
instance-attribute
The order of the user in workflow for which the field is being added.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
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.
instance-attribute
Maximum length of the value allowed in the field. Must between 1 - 9999
class-attribute
instance-attribute
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
class-attribute
instance-attribute
Name of the field that is to be added. If not provided, system will assign an unique auto generated name to the field.
dataclass
UpdateTextBoxFieldRequest(field_name: str, page_no: int, max_length: int, field_type: FieldType, validation_rule: ValidationRule, *, renamed_as: Optional[str] = None, value: Optional[str] = None, font: Optional[Font | Mapping[str, Any]] = None, dimensions: Optional[FieldDimension | Mapping[str, Any]] = None, placeholder: Optional[str] = None, format: Optional[str] = None, validation: Optional[FieldValidationValue | Mapping[str, Any]] = None)
Definition: UpdateTextBoxFieldRequest
Attributes
class-attribute
instance-attribute
Updated name of the field if renaming is intended.
class-attribute
instance-attribute
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.
instance-attribute
Maximum length of the value allowed in the field. Must between 1 - 9999
class-attribute
instance-attribute
Developers can provide a their own placeholder texts. These placeholders appear in the text fields while viewing the document in viewer.
class-attribute
instance-attribute
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
dataclass
RadioBoxFieldRequest(order: int, page_no: int, validation_rule: ValidationRule, radio_group_name: str, dimensions: FieldDimension | Mapping[str, Any], *, field_name: Optional[str] = None, value: Optional[str] = None)
Definition: RadioBoxFieldRequest
Attributes
instance-attribute
The order of the user in workflow for which the field is being added.
class-attribute
instance-attribute
Name of the provided field that is to be added. If not provided, system will assign an unique auto generated name to the field.
dataclass
UpdateRadioBoxFieldRequest(field_name: str, page_no: int, validation_rule: ValidationRule, radio_group_name: str, dimensions: FieldDimension | Mapping[str, Any], *, renamed_as: Optional[str] = None, value: Optional[str] = None)
Definition: UpdateRadioBoxFieldRequest
Attributes
class-attribute
instance-attribute
Updated name of the field if renaming is intended.
class-attribute
instance-attribute
Value of the field. Possible values are "true" or "false"
dataclass
dataclass
dataclass
UploadDocumentLibraryCertifyResponse(enabled: bool, *, allowed_permissions: Optional[List[str]] = None, default_permission: Optional[str] = None, permission: Optional[str] = None)
Definition: UploadDocumentLibraryCertifyResponse
Attributes
class-attribute
instance-attribute
Set of allowed certify permission levels for the document.
class-attribute
instance-attribute
Selected permission level for the certify signature settings.
class-attribute
instance-attribute
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".
dataclass
Definition: UploadDocumentLibraryTemplateResponse
Attributes
class-attribute
instance-attribute
Name of the template applied on the document.
dataclass
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 | Mapping[str, Any]] = None, attachment: Optional[AttachmentPermissionRequest | Mapping[str, Any]] = None)
Definition: WorkflowPermission
Attributes
class-attribute
instance-attribute
It defines whether recipient is allowed to print the document.
class-attribute
instance-attribute
It defines whether recipient is allowed to download the document.
class-attribute
instance-attribute
It defines whether recipient is allowed to add text fields in the document.
class-attribute
instance-attribute
It allows the user to change any recipient who has not signed yet.
dataclass
dataclass
Definition: PermissionLegalNotice
dataclass
DocumentLogsActions(log_id: int, *, 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 | Mapping[str, Any]] = None)
Definition: DocumentLogsActions
Attributes
class-attribute
instance-attribute
Date and time when the action was performed.
class-attribute
instance-attribute
Email of the user who performed the action.
class-attribute
instance-attribute
Name of the user who performed the action.
dataclass
Definition: DocumentLogsActionsInformation
Attributes
class-attribute
instance-attribute
The type of extra information about the action e.g. "SIGNING_METHOD" which means what signing method user used to sign the document.
dataclass
WorkflowUserUpdateRequest(role: WorkflowCollaboratorRole, delivery_method: DeliveryMethod, *, user_email: Optional[str] = None, user_name: Optional[str] = None, email_notification: Optional[bool] = None, mobile_number: Optional[str] = None, signing_order: Optional[int] = None, email_language_code: Optional[str] = None)
Definition: WorkflowUserUpdateRequest
Attributes
class-attribute
instance-attribute
The email address of the new user to be updated in workflow. If no value is provided, old value will be retained.
class-attribute
instance-attribute
Name of the recipient to be updated. If no value is provided, old value will be retained.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
Mobile number. If no value is provided, old value will be retained.
class-attribute
instance-attribute
Order in which the workflow will be signed by the recipients. This signing order is important when workflow type is set to "CUSTOM".
dataclass
dataclass
UpdateReminderRequest(apply_to_all: bool, enabled: bool, remind_after: int, *, frequency: Optional[str] = None, repeat: Optional[RepeatRequest | Mapping[str, Any]] = None)
Definition: UpdateReminderRequest
Attributes
instance-attribute
True, if reminder settings are to be applied on all the recipients in the workflow.
class-attribute
instance-attribute
Reminder Frequency. Possible Values are DAYS | HOURS.
dataclass
RepeatRequest(enabled: bool, keep_reminding_after: int, total_reminders: int, *, frequency: Optional[str] = None)
Definition: RepeatRequest
Attributes
class-attribute
instance-attribute
Repeat Reminder Frequency. Possible Values are DAYS | HOURS.
instance-attribute
Required, in case of enabled property will true. The number of days after which the subsequent reminders would be sent to workflow user.
dataclass
WorflowGroupRequest(email_notification: bool, role: CollaboratorRole, *, group_name: Optional[str] = None, signing_order: Optional[int] = None)
Definition: WorflowGroupRequest
Attributes
class-attribute
instance-attribute
The name of the new group to be added in workflow.
instance-attribute
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.
dataclass
PlaceholderRequest(email_notification: bool, role: CollaboratorRole, *, placeholder: Optional[str] = None, signing_order: Optional[int] = None)
Definition: PlaceholderRequest
Attributes
class-attribute
instance-attribute
The name of the new placeholder to be added in workflow.
instance-attribute
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.
dataclass
WorkflowPlaceholderUpdateRequest(role: WorkflowCollaboratorRole, *, placeholder: Optional[str] = None, email_notification: Optional[bool] = None, signing_order: Optional[int] = None)
Definition: WorkflowPlaceholderUpdateRequest
Attributes
class-attribute
instance-attribute
The name of the new placeholder to be added in workflow. If no value is provided, old value will be retained.
class-attribute
instance-attribute
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.
dataclass
UpdateWorkSpaceRequest(*, name: Optional[str] = None, members: Optional[List[WorkSpaceMembers | Mapping[str, Any]]] = None)
Definition: UpdateWorkSpaceRequest
Attributes
class-attribute
instance-attribute
Name of shared space
dataclass
dataclass
DigitalSignatureFieldResponse(order: int, display_order: int, page_no: int, embedded: bool, *, field_name: Optional[str] = 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 | Mapping[str, Any]] = None, verification: Optional[VerificationResponse | Mapping[str, Any]] = None, nid: Optional[str] = None, display: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, authentication: Optional[FieldAuthentication | Mapping[str, Any]] = None)
Definition: DigitalSignatureFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.
class-attribute
instance-attribute
Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
class-attribute
instance-attribute
Date time on which the document is processed.
class-attribute
instance-attribute
User who processed the field as COLLABORATOR, DELEGATEE, GROUP_MEMBER or OWNER.
class-attribute
instance-attribute
Date time on which the field is added
class-attribute
instance-attribute
Email address of the user who processed the field.
dataclass
FieldDimenssionResponse(*, field: Optional[FieldResponse | Mapping[str, Any]] = None, page: Optional[PageResponse | Mapping[str, Any]] = None)
Definition: FieldDimenssionResponse
dataclass
Definition: FieldResponse
dataclass
dataclass
dataclass
dataclass
HandSignatureFieldResponse(order: int, display_order: int, page_no: int, embedded: bool, *, field_name: Optional[str] = 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 | Mapping[str, Any]] = None, nid: Optional[str] = None)
Definition: HandSignatureFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.
class-attribute
instance-attribute
Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
class-attribute
instance-attribute
Date time on which the document is processed.
class-attribute
instance-attribute
User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
dataclass
ElectronicSignatureFieldResponse(order: int, display_order: int, page_no: int, embedded: bool, *, field_name: Optional[str] = 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 | Mapping[str, Any]] = None, signature_sub_type: Optional[str] = None, authentication: Optional[FieldAuthentication | Mapping[str, Any]] = None, verification: Optional[VerificationResponse | Mapping[str, Any]] = None, nid: Optional[str] = None, display: Optional[str] = None)
Definition: ElectronicSignatureFieldResponse
Attributes
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
If field is assigned or not, possible values are ASSIGNED, UN_ASSIGNED, SIGNED, LOGGED_IN_USER, HIDDEN and PLACEHOLDER.
class-attribute
instance-attribute
Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
class-attribute
instance-attribute
Date time on which the document is processed.
class-attribute
instance-attribute
User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
class-attribute
instance-attribute
Email address of the user who processed the field.
class-attribute
instance-attribute
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.
dataclass
InitialFieldResponse(order: int, display_order: int, page_no: int, embedded: bool, *, field_name: 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 | Mapping[str, Any]] = None)
Definition: InitialFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
class-attribute
instance-attribute
Date time on which the document is processed.
class-attribute
instance-attribute
User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
class-attribute
instance-attribute
Email address of the user who processed the field.
dataclass
InPersonFieldResponse(order: int, display_order: int, page_no: int, embedded: bool, *, field_name: Optional[str] = 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 | Mapping[str, Any]] = None, verification: Optional[VerificationResponse | Mapping[str, Any]] = None, display: Optional[str] = None, level_of_assurance: Optional[List[str]] = None, authentication: Optional[FieldAuthentication | Mapping[str, Any]] = None)
Definition: InPersonFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
class-attribute
instance-attribute
Date time on which the document is processed.
class-attribute
instance-attribute
User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
class-attribute
instance-attribute
Email address of the user who processed the field.
class-attribute
instance-attribute
Name of the in-person signer or placeholder e.g., Customer, Sales Representative etc.
class-attribute
instance-attribute
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.
class-attribute
instance-attribute
Returns the visibility value of the inperson field, possible values are "VISIBLE" and "INVISIBLE".
dataclass
TextFieldResponse(required: bool, order: int, tab_order: int, display_order: int, page_no: int, embedded: bool, read_only: bool, visible: bool, multiline: bool, max_length: int, field_rotation: int, *, field_name: Optional[str] = None, type_: Optional[str] = None, value: Optional[str] = None, validation_rule: Optional[str] = None, validation: Optional[FieldValidationValue | Mapping[str, Any]] = None, font: Optional[FontResponse | Mapping[str, Any]] = 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, align: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None)
Definition: TextFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
Type of the text field, possible values are "TEXT", "NAME", "COMPANY", "JOBTITLE", "EMAIL", "DATE".
class-attribute
instance-attribute
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.
instance-attribute
True, if the field is marked read only in the PDF document.
class-attribute
instance-attribute
One or more rules for validation of the fields, possible values are "MANDATORY" or "OPTIONAL".
instance-attribute
Maximum content length allowed to be filled in the field.
class-attribute
instance-attribute
If field is a textbox it can follow different input types. Possible values are ALPHANUMERIC, NUMBER, TEXT, EMAIL, TIME or DATE.
class-attribute
instance-attribute
Placeholder text for the textbox field.
class-attribute
instance-attribute
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
class-attribute
instance-attribute
Color of the text in the form fields.
class-attribute
instance-attribute
Border color of the form field.
class-attribute
instance-attribute
tooltip of the form field.
dataclass
RadioFieldResponse(required: bool, order: int, tab_order: int, display_order: int, page_no: int, embedded: bool, value: bool, read_only: bool, checked: bool, visible: bool, field_rotation: int, *, field_name: Optional[str] = None, type_: Optional[str] = None, validation_rule: Optional[str] = None, radio_group_name: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None)
Definition: RadioFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
instance-attribute
True, if the field is marked readonly in the PDF document.
class-attribute
instance-attribute
One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
class-attribute
instance-attribute
The group name to which the field belongs.
class-attribute
instance-attribute
Color of the text in the form fields.
class-attribute
instance-attribute
Border color of the form field.
class-attribute
instance-attribute
tooltip of the form field.
dataclass
CheckboxFieldResponse(required: bool, order: int, tab_order: int, display_order: int, page_no: int, embedded: bool, value: bool, read_only: bool, checked: bool, visible: bool, field_rotation: int, *, field_name: Optional[str] = None, type_: Optional[str] = None, validation_rule: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None)
Definition: CheckboxFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
instance-attribute
True, if the field is marked read only in the PDF document.
class-attribute
instance-attribute
One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
class-attribute
instance-attribute
Color of the text in the form fields.
class-attribute
instance-attribute
Border color of the form field.
class-attribute
instance-attribute
tooltip of the form field.
dataclass
DropdownFieldResponse(required: bool, order: int, tab_order: int, display_order: int, page_no: int, embedded: bool, read_only: bool, visible: bool, field_rotation: int, *, field_name: Optional[str] = None, validation_rule: Optional[str] = None, value: Optional[str] = None, choices: Optional[List[str]] = None, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None, font: Optional[FontResponse | Mapping[str, Any]] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None)
Definition: DropdownFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
instance-attribute
True, if the field is marked read only in the PDF document.
class-attribute
instance-attribute
Value of the field .
class-attribute
instance-attribute
Choices available for the dropdown to choose a value from.
class-attribute
instance-attribute
Color of the text in the form fields.
class-attribute
instance-attribute
Border color of the form field.
class-attribute
instance-attribute
tooltip of the form field.
dataclass
ListBoxFieldResponse(order: int, tab_order: int, display_order: int, page_no: int, embedded: bool, read_only: bool, visible: bool, field_rotation: int, *, field_name: Optional[str] = None, validation_rule: Optional[str] = None, value: Optional[str] = None, choices: Optional[List[str]] = None, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None, font: Optional[FontResponse | Mapping[str, Any]] = None, color: Optional[str] = None, border_color: Optional[str] = None, tooltip: Optional[str] = None)
Definition: ListBoxFieldResponse
Attributes
instance-attribute
Order of the recipient to whom this field is assigned. If the field is not assigned to anyone, value will be null.
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
One or more rules for validation of the fields possible values are "MANDATORY" or "OPTIONAL".
instance-attribute
True, if the field is marked read only in the PDF document.
class-attribute
instance-attribute
Value of the field.
class-attribute
instance-attribute
Choices available for the dropdown to choose a value from.
class-attribute
instance-attribute
Color of the text in the form fields.
class-attribute
instance-attribute
Border color of the form field.
class-attribute
instance-attribute
tooltip of the form field.
dataclass
Definition: FontResponse
Attributes
class-attribute
instance-attribute
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.
dataclass
QrCodeResponse(page_no: int, *, field_name: Optional[str] = None, type_: Optional[str] = None, value: Optional[str] = None, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None, data: Optional[str] = None, options: Optional[QrCodeOptions | Mapping[str, Any]] = None, color: Optional[QrCodeColor | Mapping[str, Any]] = None, logo: Optional[QrCodeLogo | Mapping[str, Any]] = None)
Definition: QrCodeResponse
Attributes
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
Field Type PDF_FIELD_TYPE like QR
class-attribute
instance-attribute
QrCode generated base64 will be provided inly in draft mode
dataclass
AttachmentFieldResponse(order: int, display_order: int, page_no: int, validation_rule: ValidationRule, *, field_name: Optional[str] = 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, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None)
Definition: AttachmentFieldResponse
Attributes
instance-attribute
Display order according to the SigningHub viewer.
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
Whether the field is processed or not. Possible values are UN_PROCESSED, PROCESSED.
class-attribute
instance-attribute
Date time on which the document is processed.
class-attribute
instance-attribute
User who processed the field as COLLABORATOR,DELEGATEE,GROUP_MEMBER or OWNER.
class-attribute
instance-attribute
Email address of the user who processed the field.
dataclass
CommentFieldResponse(id: int, page_no: int, unread_count: int, private: bool, *, recipients: Optional[List[CommentFieldRecipientResponse | Mapping[str, Any]]] = None, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None)
Definition: CommentFieldResponse
Attributes
dataclass
UniqueIdentifierFieldResponse(page_no: int, *, field_name: Optional[str] = None, value: Optional[str] = None, font: Optional[FontResponse | Mapping[str, Any]] = None, dimensions: Optional[FieldDimenssionResponse | Mapping[str, Any]] = None)
Definition: UniqueIdentifierFieldResponse
Attributes
class-attribute
instance-attribute
Unique identifier of the field.
class-attribute
instance-attribute
Value of the field.
dataclass
Definition: CommentFieldRecipientResponse
dataclass
AssignFieldRequest(field_name: str, order: int, *, radio_group_name: Optional[str] = None, level_of_assurance: Optional[List[str]] = None)
Definition: AssignFieldRequest
Attributes
class-attribute
instance-attribute
provide group name for radio box
instance-attribute
The order of the user in workflow, to which the field is being assigned.
class-attribute
instance-attribute
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(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
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 |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
attachment_delete_attachment(package_id: int, document_id: int, attachment_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete Attachment
Business applications can use this service API to delete the attachment of a document.
Swagger operation ID: V4_Attachment_DeleteAttachment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
ID of the document to which the attachment is added. |
required |
attachment_id
|
int
|
ID of the attachment. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
attachment_download_attachment(package_id: int, document_id: int, attachment_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Download Attachment
Business applications can use this service API to download the attachment of a document.
Swagger operation ID: V4_Attachment_DownloadAttachment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
ID of the document to which the attachment is added. |
required |
attachment_id
|
int
|
ID of the attachment. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_attachment_get_attachments(package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Attachments
Business applications can use this service API to get the attachments of a document.
Returns a single-page Azure Core async collection.
Swagger operation ID: V4_Attachment_GetAttachments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
ID of the document to which the attachment is added. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
attachment_upload_attachment(input: bytes, package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Upload Attachment
Business applications can use this service API to upload a attachment in a document.
Swagger operation ID: V4_Attachment_UploadAttachment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
bytes
|
The binary request body. |
required |
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
ID of the document to which the attachment needs to be add. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
checkbox_add_check_box(input: CheckBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Checkbox_AddCheckBox.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CheckBoxFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
checkbox_update_check_box(input: UpdateCheckBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Checkbox_UpdateCheckBox.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateCheckBoxFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_contacts_get(record_per_page: int, page_no: int, *, sort_by: Optional[str] = None, asc: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
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.
Returns a single-page Azure Core async collection.
Swagger operation ID: V4_Contacts_Get.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
record_per_page
|
int
|
Total number of records to be retrieved in a page. |
required |
page_no
|
int
|
Page number to be retrieved. |
required |
sort_by
|
Optional[str]
|
Sort the result by possible values are mentioned above. |
None
|
asc
|
Optional[bool]
|
Order the result set by ascending or descending. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
documents_delete_document(package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete Document
Business applications can use this service API to delete a document in a package.
Swagger operation ID: V4_Documents_DeleteDocument.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
ID of the document to be deleted. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
documents_download_document_bytes(package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Documents_DownloadDocumentBytes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
The ID of the document to be downloaded. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
documents_get_certify_policy(package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Documents_GetCertifyPolicy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
The ID of the document to be downloaded. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
documents_get_document_details(package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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}".
Swagger operation ID: V4_Documents_GetDocumentDetails.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The Package ID of the package to which the document is added. |
required |
document_id
|
int
|
The document ID for which the document details are requested. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
documents_rename_document(input: RenameDocumentRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Rename Document
Business applications can use this service API to rename a document in a package.
Swagger operation ID: V4_Documents_RenameDocument.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RenameDocumentRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
The ID of the document to on which the action is to be performed. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
documents_update_certify_policy(input: UpdateCertifyPolicyRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Documents_UpdateCertifyPolicy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateCertifyPolicyRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID of the package to which the document is added. |
required |
document_id
|
int
|
The ID of the document on which the action is to be performed. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
documents_upload_from_library(package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Documents_UploadFromLibrary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The Package ID of the package to which the document is being added. |
required |
document_id
|
int
|
The library document ID that need to add/updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
documents_upload_stream(input: bytes, package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Documents_UploadStream.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
bytes
|
The binary request body. |
required |
package_id
|
int
|
Package ID of the package to which the document is being added. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
enterprise_documents_get_enterprise_workflow_access(package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID:
V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The package ID for which workflow access security and authentication is to be updated. |
required |
order
|
int
|
Order of the recipient in the workflow for which the access security and authentication is to be updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
enterprise_documents_update_enterprise_workflow_access(input: AccessUpdateRequest | Mapping[str, Any], package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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
Swagger operation ID:
V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
AccessUpdateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The package ID for which workflow access security and authentication is to be updated. |
required |
order
|
int
|
Order of the recipient in the workflow for which the access security and authentication is to be updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
fields_auto_assign_field(input: FieldsAutoAssignFieldInput, package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Fields_AutoAssignField.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
FieldsAutoAssignFieldInput
|
The request body. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which workflow user needs to be updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
fields_auto_place(input: AutoPlaceFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Fields_AutoPlace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
AutoPlaceFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The ID of the package to which the document is added. |
required |
document_id
|
int
|
The ID of the document for which the fields are requested. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
fields_delete_document_field(input: DeleteDocumentFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete Document Field
Business applications can use this service API to delete a field of document in a package.
Swagger operation ID: V4_Fields_DeleteDocumentField.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteDocumentFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
fields_fill_form_fields(input: FormFillingRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Fields_FillFormFields.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
FormFillingRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The ID of the document. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
fields_get_all_document_fields(package_id: int, document_id: int, page_no: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Fields_GetAllDocumentFields.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The ID of the package to which the document is added. |
required |
document_id
|
int
|
The ID of the document for which the fields are requested. |
required |
page_no
|
int
|
Page no of the document for which the fields are requested. If page number is not provided fields of whole document are returned. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
folder_move_package(input: MoveToRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Folder_MovePackage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MoveToRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package id that need to move to folder. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
initials_add_initial(input: InitialFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Initials_AddInitial.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
InitialFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
initials_fill(input: InitialFillingRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Initials_Fill.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
InitialFillingRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The ID of the document. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
initials_update_initial(input: UpdateInitialFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Initials_UpdateInitial.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateInitialFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
in_person_add_in_person(input: InPersonFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_InPerson_AddInPerson.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
InPersonFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
in_person_update_in_person(input: UpdateInPersonFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_InPerson_UpdateInPerson.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateInPersonFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_add_package(input: AddDocumentPackageRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Package_AddPackage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
AddDocumentPackageRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_approve(input: ApproveRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Approve Document
Business applications can use this service API to approve a document by a specified user in the order.
Swagger operation ID: V4_Package_Approve.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ApproveRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The ID of the package to be approved. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_decline(input: DeclineRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Decline Document
Business applications can use this service API to decline a document by a specified user in the order.
Swagger operation ID: V4_Package_Decline.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeclineRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The ID of the package to be declined. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_delete_package(package_id_bulk_action: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Package_DeletePackage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id_bulk_action
|
int
|
Package ID of the package which contains the document. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_download_package_bytes(package_id_bulk_action: int, *, document_ids: Optional[List[int]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.
Swagger operation ID: V4_Package_DownloadPackageBytes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id_bulk_action
|
int
|
The package ID to be downloaded. |
required |
document_ids
|
Optional[List[int]]
|
The Document IDs parameter is optional. If x-combine-files is set to true, the documents will be merged based on the mentioned documents of the package. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_finish(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Package_Finish.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The ID of the package to be finished. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_gatekeeper_approve(input: ApproveRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Package_GatekeeperApprove.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ApproveRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The ID of the package to be approved. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_gatekeeper_decline(input: DeclineRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Package_GatekeeperDecline.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeclineRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The ID of the package to be declined. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_package_get_all_packages(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
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.
Returns a single-page Azure Core async collection.
Swagger operation ID: V4_Package_GetAllPackages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
document_status
|
str
|
Filter by document status possible values are ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS. |
required |
page_no
|
int
|
Page number, according the division of records per page. |
required |
record_per_page
|
int
|
Number of records that are needed to be fetched in one request. |
required |
package_name
|
Optional[str]
|
Package Name. |
None
|
package_id
|
Optional[int]
|
Package Id. |
None
|
recipient_from
|
Optional[str]
|
From. |
None
|
recipient_to
|
Optional[str]
|
To. |
None
|
document_id
|
Optional[int]
|
Document Id. |
None
|
expiry
|
Optional[int]
|
Expiry (Days). |
None
|
modified_from
|
Optional[str]
|
From Modified Date. |
None
|
modified_to
|
Optional[str]
|
To Modified Date. |
None
|
size_from
|
Optional[int]
|
From Size (KB). |
None
|
size_to
|
Optional[int]
|
To Size (KB). |
None
|
certified_documents
|
Optional[bool]
|
Only certified signed documents. |
None
|
form_fields
|
Optional[bool]
|
Only documents that have form fields. |
None
|
attachments
|
Optional[bool]
|
Only documents that have attachments. |
None
|
document_type
|
Optional[str]
|
Document Type like XML, PDF, DOCX etc. |
None
|
sort_by
|
Optional[str]
|
Sort the resultant records as per your choice. |
None
|
asc
|
Optional[bool]
|
Sorted the resultant records by ascending or descending order. |
None
|
document_statuses
|
Optional[List[str]]
|
Document Type. |
None
|
owned_by
|
Optional[str]
|
Owned By filter possible values are ME_OTHERS, ME, OTHERS. |
None
|
smart_form
|
Optional[str]
|
Smart form name. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_get_package_details(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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".
Swagger operation ID: V4_Package_GetPackageDetails.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
Package ID of the document package. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_rename_package(input: RenameDocumentPackageRequest | Mapping[str, Any], package_id_bulk_action: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Package_RenamePackage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RenameDocumentPackageRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id_bulk_action
|
int
|
Package ID to change the name of. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
package_submit(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Package_Submit.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The SigningHub package ID that contains the document to be submitted. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
qr_add_qr_code(input: QrCodeRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_QR_AddQRCode.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
QrCodeRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
qr_update_qr_code(input: UpdateQrCodeRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_QR_UpdateQRCode.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateQrCodeRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
radio_add_radio_box(input: RadioBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Radio_AddRadioBox.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RadioBoxFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
radio_update_radio_box(input: UpdateRadioBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Radio_UpdateRadioBox.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateRadioBoxFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_settings_get_templates(record_per_page: int, page_no: int, *, sort_by: Optional[str] = None, asc: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
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.
Returns a single-page Azure Core async collection.
Swagger operation ID: V4_Settings_GetTemplates.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
record_per_page
|
int
|
Total number of records to be retrieved in a page. |
required |
page_no
|
int
|
Page number to be retrieved. |
required |
sort_by
|
Optional[str]
|
Sort by column. Possible Values are CREATED_ON and NAME. Default is sort by CREATED_ON. |
None
|
asc
|
Optional[bool]
|
The resulting list order. Default resulting list will be descending. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
signature_add_signature(input: DigitalSignatureFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Signature_AddSignature.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DigitalSignatureFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The package ID for which workflow details need to be updated. |
required |
document_id
|
int
|
The document ID where the field is to be added. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
signature_update_signature(input: UpdateDigitalSignatureFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Signature_UpdateSignature.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateDigitalSignatureFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
signing_bulk_sign_documents(input: BulkSignRequest | Mapping[str, Any], package_id_bulk_action: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Signing_BulkSignDocuments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BulkSignRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id_bulk_action
|
str
|
Bulk action to be performed. Possible values are: SIGN | SHARE. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
signing_bulk_sign_status(input: BulkSignStatusRequest | Mapping[str, Any], bulk_action: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Signing_BulkSignStatus.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BulkSignStatusRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
bulk_action
|
str
|
Bulk action to be performed. Possible values are: SIGN | SHARE. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
signing_sign_document(input: SignDocumentRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Signing_SignDocument.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SignDocumentRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The identifier of the package that contains the document for signature. |
required |
document_id
|
int
|
Identifier of the document to be signed. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_template_get_enterprise_templates(record_per_page: int, page_no: int, *, sort_by: Optional[str] = None, asc: Optional[bool] = None, id: Optional[List[int]] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
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.
Returns a single-page Azure Core async collection.
Swagger operation ID: V4_Template_GetEnterpriseTemplates.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
record_per_page
|
int
|
Total number of records to be retrieved in a page. |
required |
page_no
|
int
|
Page number to be retrieved. |
required |
sort_by
|
Optional[str]
|
Sort the result by possible values are mentioned above. |
None
|
asc
|
Optional[bool]
|
Order the result set by ascending or descending. |
None
|
id
|
Optional[List[int]]
|
Search by template ids. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
text_box_add_text_box(input: TextBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_TextBox_AddTextBox.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
TextBoxFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
text_box_update_text_box(input: UpdateTextBoxFieldRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_TextBox_UpdateTextBox.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateTextBoxFieldRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
Package ID to which the document is added. |
required |
document_id
|
int
|
The document ID for which the action is to be taken. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_apply_template(input: ApplyTemplateRequest | Mapping[str, Any], package_id: int, document_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Workflow_ApplyTemplate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ApplyTemplateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The Package ID of the package to which the template needs to be applied. |
required |
document_id
|
int
|
The document ID on which the template needs to be applied. If the value is set to 0, if template is to be applied on all the documents in the package. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_evidence_report_download_bytes(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_WorkflowEvidenceReport_DownloadBytes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The ID of the document. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_get_workflow_detail(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Workflow Details
Business applications can use this service API to get workflow details for the package.
Swagger operation ID: V4_Workflow_GetWorkflowDetail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The ID of the package to be downloaded. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_get_workflow_history(package_id: int, page_no: int, records_per_page: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Workflow_GetWorkflowHistory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The ID of the document for which the log is required. |
required |
page_no
|
int
|
Page number to be retrieved. |
required |
records_per_page
|
int
|
Total number of records to be retrieved in a page. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_get_workflow_reminder(package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Workflow_GetWorkflowReminder.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The package ID for which workflow reminders to be updated. |
required |
order
|
int
|
The order of the user for which the workflow reminders to be updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_workflow_get_workflow_users(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Workflow Users
Business applications can use this service API to get workflow details for the package.
Returns a single-page Azure Core async collection.
Swagger operation ID: V4_Workflow_GetWorkflowUsers.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The ID of the package to be downloaded. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_mark_workflow_completed(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Workflow_MarkWorkflowCompleted.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The package ID from which the recipient is to be deleted. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_permission_get_workflow_permissions(package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_WorkflowPermission_GetWorkflowPermissions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The document ID for which workflow user needs to be updated. |
required |
order
|
int
|
The order of the user in workflow for which the permissions are requested. By providing the value 0 in order, service would return the permissions of most recently added collaborator in the workflow. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_permission_update_workflow_permissions(input: WorkflowPermissionsUpdateRequest | Mapping[str, Any], package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID:
V4_WorkflowPermission_UpdateWorkflowPermissions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
WorkflowPermissionsUpdateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The package ID for which workflow permissions to be updated. |
required |
order
|
int
|
The order of the recipient for which the workflow permissions to be updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_recall_workflow(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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".
Swagger operation ID: V4_Workflow_RecallWorkflow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The ID of the package to be recalled. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_start_workflow(package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Workflow_StartWorkflow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The document package to be shared. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_update_workflow(input: WorkflowDetailUpdateRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Workflow_UpdateWorkflow.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
WorkflowDetailUpdateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The package ID for which workflow details need to be updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_update_workflow_post_process(input: PostProcessUpdateRequest | Mapping[str, Any], package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Workflow_UpdateWorkflowPostProcess.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PostProcessUpdateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
ID of the document package for which the post processing is being updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_update_workflow_reminder(input: UpdateReminderRequest | Mapping[str, Any], package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_Workflow_UpdateWorkflowReminder.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateReminderRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The package ID for which workflow reminders to be updated. |
required |
order
|
int
|
The order of the user for which the workflow reminders to be updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_workflow_add_group(input: WorkflowWorkflowAddGroupInput, package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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"
Swagger operation ID: V4_Workflow_WorkflowAddGroup.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
WorkflowWorkflowAddGroupInput
|
The request body. |
required |
package_id
|
int
|
ID of the package for which the group is to be added. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_workflow_add_placeholder(input: WorkflowWorkflowAddPlaceholderInput, package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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"
Swagger operation ID: V4_Workflow_WorkflowAddPlaceholder.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
WorkflowWorkflowAddPlaceholderInput
|
The request body. |
required |
package_id
|
int
|
ID of the package for which the placeholder is to be added. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_workflow_add_user(input: WorkflowWorkflowAddUserInput, package_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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"
Swagger operation ID: V4_Workflow_WorkflowAddUser.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
WorkflowWorkflowAddUserInput
|
The request body. |
required |
package_id
|
int
|
SigningHub package ID, which the recipients are to be added to. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_workflow_delete_user(package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Delete Workflow User
Business applications can use this service API to delete workflow recipient.
Swagger operation ID: V4_Workflow_WorkflowDeleteUser.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
package_id
|
int
|
The package ID from which the recipient is to be deleted. |
required |
order
|
int
|
Order of the recipient in the workflow which is to be deleted. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_workflow_update_placeholder(input: WorkflowPlaceholderUpdateRequest | Mapping[str, Any], package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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"
Swagger operation ID: V4_Workflow_WorkflowUpdatePlaceholder.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
WorkflowPlaceholderUpdateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
ID of the package for which the placeholder is to be added. |
required |
order
|
int
|
Order of the recipient in the workflow. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_workflow_user_update(input: WorkflowUserUpdateRequest | Mapping[str, Any], package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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".
Swagger operation ID: V4_Workflow_WorkflowUserUpdate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
WorkflowUserUpdateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
The package ID for which workflow user needs to be updated. |
required |
order
|
int
|
The order of the user in workflow. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
workflow_workflow_user_update_order(input: WorkflowUserReorderRequest | Mapping[str, Any], package_id: int, order: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Workflow Users Order
Business applications can use this service API to update order of the recipient in the workflow.
Swagger operation ID: V4_Workflow_WorkflowUserUpdateOrder.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
WorkflowUserReorderRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
package_id
|
int
|
ID of the package to which the recipients are to be added. |
required |
order
|
int
|
Existing order of the recipient which is to be updated. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
work_space_delete_shared_space(id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_WorkSpace_DeleteSharedSpace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
Id of shared space that you want to delete. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
work_space_get_shared_space(id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_WorkSpace_GetSharedSpace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
Id of shared space that you want to get. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
work_space_update_shared_space(input: UpdateWorkSpaceRequest | Mapping[str, Any], id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.
Swagger operation ID: V4_WorkSpace_UpdateSharedSpace.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateWorkSpaceRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
id
|
int
|
Id of shared space that you want to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |