API

All API requests must contain your personal API Key parameter (api_key).

Authentication

To authenticate your requests, include your API key as a query parameter or in the request header.

GET /api/v1/documents?api_key=YOUR_API_KEY

// Or using header
Authorization: Bearer YOUR_API_KEY

Endpoints

Create Document

Create a new document for signing.

POST /api/v1/documents

{
  "title": "Contract Agreement",
  "signatories": [
    {
      "email": "signer@example.com",
      "name": "John Doe"
    }
  ],
  "file": "base64_encoded_file_content"
}

Get Document Status

Retrieve the current status of a document.

GET /api/v1/documents/{document_id}

Response:
{
  "id": "doc_123",
  "title": "Contract Agreement",
  "status": "pending",
  "signatories": [
    {
      "email": "signer@example.com",
      "name": "John Doe",
      "signed": false
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

List Documents

Get a list of all documents in your account.

GET /api/v1/documents

Query Parameters:
- page: Page number (default: 1)
- limit: Items per page (default: 20)
- status: Filter by status (pending, signed, expired)

Send Reminder

Send a reminder to signatories who haven't signed yet.

POST /api/v1/documents/{document_id}/remind

{
  "message": "Please sign the document at your earliest convenience."
}

Download Signed Document

Download the fully signed document.

GET /api/v1/documents/{document_id}/download

Response: Binary file content (PDF)

Webhooks

Set up webhooks to receive real-time notifications when documents are signed.

POST /api/v1/webhooks

{
  "url": "https://your-server.com/webhook",
  "events": ["document.signed", "document.viewed", "document.expired"]
}

Error Codes

Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid API key
403	Forbidden - Insufficient permissions
404	Not Found - Resource doesn't exist
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Rate Limits

API requests are limited based on your subscription plan:

Subscription: 100,000 requests per day
Enterprise: Unlimited requests

SDKs

We provide official SDKs for popular programming languages:

JavaScript/Node.js
Python
PHP
Ruby
Java
C#/.NET