Documentation

ScanKit documentation

Everything you need to put a clean scan into your own pipeline: the quickstart, the request contract of the scanning API, credits, limits and error codes.

Start here

Quickstart: first scan in five minutes
Get a key, send one photo, save the cleaned result. cURL, Python, Node and the browser SDK.
Open the quickstart
Interactive API reference
Every endpoint with its parameters, live in the browser playground. No account needed to look.
Open the reference
Browser SDK
Drop the ScanKit SDK into a web app and let your users capture documents on their phone.
Open the SDK page
Hosted scanners
A scanner page without code and without an account for the recipient: send a link, get cleaned scans.
Open hosted scanners

What you need

  • An account. Signup includes 50 free credits and needs no card.
  • An API key from the dashboard. Keys live under API keys.
  • A document photo, JPEG or PNG. Phone photos are exactly the input ScanKit is built for.

Three ways in

PathUse it whenDocs
REST APIYour backend or workflow does the scanningQuickstart, section "First API call"
Browser SDKYour users capture documents in your own web appQuickstart, section "Browser SDK"
Hosted scannerYou want a link that works without code or an account/instant-scanners

Where your documents go

Uploads are processed to produce the scan and are not stored afterwards. The application runs in the EU (eu-west-1, Ireland), the image processing runs in the EU too (eu-central-1, Frankfurt).