API Documentation
Integrate BoltSign's electronic signature capabilities into your applications
API Reference
Getting Started
The BoltSign API allows you to incorporate electronic signature functionality into your application. Our RESTful API supports all major signature workflows, document management, and user operations.
Base URL
https://api.boltsign.com/v1
Getting Started Steps
-
1
Create a Developer Account
Register for a developer account on our Developer Portal.
-
2
Generate API Keys
Create API keys for your application in the developer dashboard.
-
3
Make Your First API Call
Follow our Quick Start Guide to make your first API request.
Authentication
All API requests must be authenticated using API keys. We support both API key and OAuth 2.0 authentication methods.
API Key Authentication
Include your API key in the headers of all requests:
Authorization: Bearer YOUR_API_KEY
OAuth 2.0
For applications that need to act on behalf of users, use OAuth 2.0 authentication:
Authorization: Bearer OAUTH_ACCESS_TOKEN
See our OAuth Guide for detailed implementation instructions.
Documents API
The Documents API allows you to create, manage, and track the status of documents in the signing workflow.
/documents
Create a new document for signature
Request Body
{
"name": "Contract Agreement",
"file_url": "https://example.com/contract.pdf",
"recipients": [
{
"email": "[email protected]",
"name": "John Doe",
"role": "signer"
}
],
"fields": [
{
"type": "signature",
"page": 1,
"position": {
"x": 100,
"y": 100,
"width": 150,
"height": 50
},
"recipient_index": 0
}
]
}
Response
{
"id": "doc_123456789",
"status": "pending",
"created_at": "2023-05-15T10:30:00Z",
"expires_at": "2023-06-15T10:30:00Z",
"signing_url": "https://sign.boltsign.com/s/abc123"
}
/documents/{document_id}
Retrieve document details and status
Response
{
"id": "doc_123456789",
"name": "Contract Agreement",
"status": "completed",
"created_at": "2023-05-15T10:30:00Z",
"completed_at": "2023-05-16T14:25:00Z",
"recipients": [
{
"email": "[email protected]",
"name": "John Doe",
"status": "completed",
"completed_at": "2023-05-16T14:25:00Z"
}
]
}
Additional API documentation sections will be added here...
Official SDKs
Use our official client libraries to integrate quickly in your preferred language
