API Documentation
v1.0RESTAPI for extracting transaction data from PDF bank statements with AI-powered processing
Get API Access
View pricing plans and sign up for API access
Dashboard
Manage your API keys and view usage statistics
Authentication
Learn how to authenticate your API requests
Base URL
All API endpoints are prefixed with /api/v1
Authentication
All API requests require authentication using your API key. Include your key in the request header:
Keep your API key secure
Never expose your API key in client-side code or public repositories. Always make API calls from your backend server.
API Endpoints
Rate Limits
Rate limits vary by plan tier and are enforced per minute:
| Plan | Requests/Minute | Pages/Month |
|---|---|---|
| Starter | 10 | 800 |
| Professional | 30 | 2,000 |
| Business | 50 | 8,000 |
Note: Rate limit headers are included in all API responses:X-RateLimit-Limit andX-RateLimit-Remaining
Error Codes
The API uses standard HTTP status codes to indicate success or failure:
Bad Request
Invalid request format or missing required fields
Unauthorized
Missing or invalid API key
Payload Too Large
File size exceeds 10MB limit
Unsupported Media Type
File format not supported
Too Many Requests
Rate limit exceeded or quota exhausted
Internal Server Error
Server error during processing
Service Unavailable
API temporarily unavailable
Best Practices
- Implement retry logic with exponential backoff for rate limit and server errors
- Validate files client-side before uploading (file type, size, page count)
- Store API keys securely using environment variables, never in code
- Monitor your usage regularly via the dashboard or
/api/v1/usageendpoint - Use HTTPS for all API requests to ensure data security
- Cache results when appropriate to reduce API calls and improve performance