Installation

The package is available at PyPI and it can be installed via pip by executing following command:

pip install groupdocs-signature-cloud

Requirements

• Python 2.7 or 3.4+
• pip package manager
• GroupDocs Cloud credentials — Client ID and Client Secret from the Dashboard

Dependencies

The SDK automatically installs the following packages:

Python Cloud REST API for eSigning Documents

GroupDocs.Signature Cloud SDK for Python provides a comprehensive solution for integrating e-signatures into Python web apps, scripts, and automation workflows. It supports a wide range of signature types — text, image, barcode, QR-code, digital, and stamp — across Word, Excel, PDF, presentation, and image formats. Developers can customize signature appearance, placement, and security, apply digital certificates, verify signature authenticity, and search for existing signatures within documents. Whether signing a single page or managing multiple signatures across a document collection, GroupDocs.Signature delivers robust tools for secure and efficient cloud-based document signing.

Cloud Document Signing Features

Apply Signatures to Specific Pages - Apply signatures on even, odd, or specific pages for precise placement.
Configure Page Padding - Set page padding to align signatures precisely on each page.
Customize Signature Appearance - Control fonts, colors, and style of signatures.
Apply Background Crop Settings - Use background crop settings to improve signature visibility.
Repeat Signature String - Repeat signature strings to fill defined areas.
Digital Signatures with CryptoApi & XmlDsig - Support digital signatures via CryptoApi and XmlDsig.
Align Text for Barcode Signatures - Align barcode signatures using configurable text.
Sign Password-Protected Documents - Sign password-protected documents.
Verify Document Signatures - Verify authenticity and validity of document signatures.
Search for Signature Types - Search for specific signature types within documents.

Advanced Features

Customize Signature Appearance - Customize signature fonts, colors, and style.
Manage Multiple Signatures - Handle multiple signatures in one document.
Password Protection for Documents - Add password protection to signed documents.
Verify Signature Authenticity - Validate authenticity of applied signatures.
Search for Specific Signatures - Search for text, barcode, QR-code, and digital signatures.
Update and Delete Signatures - Modify or remove existing signatures from documents.

Barcode and QR-Code Signatures

Supported Formats for Barcode/QR Signatures - Supports DOC, DOCX, XLSX, PDF, and image formats.
Customize Barcode/QR-Code Signatures - Customize appearance and content of barcode/QR signatures.
Barcode/QR-Code Usage Scenarios - Use cases include document tracking and identification.

Stamp Signatures

Overview of Stamp Signatures - Visual and text stamp signatures for official documents.
Customize Stamp Signatures - Adjust stamp size, text, and appearance.

Supported Signature Types

Text Signature - Add customizable text labels with font, color, and alignment.
Image Signature - Apply image signatures with opacity, grayscale, brightness, and contrast.
Barcode Signature - Add barcode types with flexible appearance, alignment, and encoding.
QR-Code Signature - Insert QR-Code signatures with customizable encoding and appearance.
Digital Signature - Apply digital certificates (PFX, CRT) to documents or PDF pages.
Stamp Signature - Place stamp images on pages with flexible customization.

File Operations

Upload Files to Cloud - Upload files to cloud storage via the API.
Download Files from Cloud - Download files from cloud storage to local systems.
Copy Files - Copy files within the cloud storage to different locations.
Move Files - Move files between folders in cloud storage.
Delete Files - Delete specific files from cloud storage.

Folder Operations

Create Folder - Create new folders in the cloud storage.
Copy Folder - Duplicate folders within the cloud storage.
Move Folder - Move folders between directories in cloud storage.
Delete Folder - Remove entire folders from cloud storage.

Licensing and Authentication

Evaluation Mode - Try the API with a free trial account.
Secure Authentication - Use Client ID and Client Secret for secure API access.
MIT License - The Python SDK is licensed under the MIT License.

Supported Document Formats

GroupDocs.Signature Cloud supports signing across the following format categories:

• Word Processing: DOC, DOCX, DOCM, DOT, DOTX, DOTM, ODT, OTT, RTF, TXT
• Spreadsheets: XLS, XLSX, XLSB, XLSM, CSV, ODS, OTS, TSV
• Presentations: PPT, PPTX, PPTM, PPS, PPSX, PPSM, ODP, OTP, POTX, POTM
• PDF: PDF
• Images: BMP, GIF, JPEG, PNG, TIFF, SVG, PSD, WEBP, ICO, EMF, WMF, and more

Supported signature types vary by format. For the complete format matrix, see the documentation.

Quick Start

Get your API credentials

To use GroupDocs.Signature Cloud, sign up at GroupDocs.Cloud Dashboard and get your Client ID and Client Secret.

Initialize the API

Use the following code to start using the GroupDocs.Signature Cloud SDK for Python:

import groupdocs_signature_cloud

# Get your ClientId and ClientSecret at https://dashboard.groupdocs.cloud
client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create API configuration
configuration = groupdocs_signature_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"

# Create instance of the Sign API
sign_api = groupdocs_signature_cloud.SignApi.from_config(configuration)

Sign a document with a text signature

Once initialized, use this basic example to add a text signature to a Word document:

import groupdocs_signature_cloud

client_id = "YourClientId"
client_secret = "YourClientSecret"

sign_api = groupdocs_signature_cloud.SignApi.from_keys(client_id, client_secret)

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/one-page.docx"

