Class ScanbotSDK

constructor

• new ScanbotSDK(): ScanbotSDK

• Returns ScanbotSDK

storage

Static Config

Static cameras

utils

• get utils(): PublicUtils

• Returns PublicUtils

version

• get version(): string

• Returns string

Static UI

• get UI(): typeof ScanbotSDKUI2

• Returns typeof ScanbotSDKUI2

beginPdf

• beginPdf(options): Promise<PdfGenerator>

• Parameters

  • options: DeepPartial<PdfConfiguration>

    PdfConfiguration

  Returns Promise<PdfGenerator>

beginTiff

• beginTiff(options?): Promise<TiffGenerator>

• Parameters

  • Optional options: DeepPartial<TiffGeneratorParameters>

    TiffGeneratorParameters

  Returns Promise<TiffGenerator>

createBarcodeScanner

• createBarcodeScanner(configuration): Promise<IBarcodeScannerHandle>

• Parameters

  • configuration: BarcodeScannerViewConfiguration

  Returns Promise<IBarcodeScannerHandle>

createDocumentDataExtractor

• createDocumentDataExtractor(options): Promise<DocumentDataExtractor>

• Parameters

  • options: DeepPartial<DocumentDataExtractorConfiguration>

    DocumentDataExtractorConfiguration

  Returns Promise<DocumentDataExtractor>

createDocumentDataExtractorScanner

• createDocumentDataExtractorScanner(config): Promise<any>

• Parameters

  • config: DocumentDataExtractorViewConfiguration

  Returns Promise<any>

createDocumentQualityAnalyzer

• createDocumentQualityAnalyzer(config?): Promise<DocumentQualityAnalyzer>

• Parameters

  • Optional config: DeepPartial<DocumentQualityAnalyzerConfiguration>

    DocumentQualityAnalyzerConfiguration

  Returns Promise<DocumentQualityAnalyzer>

createDocumentScanner

• createDocumentScanner(configuration): Promise<IDocumentScannerHandle>

• View Components

  Parameters

  • configuration: DocumentScannerViewConfiguration

  Returns Promise<IDocumentScannerHandle>

createMrzScanner

• createMrzScanner(configuration): Promise<IMrzScannerHandle>

• Parameters

  • configuration: MrzScannerViewConfiguration

  Returns Promise<IMrzScannerHandle>

createOcrEngine

• createOcrEngine(): Promise<OcrEngine>

• Returns Promise<OcrEngine>

createSimpleMRZRecognizer

• createSimpleMRZRecognizer(): Promise<SimpleMrzRecognizer>

• Returns Promise<SimpleMrzRecognizer>

createTextPatternScanner

• createTextPatternScanner(configuration): Promise<ITextPatternScannerHandle>

• Parameters

  • configuration: TextPatternScannerViewConfiguration

  Returns Promise<ITextPatternScannerHandle>

createVinScanner

• createVinScanner(configuration): Promise<ITextPatternScannerHandle>

• Parameters

  • configuration: VinScannerViewConfiguration

  Returns Promise<ITextPatternScannerHandle>

detectAndCropDocument

• detectAndCropDocument(imageBuffer, consumeImage?): Promise<CroppedDetectionResult>

• Parameters

  • imageBuffer: Image

  • Optional consumeImage: ConsumeType

  Returns Promise<CroppedDetectionResult>

detectBarcodes

• detectBarcodes(image, partialDetectionParameters?, consumeImage?): Promise<BarcodeScannerResult & {
      originalImage: Image;
  }>

• Parameters

  • image: string | Image

    An image URL (e.g. Data URL or HTTP URL) or an Image object

  • Optional partialDetectionParameters: Omit<DeepPartial<BarcodeScannerConfiguration>, "live">

    BarcodeScannerConfiguration

  • Optional consumeImage: ConsumeType

  Returns Promise<BarcodeScannerResult & {
      originalImage: Image;
  }>

detectDocument

• detectDocument(image, detectionParameters?, consumeImage?): Promise<DocumentDetectionResult>

• Parameters

  • image: Image

  • Optional detectionParameters: DeepPartial<DocumentScannerParameters>

    DocumentScannerParameters

  • Optional consumeImage: ConsumeType

  Returns Promise<DocumentDetectionResult>

getLicenseInfo

• getLicenseInfo(): Promise<LicenseInfo>

• Misc. Features

  Returns Promise<LicenseInfo>

imageCrop

• imageCrop(image, polygon, consumeImage?): Promise<RawImage>

• Crops and stretches the image to the convex hull of the supplied points. All points should have relative coordinates between 0 and 1.

  Parameters

  • image: Image

  • polygon: Polygon

  • Optional consumeImage: ConsumeType

  Returns Promise<RawImage>

imageFilter

• imageFilter(image, filter, consumeImage?): Promise<RawImage>

• Parameters

  • image: Image

  • filter: ParametricFilter

  • Optional consumeImage: ConsumeType

  Returns Promise<RawImage>

imageResize

• imageResize(image, destinationSize, consumeImage?): Promise<RawImage>

• Parameters

  • image: Image

  • destinationSize: number

  • Optional consumeImage: ConsumeType

  Returns Promise<RawImage>

imageRotate

• imageRotate(image, rotation, consumeImage?): Promise<RawImage>

• Parameters

  • image: Image

  • rotation: ImageRotation

  • Optional consumeImage: ConsumeType

  Returns Promise<RawImage>

imageToJpeg

• imageToJpeg(image, consumeImage?): Promise<Uint8Array>

• Parameters

  • image: Image

  • Optional consumeImage: ConsumeType

  Returns Promise<Uint8Array>

openCroppingView

• openCroppingView(configuration): Promise<ICroppingViewHandle>

• Parameters

  • configuration: CroppingViewConfiguration

  Returns Promise<ICroppingViewHandle>

parseBarcodeDocument

• parseBarcodeDocument(acceptedDocumentFormats, rawBarcodeData): Promise<GenericDocument>

• Parameters

  • acceptedDocumentFormats: BarcodeDocumentFormat[]

  • rawBarcodeData: string

  Returns Promise<GenericDocument>

release

• release(object, source?): Promise<void>

• Parameters

  • object: ObjectId<any>

  • Optional source: string

  Returns Promise<void>

toDataUrl

• toDataUrl(imageBuffer): Promise<string>

• Image Operations

  Parameters

  • imageBuffer: ArrayBuffer

  Returns Promise<string>

Static initialize

• initialize(options): Promise<ScanbotSDK>

• Parameters

  • options: InitializationOptions

  Returns Promise<ScanbotSDK>