API Documentation

Complete reference for the AuthenlySign REST API. Integrate document signing into your applications.

Authentication

Signing Flow

Endpoints

Webhooks

SDKs

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.authenlysign.com/v1/documents

Keep your API key secure

Never expose your API key in client-side code. Use environment variables and server-side requests.

Generate API keys in your Dashboard Settings. API access requires Medium Team plan or higher.

Base URL

Production

https://api.authenlysign.com/v1

Sandbox (Testing)

https://sandbox-api.authenlysign.com/v1

Rate Limits

Standard

1,000

requests/hour

Large Team

5,000

requests/hour

Enterprise

Unlimited

custom limits available

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Document Signing Flow

The complete end-to-end document signing workflow consists of these steps:

Upload Document

Upload a PDF document using POST /api/documents/upload. The document is created in "draft" status.

curl -X POST /api/documents/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@contract.pdf" \
  -F "title=Service Agreement"

Send for Signing

Send the document to signers using POST /api/documents/:id/send-for-signing. Email invitations are sent automatically.

curl -X POST /api/documents/doc_abc123/send-for-signing \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"signers": [{"email": "signer@example.com", "name": "John Doe"}], "expirationDays": 30}'

Monitor Status

Poll GET /api/documents/:id/status or configure webhooks to track signing progress in real-time.

// Response includes completion percentage and signer details
{
  "signedCount": 1,
  "totalSigners": 2,
  "completionPercentage": 50,
  "status": "in-progress",
  "signers": [
    {"email": "signer1@example.com", "status": "signed", "signed_at": "2026-06-02T11:00:00Z"},
    {"email": "signer2@example.com", "status": "pending-signature", "signed_at": null}
  ]
}

Receive Completion Webhook

When all signers complete, you receive a document.completed webhook event.

{
  "id": "evt_abc123",
  "type": "document.completed",
  "created": 1717329600,
  "data": {
    "object": {
      "documentId": "doc_abc123",
      "document": {"id": "doc_abc123", "title": "Service Agreement", "status": "completed"}
    }
  }
}

Download Signed Document

Retrieve the signed PDF using GET /api/documents/:id/download.

curl /api/documents/doc_abc123/download \
  -H "Authorization: Bearer YOUR_API_KEY"

// Response
{"success": true, "downloadUrl": "https://storage.authenlysign.app/signed/...", "filename": "Service Agreement.pdf"}

Verify Signatures (Optional)

Cryptographically verify all signatures using GET /api/documents/:id/verify.

// Response
{
  "documentId": "doc_abc123",
  "isValid": true,
  "signatures": [
    {"signerEmail": "signer@example.com", "signedAt": "2026-06-02T11:05:00Z", "isValid": true}
  ],
  "verifiedAt": "2026-06-03T10:00:00Z"
}

Document Status Lifecycle

draft

Document uploaded, not yet sent to signers

in-progress

Sent to signers, awaiting signatures

completed

All signers have signed successfully

expired

Expiration date passed before completion

API Endpoints

Documents

POST/api/documents/uploadAuth Required

Upload a new document for signing. Accepts PDF files up to 50MB.

{
  "file": "File (PDF only, max 50MB)",
  "title": "string (optional, defaults to filename)",
  "description": "string (optional)"
}

GET/api/documents/paginatedAuth Required

List documents with pagination, filtering, and sorting

page- number (default: 1)

pageSize- number (default: 20, max: 100)

status- string (draft | in-progress | completed | archived)

search- string (filter by title)

sortBy- string (created_at | updated_at | title | status)

sortOrder- string (asc | desc, default: desc)

cursor- string (for cursor-based pagination)

GET/api/documents/:id/statusAuth Required

Get document status with signer progress and expiration info

id- Document ID (required)

POST/api/documents/:id/send-for-signingAuth Required

Send document to signers for signature collection

id- Document ID (required)

POST/api/documents/:id/sign

Submit a signature for a document (called by signer)

