API Documentation

Build intelligent document approval workflows with SignumFlow's RESTful API. Get started in minutes with blockchain-grade security and AI-powered routing.

🔑 API Key Required: All requests require authentication. Get your free trial key to start testing.

Overview

SignumFlow provides a simple REST API for automating document approval workflows. Our API is designed for developers who need enterprise-grade security with the simplicity of modern web APIs.

Base URL

https://api.signumflow.com/v1

Response Format

All API responses are in JSON format with consistent error handling and status codes.

Authentication

SignumFlow uses API keys for authentication. Include your API key in the Authorization header:

Authorization: sk_test_your_api_key_here

API keys are prefixed with:

  • sk_test_ for test/trial keys
  • sk_live_ for production keys

Quick Start

Create your first approval workflow in 3 simple steps:

1. Create a Workflow

POST /workflows
{ "name": "Invoice Approval", "steps": [ { "step_id": "manager_review", "approvers": [{"email": "[email protected]"}], "timeout_hours": 24 } ] }

2. Start an Approval

POST /approvals/start
{ "workflow_id": "wf_...", "document": { "title": "Invoice #1234", "file_url": "https://your-domain.com/invoice.pdf" } }

3. Check Status

GET /approvals/{id}/status

Workflows

Define multi-step approval processes with automatic routing and escalation.

POST /workflows - Create workflow
GET /workflows - List workflows
GET /workflows/{id} - Get workflow details

Approvals

Start, track, and manage document approvals with real-time status updates.

POST /approvals/start - Start approval process
POST /approvals - Submit approval decision
GET /approvals/{id}/status - Get approval status

Documents

Upload and manage documents with secure storage and blockchain verification.

POST /upload - Upload document
GET /documents/{id} - Get document details

Audit Trail

Access complete audit logs with cryptographic proof for compliance.

GET /audit/{document_id} - Get audit trail

Error Codes

SignumFlow uses conventional HTTP status codes:

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 429 - Rate Limited
  • 500 - Server Error

Rate Limits

API requests are limited based on your plan:

  • Trial: 100 requests/hour
  • Pro: 10,000 requests/hour
  • Enterprise: Custom limits

Webhooks

Receive real-time notifications for approval events, escalations, and status changes.

Get API Access

Need help? Contact our developer support team.