Variable ScanbotSdkConst

Type declaration

• Barcode: {
      parseDocument(params): Promise<BarcodeDocumentParserResult>;
      scanFromImage(params): Promise<BarcodeScannerResult>;
      scanFromPdf(params): Promise<BarcodeScannerResult>;
      startScanner(configuration): Promise<ResultWrapper<BarcodeScannerUiResult>>;
  }

  Used for barcode scanning features.

  • parseDocument:function

    • parseDocument(params): Promise<BarcodeDocumentParserResult>

    • Parameters

      • params: {
            acceptedFormats?: BarcodeDocumentFormat[];
            rawText: string;
        }

        • Optional acceptedFormats?: BarcodeDocumentFormat[]

        • rawText: string

      Returns Promise<BarcodeDocumentParserResult>

  • scanFromImage:function

    • scanFromImage(params): Promise<BarcodeScannerResult>

    • Parameters

      • params: {
            configuration: BarcodeScannerConfiguration;
            image: ImageInput;
        }

        • configuration: BarcodeScannerConfiguration

        • image: ImageInput

      Returns Promise<BarcodeScannerResult>

  • scanFromPdf:function

    • scanFromPdf(params): Promise<BarcodeScannerResult>

    • Parameters

      • params: {
            configuration: BarcodeScannerConfiguration;
            pdfFileUri: string;
        }

        • configuration: BarcodeScannerConfiguration

        • pdfFileUri: string

      Returns Promise<BarcodeScannerResult>

  • startScanner:function

    • startScanner(configuration): Promise<ResultWrapper<BarcodeScannerUiResult>>

    • Parameters

      • configuration: BarcodeScannerScreenConfiguration

      Returns Promise<ResultWrapper<BarcodeScannerUiResult>>

• Check: {
      scanFromImage(params): Promise<CheckScanningResult>;
      startScanner(configuration): Promise<ResultWrapper<CheckScannerUiResult>>;
  }

  Used for check scanning features.

  • scanFromImage:function

    • scanFromImage(params): Promise<CheckScanningResult>

    • Parameters

      • params: {
            configuration: CheckScannerConfiguration;
            image: ImageInput;
        }

        • configuration: CheckScannerConfiguration

        • image: ImageInput

      Returns Promise<CheckScanningResult>

  • startScanner:function

    • startScanner(configuration): Promise<ResultWrapper<CheckScannerUiResult>>

    • Parameters

      • configuration: CheckScannerScreenConfiguration

      Returns Promise<ResultWrapper<CheckScannerUiResult>>

• CreditCard: {
      scanFromImage(params): Promise<CreditCardScanningResult>;
      startScanner(configuration): Promise<ResultWrapper<CreditCardScannerUiResult>>;
  }

  Used for credit card scanning features.

  • scanFromImage:function

    • scanFromImage(params): Promise<CreditCardScanningResult>

    • Parameters

      • params: {
            configuration: CreditCardScannerConfiguration;
            image: ImageInput;
        }

        • configuration: CreditCardScannerConfiguration

        • image: ImageInput

      Returns Promise<CreditCardScanningResult>

  • startScanner:function

    • startScanner(configuration): Promise<ResultWrapper<CreditCardScannerUiResult>>

    • Parameters

      • configuration: CreditCardScannerScreenConfiguration

      Returns Promise<ResultWrapper<CreditCardScannerUiResult>>

