Skip to content
Kor Vision Kor Vision Kor Vision SDK

SDK API

Main exports

Section titled “Main exports”

From package root:

  • DocumentScannerFlow
  • DocumentScanner (alias of flow)
  • DocumentScannerScreen
  • EditDocumentScreen
  • ShareDocumentScreen
  • OCRResultScreen
  • ScannerProvider
  • useScannerContext
  • ScannerNavigationProvider
  • useScannerNavigation
  • detectDocument
  • processDocumentImage
  • processImageFilterPreview
  • useOCR

Core types

Section titled “Core types”
  • DocumentScannerFlowProps
  • ScannerRoute = scan | edit | share | ocr
  • ScannerNavigationMethod = push | replace
  • NavigationManager
  • CapturedImage
  • FilterMode = original | grayscale | bw
  • Point
  • Size

Flow props

Section titled “Flow props”

DocumentScannerFlowProps

Section titled “DocumentScannerFlowProps”
  • initialRoute?: ScannerRoute (default: scan)

Processing signatures

Section titled “Processing signatures”

processDocumentImage(params)

Section titled “processDocumentImage(params)”

Required:

  • sourceBase64
  • normalizedPoints (4 points)
  • filter
  • outputUri

Optional:

  • targetAspectRatio
  • exifOrientation
  • orientation

Returns: Promise<string> output URI.

processImageFilterPreview(params)

Section titled “processImageFilterPreview(params)”

Required:

  • sourceBase64
  • filter
  • outputUri

Optional:

  • targetAspectRatio
  • exifOrientation
  • orientation

Returns: Promise<string> output URI.