API Documentation

Integrate VeloSign into your applications with our REST API.

Authentication

All API requests require authentication using a Bearer token. Generate an API key in your account settings. API access is available on Pro and Business plans.

curl -H "Authorization: Bearer zk_your_api_key" \
  https://velosign.com/api/v1/documents

Base URL

https://velosign.com/api/v1

Rate Limits

PlanRate Limit
Pro100 requests/minute
Business1,000 requests/minute

Endpoints

GET/api/v1/documents?page=1&limit=20

List your documents with pagination

Response

{
  "documents": [...],
  "pagination": { "page": 1, "limit": 20, "total": 42, "totalPages": 3 }
}
POST/api/v1/documents

Create a document and send for signing

Request Body

FormData:
  file: (PDF/DOCX/PNG/JPG, max 25MB)
  name: "Contract Agreement"
  signers: '[{"name":"John","email":"john@example.com","role":"signer"}]'
  message: "Please sign this" (optional)

Response

{ "id": "...", "name": "...", "status": "pending", "signers": [...] }
GET/api/v1/documents/:id

Get document details with signers and audit trail

Response

{ "id": "...", "name": "...", "status": "...", "signers": [...], "auditLogs": [...] }
GET/api/v1/documents/:id/file

Download the document file (signed version if completed)

Response

Binary file data
DELETE/api/v1/documents/:id

Delete a document and its files

Response

{ "success": true }
GET/api/v1/templates

List your saved templates

Response

[{ "id": "...", "name": "...", "fields": [...] }]

Error Codes

CodeDescription
401Invalid or missing API key
403Insufficient plan or permissions
404Resource not found
400Invalid request parameters
429Rate limit exceeded
500Internal server error