Developer documentation
Build with MaxScanner.
A complete guide to documents, processing, APIs, SDKs, automation and the Chrome extension — built around one account and one document platform.
MAXScanner documentation
Everything required to build, process, store and automate documents with MAXScanner.
Read guide →Quickstart: your first processed document
Go from upload to a reusable saved result in minutes.
Read guide →My Documents
Understand the account document workspace and its navigation model.
Read guide →Folders, groups and pages
Organize large document collections without losing page-level control.
Read guide →Versions and artifacts
Learn how processing outputs become durable document history.
Read guide →Sharing and secure links
Design for controlled document sharing without exposing permanent storage URLs.
Read guide →Tool workflows
Connect PDF, image, OCR and document tools into repeatable processing journeys.
Read guide →PDF tools
Architecture and UX expectations for PDF merge, split, compress, convert and OCR tools.
Read guide →Image tools
Resize, compress, convert and optimize images with predictable output controls.
Read guide →API overview
Build against the unified MAXScanner API surface.
Read guide →API authentication
Use scoped API keys and server-side credentials safely.
Read guide →Jobs API
Create, inspect and recover asynchronous processing jobs.
Read guide →Documents API
Search and operate on account-owned documents.
Read guide →Files API
Upload and retrieve files using bounded, private object-storage workflows.
Read guide →OCR API
Submit OCR jobs and consume searchable text/results.
Read guide →Conversion API
Convert documents between supported formats through the processor router.
Read guide →Webhooks
Receive signed job completion and failure events.
Read guide →API errors and status codes
Understand consistent errors, validation failures, limits and job states.
Read guide →Formats, limits and quotas
Reference supported formats, request limits and plan-dependent quotas.
Read guide →OpenAPI and API reference
Maintain a machine-readable contract for generated clients and developer tooling.
Read guide →SDK integration patterns
Build reliable integrations for JavaScript, Python and server-side applications.
Read guide →Chrome extension
Capture webpages, screenshots and images and hand them to the same MAXScanner account pipeline.
Read guide →Chrome extension security
Secure authentication, uploads, permissions and message passing.
Read guide →Zapier
Connect MAXScanner processing to business automation.
Read guide →n8n
Build self-hosted document processing workflows.
Read guide →Zoho automation
Connect MAXScanner to CRM, Desk and business workflows through scoped API credentials and webhooks.
Read guide →Processing architecture
Understand the API gateway, queue, router, workers, storage and document version flow.
Read guide →Retries, idempotency and dead letters
Operate processing safely under failures and worker restarts.
Read guide →Processing limits and concurrency
Control worker utilization and protect the platform from pathological workloads.
Read guide →Billing and plans
Understand subscriptions, entitlements, credits and usage.
Read guide →API usage and metering
Measure API consumption and communicate quotas to customers.
Read guide →Security model
Account isolation, RBAC, scoped keys and private storage.
Read guide →Privacy and retention
Define document retention, deletion and temporary-processing policies.
Read guide →Job object reference
Understand the canonical fields returned by processing jobs.
Read guide →Webhook event reference
Catalog event payload conventions and delivery semantics.
Read guide →