• Document: {
      addPages(params): Promise<DocumentData>;
      analyzeQualityOnImage(params): Promise<DocumentQualityAnalyzerResult>;
      cloneDocument(documentUuid): Promise<DocumentData>;
      createDocumentFromImages(params): Promise<DocumentData>;
      createDocumentFromLegacyPages(params): Promise<DocumentData>;
      createDocumentFromPdf(params): Promise<DocumentData>;
      deleteAllDocuments(): Promise<void>;
      deleteDocument(documentUuid): Promise<void>;
      documentExists(documentUuid): Promise<boolean>;
      getStoredDocumentUuids(): Promise<string[]>;
      loadDocument(documentUuid): Promise<DocumentData>;
      modifyPage(params): Promise<DocumentData>;
      movePage(params): Promise<DocumentData>;
      removeAllPages(documentUuid): Promise<DocumentData>;
      removePages(params): Promise<DocumentData>;
      scanFromImage(params): Promise<DocumentScanningResult>;
      startCroppingScreen(configuration): Promise<ResultWrapper<DocumentData>>;
      startScanner(configuration): Promise<ResultWrapper<DocumentData>>;
  }

  Used for document scanning features.

  • addPages:function

    • addPages(params): Promise<DocumentData>

    • Parameters

      • params: {
            documentUuid: string;
            images: ImageInput[];
            options?: AddPageOptions;
        }

        • documentUuid: string

        • images: ImageInput[]

        • Optional options?: AddPageOptions

      Returns Promise<DocumentData>

  • analyzeQualityOnImage:function

    • analyzeQualityOnImage(params): Promise<DocumentQualityAnalyzerResult>

    • Parameters

      • params: {
            configuration: DocumentQualityAnalyzerConfiguration;
            image: ImageInput;
        }

        • configuration: DocumentQualityAnalyzerConfiguration

        • image: ImageInput

      Returns Promise<DocumentQualityAnalyzerResult>

  • cloneDocument:function

    • cloneDocument(documentUuid): Promise<DocumentData>

    • Parameters

      • documentUuid: string

      Returns Promise<DocumentData>

  • createDocumentFromImages:function

    • createDocumentFromImages(params): Promise<DocumentData>

    • Parameters

      • params: {
            images?: ImageInput[];
            options?: CreateDocumentOptions;
        }

        • Optional images?: ImageInput[]

        • Optional options?: CreateDocumentOptions

      Returns Promise<DocumentData>

  • createDocumentFromLegacyPages:function

    • createDocumentFromLegacyPages(params): Promise<DocumentData>

    • Parameters

      • params: {
            documentImageSizeLimit?: number;
            pages: Page[];
        }

        • Optional documentImageSizeLimit?: number

        • pages: Page[]

      Returns Promise<DocumentData>

  • createDocumentFromPdf:function

    • createDocumentFromPdf(params): Promise<DocumentData>

    • Parameters

      • params: {
            options?: CreateDocumentOptions;
            pdfFileUri: string;
        }

        • Optional options?: CreateDocumentOptions

        • pdfFileUri: string

      Returns Promise<DocumentData>

  • deleteAllDocuments:function

    • deleteAllDocuments(): Promise<void>

    • Returns Promise<void>

  • deleteDocument:function

    • deleteDocument(documentUuid): Promise<void>

    • Parameters

      • documentUuid: string

      Returns Promise<void>

  • documentExists:function

    • documentExists(documentUuid): Promise<boolean>

    • Parameters

      • documentUuid: string

      Returns Promise<boolean>

  • getStoredDocumentUuids:function

    • getStoredDocumentUuids(): Promise<string[]>

    • Returns Promise<string[]>

  • loadDocument:function

    • loadDocument(documentUuid): Promise<DocumentData>

    • Parameters

      • documentUuid: string

      Returns Promise<DocumentData>

  • modifyPage:function

    • modifyPage(params): Promise<DocumentData>

    • Parameters

      • params: {
            documentUuid: string;
            options?: ModifyPageOptions;
            pageUuid: string;
        }

        • documentUuid: string

        • Optional options?: ModifyPageOptions

        • pageUuid: string

      Returns Promise<DocumentData>

  • movePage:function

    • movePage(params): Promise<DocumentData>

    • Parameters

      • params: {
            documentUuid: string;
            fromIndex: number;
            toIndex: number;
        }

        • documentUuid: string

        • fromIndex: number

        • toIndex: number

      Returns Promise<DocumentData>

  • removeAllPages:function

    • removeAllPages(documentUuid): Promise<DocumentData>

    • Parameters

      • documentUuid: string

      Returns Promise<DocumentData>

  • removePages:function

    • removePages(params): Promise<DocumentData>

    • Parameters

      • params: {
            documentUuid: string;
            pageUuids: string[];
        }

        • documentUuid: string

        • pageUuids: string[]

      Returns Promise<DocumentData>

  • scanFromImage:function

    • scanFromImage(params): Promise<DocumentScanningResult>

    • Parameters

      • params: {
            configuration: DocumentScannerConfiguration;
            image: ImageInput;
        }

        • configuration: DocumentScannerConfiguration

        • image: ImageInput

      Returns Promise<DocumentScanningResult>

  • startCroppingScreen:function

    • startCroppingScreen(configuration): Promise<ResultWrapper<DocumentData>>

    • Parameters

      • configuration: CroppingConfiguration

      Returns Promise<ResultWrapper<DocumentData>>

  • startScanner:function

    • startScanner(configuration): Promise<ResultWrapper<DocumentData>>

    • Parameters

      • configuration: DocumentScanningFlow

      Returns Promise<ResultWrapper<DocumentData>>

