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-3.1.1.tar.gz (152.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

boldsign-3.1.1-py3-none-any.whl (435.2 kB view details)

Uploaded Python 3

File details

Details for the file boldsign-3.1.1.tar.gz.

File metadata

  • Download URL: boldsign-3.1.1.tar.gz
  • Upload date:
  • Size: 152.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for boldsign-3.1.1.tar.gz
Algorithm Hash digest
SHA256 d0eb235a7c73b3741c0eb034f5d084dcdedcd4ea3f00fcf0527c2214fe6502c5
MD5 3aaea0a5074684754197dd11fef3c995
BLAKE2b-256 cbc6c4516672b35403276b22de1dba13f0951fcb181e33c1cb3a31ef52fe4e87

See more details on using hashes here.

File details

Details for the file boldsign-3.1.1-py3-none-any.whl.

File metadata

  • Download URL: boldsign-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 435.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for boldsign-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 81a7b25fe19230fd740790c664844860e7daa67059c80b2455be9ab8861f45f0
MD5 a3f5df227ee63122e08a56632c769ba0
BLAKE2b-256 4105963155f9c59028695090984b2f33c3010afe66b87d607078ae45876ce2b5

See more details on using hashes here.

Supported by

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