id- Document ID (required)

PATCH/api/documents/:idAuth Required

Update document metadata (draft documents only)

id- Document ID (required)

DELETE/api/documents/:idAuth Required

Delete a draft document (completed documents cannot be deleted)

id- Document ID (required)

GET/api/documents/:id/downloadAuth Required

Get download URL for the document PDF

id- Document ID (required)

GET/api/documents/:id/verifyAuth Required

Verify cryptographic signatures on a completed document

id- Document ID (required)

POST/api/documents/:id/remindAuth Required

Send reminder emails to pending signers

id- Document ID (required)

POST/api/documents/paginatedAuth Required

Batch operations on multiple documents

{
  "action": "'archive' | 'delete' | 'restore' (required)",
  "documentIds": "string[] (required, max 100)"
}

Signing Flow

POST/api/signing/in-personAuth Required

Initialize an in-person (kiosk) signing session

{
  "documentId": "string (required)",
  "signerEmail": "string (required)",
  "signerName": "string (optional)"
}

POST/api/signing/in-person/capture

Capture signature in kiosk/in-person mode

{
  "sessionId": "string (required)",
  "signatureData": "string (base64-encoded signature)"
}

POST/api/signing/in-person/verify

Verify signer identity for in-person signing

{
  "sessionId": "string (required)",
  "verificationCode": "string (optional, if access code required)"
}

API Keys

GET/api/settings/api-keysAuth Required

List all API keys for the authenticated user

{
  "apiKeys": [
    {
      "id": "key_001",
      "name": "Production Key",
      "created_at": "2026-06-01T10:00:00Z",
      "last_used_at": "2026-06-02T15:30:00Z",
      "expires_at": null
    }
  ]
}

POST/api/settings/api-keysAuth Required

Create a new API key (Medium Team plan or higher)

{
  "name": "string (required)",
  "expiresInDays": "number (optional, null for no expiration)"
}

DELETE/api/settings/api-keys?id=:keyIdAuth Required

Delete an API key

id- API Key ID (required)

POST/api/settings/api-keys/:keyId/rotateAuth Required

Rotate an API key (generates new key, invalidates old)

keyId- API Key ID (required)

Webhooks

GET/api/integrations/webhooks/:integrationIdAuth Required

Get webhook configuration for an integration

integrationId- Integration ID (required)

POST/api/integrations/webhooks/:integrationIdAuth Required

Configure webhook endpoint for an integration

integrationId- Integration ID (required)

Health & Status

GET/api/health

Basic health check endpoint

{
  "status": "healthy",
  "timestamp": "2026-06-02T10:00:00Z"
}

GET/api/health/signing

Check signing service health (PKI, certificates)

{
  "status": "healthy",
  "pki": "operational",
  "certificates": "valid"
}

GET/api/health/database

Check database connectivity

{
  "status": "healthy",
  "latency_ms": 12
}

Webhooks

Webhooks allow you to receive real-time notifications when events occur in AuthenlySign. Configure webhook endpoints in your dashboard or via the API.

Webhook Payload Structure

{
  "id": "evt_abc123",
  "event": "document.completed",
  "created_at": "2025-12-02T10:00:00Z",
  "data": {
    "document_id": "doc_xyz789",
    "title": "Service Agreement",
    "status": "completed",
    "completed_at": "2025-12-02T10:00:00Z",
    "signers": [
      { "email": "client@example.com", "signed_at": "2025-12-02T10:00:00Z" }
    ]
  }
}

Available Events

document.sentDocument was sent for signing to recipients

document.viewedA signer viewed the document

document.signedA signer completed their signature

document.completedAll signers have signed, document is complete

document.voidedDocument was voided/cancelled by owner

document.expiredDocument expired before all signatures were collected

recipient.startedA recipient started the signing process

recipient.completedA recipient completed all their required actions

recipient.declinedA recipient declined to sign the document

package.sentA multi-document package was sent for signing