• DocumentDataExtractor: {
      extractFromImage(params): Promise<DocumentDataExtractionResult>;
      startExtractorScreen(configuration): Promise<ResultWrapper<DocumentDataExtractorUiResult>>;
      verifyDocument(documentParts): Promise<DocumentVerificationReport>;
  }

  Used for document data extraction features.

  • extractFromImage:function

    • extractFromImage(params): Promise<DocumentDataExtractionResult>

    • Parameters

      • params: {
            configuration: DocumentDataExtractorConfiguration;
            image: ImageInput;
        }

        • configuration: DocumentDataExtractorConfiguration

        • image: ImageInput

      Returns Promise<DocumentDataExtractionResult>

  • startExtractorScreen:function

    • startExtractorScreen(configuration): Promise<ResultWrapper<DocumentDataExtractorUiResult>>

    • Parameters

      • configuration: DocumentDataExtractorScreenConfiguration

      Returns Promise<ResultWrapper<DocumentDataExtractorUiResult>>

  • verifyDocument:function

    • verifyDocument(documentParts): Promise<DocumentVerificationReport>

    • Parameters

      • documentParts: GenericDocument[]

      Returns Promise<DocumentVerificationReport>

• ImageProcessor: {
      applyFilters(params): Promise<ImageRef>;
      applyFiltersOnImageFile(params): Promise<string>;
      crop(params): Promise<ImageRef>;
      cropImageFile(params): Promise<string>;
      readImageData(imageFileUri): Promise<string>;
      resize(params): Promise<ImageRef>;
      resizeImageFile(params): Promise<string>;
      rotate(params): Promise<ImageRef>;
      rotateImageFile(params): Promise<string>;
  }

  Used for image processing features.

  • applyFilters:function

    • applyFilters(params): Promise<ImageRef>

    • Parameters

      • params: {
            filters: ParametricFilter[];
            image: ImageRef;
        }

        • filters: ParametricFilter[]

        • image: ImageRef

      Returns Promise<ImageRef>

  • applyFiltersOnImageFile:function

    • applyFiltersOnImageFile(params): Promise<string>

    • Parameters

      • params: {
            filters: ParametricFilter[];
            imageFileUri: string;
            overwrite?: boolean;
            saveOptions?: SaveImageOptions;
        }

        • filters: ParametricFilter[]

        • imageFileUri: string

        • Optional overwrite?: boolean

        • Optional saveOptions?: SaveImageOptions

      Returns Promise<string>

  • crop:function

    • crop(params): Promise<ImageRef>

    • Parameters

      • params: {
            image: ImageRef;
            polygon: Point[];
        }

        • image: ImageRef

        • polygon: Point[]

      Returns Promise<ImageRef>

  • cropImageFile:function

    • cropImageFile(params): Promise<string>

    • Parameters

      • params: {
            imageFileUri: string;
            overwrite?: boolean;
            polygon: Point[];
            saveOptions?: SaveImageOptions;
        }

        • imageFileUri: string

        • Optional overwrite?: boolean

        • polygon: Point[]

        • Optional saveOptions?: SaveImageOptions

      Returns Promise<string>

  • readImageData:function

    • readImageData(imageFileUri): Promise<string>

    • Parameters

      • imageFileUri: string

      Returns Promise<string>

  • resize:function

    • resize(params): Promise<ImageRef>

    • Parameters

      • params: {
            image: ImageRef;
            maxSize: number;
        }

        • image: ImageRef

        • maxSize: number

      Returns Promise<ImageRef>

  • resizeImageFile:function

    • resizeImageFile(params): Promise<string>

    • Parameters

      • params: {
            imageFileUri: string;
            maxSize: number;
            overwrite?: boolean;
            saveOptions?: SaveImageOptions;
        }

        • imageFileUri: string

        • maxSize: number

        • Optional overwrite?: boolean

        • Optional saveOptions?: SaveImageOptions

      Returns Promise<string>

  • rotate:function

    • rotate(params): Promise<ImageRef>

    • Parameters

      • params: {
            image: ImageRef;
            rotation: ImageRotation;
        }

        • image: ImageRef

        • rotation: ImageRotation

      Returns Promise<ImageRef>

  • rotateImageFile:function

    • rotateImageFile(params): Promise<string>

    • Parameters

      • params: {
            imageFileUri: string;
            overwrite?: boolean;
            rotation: ImageRotation;
            saveOptions?: SaveImageOptions;
        }

        • imageFileUri: string

        • Optional overwrite?: boolean

        • rotation: ImageRotation

        • Optional saveOptions?: SaveImageOptions

      Returns Promise<string>