opts = groupdocs_signature_cloud.SignTextOptions()
opts.signature_type = "Text"
opts.text = "GroupDocs.Signature Cloud"
opts.left = 100
opts.top = 100
opts.width = 100
opts.height = 100
opts.page = 1

settings = groupdocs_signature_cloud.SignSettings()
settings.options = [opts]
settings.file_info = file_info
settings.save_options = groupdocs_signature_cloud.SaveOptions()
settings.save_options.output_file_path = "signaturedocs/signedTextOne_page.docx"

request = groupdocs_signature_cloud.CreateSignaturesRequest(settings)
response = sign_api.create_signatures(request)

print("Succeeded count: " + str(len(response.succeeded)))

With this quick start guide, you’re all set to begin signing documents using GroupDocs.Signature Cloud in your Python applications. For more details, visit the documentation.

Get Supported File Formats

Retrieve the full list of supported file formats available through the Signature API.

import groupdocs_signature_cloud

info_api = groupdocs_signature_cloud.InfoApi.from_keys("YourClientId", "YourClientSecret")

result = info_api.get_supported_file_formats()

for fmt in result.formats:
    print(fmt.file_format)

Sign Document with Digital Signature

Apply a digital certificate to a document for secure, tamper-evident signing.

import groupdocs_signature_cloud

sign_api = groupdocs_signature_cloud.SignApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/one-page.docx"

opts = groupdocs_signature_cloud.SignDigitalOptions()
opts.signature_type = "Digital"
opts.image_file_path = "signaturedocs/signature.jpg"
opts.certificate_file_path = "signaturedocs/temp.pfx"
opts.password = "1234567890"
opts.left = 100
opts.top = 100
opts.width = 200
opts.height = 100
opts.page = 1

settings = groupdocs_signature_cloud.SignSettings()
settings.options = [opts]
settings.file_info = file_info
settings.save_options = groupdocs_signature_cloud.SaveOptions()
settings.save_options.output_file_path = "signaturedocs/signedDigitalOne_page.docx"

request = groupdocs_signature_cloud.CreateSignaturesRequest(settings)
response = sign_api.create_signatures(request)

print("Succeeded count: " + str(len(response.succeeded)))

Search for Barcode Signatures

Search a signed document for barcode signatures and retrieve matching signature details.

import groupdocs_signature_cloud

sign_api = groupdocs_signature_cloud.SignApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/signedBarcodeOne_page.docx"

opts = groupdocs_signature_cloud.SearchBarcodeOptions()
opts.signature_type = "Barcode"
opts.page = 1

settings = groupdocs_signature_cloud.SearchSettings()
settings.options = [opts]
settings.file_info = file_info

request = groupdocs_signature_cloud.SearchSignaturesRequest(settings)
response = sign_api.search_signatures(request)

print("Signatures found: " + str(len(response.signatures)))

Verify Text Signature

Verify that a text signature with the expected content exists in a signed document.

import groupdocs_signature_cloud

sign_api = groupdocs_signature_cloud.SignApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/signedTextOne_page.docx"

opts = groupdocs_signature_cloud.VerifyTextOptions()
opts.signature_type = "Text"
opts.text = "GroupDocs.Signature Cloud"
opts.match_type = "Contains"
opts.page = 1

settings = groupdocs_signature_cloud.VerifySettings()
settings.options = [opts]
settings.file_info = file_info

request = groupdocs_signature_cloud.VerifySignaturesRequest(settings)
response = sign_api.verify_signatures(request)

print("IsSuccess: " + str(response.is_success))

Sign Document with Barcode Signature

Add a barcode signature to a document with customizable appearance and encoding.

import groupdocs_signature_cloud

sign_api = groupdocs_signature_cloud.SignApi.from_keys("YourClientId", "YourClientSecret")

file_info = groupdocs_signature_cloud.FileInfo()
file_info.file_path = "signaturedocs/one-page.docx"

opts = groupdocs_signature_cloud.SignBarcodeOptions()
opts.signature_type = "Barcode"
opts.text = "123456789012"
opts.barcode_type = "Code128"
opts.left = 100
opts.top = 100
opts.width = 300
opts.height = 100
opts.page = 1

settings = groupdocs_signature_cloud.SignSettings()
settings.options = [opts]
settings.file_info = file_info
settings.save_options = groupdocs_signature_cloud.SaveOptions()
settings.save_options.output_file_path = "signaturedocs/signedBarcodeOne_page.docx"

request = groupdocs_signature_cloud.CreateSignaturesRequest(settings)
response = sign_api.create_signatures(request)

print("Succeeded count: " + str(len(response.succeeded)))

Sample Projects on GitHub

The GroupDocs.Signature Cloud Python Samples repository includes ready-to-run examples covering:

How to run the examples

1. Clone or download the samples repository
2. Edit RunExamples.py and set your client_id and client_secret
3. Go to the Examples directory
4. Run pip install groupdocs-signature-cloud -U
5. Execute python RunExamples.py

For more details, visit Getting Started.

Tags

eSignature API | Python Cloud API | GroupDocs.Signature Cloud | REST API | Digital Signature | Text Signature | Barcode Signature | QR-Code Signature | Document Signing | Signature Verification | Signature Search | Cloud Storage Integration | File Operations | Folder Operations | Secure API Access | PDF Signing | Word Document Signing | Image Signature | Stamp Signature | Cross-platform API | Document Security | Electronic Signature