package.completedAll documents in a package are fully signed

package.expiredA signing package expired before completion

package.cancelledA signing package was cancelled

field.completedA form field was completed by a signer

Webhook Security

Verify webhook signatures to ensure requests are from AuthenlySign:

const crypto = require('crypto');

function verifyWebhookSignature(payload, signature, secret) {
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
  
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(`sha256=${expectedSignature}`)
  );
}

SDKs & Libraries

Install: npm install @authenlysign/sdk

import AuthenlySign from '@authenlysign/sdk';

const client = new AuthenlySign({
  apiKey: process.env.AUTHENLYSIGN_API_KEY
});

// Upload a document
const formData = new FormData();
formData.append('file', pdfFile);
formData.append('title', 'Service Agreement');

const { document } = await client.documents.upload(formData);

// Send for signing
await client.documents.sendForSigning(document.id, {
  signers: [
    { email: 'client@company.com', name: 'Client Name' }
  ],
  emailSubject: 'Please sign this agreement',
  expirationDays: 30
});

// Check document status
const status = await client.documents.getStatus(document.id);
console.log('Completion:', status.completionPercentage + '%');

// Download signed document when complete
if (status.status === 'completed') {
  const { downloadUrl } = await client.documents.download(document.id);
  console.log('Download:', downloadUrl);
}

Error Codes

The API returns standard HTTP status codes and JSON error objects:

{
  "error": {
    "code": "validation_error",
    "message": "Invalid email address format",
    "field": "signers[0].email",
    "status": 422
  }
}

400Bad RequestInvalid request parameters or body

401UnauthorizedMissing or invalid API key

403ForbiddenInsufficient permissions for this action

404Not FoundResource not found

409ConflictResource already exists or state conflict

422Unprocessable EntityValidation error in request data

429Too Many RequestsRate limit exceeded

500Internal Server ErrorUnexpected server error

Need Help?

Our developer support team is here to help you integrate AuthenlySign

Resources

API Documentation

Complete reference for the AuthenlySign REST API. Integrate document signing into your applications.

Authentication

Signing Flow

Endpoints

Webhooks

SDKs

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.authenlysign.com/v1/documents

Keep your API key secure

Never expose your API key in client-side code. Use environment variables and server-side requests.

Generate API keys in your Dashboard Settings. API access requires Medium Team plan or higher.

Base URL

Production

https://api.authenlysign.com/v1

Sandbox (Testing)

https://sandbox-api.authenlysign.com/v1

Rate Limits

Standard

1,000

requests/hour

Large Team

5,000

requests/hour

Enterprise

Unlimited

custom limits available

Rate limit headers are included in all responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

Document Signing Flow

The complete end-to-end document signing workflow consists of these steps:

Upload Document

Upload a PDF document using POST /api/documents/upload. The document is created in "draft" status.

curl -X POST /api/documents/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@contract.pdf" \
  -F "title=Service Agreement"

Send for Signing

Send the document to signers using POST /api/documents/:id/send-for-signing. Email invitations are sent automatically.

curl -X POST /api/documents/doc_abc123/send-for-signing \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"signers": [{"email": "signer@example.com", "name": "John Doe"}], "expirationDays": 30}'

Monitor Status

Poll GET /api/documents/:id/status or configure webhooks to track signing progress in real-time.

// Response includes completion percentage and signer details
{
  "signedCount": 1,
  "totalSigners": 2,
  "completionPercentage": 50,
  "status": "in-progress",
  "signers": [
    {"email": "signer1@example.com", "status": "signed", "signed_at": "2026-06-02T11:00:00Z"},
    {"email": "signer2@example.com", "status": "pending-signature", "signed_at": null}
  ]
}

Receive Completion Webhook

When all signers complete, you receive a document.completed webhook event.

{
  "id": "evt_abc123",
  "type": "document.completed",
  "created": 1717329600,
  "data": {
    "object": {
      "documentId": "doc_abc123",
      "document": {"id": "doc_abc123", "title": "Service Agreement", "status": "completed"}
    }
  }
}

