Class ScanbotSDK

constructor

• new ScanbotSDK(): ScanbotSDK

• Returns ScanbotSDK

storage

Static Config

Static cameras

API

• get API(): BridgeApiEntrypoint

• Returns BridgeApiEntrypoint

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>

createCheckScanner

• createCheckScanner(config): Promise<ICheckScannerHandle>

• Parameters

  • config: CheckScannerViewConfiguration

  Returns Promise<ICheckScannerHandle>

createCheckScannerEngine

• createCheckScannerEngine(config?): Promise<CheckScanner>

• Parameters

  • Optional config: CheckScannerConfiguration

  Returns Promise<CheckScanner>

createDocumentDataExtractor

• createDocumentDataExtractor(config): Promise<IDocumentDataExtractorHandle>

• Parameters

  • config: DocumentDataExtractorViewConfiguration

  Returns Promise<IDocumentDataExtractorHandle>

createDocumentDataExtractorEngine

• createDocumentDataExtractorEngine(config?): Promise<DocumentDataExtractor>

• Parameters

  • Optional config: DocumentDataExtractorConfiguration

  Returns Promise<DocumentDataExtractor>

createDocumentQualityAnalyzer

• createDocumentQualityAnalyzer(configuration): Promise<DocumentQualityAnalyzer>

• Parameters

  • configuration: DocumentQualityAnalyzerConfiguration

  Returns Promise<DocumentQualityAnalyzer>

createDocumentScanner

• createDocumentScanner(configuration): Promise<IDocumentScannerHandle>

• View Components

  Parameters

  • configuration: DocumentScannerViewConfiguration

  Returns Promise<IDocumentScannerHandle>

createImageProcessor

• createImageProcessor(): Promise<ImageProcessor>

• Returns Promise<ImageProcessor>

createMrzScanner

• createMrzScanner(configuration): Promise<IMrzScannerHandle>

• Parameters

  • configuration: MrzScannerViewConfiguration

  Returns Promise<IMrzScannerHandle>

createMrzScannerEngine

• createMrzScannerEngine(config?): Promise<MrzScanner>

• Parameters

  • Optional config: MrzScannerConfiguration

  Returns Promise<MrzScanner>

createOcrEngine

• createOcrEngine(): Promise<OcrEngine>

• Returns Promise<OcrEngine>

createTextPatternScanner

• createTextPatternScanner(configuration): Promise<ITextPatternScannerHandle>

• Parameters

  • configuration: TextPatternScannerViewConfiguration

  Returns Promise<ITextPatternScannerHandle>

createVinScanner

• createVinScanner(configuration): Promise<ITextPatternScannerHandle>

• Parameters

  • configuration: VinScannerViewConfiguration

  Returns Promise<ITextPatternScannerHandle>

detectAndCropDocument

• detectAndCropDocument(image, consumeImage?): Promise<DocumentScannerScanResponse>

• Parameters

  • image: Image

  • Optional consumeImage: ConsumeType

  Returns Promise<DocumentScannerScanResponse>

detectBarcodes

• detectBarcodes(image, config?, consumeType?): Promise<BarcodeScannerResult>

• Parameters

  • image: string | Image

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

  • Optional config: DeepPartial<BarcodeScannerConfiguration>

    BarcodeScannerConfiguration

  • Optional consumeType: ConsumeType

    ConsumeType

  Returns Promise<BarcodeScannerResult>

detectDocument

• detectDocument(image, config?, consumeType?): Promise<DocumentDetectionResult>

• Parameters

  • image: Image

    Image

  • Optional config: DeepPartial<DocumentScannerConfiguration>

    DocumentScannerConfiguration

  • Optional consumeType: ConsumeType

    ConsumeType

  Returns Promise<DocumentDetectionResult>

getLicenseInfo

• getLicenseInfo(): Promise<LicenseInfo>

• Misc. Features

  Returns Promise<LicenseInfo>

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<BarcodeDocumentParserResult>

• Parameters

  • acceptedDocumentFormats: BarcodeDocumentFormat[]

  • rawBarcodeData: string

  Returns Promise<BarcodeDocumentParserResult>

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>