Skip to main content

Quickstart Guide

Follow this guide to start using the Skribble SDK in your project. We’ll walk through installation, authentication, and creating your first signature request.

Installation

pip install skribble-sdk

Authentication

First, you’ll need to get your API credentials from the Skribble Dashboard.
import skribble

# Initialize with your API credentials
skribble.init(
    username="api_xxxxx",
    api_key="xxxxx"
)

Create Your First Signature Request

Let’s create a simple signature request for a single signer:
# Prepare the signature request
signature_request = {
    "title": "My First Signature Request",
    "message": "Please sign this document",
    # You can use file_url, content (base64), or document_id
    "file_url": "https://example.com/document.pdf",
    "signatures": [
        {
            "account_email": "signer@example.com",
            "signer_identity_data": {
                "first_name": "John",
                "last_name": "Doe",
                "email_address": "signer@example.com"
            }
        }
    ]
}

try:
    # Create the signature request
    response = skribble.signature_request.create(signature_request)
    print(f"Created signature request: {response['id']}")
    
    # Get the status
    status = skribble.signature_request.get(response['id'])
    print(f"Status: {status['status_overall']}")
    
except Exception as e:
    print(f"Error: {str(e)}")

Monitor the Signing Process

You can track the status of your signature request:
def check_status(signature_request_id):
    status = skribble.signature_request.get(signature_request_id)
    
    print(f"Overall status: {status['status_overall']}")
    for signature in status['signatures']:
        print(f"Signer {signature['account_email']}: {signature['status_code']}")

Download the Signed Document

Once all parties have signed, you can download the signed document:
def download_signed_document(signature_request_id):
    # Get the signature request details
    signature_request = skribble.signature_request.get(signature_request_id)
    
    if signature_request['status_overall'] == 'SIGNED':
        # Download the document
        document = skribble.document.download(signature_request['document_id'])
        
        # Save to file
        with open('signed_document.pdf', 'wb') as f:
            f.write(document)

Dive into full examples

Explore examples on Github how to use the SDK in Python and TypeScript

Next Steps

Now that you’ve created your first signature request, you can:
I