• LegacyPage: {
      refreshImageUris(pages): Promise<Page[]>;
      removeAllPages(): Promise<void>;
      removePage(page): Promise<void>;
      setDocumentImage(params): Promise<Page>;
  }

  Used for legacy page features.

  Deprecated

  Please, use ScanbotDocument instead.

  • refreshImageUris:function

    • refreshImageUris(pages): Promise<Page[]>

    • Parameters

      • pages: Page[]

      Returns Promise<Page[]>

  • removeAllPages:function

    • removeAllPages(): Promise<void>

    • Returns Promise<void>

  • removePage:function

    • removePage(page): Promise<void>

    • Parameters

      • page: Page

      Returns Promise<void>

  • setDocumentImage:function

    • setDocumentImage(params): Promise<Page>

    • Parameters

      • params: {
            imageFileUri: string;
            page: Page;
        }

        • imageFileUri: string

        • page: Page

      Returns Promise<Page>

• Mrz: {
      scanFromImage(params): Promise<MrzScannerResult>;
      startScanner(configuration): Promise<ResultWrapper<MrzScannerUiResult>>;
  }

  Used for MRZ scanning features.

  • scanFromImage:function

    • scanFromImage(params): Promise<MrzScannerResult>

    • Parameters

      • params: {
            configuration: MrzScannerConfiguration;
            image: ImageInput;
        }

        • configuration: MrzScannerConfiguration

        • image: ImageInput

      Returns Promise<MrzScannerResult>

  • startScanner:function

    • startScanner(configuration): Promise<ResultWrapper<MrzScannerUiResult>>

    • Parameters

      • configuration: MrzScannerScreenConfiguration

      Returns Promise<ResultWrapper<MrzScannerUiResult>>

• OcrEngine: {
      recognizeOnDocument(params): Promise<PerformOcrResult>;
      recognizeOnImages(params): Promise<PerformOcrResult>;
  }

  Used for OCR features.

  • recognizeOnDocument:function

    • recognizeOnDocument(params): Promise<PerformOcrResult>

    • Parameters

      • params: {
            configuration?: OcrConfiguration;
            documentUuid: string;
        }

        • Optional configuration?: OcrConfiguration

        • documentUuid: string

      Returns Promise<PerformOcrResult>

  • recognizeOnImages:function

    • recognizeOnImages(params): Promise<PerformOcrResult>

    • Parameters

      • params: {
            configuration?: OcrConfiguration;
            images: ImageInput[];
        }

        • Optional configuration?: OcrConfiguration

        • images: ImageInput[]

      Returns Promise<PerformOcrResult>

• PdfGenerator: {
      generateFromDocument(params): Promise<string>;
      generateFromImages(params): Promise<string>;
  }

  Used for PDF generation features.

  • generateFromDocument:function

    • generateFromDocument(params): Promise<string>

    • Parameters

      • params: {
            documentUuid: string;
            ocrConfiguration?: OcrConfiguration;
            pdfConfiguration: PdfConfiguration;
        }

        • documentUuid: string

        • Optional ocrConfiguration?: OcrConfiguration

        • pdfConfiguration: PdfConfiguration

      Returns Promise<string>

  • generateFromImages:function

    • generateFromImages(params): Promise<string>

    • Parameters

      • params: {
            images: ImageInput[];
            ocrConfiguration?: OcrConfiguration;
            pdfConfiguration: PdfConfiguration;
        }

        • images: ImageInput[]

        • Optional ocrConfiguration?: OcrConfiguration

        • pdfConfiguration: PdfConfiguration

      Returns Promise<string>