Download Signed Document

Retrieve the signed PDF using GET /api/documents/:id/download.

curl /api/documents/doc_abc123/download \
  -H "Authorization: Bearer YOUR_API_KEY"

// Response
{"success": true, "downloadUrl": "https://storage.authenlysign.app/signed/...", "filename": "Service Agreement.pdf"}

Verify Signatures (Optional)

Cryptographically verify all signatures using GET /api/documents/:id/verify.

// Response
{
  "documentId": "doc_abc123",
  "isValid": true,
  "signatures": [
    {"signerEmail": "signer@example.com", "signedAt": "2026-06-02T11:05:00Z", "isValid": true}
  ],
  "verifiedAt": "2026-06-03T10:00:00Z"
}

Document Status Lifecycle

draft

Document uploaded, not yet sent to signers

in-progress

Sent to signers, awaiting signatures

completed

All signers have signed successfully

expired

Expiration date passed before completion

API Endpoints

Documents

POST/api/documents/uploadAuth Required

Upload a new document for signing. Accepts PDF files up to 50MB.

{
  "file": "File (PDF only, max 50MB)",
  "title": "string (optional, defaults to filename)",
  "description": "string (optional)"
}

GET/api/documents/paginatedAuth Required

List documents with pagination, filtering, and sorting

page- number (default: 1)

pageSize- number (default: 20, max: 100)

status- string (draft | in-progress | completed | archived)

search- string (filter by title)

sortBy- string (created_at | updated_at | title | status)

sortOrder- string (asc | desc, default: desc)

cursor- string (for cursor-based pagination)

GET/api/documents/:id/statusAuth Required

Get document status with signer progress and expiration info

id- Document ID (required)

POST/api/documents/:id/send-for-signingAuth Required

Send document to signers for signature collection

id- Document ID (required)

POST/api/documents/:id/sign

Submit a signature for a document (called by signer)

id- Document ID (required)

PATCH/api/documents/:idAuth Required

Update document metadata (draft documents only)

id- Document ID (required)

DELETE/api/documents/:idAuth Required

Delete a draft document (completed documents cannot be deleted)

id- Document ID (required)

GET/api/documents/:id/downloadAuth Required

Get download URL for the document PDF

id- Document ID (required)

GET/api/documents/:id/verifyAuth Required

Verify cryptographic signatures on a completed document

id- Document ID (required)

POST/api/documents/:id/remindAuth Required

Send reminder emails to pending signers

id- Document ID (required)

POST/api/documents/paginatedAuth Required

Batch operations on multiple documents

{
  "action": "'archive' | 'delete' | 'restore' (required)",
  "documentIds": "string[] (required, max 100)"
}

Signing Flow

POST/api/signing/in-personAuth Required

Initialize an in-person (kiosk) signing session

{
  "documentId": "string (required)",
  "signerEmail": "string (required)",
  "signerName": "string (optional)"
}

POST/api/signing/in-person/capture

Capture signature in kiosk/in-person mode

{
  "sessionId": "string (required)",
  "signatureData": "string (base64-encoded signature)"
}

POST/api/signing/in-person/verify

Verify signer identity for in-person signing

{
  "sessionId": "string (required)",
  "verificationCode": "string (optional, if access code required)"
}

API Keys

GET/api/settings/api-keysAuth Required

List all API keys for the authenticated user

{
  "apiKeys": [
    {
      "id": "key_001",
      "name": "Production Key",
      "created_at": "2026-06-01T10:00:00Z",
      "last_used_at": "2026-06-02T15:30:00Z",
      "expires_at": null
    }
  ]
}

POST/api/settings/api-keysAuth Required

Create a new API key (Medium Team plan or higher)

{
  "name": "string (required)",
  "expiresInDays": "number (optional, null for no expiration)"
}

