POST
/api/v1/upload/
Generate presigned URL for single file or batch upload with automatic virus scanning
https://api.signumflow.com/api/v1/upload/
Welcome to the SignumFlow API documentation. Our REST API enables you to automate document workflows, manage approvals, generate certificates, and integrate SignumFlow's powerful document processing capabilities directly into your applications.
The API is organized around REST principles with predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
All API endpoints are relative to this base URL. API requests must be made over HTTPS.
The SignumFlow API uses API keys to authenticate requests. You can view and manage your API keys through the Developer Portal.
To get started, create an account through the developer portal and generate your API keys. We provide two types of API keys:
sf_test_) - Use for development and testing without affecting production datasf_live_) - Use in production environmentsAuthentication is performed via the Authorization header. Include your API key in every request:
Do not share your API keys in publicly accessible areas such as GitHub, client-side code, or anywhere else that could expose them.
SignumFlow uses conventional HTTP response codes to indicate the success or failure of an API request. In general: codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided, and codes in the 5xx range indicate an error with SignumFlow's servers.
Everything worked as expected
The resource was successfully created
The request was invalid or cannot be served. Check the error message for details
Invalid or missing API key. Check your Authorization header
The API key doesn't have permissions to perform the request
The requested resource doesn't exist
The request conflicts with another request or the current state of the resource
You've exceeded the rate limit. Please slow down your requests
Something went wrong on our end. Please try again later
The service is temporarily unavailable. Please try again later
All errors return a JSON object with details about the error:
Generate presigned URL for single file or batch upload with automatic virus scanning