The AbroadSign REST API enables organizations to embed enterprise-grade electronic signature capabilities directly into their existing business systems, eliminating manual document handling and enabling fully automated cross-border document workflows. The API supports the complete document lifecycle from template creation and bulk document generation through multi-party signing ceremonies, blockchain timestamping, and post-completion archival — all accessible through a well-documented REST interface that integrates with any technology stack capable of making HTTPS requests. Whether you are building custom integrations forERP systems, developing automated workflows for trade finance platforms, or creating bespoke client portals for international trade operations, the AbroadSign API provides the building blocks you need. The primary API reference is now available at our API v2 Reference Portal, which provides comprehensive endpoint documentation, authentication guides, and integration patterns for developers of all experience levels.
“We integrated AbroadSign’s API into our freight management system in less than three days. Now every booking confirmation is digitally signed automatically — no manual intervention required for the entire process.” — CTO, global freight forwarding platform
API Overview and Authentication
The AbroadSign API is a RESTful service that uses JSON for request and response payloads. All endpoints are accessible via HTTPS at the base URL https://www.abroadsign.com/api-v2-reference/. For the complete v2 endpoint reference including all endpoint groups, parameters, and response schemas, visit the API v2 Reference Portal. Authentication is handled through API keys generated from the AbroadSign administration dashboard, with each API key scoped to specific permissions that align with your integration requirements and security policies. API keys should be treated as highly sensitive credentials — they provide programmatic access to your organization’s document vault and signing workflows, and must be stored securely using environment variables or secrets management systems rather than hardcoded in source code repositories.
- Base URL: All API requests should be directed to
https://www.abroadsign.com/api-v2-reference/. The API enforces TLS 1.3 — connections using older TLS versions will be rejected to ensure that API credentials and document content are never transmitted over insecure channels. - Authentication Header: Include your API key in the
Authorizationheader as a Bearer token:Authorization: Bearer YOUR_API_KEY. Each API key is associated with specific permission scopes that control which endpoints and operations are accessible from your integration. - Rate Limiting: API requests are rate-limited to prevent abuse and ensure platform stability. Standard tier accounts are limited to 1,000 requests per minute per API key. Enterprise accounts can request elevated rate limits based on documented integration requirements and expected transaction volumes.
- Versioning Strategy: The API uses URL-based versioning. Major breaking changes will be introduced only through new versioned endpoints, with a minimum 12-month deprecation notice provided before old versions are retired to give integrations adequate migration time.
- Error Response Format: All error responses return a JSON body with
code,message, and optionaldetailsfields that provide specific error information for debugging failed requests. HTTP status codes follow REST conventions: 2xx for success, 4xx for client errors, and 5xx for server-side issues.
Core API Endpoints
The AbroadSign API organizes functionality around resource-oriented endpoints that map to the natural entities in a digital signing workflow: documents, templates, signers, and signatures. Each resource supports standard CRUD operations (Create, Read, Update, Delete) plus resource-specific actions such as sending documents for signing, reminding signers, or downloading completed document packages. For the complete endpoint reference table, visit our API v2 Reference Portal.
| Endpoint Group | Base Path | Primary Operations | Typical Use Cases |
|---|---|---|---|
| Documents | /documents | Create, Read, List, Download, Archive | Initiating signatures, retrieving signed copies |
| Templates | /templates | Create, Read, Update, Delete, Clone | Standardized document workflows |
| Signers | /signers | Invite, Resend, Cancel, Verify | Managing signing parties and identity |
| Signatures | /signatures | Apply, Verify, Status, Retrieve | Completing and validating signatures |
| Webhooks | /webhooks | Create, List, Delete, Test | Real-time event notifications |
| Organizations | /organizations | Read, Update, Settings | Admin and compliance configuration |
Document Workflow Integration
The most common API integration pattern involves creating documents programmatically and managing their lifecycle through the signing process. A typical integration workflow begins with your system creating a document from a template or raw content, adding the required signers with their contact details and signature placement instructions, and then sending the document for signing. The API’s webhook system then notifies your system when signers complete their actions, enabling your backend to automatically progress documents through multi-step workflows without manual monitoring.
- Document Creation: POST to
/documentswith the document content, title, and metadata. The API supports PDF upload, HTML content, and direct URL reference to source document systems. Documents can be created from templates pre-configured in the AbroadSign dashboard, passing template-specific field values through the API call for mass customization of document content. - Signer Configuration: Add signers to a document via
/documents/{id}/signers. Each signer record includes email address, name, role in the signing sequence (sequential or parallel), and signing reason. For high-value transactions requiring enhanced identity assurance, you can enable biometric or video-based verification for specific signers. - Workflow Dispatch: Send the document to signers using
POST /documents/{id}/send. The API automatically generates and sends professionally formatted email invitations with the document link, expiry period, and signer-specific instructions. Reminder emails are automatically sent at configurable intervals to signers who have not yet taken action. - Signature Completion: When all required signatures are collected, the API triggers a
document.completedwebhook event to your configured endpoint. Your system can then retrieve the completed document package including the original document with embedded signatures, a cryptographic hash certificate, and a complete audit trail document.
“The webhook system is the heart of our integration. Every time a freight contract is signed by all parties, our system receives the webhook, updates our operational database, and triggers the next logistics workflow automatically. It runs completely hands-free.”
— Lead Systems Architect, international logistics platform
SDK Packages and Code Examples
AbroadSign provides official SDK packages for the most popular programming languages and frameworks, each encapsulating the REST API with native-language data structures, automatic retry logic with exponential backoff for transient failures, and comprehensive type definitions that enable IDE autocomplete and compile-time type checking for faster, more reliable integration development. SDK packages are open source and community-contributions for additional languages are welcome through our GitHub repository.
- Python SDK: The Python package supports async/await patterns for modern Python applications and includes built-in support for Django and FastAPI integration with automatic request/response serialization. Install via
pip install abroadsign-apiand access documentation with full code examples at our developer portal. - Node.js / TypeScript SDK: A fully typed TypeScript package with complete type definitions for all request and response objects. Includes native support for Express.js middleware, Next.js API routes, and serverless functions on AWS Lambda, Vercel, and Cloudflare Workers. Install via
npm install abroadsign-api. - Java / Spring Boot SDK: Official Java package compatible with Spring Boot 2.x and 3.x, including auto-configuration support for Spring applications and comprehensive Javadoc documentation. Maven coordinates available on Maven Central for straightforward dependency management in enterprise Java projects.
- PHP SDK: A PSR-compliant PHP package compatible with Laravel, Symfony, and standalone PHP applications. Includes Laravel-specific service provider for easy dependency injection and automatic API client configuration through the Laravel service container.
- .NET / C# SDK: Full .NET Standard 2.0 compatibility supporting .NET Framework, .NET Core, and .NET 5+ applications. Includes ASP.NET Core integration with dependency injection support and HttpClientFactory pattern for optimal HTTP connection management in high-throughput scenarios.
Webhook Events and Real-Time Notifications
Webhooks enable your systems to receive real-time notifications when events occur within the AbroadSign platform, eliminating the need for polling-based integration patterns that waste API quota on repetitive status checks. Configure webhook endpoints from the API Settings page in your AbroadSign dashboard, specifying the HTTPS URL that should receive POST notifications and selecting which event types should trigger notifications. Each webhook delivery includes a cryptographic signature in the header that your system should verify to confirm the notification originated from AbroadSign and has not been tampered with during transmission.
| Event Type | Trigger Condition | Payload Includes | Common Integration Response |
|---|---|---|---|
| document.created | New document added to platform | document_id, title, created_by | Add to internal tracking system |
| document.sent | Document dispatched to signers | document_id, signers[], expires_at | Update workflow status dashboard |
| signer.viewed | Signer opens document link | document_id, signer_id, viewed_at | Log engagement activity |
| signer.completed | Signer submits their signature | document_id, signer_id, signed_at | Check if all signatures collected |
| document.completed | All signatures obtained | document_id, completed_at, download_url | Trigger downstream processes |
| document.expired | Signing deadline passed | document_id, expired_at | Initiate renewal workflow |
| document.declined | Signer declines to sign | document_id, signer_id, declined_at | Alert operations team |
Getting Started with Your Integration
Begin your API integration by generating API credentials from the AbroadSign dashboard under Settings > API Access. Start with the sandbox environment to develop and test your integration without processing live documents — the sandbox provides a fully functional API mirror with test document processing that does not affect production data or count against production quotas. Our comprehensive API documentation portal includes interactive API explorer, detailed endpoint specifications, and integration recipes for common use cases across trade finance, logistics, and cross-border commerce applications.
For deeper technical guidance, explore our document workflow automation documentation that covers advanced API patterns for high-volume document processing, batch operations for processing multiple documents simultaneously, and performance optimization techniques for integrations that need to handle thousands of concurrent signing workflows. Our integration team also offers complimentary technical review sessions for enterprise customers to ensure your integration architecture is optimal before you go live with production document traffic.
“The API documentation is genuinely excellent — the best we’ve encountered for any enterprise SaaS integration. The combination of comprehensive endpoint specs, working code examples, and interactive API explorer meant we had a proof-of-concept running within hours of signing up.”
— Senior Integration Engineer, commodity trading platform
Ready to build your integration? Visit our API v2 Reference Portal for full endpoint references, SDK downloads, and working code examples. For questions about enterprise API requirements, webhook reliability, or custom integration architecture, contact our technical integration team to schedule a complimentary architecture review session with one of our senior API engineers.
