eSignature Cloud API

Browse our Products

Are you looking for an evaluation version of a product?

If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.

Are you having troubles in downloading?

If you experience errors, when you try to download a file, make sure your network policies (enforced by your company or ISP) allow downloading ZIP and/or MSI files.

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:

Package	Constraint
urllib3	>= 1.15
six	>= 1.10
certifi	—
python-dateutil	—

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:

Category	Examples
Basic Usage	Supported formats, supported barcodes, supported QR codes, document info, document preview, file and folder operations
Advanced Usage — Sign	Text, image, barcode, QR-code, digital, stamp, and collection signatures
Advanced Usage — Search	Search text, barcode, QR-code, and digital signatures
Advanced Usage — Verify	Verify text, barcode, QR-code, and digital signatures
Advanced Usage — Update	Update barcode and QR-code signatures
Advanced Usage — Delete	Delete barcode and QR-code signatures

How to run the examples

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

For more details, visit Getting Started.