Skip to main content

BoldSign API

Project description

BoldSign

Easily integrate BoldSign's e-signature features into your Python applications. This package simplifies sending documents for signature, embedding signing ceremonies, tracking document status, downloading signed documents, and managing e-signature workflows.

Prerequisites

Documentation

Installation & Usage

You can install this package by using the pip tool:

pip install boldsign

(You may need to run pip with root permission: sudo pip install boldsign)

Then import the package:

import boldsign

Dependencies

This package requires the following dependencies to function properly. They will be installed automatically when you install the package:

  • urllib3>=1.25.3
  • python-dateutil
  • pydantic>=2
  • typing-extensions>=4.7.1

Getting Started

Please follow the installation procedure and then run the following:

import boldsign

configuration = boldsign.Configuration(
    api_key = "***your_api_key***"
)

# Enter a context with an instance of the API client
with boldsign.ApiClient(configuration) as api_client:
    # Create an instance of the DocumentApi class
    document_api = boldsign.DocumentApi(api_client)

    # Define the signature field to be added to the document
    signatureField = boldsign.FormField(
        fieldType="Signature",  # Field type is Signature
        pageNumber=1,  # Specify the page number
        bounds=boldsign.Rectangle(x=100, y=100, width=100, height=50),  # Position and size of the signature field
    )

    # Define the signer with a name and email address
    signer = boldsign.DocumentSigner(
        name="David",  # Name of the signer
        emailAddress="david@example.com",  # Signer's email address
        signerType="Signer",  # Specify the signer type
        formFields=[signatureField]  # Assign the signature field to the signer
    )

    # Prepare the request body for sending the document for signature
    send_for_sign = boldsign.SendForSign(
        title="Agreement",  # Title of the document
        signers=[signer],  # List of signers
        files=["/documents/agreement.pdf"]  # Path to the document file to be signed
    )
    
    # Send the document for signature and capture the response
    api_response = document_api.send_document(send_for_sign=send_for_sign)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

boldsign-1.0.0b4.tar.gz (115.3 kB view details)

Uploaded Source

Built Distribution

boldsign-1.0.0b4-py3-none-any.whl (314.7 kB view details)

Uploaded Python 3

File details

Details for the file boldsign-1.0.0b4.tar.gz.

File metadata

  • Download URL: boldsign-1.0.0b4.tar.gz
  • Upload date:
  • Size: 115.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for boldsign-1.0.0b4.tar.gz
Algorithm Hash digest
SHA256 c09f4db25756b59c17d7561a5204462377aa4261bebc86bce47f64985643feb5
MD5 10f68c6658aaec2246414179cd47ea84
BLAKE2b-256 827489483e3a0971b73607dc225f6ce1082ec0343f6bf13dff6e451e8e18947b

See more details on using hashes here.

File details

Details for the file boldsign-1.0.0b4-py3-none-any.whl.

File metadata

  • Download URL: boldsign-1.0.0b4-py3-none-any.whl
  • Upload date:
  • Size: 314.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for boldsign-1.0.0b4-py3-none-any.whl
Algorithm Hash digest
SHA256 a95cbe0f52e3720453f745e83690bae7cdd1429b83166c3c99b8e98fbcdf2f87
MD5 e5b2384dc155d638be75ee41d43f724c
BLAKE2b-256 527e9c89b25b07f61fe328127fdd3f8bde8ded67ee1bcd7691a1e049174f177a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page