Variable ScanbotSDKConst

Type Declaration

• Barcode: {
      parseDocument(
          params: { acceptedFormats?: BarcodeDocumentFormat[]; rawText: string },
      ): Promise<BarcodeDocumentParserResult>;
      scanFromImage(
          params: {
              configuration: BarcodeScannerConfiguration;
              image: ImageInput;
          },
      ): Promise<BarcodeScannerResult>;
      scanFromPdf(
          params: {
              configuration: BarcodeScannerConfiguration;
              pdfFileUri: string;
          },
      ): Promise<BarcodeScannerResult>;
      startScanner(
          configuration: BarcodeScannerScreenConfiguration,
      ): Promise<ResultWrapper<BarcodeScannerUiResult>>;
  }

  Used for barcode scanning features.

• Check: {
      scanFromImage(
          params: { configuration: CheckScannerConfiguration; image: ImageInput },
      ): Promise<CheckScanningResult>;
      startScanner(
          configuration: CheckScannerScreenConfiguration,
      ): Promise<ResultWrapper<CheckScannerUiResult>>;
  }

  Used for check scanning features.

• CreditCard: {
      scanFromImage(
          params: {
              configuration: CreditCardScannerConfiguration;
              image: ImageInput;
          },
      ): Promise<CreditCardScanningResult>;
      startScanner(
          configuration: CreditCardScannerScreenConfiguration,
      ): Promise<ResultWrapper<CreditCardScannerUiResult>>;
  }

  Used for credit card scanning features.

• Document: {
      addPages(
          params: {
              documentUuid: string;
              images: ImageInput[];
              options?: AddPageOptions;
          },
      ): Promise<DocumentData>;
      analyzeQualityOnImage(
          params: {
              configuration: DocumentQualityAnalyzerConfiguration;
              image: ImageInput;
          },
      ): Promise<DocumentQualityAnalyzerResult>;
      cloneDocument(documentUuid: string): Promise<DocumentData>;
      createDocumentFromImages(
          params: { images?: ImageInput[]; options?: CreateDocumentOptions },
      ): Promise<DocumentData>;
      createDocumentFromLegacyPages(
          params: { documentImageSizeLimit?: number; pages: Page[] },
      ): Promise<DocumentData>;
      createDocumentFromPdf(
          params: { options?: CreateDocumentOptions; pdfFileUri: string },
      ): Promise<DocumentData>;
      deleteAllDocuments(): Promise<void>;
      deleteDocument(documentUuid: string): Promise<void>;
      documentExists(documentUuid: string): Promise<boolean>;
      getStoredDocumentUuids(): Promise<string[]>;
      loadDocument(documentUuid: string): Promise<DocumentData>;
      modifyPage(
          params: {
              documentUuid: string;
              options?: ModifyPageOptions;
              pageUuid: string;
          },
      ): Promise<DocumentData>;
      movePage(
          params: { documentUuid: string; fromIndex: number; toIndex: number },
      ): Promise<DocumentData>;
      removeAllPages(documentUuid: string): Promise<DocumentData>;
      removePages(
          params: { documentUuid: string; pageUuids: string[] },
      ): Promise<DocumentData>;
      scanFromImage(
          params: {
              configuration: DocumentScannerConfiguration;
              image: ImageInput;
          },
      ): Promise<DocumentScanningResult>;
      startCroppingScreen(
          configuration: CroppingConfiguration,
      ): Promise<ResultWrapper<DocumentData>>;
      startScanner(
          configuration: DocumentScanningFlow,
      ): Promise<ResultWrapper<DocumentData>>;
  }

  Used for document scanning features.

• DocumentDataExtractor: {
      extractFromImage(
          params: {
              configuration: DocumentDataExtractorConfiguration;
              image: ImageInput;
          },
      ): Promise<DocumentDataExtractionResult>;
      startExtractorScreen(
          configuration: DocumentDataExtractorScreenConfiguration,
      ): Promise<ResultWrapper<DocumentDataExtractorUiResult>>;
      verifyDocument(
          documentParts: GenericDocument[],
      ): Promise<DocumentVerificationReport>;
  }

  Used for document data extraction features.

