Cognify Works E-Sign API Docs

RESTful API for creating envelopes, managing signers, and receiving webhook notifications.

Base URL: https://esign.cognifyworks.ai/api/v1

Overview#

The Cognify Works E-Sign API lets you create envelopes, manage recipients, send signing requests, and subscribe to event updates with webhooks. It is designed for teams that want a simple API surface with room to scale as signature workflows grow.

Compatibility note: existing cyst_live_* API keys and /api/v1 routes remain unchanged after the product rename.

Overview

Learn the core request flow and where the API fits into your product.

Auth

Use API keys from your dashboard to authenticate every request.

Webhooks

Listen for sends, completions, and other envelope events in real time.

Authentication#

All API requests require authentication using an API key. API keys are available on Pro and Enterprise plans.

Include your API key in the Authorization header:

Authorization: Bearer cyst_live_...

You can create and manage API keys in your dashboard under Settings → API Keys.

Envelopes#

Envelopes are the core resource in Cognify Works E-Sign. You create them with a document and recipient list, then track status through your dashboard or API.

Create an Envelope#

Create a new envelope with a PDF document and signers.

POST /api/v1/envelopes
Content-Type: application/json
Authorization: Bearer cyst_live_...

{
  "subject": "Contract Agreement",
  "signers": [
    {
      "name": "John Doe",
      "email": "[email protected]",
      "signingOrder": 1
    },
    {
      "name": "Jane Smith",
      "email": "[email protected]",
      "signingOrder": 2
    }
  ],
  "documentBase64": "JVBERi0xLjQKJeLjz9MKMy..."
}

Response#

{
  "id": "env_abc123",
  "subject": "Contract Agreement",
  "status": "DRAFT",
  "signers": [
    {
      "id": "sig_xyz789",
      "name": "John Doe",
      "email": "[email protected]",
      "status": "PENDING",
      "signingOrder": 1
    },
    {
      "id": "sig_def456",
      "name": "Jane Smith",
      "email": "[email protected]",
      "status": "PENDING",
      "signingOrder": 2
    }
  ],
  "createdAt": "2025-12-06T18:00:00Z"
}

List Envelopes#

Retrieve a list of envelopes for your organization.

GET /api/v1/envelopes
Authorization: Bearer cyst_live_...

Response#

{
  "envelopes": [
    {
      "id": "env_abc123",
      "subject": "Contract Agreement",
      "status": "COMPLETED",
      "signers": [...],
      "createdAt": "2025-12-06T18:00:00Z",
      "completedAt": "2025-12-07T10:30:00Z"
    },
    ...
  ],
  "total": 42
}

Webhooks#

Webhooks allow you to receive real-time notifications when envelope events occur. Configure webhook endpoints in your dashboard under Settings → Webhooks.

Events#

envelope.completed - Fired when all signers have completed signing
envelope.sent - Fired when the envelope is sent to signers
envelope.voided - Fired when the envelope is voided

Sample Payload#

{
  "event": "envelope.completed",
  "envelopeId": "env_abc123",
  "subject": "Contract Agreement",
  "status": "COMPLETED",
  "completedAt": "2025-12-07T10:30:00Z",
  "signers": [
    {
      "id": "sig_xyz789",
      "name": "John Doe",
      "email": "[email protected]",
      "status": "SIGNED",
      "signedAt": "2025-12-07T09:15:00Z"
    },
    {
      "id": "sig_def456",
      "name": "Jane Smith",
      "email": "[email protected]",
      "status": "SIGNED",
      "signedAt": "2025-12-07T10:30:00Z"
    }
  ],
  "completedPdfUrl": "https://..."
}

Retry Behavior#

If your webhook endpoint returns a non-2xx status code or times out, we retry delivery with exponential backoff:

Initial retry: 1 minute
Second retry: 5 minutes
Third retry: 30 minutes
Final retry: 24 hours

You can view webhook delivery attempts and status in your dashboard under Settings → Webhooks.

Next Steps

This is a high-level overview of the Cognify Works E-Sign API. For more detailed documentation, including all available endpoints, request and response schemas, and error codes, visit your dashboard.

Go to Dashboard Get API Access

Overview#

Compatibility note: existing cyst_live_* API keys and /api/v1 routes remain unchanged after the product rename.

Overview

Learn the core request flow and where the API fits into your product.

Auth

Use API keys from your dashboard to authenticate every request.

Webhooks

Listen for sends, completions, and other envelope events in real time.

POST /api/v1/envelopes Content-Type: application/json Authorization: Bearer cyst_live_... { "subject": "Contract Agreement", "signers": [ { "name": "John Doe", "email": "[email protected]", "signingOrder": 1 }, { "name": "Jane Smith", "email": "[email protected]", "signingOrder": 2 } ], "documentBase64": "JVBERi0xLjQKJeLjz9MKMy..." }

{ "id": "env_abc123", "subject": "Contract Agreement", "status": "DRAFT", "signers": [ { "id": "sig_xyz789", "name": "John Doe", "email": "[email protected]", "status": "PENDING", "signingOrder": 1 }, { "id": "sig_def456", "name": "Jane Smith", "email": "[email protected]", "status": "PENDING", "signingOrder": 2 } ], "createdAt": "2025-12-06T18:00:00Z" }

{ "envelopes": [ { "id": "env_abc123", "subject": "Contract Agreement", "status": "COMPLETED", "signers": [...], "createdAt": "2025-12-06T18:00:00Z", "completedAt": "2025-12-07T10:30:00Z" }, ... ], "total": 42 }

{ "event": "envelope.completed", "envelopeId": "env_abc123", "subject": "Contract Agreement", "status": "COMPLETED", "completedAt": "2025-12-07T10:30:00Z", "signers": [ { "id": "sig_xyz789", "name": "John Doe", "email": "[email protected]", "status": "SIGNED", "signedAt": "2025-12-07T09:15:00Z" }, { "id": "sig_def456", "name": "Jane Smith", "email": "[email protected]", "status": "SIGNED", "signedAt": "2025-12-07T10:30:00Z" } ], "completedPdfUrl": "https://..." }