Home/Documentation/Hosted scanner webhooks
Endpoint reference

Hosted scanner webhooks

A hosted scanner gives a link or QR code to people who should scan documents. When the scan is done, the finished PDF is posted to the webhook URL you configured on that scanner.

What ScanKit posts

A multipart/form-data POST with two parts:

  • file: the finished scan as a PDF, filename scan.pdf.
  • metadata: a JSON part with scanner_id, scanner_name, page_count and timestamp.
http
POST https://your-app.example.com/scan-webhook
Content-Type: multipart/form-data; boundary=...

--boundary
Content-Disposition: form-data; name="file"; filename="scan.pdf"
Content-Type: application/pdf

<the finished scan as a PDF>
--boundary
Content-Disposition: form-data; name="metadata"
Content-Type: application/json

{
  "scanner_id": 4711,
  "scanner_name": "Delivery notes",
  "page_count": 2,
  "timestamp": "2026-09-19T19:41:07.512Z"
}
--boundary--
The payload carries no OCR text
Extraction happens downstream, in your workflow or app: send the PDF on to your OCR or vision step, or use POST /scan/scan_pdf with ocr_lang if you want the text layer inside the file.

What your receiver has to do

  • Accept a POST with multipart form data and read the file part as a PDF.
  • Answer with a 2xx status. The scanner reports a non-2xx response back to the person scanning, so a slow or failing endpoint is visible to them.
  • Accept the request cross-origin: the browser of the person scanning sends it directly to your URL.
  • Use an HTTPS endpoint. A webhook URL that is not reachable from the public internet cannot receive anything.

Setting it up

  • Create the scanner in the dashboard and give it a name and a colour.
  • Enter your webhook URL on the scanner. Without a webhook the finished scan stays with the person who scanned it as a download.
  • Share the scanner link or the QR code, or embed the page on your own site.
  • No API key is needed at the scanner: the people scanning do not see credentials.
n8n, Make and Zapier templates
Ready-made flows that receive the PDF and file it in your own storage.
See the examples
Instant Scanner
What a hosted scanner is, and when a link beats an integration.
About Instant Scanners
Documentation