Sign API Overview

The Sign API enables you to create, send, and manage electronic signature workflows programmatically. It provides a DocuSign-compatible REST API, making migration straightforward while offering modern, developer-friendly features.

Key Features

• Document Management - Upload PDFs and manage documents for signing
• Flexible Signing - Email delivery or embedded signing within your app
• Multiple Signers - Sequential and parallel signing workflows
• Templates - Reusable document structures with predefined fields
• Audit Trails - Complete signing history for compliance
• Webhooks - Real-time notifications on document events
• DocuSign Compatible - Drop-in replacement for existing integrations

Architecture

Core Concepts

Envelope

An envelope is the container for a signing transaction. It holds documents, recipients, and tracks the signing workflow status.

Status	Description
created	Draft - not yet sent
sent	Sent to recipients
delivered	Viewed by recipient
completed	All recipients signed
declined	Recipient declined
voided	Cancelled by sender

Recipients

Recipients are the people involved in the signing process:

Type	Description
signer	Must sign the document
cc	Receives a copy when complete
viewer	Can view but not sign

Tabs (Fields)

Tabs are the interactive fields placed on documents:

Tab Type	Description
signHere	Signature field
initialHere	Initials field
dateSigned	Auto-filled date
text	Free-form text input
checkbox	Checkbox field

Views

Views are URLs for embedded experiences:

View	Description
recipient	Signing URL for embedded signing
sender	Editing URL for sender corrections
console	Management dashboard URL

Terminology Mapping

If you're coming from DocuSign, here's how concepts map:

DocuSign Term	Propper Term	Notes
Envelope	Envelope	Same concept
Document	Document	Same concept
Recipient	Recipient	Same concept
Tab	Tab	Same concept
PowerForm	Template	Similar functionality
Connect	Webhook	Same concept
Account ID	Organization ID	UUID format

Integration Paths

Choose the integration approach that fits your use case:

Path 1: Embedded Signing (Recommended)

Best for: Customer portals, internal tools, mobile apps

Your App → Create Envelope → Get Signing URL → Embed in iframe → Handle completion

Embedded Signing Guide →

Path 2: Email Signing

Best for: B2B contracts, external parties, async workflows

Your App → Create Envelope → Send Email → Signer clicks link → Webhook notifies completion

Signing Flow Guide →

Path 3: Template-Based

Best for: Standardized documents, high volume, consistent workflows

Create Template (once) → Create from Template → Send → Track

Templates Guide →

Quick Example

Create and send a document for signature:

# 1. Get access token
TOKEN=$(curl -s -X POST "https://auth.propper.ai/oauth/token" \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "scope": "sign:read sign:write"
  }' | jq -r '.access_token')

# 2. Create and send envelope
curl -X POST "https://api.propper.ai/restapi/v2.1/accounts/{accountId}/envelopes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "emailSubject": "Please sign: Service Agreement",
    "status": "sent",
    "documents": [{
      "documentId": "1",
      "name": "Agreement.pdf",
      "documentBase64": "JVBERi0xLjQK..."
    }],
    "recipients": {
      "signers": [{
        "email": "client@example.com",
        "name": "John Smith",
        "recipientId": "1",
        "routingOrder": "1"
      }]
    }
  }'

API Base URL

Environment	Base URL
Production	https://api.propper.ai/restapi/v2.1

Authentication

The Sign API uses OAuth 2.0 with client credentials:

POST https://auth.propper.ai/oauth/token
Content-Type: application/json

{
  "grant_type": "client_credentials",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "scope": "sign:read sign:write"
}

Authentication Guide →

Rate Limits

Tier	Requests/Second	Requests/Day
Free	10	1,000
Pro	50	50,000
Enterprise	Custom	Custom

Rate Limits →

Next Steps

🚀 Quickstart

Get your first document signed in 5 minutes.

Get Started

📖 API Reference

Complete endpoint documentation with examples.

View Reference

🔄 Migrating from DocuSign?

Step-by-step guide to migrate your existing integration.

Migration Guide

💻 Code Examples

Complete, runnable examples for common workflows.

View Examples