• PdfImageExtractor: {
      extractImageFiles(params): Promise<string[]>;
  }

  Used to extract images from PDF documents.

  • extractImageFiles:function

    • extractImageFiles(params): Promise<string[]>

    • Parameters

      • params: {
            options?: PdfExtractorOptions;
            pdfFileUri: string;
        }

        • Optional options?: PdfExtractorOptions

        • pdfFileUri: string

      Returns Promise<string[]>

• TextPattern: {
      startScanner(configuration): Promise<ResultWrapper<TextPatternScannerUiResult>>;
  }

  Used for text pattern recognition features.

  • startScanner:function

    • startScanner(configuration): Promise<ResultWrapper<TextPatternScannerUiResult>>

    • Parameters

      • configuration: TextPatternScannerScreenConfiguration

      Returns Promise<ResultWrapper<TextPatternScannerUiResult>>

• TiffGenerator: {
      generateFromDocument(params): Promise<string>;
      generateFromImages(params): Promise<string>;
  }

  Used for TIFF generation features.

  • generateFromDocument:function

    • generateFromDocument(params): Promise<string>

    • Parameters

      • params: {
            documentUuid: string;
            tiffGeneratorParameters: TiffGeneratorParameters;
        }

        • documentUuid: string

        • tiffGeneratorParameters: TiffGeneratorParameters

      Returns Promise<string>

  • generateFromImages:function

    • generateFromImages(params): Promise<string>

    • Parameters

      • params: {
            images: ImageInput[];
            tiffGeneratorParameters: TiffGeneratorParameters;
        }

        • images: ImageInput[]

        • tiffGeneratorParameters: TiffGeneratorParameters

      Returns Promise<string>

• Vin: {
      startScanner(configuration): Promise<ResultWrapper<VinScannerUiResult>>;
  }

  Used for VIN scanning features.

  • startScanner:function

    • startScanner(configuration): Promise<ResultWrapper<VinScannerUiResult>>

    • Parameters

      • configuration: VinScannerScreenConfiguration

      Returns Promise<ResultWrapper<VinScannerUiResult>>

• cleanupStorage:function

  • cleanupStorage(): Promise<void>

  • Cleans up the storage used by the Scanbot SDK.

    Returns Promise<void>

• getLicenseInfo:function

  • getLicenseInfo(): Promise<LicenseInfo>

  • Provides complete information about the current license.

    Returns Promise<LicenseInfo>

    • Returns complete information about the current license.

• getOcrConfigs:function

  • getOcrConfigs(): Promise<OcrConfigsResult>

  • Retrieves the OCR configurations available in the Scanbot SDK.

    Returns Promise<OcrConfigsResult>

    • The OCR configurations available in the Scanbot SDK.

    Deprecated

• initialize:function

  • initialize(configuration): Promise<LicenseInfo>

  • Initializes the Scanbot SDK with the preferred configuration.

    Parameters

    • configuration: SdkConfiguration

      The SDK configuration to be used for initialization.

    Returns Promise<LicenseInfo>

    • Returns complete information about the license used for initialization.

• mockCamera:function

  • mockCamera(params): Promise<void>

  • Mock camera preview by using static images as a frame source. This is useful for testing purposes.

    Parameters

    • params: {
          captureFileUri?: string;
          imageFileUri: string;
          refreshOnEachFrame?: boolean;
      }

      • Optional captureFileUri?: string

        The file uri of the image to be used as a mock captured frame. If not provided, the imageFileUri will be used. Default is ""

      • imageFileUri: string

        The file uri of the image to be used as a mock camera frame.

      • Optional refreshOnEachFrame?: boolean

        If true, the mock camera will refresh the frame on each request, simulating a live camera feed. Default is false

    Returns Promise<void>

• setAnalyticsSubscriber:function

  • setAnalyticsSubscriber(subscriber): Promise<void>

  • Sets a custom analytics subscriber to receive analytics events from the Scanbot SDK.

    Parameters

    • subscriber: null | AnalyticsSubscriber

      The analytics subscriber to be set.

    Returns Promise<void>