• ImageProcessor: {
      applyFilters(
          params: { filters: ParametricFilter[]; image: ImageRef },
      ): Promise<ImageRef>;
      applyFiltersOnImageFile(
          params: {
              filters: ParametricFilter[];
              imageFileUri: string;
              overwrite?: boolean;
              saveOptions?: SaveImageOptions;
          },
      ): Promise<string>;
      crop(params: { image: ImageRef; polygon: Point[] }): Promise<ImageRef>;
      cropImageFile(
          params: {
              imageFileUri: string;
              overwrite?: boolean;
              polygon: Point[];
              saveOptions?: SaveImageOptions;
          },
      ): Promise<string>;
      readImageData(imageFileUri: string): Promise<string>;
      resize(params: { image: ImageRef; maxSize: number }): Promise<ImageRef>;
      resizeImageFile(
          params: {
              imageFileUri: string;
              maxSize: number;
              overwrite?: boolean;
              saveOptions?: SaveImageOptions;
          },
      ): Promise<string>;
      rotate(
          params: { image: ImageRef; rotation: ImageRotation },
      ): Promise<ImageRef>;
      rotateImageFile(
          params: {
              imageFileUri: string;
              overwrite?: boolean;
              rotation: ImageRotation;
              saveOptions?: SaveImageOptions;
          },
      ): Promise<string>;
  }

  Used for image processing features.

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

  Used for legacy page features.

  Deprecated

  Please, use ScanbotDocument instead.

• Mrz: {
      scanFromImage(
          params: { configuration: MrzScannerConfiguration; image: ImageInput },
      ): Promise<MrzScannerResult>;
      startScanner(
          configuration: MrzScannerScreenConfiguration,
      ): Promise<ResultWrapper<MrzScannerUiResult>>;
  }

  Used for MRZ scanning features.

• OcrEngine: {
      recognizeOnDocument(
          params: { configuration?: OcrConfiguration; documentUuid: string },
      ): Promise<PerformOcrResult>;
      recognizeOnImages(
          params: { configuration?: OcrConfiguration; images: ImageInput[] },
      ): Promise<PerformOcrResult>;
  }

  Used for OCR features.

• PdfGenerator: {
      generateFromDocument(
          params: {
              documentUuid: string;
              ocrConfiguration?: OcrConfiguration;
              pdfConfiguration: PdfConfiguration;
          },
      ): Promise<string>;
      generateFromImages(
          params: {
              images: ImageInput[];
              ocrConfiguration?: OcrConfiguration;
              pdfConfiguration: PdfConfiguration;
          },
      ): Promise<string>;
  }

  Used for PDF generation features.

• PdfImageExtractor: {
      extractImageFiles(
          params: { options?: PdfExtractorOptions; pdfFileUri: string },
      ): Promise<string[]>;
  }

  Used to extract images from PDF documents.

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

  Used for text pattern recognition features.

• TiffGenerator: {
      generateFromDocument(
          params: {
              documentUuid: string;
              tiffGeneratorParameters: TiffGeneratorParameters;
          },
      ): Promise<string>;
      generateFromImages(
          params: {
              images: ImageInput[];
              tiffGeneratorParameters: TiffGeneratorParameters;
          },
      ): Promise<string>;
  }

  Used for TIFF generation features.

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

  Used for VIN scanning features.

• 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: SdkConfiguration): 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: {
            captureFileUri?: string;
            imageFileUri: string;
            refreshOnEachFrame?: boolean;
        },
    ): 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 }

      • OptionalcaptureFileUri?: 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.

      • OptionalrefreshOnEachFrame?: 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: AnalyticsSubscriber | null): Promise<void>

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

    Parameters

    • subscriber: AnalyticsSubscriber | null

      The analytics subscriber to be set.

    Returns Promise<void>