How to Generate Your API Key
To use the API, you’ll first need to generate your API key.
Steps:
-
Go to Settings > API Integration
-
Under Generate API Key, click Generate API Key
-
Your key will appear in the field — click Copy to use it in your system
Use this key in your API calls by including it in the request headers as:
x-api-key: [your_key_here]
⚠️ Key Generation Rules:
-
The second click will regenerate a new key, replacing the old one
-
The third click will trigger a 10-minute cooldown before you can generate again
-
🔒 We recommend updating your key once a month for security purposes
📚 Where to Use It
Once your API key is generated, go to Settings > API Documentation
There, you’ll find all available endpoints, grouped by:
-
File – upload, retrieve, and download documents
-
Purchase Orders – retrieve your available POs
-
Webhooks – receive automatic status updates
Related Articles
Uploading Documents via API
? Upload Documents Directly From Your Platform Use the File Upload API to submit files for accessibility processing from your own system or app. ? Upload Endpoint POST /v1/external/user/files ? Request Body Example: ? Fields Explained: name, ...Using Webhooks to Get Document Status Updates
? Get Automatic Updates When Your Document Is Ready Want to receive real-time updates when your documents are processed? Use webhooks to automatically notify your system when a file is complete. ? Generate Your Webhook Secret Key Go to Settings > ...Using Purchase Orders with API Uploads
? Upload Files Under a Purchase Order If you're using page-based billing, your files need to be tied to an approved purchase order (PO) through an Enterprise subscription. Here's how to do that through the API. ? Step 1: Get Your Purchase Orders ...Two-Factor Authentication (2FA) Overview
Two-Factor Authentication (2FA) is an extra layer of security that helps protect your account by requiring a verification code in addition to your password.? Why Enable 2FA? ✅ Prevents unauthorized access ✅ Enhances account security beyond just a ...Retrieving & Downloading Files with the API
? Search, View, and Download Documents After uploading, you can use the API to list, inspect, and download files. ? Get All Files (Company Admins) GET /v1/external/admin/company/files Supports filters like: users (array of user IDs) tags, search, ...