API Reference | Web Document Scanner

See our API documentation for a complete list of classes and methods.
See below for the most important operations and integration examples.

• ScanbotSdk
  • .initialize(options: InitializationOptions) - function
  • .createDocumentScanner(configuration: DocumentScannerConfiguration) - function
  • .createMrzScanner(configuration: MrzScannerConfiguration) - function
  • .createBarcodeScanner(configuration: BarcodeScannerConfiguration) - function
  • .openCroppingView(configuration: CroppingViewConfiguration) - function
  • .createTextDataScanner(configuration: TextDataScannerConfiguration) - function
  • .createVINScanner(configuration: VINScannerConfiguration) - function
  • .toDataUrl(imageBuffer: ArrayBuffer) - function
  • .applyFilter(imageBuffer: ArrayBuffer, filterType: ImageFilter) - function
  • .rotateImageCcw(imageBuffer: ArrayBuffer, rotations: number) - function
  • .cropAndRotateImageCcw(imageBuffer: ArrayBuffer, polygon: Polygon, rotations: number) - function
  • .detectDocument(imageBuffer: ArrayBuffer, acceptedAngleScore?: number, acceptedSizeScore?: number) - function
  • .detectBarcodes(base64: string, engineMode?: EngineMode, barcodeFormats?: BarcodeFormat[], returnBarcodeImage?: boolean) - function
  • .createSimpleMRZRecognizer() - function
  • .createOcrEngine(languages) - function
  • .createDocumentQualityAnalyzer() - function
  • .getLicenseInfo() - function
  • .beginPdf(options?: PdfGenerationOptions) - function
  • .beginTiff(options?: TiffGenerationOptions) - function
  • version() - function
  • utils() - function

Want to scan longer than one minute?

Generate your free "no-strings-attached" Trial License and properly test the Scanbot SDK.

Get your free Trial License

What do you think of this documentation?

What can we do to improve it? Please be as detailed as you like.

---