Initial and Sign REST API Documentation

API Overview

The Initial and Sign REST API allows you to integrate document signing capabilities into your applications. All endpoints return JSON responses.

Base URL

https://docusign.codecomply.local/cgi-bin/api/v1

Version

v1 - Current stable version

Rate Limiting

API calls are limited to 1000 requests per hour per API key.

Authentication

All API requests require an API key. You can pass it as a query parameter or header.

🔑 Get Your API Key

Generate API keys in your account settings. Keep them secure! Never commit them to version control.

Go to Settings

Query Parameter

GET /cgi-bin/api/v1/documents?api_key=sk_live_1234567890abcdef

Header

curl -H "X-API-Key: sk_live_1234567890abcdef" \
  https://docusign.codecomply.local/cgi-bin/api/v1/documents
            

Documents API

Manage documents and their sending workflow.

GET /documents

List all documents

Parameters

Parameter	Type	Description
`status`	string	Filter by status: draft, sent, completed, declined
`limit`	integer	Results per page (default: 20, max: 100)
`offset`	integer	Pagination offset (default: 0)

Response

{
  "success": true,
  "documents": [
    {
      "id": 42,
      "title": "Purchase Agreement",
      "status": "sent",
      "created_at": "2026-08-03 10:30:00"
    }
  ],
  "count": 1,
  "total_count": 15
}
                

GET /documents/{id}

Get document details with signers

POST /documents

Update document (title, description)

DELETE /documents/{id}

Delete document

Signers API

Manage signers and their signing status.

GET /signers?document_id=42

List signers for a document

GET /signers/{id}

Get signer details

POST /signers

Add signer to document

Request Body

{
  "document_id": 42,
  "email": "john@example.com",
  "name": "John Doe",
  "signing_order": 1
}
                

Templates API

Create and manage reusable document templates.

GET /templates

List templates

GET /templates/{id}

Get template details

POST /templates

Create new template

DELETE /templates/{id}

Delete template

Webhooks API

Subscribe to document events and receive real-time notifications.

GET /webhooks

List registered webhooks

POST /webhooks

Register webhook

Request Body

{
  "url": "https://example.com/webhooks",
  "events": [
    "document.sent",
    "document.signed",
    "document.completed"
  ]
}
                

PUT /webhooks/{id}

Update webhook

DELETE /webhooks/{id}

Delete webhook

Error Handling

All errors return appropriate HTTP status codes with JSON error messages.

Error Response Format

{
  "success": false,
  "error": "Invalid API key"
}
            

Common Errors

Error	HTTP Status	Cause
Invalid API key	401	API key missing or invalid
Not found	404	Resource doesn't exist
Method not allowed	405	Wrong HTTP method
Server error	500	Internal server error

Code Examples

cURL - List Documents

curl -X GET https://docusign.codecomply.local/cgi-bin/api/v1/documents \
  -H "X-API-Key: sk_live_your_api_key"
            

JavaScript - Create Webhook

const response = await fetch(
  'https://docusign.codecomply.local/cgi-bin/api/v1/webhooks',
  {
    method: 'POST',
    headers: {
      'X-API-Key': 'sk_live_your_api_key',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      url: 'https://example.com/webhooks',
      events: ['document.completed']
    })
  }
);
            

Python - Get Signer Status

import requests

response = requests.get(
    'https://docusign.codecomply.local/cgi-bin/api/v1/signers/123',
    headers={'X-API-Key': 'sk_live_your_api_key'}
)
data = response.json()
            

Need help? Check the community forums or email support@cloudsign.local

Last updated: August 3, 2026