DELETE/api/settings/api-keys?id=:keyIdAuth Required

Delete an API key

id- API Key ID (required)

POST/api/settings/api-keys/:keyId/rotateAuth Required

Rotate an API key (generates new key, invalidates old)

keyId- API Key ID (required)

Webhooks

GET/api/integrations/webhooks/:integrationIdAuth Required

Get webhook configuration for an integration

integrationId- Integration ID (required)

POST/api/integrations/webhooks/:integrationIdAuth Required

Configure webhook endpoint for an integration

integrationId- Integration ID (required)

Health & Status

GET/api/health

Basic health check endpoint

{
  "status": "healthy",
  "timestamp": "2026-06-02T10:00:00Z"
}

GET/api/health/signing

Check signing service health (PKI, certificates)

{
  "status": "healthy",
  "pki": "operational",
  "certificates": "valid"
}

GET/api/health/database

Check database connectivity

{
  "status": "healthy",
  "latency_ms": 12
}

Webhooks

Webhooks allow you to receive real-time notifications when events occur in AuthenlySign. Configure webhook endpoints in your dashboard or via the API.

Webhook Payload Structure

{
  "id": "evt_abc123",
  "event": "document.completed",
  "created_at": "2025-12-02T10:00:00Z",
  "data": {
    "document_id": "doc_xyz789",
    "title": "Service Agreement",
    "status": "completed",
    "completed_at": "2025-12-02T10:00:00Z",
    "signers": [
      { "email": "client@example.com", "signed_at": "2025-12-02T10:00:00Z" }
    ]
  }
}

Available Events

document.sentDocument was sent for signing to recipients

document.viewedA signer viewed the document

document.signedA signer completed their signature

document.completedAll signers have signed, document is complete

document.voidedDocument was voided/cancelled by owner

document.expiredDocument expired before all signatures were collected

recipient.startedA recipient started the signing process

recipient.completedA recipient completed all their required actions

recipient.declinedA recipient declined to sign the document

package.sentA multi-document package was sent for signing

package.completedAll documents in a package are fully signed

package.expiredA signing package expired before completion

package.cancelledA signing package was cancelled

field.completedA form field was completed by a signer

Webhook Security

Verify webhook signatures to ensure requests are from AuthenlySign:

const crypto = require('crypto');

function verifyWebhookSignature(payload, signature, secret) {
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
  
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(`sha256=${expectedSignature}`)
  );
}

SDKs & Libraries

Install: npm install @authenlysign/sdk

import AuthenlySign from '@authenlysign/sdk';

const client = new AuthenlySign({
  apiKey: process.env.AUTHENLYSIGN_API_KEY
});

// Upload a document
const formData = new FormData();
formData.append('file', pdfFile);
formData.append('title', 'Service Agreement');

const { document } = await client.documents.upload(formData);

// Send for signing
await client.documents.sendForSigning(document.id, {
  signers: [
    { email: 'client@company.com', name: 'Client Name' }
  ],
  emailSubject: 'Please sign this agreement',
  expirationDays: 30
});

// Check document status
const status = await client.documents.getStatus(document.id);
console.log('Completion:', status.completionPercentage + '%');

// Download signed document when complete
if (status.status === 'completed') {
  const { downloadUrl } = await client.documents.download(document.id);
  console.log('Download:', downloadUrl);
}

Error Codes

The API returns standard HTTP status codes and JSON error objects:

{
  "error": {
    "code": "validation_error",
    "message": "Invalid email address format",
    "field": "signers[0].email",
    "status": 422
  }
}

400Bad RequestInvalid request parameters or body

401UnauthorizedMissing or invalid API key

403ForbiddenInsufficient permissions for this action

404Not FoundResource not found

409ConflictResource already exists or state conflict

422Unprocessable EntityValidation error in request data

429Too Many RequestsRate limit exceeded

500Internal Server ErrorUnexpected server error

Need Help?

Our developer support team is here to help you integrate AuthenlySign