API Reference | Capacitor Document Scanner

• startDocumentScanner(...)
• closeDocumentScanner()
• startFinderDocumentScanner(...)
• closeFinderDocumentScanner()
• startCroppingScreen(...)
• closeCroppingScreen()
• startMrzScanner(...)
• closeMrzScanner()
• startBarcodeScanner(...)
• closeBarcodeScanner()
• startBatchBarcodeScanner(...)
• closeBatchBarcodeScanner()
• startEHICScanner(...)
• closeEHICScanner()
• startTextDataScanner(...)
• closeTextDataScanner()
• startLicensePlateScanner(...)
• closeLicensePlateScanner()
• startMedicalCertificateRecognizer(...)
• closeMedicalCertificateRecognizer()
• startGenericDocumentRecognizer(...)
• closeGenericDocumentRecognizer()
• startCheckRecognizer(...)
• closeCheckRecognizer()
• startVinScanner(...)
• closeVinScanner()
• initializeSDK(...)
• getLicenseInfo()
• detectBarcodesOnImage(...)
• detectBarcodesOnImages(...)
• applyImageFilter(...)
• applyImageFilterOnPage(...)
• getImageData(...)
• rotateImage(...)
• createPage(...)
• removePage(...)
• rotatePage(...)
• setDocumentImage(...)
• detectDocument(...)
• detectDocumentOnPage(...)
• documentQualityAnalyzer(...)
• extractImagesFromPdf(...)
• extractPagesFromPdf(...)
• recognizeCheck(...)
• recognizeMrz(...)
• refreshImageUris(...)
• getOCRConfigs()
• cleanup()
• getFilteredDocumentPreviewUri(...)
• performOCR(...)
• createPDF(...)
• writeTIFF(...)
• Interfaces
• Type Aliases

startDocumentScanner(...)

startDocumentScanner(configuration: DocumentScannerConfiguration) => Promise<ResultWrapper<DocumentScannerResult>>

Param	Type
configuration	DocumentScannerConfiguration

Returns: Promise<ResultWrapper<DocumentScannerResult>>

---

closeDocumentScanner()

closeDocumentScanner() => Promise<void>

---

startFinderDocumentScanner(...)

startFinderDocumentScanner(configuration: FinderDocumentScannerConfiguration) => Promise<ResultWrapper<DocumentScannerResult>>

Param	Type
configuration	FinderDocumentScannerConfiguration

Returns: Promise<ResultWrapper<DocumentScannerResult>>

---

closeFinderDocumentScanner()

closeFinderDocumentScanner() => Promise<void>

---

startCroppingScreen(...)

startCroppingScreen(args: { page: Page; configuration: CroppingConfiguration; }) => Promise<ResultWrapper<CroppingResult>>

Param	Type
args	{ page: Page; configuration: CroppingConfiguration; }

Returns: Promise<ResultWrapper<CroppingResult>>

---

closeCroppingScreen()

closeCroppingScreen() => Promise<void>

---

startMrzScanner(...)

startMrzScanner(configuration: MrzScannerConfiguration) => Promise<ResultWrapper<MrzScannerResult>>

Param	Type
configuration	MrzScannerConfiguration

Returns: Promise<ResultWrapper<MrzScannerResult>>

---

closeMrzScanner()

closeMrzScanner() => Promise<void>

---

startBarcodeScanner(...)

startBarcodeScanner(configuration: BarcodeScannerConfiguration) => Promise<ResultWrapper<BarcodeScannerResult>>

Param	Type
configuration	BarcodeScannerConfiguration

Returns: Promise<ResultWrapper<BarcodeScannerResult>>

---

closeBarcodeScanner()

closeBarcodeScanner() => Promise<void>

---

startBatchBarcodeScanner(...)

startBatchBarcodeScanner(configuration: BatchBarcodeScannerConfiguration) => Promise<ResultWrapper<BatchBarcodeScannerResult>>

Param	Type
configuration	BatchBarcodeScannerConfiguration

Returns: Promise<ResultWrapper<BatchBarcodeScannerResult>>

---

closeBatchBarcodeScanner()

closeBatchBarcodeScanner() => Promise<void>

---

startEHICScanner(...)

startEHICScanner(configuration: HealthInsuranceCardScannerConfiguration) => Promise<ResultWrapper<HealthInsuranceCardScannerResult>>

Param	Type
configuration	HealthInsuranceCardScannerConfiguration

Returns: Promise<ResultWrapper<HealthInsuranceCardScannerResult>>

---

closeEHICScanner()

closeEHICScanner() => Promise<void>

---

startTextDataScanner(...)

startTextDataScanner(configuration: TextDataScannerConfiguration) => Promise<ResultWrapper<TextDataScannerResult>>

Param	Type
configuration	TextDataScannerConfiguration

Returns: Promise<ResultWrapper<TextDataScannerResult>>

---

closeTextDataScanner()

closeTextDataScanner() => Promise<void>

---

startLicensePlateScanner(...)

startLicensePlateScanner(configuration: LicensePlateScannerConfiguration) => Promise<ResultWrapper<LicensePlateScannerResult>>

Param	Type
configuration	LicensePlateScannerConfiguration

Returns: Promise<ResultWrapper<LicensePlateScannerResult>>

---

closeLicensePlateScanner()

closeLicensePlateScanner() => Promise<void>

---

startMedicalCertificateRecognizer(...)

startMedicalCertificateRecognizer(configuration: MedicalCertificateRecognizerConfiguration) => Promise<ResultWrapper<MedicalCertificateRecognizerResult>>

Param	Type
configuration	MedicalCertificateRecognizerConfiguration

Returns: Promise<ResultWrapper<MedicalCertificateScannerResult>>

---

closeMedicalCertificateRecognizer()

closeMedicalCertificateRecognizer() => Promise<void>

---

startGenericDocumentRecognizer(...)

startGenericDocumentRecognizer(configuration: GenericDocumentRecognizerConfiguration) => Promise<ResultWrapper<GenericDocumentRecognizerResult>>

Param	Type
configuration	GenericDocumentRecognizerConfiguration

Returns: Promise<ResultWrapper<GenericDocumentRecognizerResult>>

---

closeGenericDocumentRecognizer()

closeGenericDocumentRecognizer() => Promise<void>

---

startCheckRecognizer(...)

startCheckRecognizer(configuration: CheckRecognizerConfiguration) => Promise<ResultWrapper<CheckRecognizerResult>>

Param	Type
configuration	CheckRecognizerConfiguration

Returns: Promise<ResultWrapper<CheckRecognizerResult>>

---

closeCheckRecognizer()

closeCheckRecognizer() => Promise<void>

---

startVinScanner(...)

startVinScanner(configuration: VinScannerConfiguration) => Promise<ResultWrapper<VinScannerResult>>

Param	Type
configuration	VinScannerConfiguration

Returns: Promise<ResultWrapper<VinScannerResult>>

---

closeVinScanner()

closeVinScanner() => Promise<void>

---

initializeSDK(...)

initializeSDK(options: ScanbotSdkConfiguration) => Promise<ResultWrapper<InitializeSDKResult>>

SDK Operations *

Param	Type
options	ScanbotSdkConfiguration

Returns: Promise<ResultWrapper<InitializeSDKResult>>

---

getLicenseInfo()

getLicenseInfo() => Promise<ResultWrapper<GetLicenseInfoResult>>

Returns: Promise<ResultWrapper<GetLicenseInfoResult>>

---

detectBarcodesOnImage(...)

detectBarcodesOnImage(args: DetectBarcodesOnImageArguments) => Promise<ResultWrapper<DetectBarcodesOnImageResult>>

Param	Type
args	DetectBarcodesOnImageArguments

Returns: Promise<ResultWrapper<DetectBarcodesOnImageResult>>

---

detectBarcodesOnImages(...)

detectBarcodesOnImages(args: DetectBarcodesOnImagesArguments) => Promise<ResultWrapper<DetectBarcodesOnImagesResult>>

Param	Type
args	DetectBarcodesOnImagesArguments

Returns: Promise<ResultWrapper<DetectBarcodesOnImagesResult>>

---

applyImageFilter(...)

applyImageFilter(args: { imageFileUri: string; filter: ImageFilterType; }) => Promise<ResultWrapper<ApplyImageFilterResult>>

Param	Type
args	{ imageFileUri: string; filter: ImageFilterType; }

Returns: Promise<ResultWrapper<ApplyImageFilterResult>>

---

applyImageFilterOnPage(...)

applyImageFilterOnPage(args: { page: Page; filter: ImageFilterType; }) => Promise<ResultWrapper<ApplyImageFilterOnPageResult>>

Param	Type
args	{ page: Page; filter: ImageFilterType; }

Returns: Promise<ResultWrapper<ApplyImageFilterOnPageResult>>

---

getImageData(...)

getImageData(args: { imageFileUri: string; }) => Promise<ResultWrapper<GetImageDataResult>>

Param	Type
args	{ imageFileUri: string; }

Returns: Promise<ResultWrapper<GetImageDataResult>>

---

rotateImage(...)

rotateImage(args: { imageFileUri: string; degrees: number; }) => Promise<ResultWrapper<RotateImageResult>>

Param	Type
args	{ imageFileUri: string; degrees: number; }

Returns: Promise<ResultWrapper<RotateImageResult>>

---

createPage(...)

createPage(args: { imageUri: string; }) => Promise<ResultWrapper<CreatePageResult>>

Param	Type
args	{ imageUri: string; }

Returns: Promise<ResultWrapper<CreatePageResult>>

---

removePage(...)

removePage(args: { page: Page; }) => Promise<ResultWrapper<RemovePageResult>>

Param	Type
args	{ page: Page; }

Returns: Promise<ResultWrapper<RemovePageResult>>

---

rotatePage(...)

rotatePage(args: { page: Page; times: number; }) => Promise<ResultWrapper<RotatePageResult>>

Param	Type
args	{ page: Page; times: number; }

Returns: Promise<ResultWrapper<RotatePageResult>>

---

setDocumentImage(...)

setDocumentImage(args: { page: Page; imageFileUri: string; }) => Promise<ResultWrapper<SetDocumentImageResult>>

Param	Type
args	{ page: Page; imageFileUri: string; }

Returns: Promise<ResultWrapper<SetDocumentImageResult>>

---

detectDocument(...)

detectDocument(args: { imageFileUri: string; }) => Promise<ResultWrapper<DetectDocumentResult>>

Param	Type
args	{ imageFileUri: string; }

Returns: Promise<ResultWrapper<DetectDocumentResult>>

---

detectDocumentOnPage(...)

detectDocumentOnPage(args: { page: Page; }) => Promise<ResultWrapper<DetectDocumentOnPageResult>>

Param	Type
args	{ page: Page; }

Returns: Promise<ResultWrapper<DetectDocumentOnPageResult>>

---

documentQualityAnalyzer(...)

documentQualityAnalyzer(args: { imageFileUri: string; imageSizeLimit?: number; }) => Promise<ResultWrapper<DocumentQualityAnalyzerResult>>

Param	Type
args	{ imageFileUri: string; imageSizeLimit?: number; }

Returns: Promise<ResultWrapper<DocumentQualityAnalyzerResult>>

---

extractImagesFromPdf(...)

extractImagesFromPdf(args: ExtractImagesFromPdfArguments) => Promise<ResultWrapper<ExtractImagesFromPdfResult>>

Param	Type
args	ExtractImagesFromPdfArguments

Returns: Promise<ResultWrapper<ExtractImagesFromPdfResult>>

---

extractPagesFromPdf(...)

extractPagesFromPdf(args: ExtractPagesFromPdfArguments) => Promise<ResultWrapper<ExtractPagesFromPdfResult>>

Param	Type
args	ExtractPagesFromPdfArguments

Returns: Promise<ResultWrapper<ExtractPagesFromPdfResult>>

---

recognizeCheck(...)

recognizeCheck(args: { imageFileUri: string; acceptedCheckStandards?: CheckStandard[]; }) => Promise<ResultWrapper<RecognizeCheckResult>>

Param	Type
args	{ imageFileUri: string; acceptedCheckStandards?: CheckStandard[]; }

Returns: Promise<ResultWrapper<RecognizeCheckResult>>

---

recognizeMrz(...)

recognizeMrz(args: { imageFileUri: string; }) => Promise<ResultWrapper<RecognizeMRZResult>>

Param	Type
args	{ imageFileUri: string; }

Returns: Promise<ResultWrapper<RecognizeMRZResult>>

---

refreshImageUris(...)

refreshImageUris(args: { pages: Page[]; }) => Promise<ResultWrapper<RefreshImageUrisResult>>

Param	Type
args	{ pages: Page[]; }

Returns: Promise<ResultWrapper<RefreshImageUrisResult>>

---

getOCRConfigs()

getOCRConfigs() => Promise<ResultWrapper<GetOCRConfigsResult>>

Returns: Promise<ResultWrapper<GetOCRConfigsResult>>

---

cleanup()

cleanup() => Promise<ResultWrapper<void>>

Returns: Promise<ResultWrapper<void>>

---

getFilteredDocumentPreviewUri(...)

getFilteredDocumentPreviewUri(args: { page: Page; filter: ImageFilterType; }) => Promise<ResultWrapper<GetFilteredDocumentPreviewUriResult>>

Param	Type
args	{ page: Page; filter: ImageFilterType; }

Returns: Promise<ResultWrapper<GetFilteredDocumentPreviewUriResult>>

---

performOCR(...)

performOCR(args: PerformOCRArguments) => Promise<ResultWrapper<PerformOCRResult>>

Param	Type
args	PerformOCRArguments

Returns: Promise<ResultWrapper<PerformOCRResult>>

---

createPDF(...)

createPDF(args: CreatePDFArguments) => Promise<ResultWrapper<CreatePDFResult>>

Param	Type
args	CreatePDFArguments

Returns: Promise<ResultWrapper<CreatePDFResult>>

---

writeTIFF(...)

writeTIFF(args: WriteTIFFArguments) => Promise<ResultWrapper<WriteTIFFResult>>

Param	Type
args	WriteTIFFArguments

Returns: Promise<ResultWrapper<WriteTIFFResult>>

---

Interfaces

DocumentScannerResult

Prop	Type	Description
pages	Page[]	The array of scanned pages

Page

SDK Page

Prop	Type	Description
pageId	string	A string identifying the page in the internal page file storage
polygon	PolygonPoint[]	The page's cropping polygon as calculated by a document detection operation or as set by the cropping UI. Modifying the polygon will change the polygon as shown in the cropping UI but will not automatically re-crop the original image
detectionResult	DetectionStatus	The document detection result status for the operation that produced the page
pageImageSource	PageImageSource	The image source
filter	ImageFilterType	The Image Filter that was applied on the page image
documentImageSizeLimit	Size	The value that was set for documentImageSizeLimit, which limits the maximum size of the document image.
originalImageFileUri	string	File URI of the original image
documentImageFileUri	string	File URI of the cropped document image (if document detection was successful)
originalPreviewImageFileUri	string	File URI of a screen-sized preview of the original image
documentPreviewImageFileUri	string	File URI of a screen-sized preview of the document image (if document detection was successful)

PolygonPoint

Polygon Point

Prop	Type	Description
x	number	Polygon point X
y	number	Polygon point Y

Size

Standard size object

Prop	Type	Description
width	number	Width parameter
height	number	Height parameter

DocumentScannerConfiguration

Prop	Type	Description
acceptedAngleScore	number	The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0.
acceptedSizeScore	number	The minimum document width or height in percent (0 - 100) of the screen size to accept a detected document. Default is 80.0.
autoSnappingButtonHidden	boolean	Controls whether the auto-snapping toggle button is hidden or not.
autoSnappingButtonTitle	string	Title of the auto-snapping toggle button.
autoSnappingEnabled	boolean	When auto-snapping is enabled the document scanner will take a photo automatically when a document is detected, conditions are good and the auto-snapping time-out elapses. In this mode the user can still tap the shutter button to snap a document.
autoSnappingSensitivity	number	Controls the auto-snapping speed. Sensitivity must be within the 0..1 range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds. The default value is 0.66 (2 seconds)
autoSnappingDelay	number	The minimum delay in seconds between two consecutive automatic image captures. iOS only.
bottomBarBackgroundColor	string	The background color of the bottom shutter-bar.
bottomBarButtonsColor	string	The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraBackgroundColor	string	The color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. Fit-In or Fill-In.
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
cameraUnavailableExplanationText	string	String being displayed on the label describing that the app is in split mode and needs to go fullscreen to work with camera. iOS only.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
cancelButtonTitle	string	Title of the cancel button.
defaultPageFilter	ImageFilterType	The default image filter type for new documents pages. Defaults to ImageFilterTypeNone.
detectorMode	DocumentDetectorMode	The mode of the document detector to be used for document outline detection. Defaults to ML_BASED. iOS only. For Android, use the Scanbot SDK initializer.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not.
flashButtonTitle	string	Title of the flash toggle button.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
forceUserGuidance	boolean	Shows the user guidance elements if autosnapping is disabled.
ignoreBadAspectRatio	boolean	Sets whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status. By default BadAspectRatio is not ignored.
imageScale	number	The image scaling factor. The factor must be within the 0..1 range. A factor of 1 means that the resulting images retain their original size. When the factor is less than 1, resulting images will be made smaller by that factor. By default the scale is 1.
multiPageButtonHidden	boolean	Controls whether the multi-page toggle button is hidden or not.
multiPageButtonTitle	string	Title of the multi-page mode toggle button.
multiPageEnabled	boolean	Controls multi-page mode. When enabled, the user can take multiple document photos before closing the screen by tapping the page counter button. When disabled, the screen will be closed immediately after the first document photo is made. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
pageCounterButtonTitle	string	Title suffix of the button that finishes the document scanning when multi-page scanning is enabled. The button's title has the format "# Pages", where '#' shows the number of images captured up to now and the suffix "Pages" is set using this method.
photoQualityPrioritization	CapturePhotoQualityPrioritization	The prioritization of still image quality and capturing speed. Defaults to CapturePhotoQualityPrioritization.BALANCED. If you experience lots of blurry still images try to set this property to CapturePhotoQualityPrioritization.QUALITY. Note: Has no effect on devices prior to iOS 13.0!. iOS only.
polygonBackgroundColor	string	The background color of the detected document outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX).
polygonBackgroundColorOK	string	The background color of the detected document outline when we are ready to snap OK.
polygonColor	string	The color of the detected document outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All detection statuses in net.doo.snap.lib.detector.DetectionResult that have the OK_BUT_XXX prefix).
polygonColorOK	string	The color of the detected document outline when we are ready to snap OK.
polygonLineWidth	number	Width of the detected document outline.
polygonCornerRadius	number	The radius to use when drawing rounded corners of the polygon. Default is 8.0.
polygonAutoSnapProgressColor	string	Stroke color of polygon auto snap progress animation. Default is green. Can't be nil.
polygonAutoSnapProgressLineWidth	number	Line width of polygon auto snap progress animation. Default is 5.0.
polygonAutoSnapProgressEnabled	boolean	Whether polygon auto snap progress animation is enabled or not. Default is true.
requiredAspectRatios	AspectRatio[]	An optional array of aspect ratios the documents have to conform to.
preferredAspectRatios	AspectRatio[]	An optional array of aspect ratios the documents may conform to.
shutterButtonAutoInnerColor	string	Whether polygon auto snap progress animation is enabled or not. Default is true.
shutterButtonAutoOuterColor	string	The background color of the shutter button in auto-snapping mode.
shutterButtonIndicatorColor	string	The indicator color of the shutter button in auto-snapping mode. iOS only.
shutterButtonManualInnerColor	string	The foreground color of the shutter button in manual mode.
shutterButtonManualOuterColor	string	The background color of the shutter button in manual mode.
stopsCameraSessionWhenDisappeared	boolean	The camera session will be stopped entirely, when the receiver disappears and restarts when the receiver reappears if set to True else will pause the delivery of video frames and QR Codes. Defaults to True. iOS only.
textHintBadAngles	string	Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES
textHintBadAspectRatio	string	Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO
textHintNothingDetected	string	Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED
textHintOffCenter	string	The text being displayed on the user-guidance label, when a document was detected, but its center is too far away from the image center.
textHintOK	string	Text hint that will be shown when the current detection status is OK
textHintTooDark	string	Text hint that will be shown when the current detection status is ERROR_TOO_DARK
textHintTooNoisy	string	Text hint that will be shown when the current detection status is ERROR_TOO_NOISY
textHintTooSmall	string	Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
userGuidanceBackgroundColor	string	The background color of the user guidance hints.
userGuidanceTextColor	string	The text color of the user guidance hints.
userGuidanceFontSize	number	Font size of the user guidance. Default is 17.0.
documentImageSizeLimit	Size	Limits the maximum size of the document image. If width or height are zero, this property is effectively ignored.
shutterButtonHidden	boolean	Hides the shutter button if set to TRUE. Shows it otherwise. Defaults to FALSE. If set to TRUE, auto-snapping is enabled and the property autoSnappingEnabled of the behaviour configuration will have no effect. Also the auto-snapping button will be hidden.
textHintEnergySavingActive	string	The text being displayed on the user-guidance label, when the scanners energy saver is activated. iOS only.
maxNumberOfPages	number	Maximum number of pages to scan. Ignored when set to null, or when multiPageEnabled is FALSE. Default value is null.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
accessibilityConfiguration	DocumentScannerAccessibilityConfiguration	Allows you to customize the accessibility configuration for the Document Scanner UI

AspectRatio

Finder aspect ratio

Prop	Type	Description
width	number	The width component of the aspect ratio.
height	number	The height component of the aspect ratio.

DocumentScannerAccessibilityConfiguration

Document scanner accessibility configuration

Prop	Type	Description
flashButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the flash button.
flashButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the flash button.
multiPageButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the multi-page button.
multiPageButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the multi-page button.
autoSnappingButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the auto-snapping button.
autoSnappingButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the auto-snapping button.
cancelButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the cancel button.
cancelButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the cancel button.
pageCounterButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the page-amount button.
pageCounterAccessibilityHint	string	Text, that is used as an accessibility hint for the page-amount button.
shutterButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the shutter button.
shutterButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the shutter button.

FinderDocumentScannerConfiguration

Prop	Type	Description
acceptedAngleScore	number	The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0.
acceptedSizeScore	number	The minimum document width or height in percent (0 - 100) of the screen size to accept a detected document. Default is 80.0.
autoSnappingEnabled	boolean	When auto-snapping is enabled the document scanner will take a photo automatically when a document is detected, conditions are good and the auto-snapping time-out elapses. In this mode the user can still tap the shutter button to snap a document.
autoSnappingSensitivity	number	Controls the auto-snapping speed. Sensitivity must be within the 0..1 range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds. The default value is 0.66 (2 seconds)
autoSnappingDelay	number	The minimum delay in seconds between two consecutive automatic image captures. iOS only.
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraBackgroundColor	string	The color of the camera background (relevant only when the camera preview mode is CameraPreviewMode.FIT_IN).
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. Fit-In or Fill-In.
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
cameraUnavailableExplanationText	string	String being displayed on the label describing that the app is in split mode and needs to go fullscreen to work with camera. iOS only.
cancelButtonTitle	string	Title of the cancel button.
defaultPageFilter	ImageFilterType	The default image filter type for new documents pages. Defaults to ImageFilterTypeNone.
detectorMode	DocumentDetectorMode	The mode of the document detector to be used for document outline detection. Defaults to ML_BASED. iOS only. For Android, use the Scanbot SDK initializer.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
forceUserGuidance	boolean	Shows the user guidance elements if autosnapping is disabled.
finderEnabled	boolean	Enables the view finder.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
cameraOverlayColor	string	Background color outside of the finder window.
finderAspectRatio	AspectRatio	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is the DIN A4 aspect ratio.
ignoreBadAspectRatio	boolean	Sets whether to ignore the OK_BUT_BAD_ASPECT_RATIO detection status. By default BadAspectRatio is not ignored.
imageScale	number	The image scaling factor. The factor must be within the 0..1 range. A factor of 1 means that the resulting images retain their original size. When the factor is less than 1, resulting images will be made smaller by that factor. By default the scale is 1.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
photoQualityPrioritization	CapturePhotoQualityPrioritization	The prioritization of still image quality and capturing speed. Defaults to CapturePhotoQualityPrioritization.BALANCED. If you experience lots of blurry still images try to set this property to CapturePhotoQualityPrioritization.QUALITY. Note: Has no effect on devices prior to iOS 13.0!.
polygonEnabled	boolean	Enables the displaying of the documents polygon.
polygonBackgroundColor	string	The background color of the detected document outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX).
polygonBackgroundColorOK	string	The background color of the detected document outline when we are ready to snap OK.
polygonColor	string	The color of the detected document outline when the document's angle, size or aspect ratio is not yet sufficiently good. (All detection statuses in net.doo.snap.lib.detector.DetectionResult that have the OK_BUT_XXX prefix).
polygonColorOK	string	The color of the detected document outline when we are ready to snap OK.
polygonLineWidth	number	Width of the detected document outline.
polygonCornerRadius	number	The radius to use when drawing rounded corners of the polygon. Default is 8.0.
autoSnapProgressColor	string	Stroke color of polygon or finder auto snap progress animation. Default is green. Can't be nil.
autoSnapProgressLineWidth	number	Line width of polygon or finder auto snap progress animation. Default is 5.0.
autoSnapProgressEnabled	boolean	Whether polygon or finder auto snap progress animation is enabled or not. Default is true.
lockDocumentAspectRatioToFinder	boolean	If true allows only scanning of documents with the aspect ratio that the finder has.
shutterButtonAutoInnerColor	string	Whether polygon auto snap progress animation is enabled or not. Default is true.
shutterButtonAutoOuterColor	string	The background color of the shutter button in auto-snapping mode.
shutterButtonIndicatorColor	string	The indicator color of the shutter button in auto-snapping mode. iOS only.
shutterButtonManualInnerColor	string	The foreground color of the shutter button in manual mode.
shutterButtonManualOuterColor	string	The background color of the shutter button in manual mode.
stopsCameraSessionWhenDisappeared	boolean	The camera session will be stopped entirely, when the receiver disappears and restarts when the receiver reappears if set to True else will pause the delivery of video frames and QR Codes. Defaults to True. iOS only.
textHintBadAngles	string	Text hint that will be shown when the current detection status is OK_BUT_BAD_ANGLES
textHintBadAspectRatio	string	Text hint that will be shown when the current detection status is OK_BUT_BAD_ASPECT_RATIO
textHintNothingDetected	string	Text hint that will be shown when the current detection status is ERROR_NOTHING_DETECTED
textHintOffCenter	string	The text being displayed on the user-guidance label, when a document was detected, but its center is too far away from the image center.
textHintOK	string	Text hint that will be shown when the current detection status is OK
textHintTooDark	string	Text hint that will be shown when the current detection status is ERROR_TOO_DARK
textHintTooNoisy	string	Text hint that will be shown when the current detection status is ERROR_TOO_NOISY
textHintTooSmall	string	Text hint that will be shown when the current detection status is OK_BUT_TOO_SMALL
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
userGuidanceBackgroundColor	string	The background color of the user guidance hints.
userGuidanceTextColor	string	The text color of the user guidance hints.
userGuidanceFontSize	number	Font size of the user guidance. Default is 17.0.
documentImageSizeLimit	Size	Limits the maximum size of the document image. If width or height are zero, this property is effectively ignored.
shutterButtonHidden	boolean	Hides the shutter button if set to TRUE. Shows it otherwise. Defaults to TRUE. If set to TRUE, auto-snapping is enabled and the property autoSnappingEnabled of the behaviour configuration will have no effect. Also the auto-snapping button will be hidden.
textHintEnergySavingActive	string	The text being displayed on the user-guidance label, when the scanners energy saver is activated. iOS only.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
accessibilityConfiguration	FinderDocumentScannerAccessibilityConfiguration	Allows you to customize the accessibility configuration for the Document Scanner UI

FinderDocumentScannerAccessibilityConfiguration

Finder Document scanner accessibility configuration

Prop	Type	Description
flashButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the flash button.
flashButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the flash button.
cancelButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the cancel button.
cancelButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the cancel button.
shutterButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the shutter button.
shutterButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the shutter button.

CroppingResult

Prop	Type	Description
page	Page	The cropped page

CroppingConfiguration

Prop	Type	Description
cancelButtonTitle	string	Title of the cancel button.
hintTitle	string	Text of the edit screen hint.
hintTitleColor	string	Color of the edit screen hint text.
backgroundColor	string	Background color of the screen.
rotateButtonTitle	string	Title of the Rotate button.
resetButtonTitle	string	Title of the Reset button.
detectButtonTitle	string	Title of the Detect button.
doneButtonTitle	string	Title of the Done button.
rotateButtonHidden	boolean	Changes the visibility of the Rotate button.
detectResetButtonHidden	boolean	Changes the visibility of Detect and Reset buttons.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
polygonColor	string	Default color of the cropping outline.
anchorPointsColor	string	Default color of the cropping draggable elements.
polygonColorMagnetic	string	Outline color of magnetically snapped edges.
polygonLineWidth	number	Width of the detected document outline.
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
bottomBarBackgroundColor	string	The background color of the bottom shutter-bar.
bottomBarButtonsColor	string	The color of the title of all buttons in the bottom shutter-bar (Cancel button, etc.), as well as the camera permission prompt button.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
swapTopBottomButtons	boolean	Swap top and bottom buttons on the screen
topBarTitle	string	The title of the Cropping UI Screen. iOS only
topBarTitleColor	string	The color of the title. iOS only
accessibilityConfiguration	CroppingAccessibilityConfiguration	Allows you to customize the accessibility configuration for the Cropping UI

CroppingAccessibilityConfiguration

Cropping screen accessibility configuration

Prop	Type	Description
cancelButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the cancel button
cancelButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the cancel button
doneButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the done button
doneButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the done button.
detectButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the detect button
detectButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the detect button
resetButtonAccessibilityLabel	string	Text, that is used as an accessibility label for the reset button
resetButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the reset button
rotateButtonAccessibilityLabel	string	Text, that is used as an accessibility hint for the rotate button
rotateButtonAccessibilityHint	string	Text, that is used as an accessibility hint for the rotate button

MrzScannerResult

MrzScannerConfiguration

Prop	Type	Description
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraOverlayColor	string	Background color outside of the finder window.
cancelButtonTitle	string	Title of the cancel button.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
finderTextHint	string	String being displayed as description.
finderTextHintColor	string	Foreground color of the description label.
finderAspectRatio	AspectRatio	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 7 - which is good for standard machine readable zones.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	Title of the flash toggle button. iOS only.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
successBeepEnabled	boolean	Controls whether to play a beep sound after a successful detection. Default value is TRUE.
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon	boolean	If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

BarcodeScannerResult

Prop	Type	Description
barcodes	BarcodeResultField[]	The array of detected barcodes

BarcodeResultField

The Barcode Scanner Result Field

Prop	Type	Description
type	BarcodeFormat	The recognized barcode type
text	string	The recognized barcode text
textWithExtension	string	The recognized barcode text with extension (if available)
rawBytes	number[]	The array of raw bytes that compose the recognized barcode
parsedSuccessful	boolean	True if the Barcode Document has been parsed successfully
formattedResult	AAMVADocumentFormat | BoardingPassDocumentFormat | GS1DocumentFormat | IDCardPDF417DocumentFormat | MedicalCertificateDocumentFormat | MedicalPlanDocumentFormat | SEPADocumentFormat | SwissQRCodeDocumentFormat | VCardDocumentFormat	The formatted barcode document (if it was parsed succesfully)

AAMVADocumentFormat

AAMVA Document Format

Prop	Type	Description
headerRawString	string	Header Raw String
fileType	string	File Type
issuerIdentificationNumber	string	Issuer Identification Number
aamvaVersionNumber	string	AAMVA Version Number
jurisdictionVersionNumber	string	Jurisdiction Version Number
numberOfEntries	number	Number of entries
subfiles	AAMVADocumentSubfile[]	Sub-files

AAMVADocumentSubfile

AAMVA Document Sub-File

Prop	Type	Description
subFileType	string	Sub-file type
subFileRawHeader	string	Sub-file raw header
fields	AAMVADocumentSubfileField[]	Sub-file fields

AAMVADocumentSubfileField

AAMVA Document Sub-File Field

Prop	Type	Description
type	AAMVARecordFieldType	AAMVA Document sub-file Record Field Type
typeString	string	AAMVA Document sub-file Field Type String
value	string	AAMVA Document sub-file Field value
rawValue	string	AAMVA Document sub-file Field raw value

BoardingPassDocumentFormat

Boarding Pass Document Format

Prop	Type	Description
numberOfLegs	number	Number of legs
electronicTicket	boolean	True if electronic ticket, false otherwise
securityData	string	Security Data
legs	BoardingPassLeg[]	Legs

BoardingPassLeg

Boarding Pass Leg

Prop	Type	Description
fields	BoardingPassLegField[]	Boarding Pass Leg Fields

BoardingPassLegField

Boarding Pass Leg Field

Prop	Type	Description
type	BoardingPassDocumentFieldType	Boarding Pass Document Field Type
value	string	Boarding Pass Document Field Value

GS1DocumentFormat

GS1 Document Format

Prop	Type	Description
fields	GS1DocumentField[]	GS1 Document fields

GS1DocumentField

GS1 Document Field

Prop	Type	Description
rawValue	string	Field raw value
applicationIdentifier	string	Application Identifier
dataTitle	string	Data Title
fieldDescription	string	Field description
standard	boolean	True if it is standard, false otherwise
validationStatus	GS1SystemElementValidationStatus	Validation Status

IDCardPDF417DocumentFormat

ID Card PDF417 Document Format

Prop	Type	Description
fields	IDCardPDF417DocumentField[]	ID Card PDF417 Document Fields

IDCardPDF417DocumentField

ID Card PDF417 Document Field

Prop	Type	Description
type	IDCardPDF417DocumentFieldType	Field Type
value	string	Field Value

MedicalCertificateDocumentFormat

Medical Certificate Document Format

Prop	Type	Description
fields	MedicalCertificateDocumentField[]	Medical Certificate Document Fields

MedicalCertificateDocumentField

Medical Certificate Document Field

Prop	Type	Description
type	MedicalCertificateDocumentFieldType	Medical Certificate Document Field Type
value	string	Medical Certificate Document Field Value

MedicalPlanDocumentFormat

Medical Plan Document Format

Prop	Type	Description
GUID	string	Identifier
currentPage	number	Current page (index)
totalNumberOfPages	number	Total number of pages
documentVersionNumber	string	Document version number
patchVersionNumber	string	Patch version number
languageCountryCode	string	Language country code
patient	MedicalPlanPatientInformation	Patient Information
doctor	MedicalPlanDoctorInformation	Doctor Information
subheadings	MedicalPlanStandardSubheading[]	Subheadings

MedicalPlanPatientInformation

Medical Plan Patient Information

Prop	Type	Description
fields	MedicalPlanPatientField[]	Medical Plan Patient Fields

MedicalPlanPatientField

Medical Plan Patient Field

Prop	Type	Description
type	MedicalPlanPatientFieldType	Medical Plan Patient Field Type
value	string	Medical Plan Patient Field Value

MedicalPlanDoctorInformation

Medical Plan Doctor Information

Prop	Type	Description
fields	MedicalPlanDoctorField[]	Medical Plan Doctor Information Fields

MedicalPlanDoctorField

Medical Plan Doctor Field

Prop	Type	Description
type	MedicalPlanDoctorFieldType	Medical Plan Doctor Field Type
value	string	Medical Plan Doctor Field Value

MedicalPlanStandardSubheading

Medical Plan Standard Subheading

Prop	Type	Description
fields	MedicalPlanStandardSubheadingField[]	Subheading Fields
generalNotes	string[]	General Notes
medicines	MedicalPlanMedicine[]	Medicines
prescriptions	MedicalPlanPrescription[]	Prescriptions

MedicalPlanStandardSubheadingField

Medical Plan Standard Subheading Field

Prop	Type	Description
type	MedicalPlanStandardSubheadingFieldType	Medical Plan Standard Subheading Field Type
value	string	Medical Plan Standard Subheading Field Value

MedicalPlanMedicine

Medical Plan Medicine

Prop	Type	Description
fields	MedicalPlanMedicineField[]	Medical Plan Medicine Fields
substances	MedicalPlanMedicineSubstance[]	Medical Plan Medicine Substances

MedicalPlanMedicineField

Medical Plan Medicine Field

Prop	Type	Description
type	MedicalPlanMedicineFieldType	Medical Plan Medicine Field Type
value	string	Medical Plan Medicine Field Value

MedicalPlanMedicineSubstance

Medical Plan Medicine Substance

Prop	Type	Description
fields	MedicalPlanMedicineSubstanceField[]	Medical Plan Medicine Substance Fields

MedicalPlanMedicineSubstanceField

Medical Plan Medicine Substance Field

Prop	Type	Description
type	MedicalPlanMedicineSubstanceFieldType	Medical Plan Medicine Substance Field Type
value	string	Medical Plan Medicine Substance Field Value

MedicalPlanPrescription

Medical Plan Prescription

Prop	Type	Description
fields	MedicalPlanPrescriptionField[]	Medical Plan Prescription Fields

MedicalPlanPrescriptionField

Medical Plan Prescription Field

Prop	Type	Description
type	MedicalPlanPrescriptionFieldType	Medical Plan Prescription Field Type
value	string	Medical Plan Prescription Field Value

SEPADocumentFormat

SEPA Document Format

Prop	Type	Description
fields	SEPADocumentFormatField[]	SEPA Document Format Fields

SEPADocumentFormatField

SEPA Document Format Field

Prop	Type	Description
type	SEPADocumentFieldType	SEPA Document Field Type
value	string	SEPA Document Field Value

SwissQRCodeDocumentFormat

Swiss QR Code Document Format

Prop	Type	Description
fields	SwissQRCodeDocumentField[]	Swiss QR Code Document Fields
version	SwissQRCodeVersion	Swiss QR Code Version

SwissQRCodeDocumentField

Swiss QR Code Document Field

Prop	Type	Description
type	SwissQRCodeDocumentFieldType	Swiss QR Code Document Field Type
value	string	Swiss QR Code Document Field Value
typeHumanReadableString	string	Swiss QR Code Document Field Human-readable String

VCardDocumentFormat

vCard Document Format

Prop	Type	Description
fields	VCardDocumentFormatField[]	vCard Document Format Fields

VCardDocumentFormatField

vCard Document Field

Prop	Type	Description
type	VCardDocumentFormatFieldType	vCard Document Field Type
typeModifiers	string[]	vCard Document Field Type Modifiers
rawText	string	vCard Document Field Raw Text
values	string[]	vCard Document Field Values

BarcodeScannerConfiguration

Prop	Type	Description
acceptedDocumentFormats	BarcodeDocumentFormat[]	An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
barcodesExtensionFilter	BarcodesExtensionFilter	The extension filter for EAN and UPC barcodes.
barcodeValueFilter	string	Filter barcodes results by regular expression. To accept scanned barcode, regular expression should match the entire barcode value. By default, no filter is applied
cameraOverlayColor	string	Background color of the detection overlay.
cameraModule	CameraModule	Background color of the detection overlay.
cameraZoomFactor	number	The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in. Default value is 0.0.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
cancelButtonTitle	string	String being displayed on the cancel button.
engineMode	EngineMode	The engine mode to be used for barcode scanning. The default value is NEXT_GEN.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
finderTextHint	string	String being displayed as description.
finderTextHintColor	string	Foreground color of the description label.
finderAspectRatio	AspectRatio	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	String being displayed on the flash button. iOS only.
flashButtonInactiveColor	string	Foreground color of the flash button when flash is off.
flashEnabled	boolean	Whether flash is toggled on or off.
focusLockEnabled	boolean	Disables auto-focus and locks the lens at the specified focus lock lens position. Default value is false. iOS only. For Android, minFocusDistanceLock can be used.
focusLockPosition	number	The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). The default value is 0.0 iOS only. For Android, minFocusDistanceLock can be used.
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
minimumTextLength	number	Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
maximumTextLength	number	Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
minFocusDistanceLock	boolean	Lock focus distance withing minimum possible range
minimum1DBarcodesQuietZone	number	Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE - This feature works on ITF barcodes only.
stripCheckDigits	boolean	With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false
successBeepEnabled	boolean	Whether scanner screen should make a sound on successful barcode or MRZ detection.
topBarBackgroundColor	string	Background color of the top bar.
topBarButtonsColor	string	Foreground color of the cancel button.
barcodeFormats	BarcodeFormat[]	Accepted barcode formats
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon	boolean	If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
cameraZoomRange	ZoomRange	The range of valid camera zoom factors. Default value is (1.0; 12.0).
autoCancelTimeout	number	Sets auto close timer in seconds. 0 = disabled and it is the default value.
gs1HandlingMode	Gs1HandlingMode	The GS1 handling mode. The default value is PARSE.
msiPlesseyChecksumAlgorithm	MSIPlesseyChecksumAlgorithm	The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.
lowPowerMode	boolean	If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.
codeDensity	CodeDensity	The expected density of QR codes in an image.
initialScanDelay	number	Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
delayAfterScan	number	Freezes a preview after a scan for a given amount of seconds. Defaults to 0 secs. Android only.
doubleTapToZoomEnabled	boolean	When this property is set to true, the zoom can be activated by double tapping somewhere in the receivers view. iOS only.
pinchToZoomEnabled	boolean	When this property is set to true, the zoom can be activated by a pinch gesture somewhere in the receivers view. iOS only.
shouldAnimateZooming	boolean	Defines, if zooming in or out should be animated. iOS only.
viewFinderEnabled	boolean	Display the region of interest. The default value is TRUE.
confirmationDialogConfiguration	ConfirmationDialogConfiguration	The confirmation dialog configuration.
overlayConfiguration	SelectionOverlayConfiguration	The selection overlay configuration.

ZoomRange

Defines a range for zooming

Prop	Type	Description
minZoom	number	The minimum zoom scale. Defaults to 1.0.
maxZoom	number	The maximum zoom scale. Defaults to 12.0.

ConfirmationDialogConfiguration

Confirmation Dialog configuration

Prop	Type	Description
resultWithConfirmationEnabled	boolean	Defines, if the confirmation dialog should be displayed or not before returing the results to the delegate. Defaults to False.
dialogTextFormat	BarcodeDialogFormat	The text format of the result dialog. Defaults to TYPE_AND_CODE.
confirmationDialogStyle	DialogStyle	The style of the confirmation dialog. iOS only.
confirmButtonTitle	string	The title of the confirmation dialog confirm button.
confirmationDialogConfirmButtonStyle	DialogButtonStyle	The style of the confirmation dialogs confirm button. iOS only.
retryButtonTitle	string	The title of the confirmation dialog retry button.
confirmationDialogRetryButtonStyle	DialogButtonStyle	The style of the confirmation dialogs retry button. iOS only.
dialogTitle	string	The title of the confirmation dialog.
dialogMessage	string	The message text of the confirmation dialog.
dialogButtonsAccentColor	string	The accent color of buttons on a confirmation dialog. Android only.
confirmButtonFilled	boolean	Allows to set if the confirm button should be filled. Defaults to TRUE. Android only.
confirmButtonFilledTextColor	string	Allows to set a text color of the filled button. See confirmationDialogConfirmButtonFilled. Android only.

DialogStyle

Configuration for the dialog/alert style

Prop	Type	Description
screenBackgroundColor	string	The Color of the screen-covering backdrop view.
dialogBackgroundColor	string	The general background color of the actual dialog view.
dialogBackgroundEffect	BlurEffect	The visual effect of the dialogs background.
cornerRadius	number	The corner radius of the dialog.
titleColor	string	The color of the dialogs title.
titleFont	Font	The font of the dialogs title
messageColor	string	The color of the dialogs message.
messageFont	Font	The font of the dialogs message.
separatorColor	string	The color of the separators around the dialogs button area.
separatorWidth	number	The width of the separators in points.

Font

The font name and size. iOS only.

Prop	Type	Description
fontName	string	The font name. defaults to SYSTEM.
fontSize	number	The font size. defaults 17.0 .

DialogButtonStyle

Configuration for the dialogs/alerts OK button style.

Prop	Type	Description
font	Font	The font of the button title.
textColor	string	The color of the buttons title while not pressed.
highlightedTextColor	string	The color of the buttons title while pressed.
backgroundColor	string	The background color of the button while not pressed.
highlightedBackgroundColor	string	The background color of the button while pressed.

SelectionOverlayConfiguration

Barcode Selection Overlay configuration

Prop	Type	Description
overlayEnabled	boolean	Whether the barcode selection overlay is enabled or not.
automaticSelectionEnabled	boolean	Whether the barcode is selected automatically when being detected or not.
textFormat	BarcodeOverlayTextFormat	Define the way of how to show barcode data with selection overlay.
polygonColor	string	The color of the polygon in the selection overlay.
textColor	string	The color of the text in the selection overlay.
textContainerColor	string	The color of the texts background in the selection overlay.
highlightedPolygonColor	string	The color of the polygon in the selection overlay, when highlighted.
highlightedTextColor	string	The color of the text in the selection overlay, when highlighted.
highlightedTextContainerColor	string	The color of the texts background in the selection overlay, when highlighted.

BatchBarcodeScannerResult

BatchBarcodeScannerConfiguration

Prop	Type	Description
acceptedDocumentFormats	BarcodeDocumentFormat[]	An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
barcodesExtensionFilter	BarcodesExtensionFilter	The extension filter for EAN and UPC barcodes.
barcodeValueFilter	string	Filter barcodes results by regular expression. To accept scanned barcode, regular expression should match the entire barcode value. By default, no filter is applied
cameraOverlayColor	string	Background color of the detection overlay.
cameraModule	CameraModule	Background color of the detection overlay.
cameraZoomFactor	number	The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in. The default value is 0.
cameraZoomRange	ZoomRange	The range of valid camera zoom factors. Default value is (0.0; 12.0). iOS only.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
cancelButtonTitle	string	String being displayed on the cancel button.
doubleTapToZoomEnabled	boolean	When this property is set to true, the zoom can be activated by double tapping somewhere in the receivers view. iOS only.
pinchToZoomEnabled	boolean	When this property is set to true, the zoom can be activated by a pinch gesture somewhere in the receivers view. iOS only.
shouldAnimateZooming	boolean	Defines, if zooming in or out should be animated. iOS only.
engineMode	EngineMode	String being displayed on the cancel button.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
finderTextHint	string	String being displayed as description.
finderTextHintColor	string	Foreground color of the description label.
finderAspectRatio	AspectRatio	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	String being displayed on the flash button. iOS only.
flashEnabled	boolean	Whether flash is toggled on or off.
focusLockEnabled	boolean	Disables auto-focus and locks the lens at the specified focus lock lens position. The default value is false. iOS only.
focusLockPosition	number	The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). The default value is 0.0 iOS only. For Android, minFocusDistanceLock can be used.
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
minimumTextLength	number	Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
maximumTextLength	number	Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
minimum1DBarcodesQuietZone	number	Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE - This feature works on ITF barcodes only.
minFocusDistanceLock	boolean	Lock focus distance withing minimum possible range
stripCheckDigits	boolean	With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false
successBeepEnabled	boolean	Whether scanner screen should make a sound on successful barcode or MRZ detection.
topBarBackgroundColor	string	Background color of the top bar.
topBarButtonsColor	string	Foreground color of the cancel button.
topBarButtonsInactiveColor	string	Foreground color of the top bar buttons when disabled.
barcodeFormats	BarcodeFormat[]	Accepted barcode formats
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
gs1HandlingMode	Gs1HandlingMode	The GS1 handling mode. The default value is PARSE.
msiPlesseyChecksumAlgorithm	MSIPlesseyChecksumAlgorithm	The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.
lowPowerMode	boolean	If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.
barcodesCountText	string	The color for barcodes count text
barcodesCountTextColor	string	The color for barcodes count text
clearButtonTitle	string	Text of the button which clears the list of scanned barcodes.
detailsActionColor	string	The color of Submit button
detailsBackgroundColor	string	The color of bottom sheet
detailsPrimaryColor	string	The color of text elements in bottom sheet
deleteButtonTitle	string	String being displayed on the delete button. iOS only.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
fetchingStateText	string	The text for the data fetching state of the barcode item in a list. Smth "Fetching info…"
noBarcodesTitle	string	Text of the message that there are no barcodes scanned
submitButtonTitle	string	Text of the button which finishes the flow
codeDensity	CodeDensity	The expected density of QR codes in an image.
replaceCancelButtonWithIcon	boolean	If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
autoCancelTimeout	number	Sets auto close timer in seconds. 0 = disabled and it is the default value. Android only
initialScanDelay	number	Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
viewFinderEnabled	boolean	Display the region of interest. The default value is TRUE.
overlayConfiguration	SelectionOverlayConfiguration	The selection overay configuration.

HealthInsuranceCardScannerResult

Prop	Type	Description
fields	HealthInsuranceCardField[]	The array of recognized Health Insurance Card fields

HealthInsuranceCardField

The Health Insurance Card field

Prop	Type	Description
type	string	Health Insurance Card Field Type
value	string	Health Insurance Card Field Recognized Text
confidence	number	Confidence in result accuracy. The value ranges from 0 to 100, higher is better.

HealthInsuranceCardScannerConfiguration

Prop	Type	Description
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraOverlayColor	string	Background color outside of the finder window.
cancelButtonTitle	string	Title of the cancel button.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
detectionStatusFailedDetectionText	string	String being displayed when health insurance card was not found.
detectionStatusFailedValidationText	string	String being displayed when health insurance card was found but not recognized.
detectionStatusSuccessText	string	String being displayed when health insurance card was found and recognized.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
finderTextHint	string	String being displayed as description.
finderTextHintColor	string	Foreground color of the description label.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	Title of the flash toggle button. iOS only.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon	boolean	If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

TextDataScannerResult

Prop	Type	Description
result	TextDataRecognitionResult	The Text Data Scanner recognition result

TextDataRecognitionResult

The Text Data Recognition Result

Prop	Type	Description
text	string	The recognized text
confidence	number	Confidence in the accuracy of the recognition (from 0 to 100)

TextDataScannerConfiguration

Prop	Type	Description
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraOverlayColor	string	Background color outside of the finder window.
cancelButtonTitle	string	Title of the cancel button.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
finderTextHintColor	string	Foreground color of the description label.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	Title of the flash toggle button. iOS only.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
wordBoxHighlightColor	string	The color of the highlight of the wordboxes founded on the frame
wordBoxHighlightEnabled	boolean	If the wordboxes should be highlighted when were found on the frame
minimumNumberOfRequiredFramesWithEqualRecognitionResult	number	Minimum number of accumulated frames that have equal result
maximumNumberOfAccumulatedFrames	number	Maximum number of accumulated frames to inspect before actual result is returned
ocrResolutionLimit	number	The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower. 0 - do not rescale.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon	boolean	If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
textDataScannerStep	TextDataScannerStep	Configuration for the scanned item

TextDataScannerStep

Configuration for the scanned item

Prop	Type	Description
guidanceText	string	User guidance hint text.
pattern	string	Validation pattern to automatically validate recognized text. '?' = any character, '#' - any digit, all other characters represent themselves. An empty string or nil value will disable the validation pattern.
shouldMatchSubstring	boolean	If set to TRUE pattern validation also validates successfully if only a part of the whole recognized text matches the the validation pattern. If set to FALSE, the whole text must match the validation pattern. Applies to pattern validation only. Defaults to FALSE.
preferredZoom	number	The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height
aspectRatio	AspectRatio	The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height
unzoomedFinderHeight	number	The preferred height of the finder for zoom scale 1.0 (unzoomed). The actual finder height might change to maintain aspect ratio and to not clip the screen. Defaults to 40 points.
allowedSymbols	string	A string (list) of accepted characters during text recognition. If empty or nil, all characters are accepted. Defaults to nil.
significantShakeDelay	number	Threshold used to pause the detection after significant movement occurred. Default = 0

LicensePlateScannerResult

Prop	Type	Description
licensePlate	string	The License Plate detected by the scanner
confidence	number	Confidence in result accuracy. The value ranges from 0 to 100, higher is better.
countryCode	string	The Country Code on the License Plate as detected by the scanner

LicensePlateScannerConfiguration

Prop	Type	Description
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraOverlayColor	string	Background color outside of the finder window.
cancelButtonTitle	string	Title of the cancel button.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
confirmationDialogStyle	DialogStyle	The style of the confirmation dialog. iOS Only.
confirmationDialogConfirmButtonStyle	DialogButtonStyle	The style of the confirmation dialogs confirm button. iOS Only.
confirmationDialogRetryButtonStyle	DialogButtonStyle	The style of the confirmation dialogs retry button. iOS Only.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
finderTextHint	string	User guidance text below the finder view
finderTextHintColor	string	Foreground color of the description label.
finderPreferredHeight	number	The preferred height of the view finder. Defaults to 150.0. iOS only.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	Title of the flash toggle button. iOS only.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
minNumberOfRequiredFramesWithEqualRecognitionResult	number	Minimum number of accumulated frames that have equal result
maximumNumberOfAccumulatedFrames	number	Maximum number of accumulated frames to inspect before actual result is returned
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
significantShakeDelay	number	Threshold used to pause the detection after significant movement occurred. -1 is default value. Default = 0 for textFilterStrategy='DOCUMENT' and 1000 for textFilterStrategy='LCD_DOT_MATRIX_DISPLAY'. Android only.
scanStrategy	LicensePlateScanStrategy	Detector mode, classic (OCR based) or ML (machine learning based) approach.
confirmationDialogTitle	string	The title of the confirmation dialog.
confirmationDialogMessage	string	The message text of the confirmation dialog.
confirmationDialogConfirmButtonTitle	string	The title of the confirmation dialog retry button.
confirmationDialogRetryButtonTitle	string	The title of the confirmation dialog confirm button.
confirmationDialogAccentColor	string	The accent color of buttons on a confirmation dialog. Android only.
confirmationDialogConfirmButtonFilled	boolean	Allows to set if the confirm button should be filled. Defaults to TRUE. Android only.
confirmationDialogConfirmButtonFilledTextColor	string	Allows to set a text color of the filled button. See confirmationDialogConfirmButtonFilled. Android only.
replaceCancelButtonWithIcon	boolean	If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

MedicalCertificateRecognizerConfiguration

Prop	Type	Description
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraOverlayColor	string	Background color outside of the finder window.
cancelButtonTitle	string	Title of the cancel button.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	Title of the flash toggle button. iOS only.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
userGuidanceBackgroundColor	string	The background color of the user guidance hints.
userGuidanceTextColor	string	The text color of the user guidance hints.
userGuidanceHidden	boolean	Whether the user guidance label is hidden or not. iOS only.
recognizePatientInfo	boolean	Whether sdk should run recognition of Patient Information block.
returnCroppedDocumentImage	boolean	Whether sdk should return cropped document image or not
errorDialogStyle	DialogStyle	The style of the dialog/alert in case of error. iOS only.
errorDialogTitle	string	Error dialog title
errorDialogAccentColor	string	The accent color of buttons on a error dialog.
errorDialogMessage	string	Error dialog message
errorDialogOkButton	string	Error dialog ok button text.
errorDialogOkButtonFilled	boolean	Allows to set if the confirm button should be filled. Android only.
errorDialogOkButtonFilledTextColor	string	Allows to set a text color of the filled button. Android only.
errorDialogButtonStyle	DialogButtonStyle	The style of the dialogs/alerts OK button in case of error. iOS only.
showFinderOverlay	boolean	Option to show or hide finder overlay
userGuidanceStrings	MedicalCertificateUserGuidanceStrings	Configuration that helps to override default hint values
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
finderAspectRatio	AspectRatio	Aspect ratio of the view finder (width \ height). Set to nil of no view finder should be displayed. iOS only.
finderSecondaryAspectRatio	AspectRatio	Secondary aspect ratio of finder frame (width \ height). Set to nil if no secondary view finder should be displayed. iOS only.

MedicalCertificateUserGuidanceStrings

Configuration for the hint values

Prop	Type	Description
startScanning	string	Text that is shown on camera open.
scanning	string	Text text that is shown when the camera is seeking for the document on the visible area, shown after the first result from the detector.
energySaving	string	Text text that is shown when energy saving is active.
capturing	string	Text that is shown when the camera snaps the image.
processing	string	Text that is shown when the detector tries to detect the document from the snapped image.
paused	string	Text that is shown when the detector is paused. iOS only.

GenericDocumentRecognizerResult

Prop	Type
documents	(MRZDocument | DeIdCardFrontDocument | DeIdCardBackDocument | DePassportDocument | DeDriverLicenseFrontDocument | DeDriverLicenseBackDocument)[]

MRZDocument

MRZ part of the document

Prop	Type	Description
unknown	Field	Unknown
documentNumber	Field	Document number
issuingAuthority	Field	Issuing authority
officeOfIssuance	Field	Office of issuance
dateOfIssuance	Field	Date of issuance
givenNames	Field	Given names
surname	Field	Surname
nationality	Field	Nationality
birthDate	Field	Birth date
gender	Field	Gender
expiryDate	Field	Expiry date
personalNumber	Field	Personal number
travelDocType	Field	Travel document type
travelDocTypeVariant	Field	Travel document type variant
optional1	Field	Optional 1
optional2	Field	Optional 2
documentTypeCode	Field	Document type code
pinCode	Field	PIN code
languageCode	Field	Language code
versionNumber	Field	Version number
checkDigitDocumentNumber	Field	Check digit document number
checkDigitBirthDate	Field	Check digit birth date
checkDigitExpiryDate	Field	Check digit expiry date
checkDigitPersonalNumber	Field	Check digit personal number
checkDigitGeneral	Field	Check digit general

Field

Document field

Prop	Type	Description
value	FieldValue	Optional value of the field
validationStatus	ValidationStatus	Field validation status. Applicable only to fields that support some kind of validation.

FieldValue

Result of GDR field recognition.

Prop	Type	Description
text	string	Recognized text
confidence	number	Confidence in result accuracy. The value ranges from 0 to 100, higher is better.

DeIdCardFrontDocument

German ID card, front side

Prop	Type	Description
id	Field	Document ID number (in the top-right corner)
surname	Field	Surname
maidenName	Field	Maiden name
givenNames	Field	Given names
birthDate	Field	Birth date
nationality	Field	Nationality
birthplace	Field	Birthplace
expiryDate	Field	Expiry date
pin	Field	PIN
signature	Field	Signature image

DeIdCardBackDocument

German ID card, back side

Prop	Type	Description
eyeColor	Field	Eye color
height	Field	Height
issueDate	Field	Issue date
issuingAuthority	Field	Issuing authority
address	Field	Address
pseudonym	Field	Pseudonym
rawMRZ	Field	Raw MRZ text value
mrz	MRZDocument	Contains the MRZ sub-document.

DePassportDocument

German travel passport (Reisepass)

Prop	Type	Description
id	Field	Document ID number (in the top-right corner)
surname	Field	Surname
maidenName	Field	Maiden name
givenNames	Field	Given names
birthDate	Field	Birth date
nationality	Field	Nationality
birthplace	Field	Birthplace
expiryDate	Field	Expiry date
passportType	Field	Passport type
countryCode	Field	Country code
gender	Field	Gender
signature	Field	Signature image
issueDate	Field	Issue date
issuingAuthority	Field	Issuing authority
rawMRZ	Field	Raw MRZ text value
mrz	MRZDocument	Contains the MRZ sub-document.

DeDriverLicenseFrontDocument

German driver license (Führerschein), front side

Prop	Type	Description
surname	Field	Surname
givenNames	Field	Given names
birthDate	Field	Birth date
birthplace	Field	Birthplace
issueDate	Field	Issue date
issuingAuthority	Field	Issuing authority
expiryDate	Field	Expiry date
id	Field	Document ID number (in the top-right corner)
signature	Field	Signature image
licenseCategories	Field	Driver's license categories

DeDriverLicenseBackDocument

German driver license (Führerschein), back side

Prop	Type	Description
restrictions	Field	Restrictions applied for the driver's license
categories	CategoriesDocument	Categories table row container

CategoriesDocument

Categories table row container

Prop	Type	Description
a	ADocument	Contains the A sub-document.
a1	A1Document	Contains the A1 sub-document.
a2	A2Document	Contains the A2 sub-document.
b	BDocument	Contains the B sub-document.
b1	B1Document	Contains the B1 sub-document.
be	BEDocument	Contains the BE sub-document.
c	CDocument	Contains the C sub-document.
c1	C1Document	Contains the C1 sub-document.
c1e	C1EDocument	Contains the C1E sub-document.
ce	CEDocument	Contains the CE sub-document.
d	DDocument	Contains the D sub-document.
d1	D1Document	Contains the D1 sub-document.
d1e	D1EDocument	Contains the D1E sub-document.
de	DEDocument	Contains the DE sub-document.
l	LDocument	Contains the L sub-document.
m	MDocument	Contains the M sub-document.
t	TDocument	Contains the T sub-document.

ADocument

The A document.

A1Document

The A1 document.

A2Document

The A2 document.

BDocument

The B document.

B1Document

The B1 document.

BEDocument

The BE document.

CDocument

The C document.

C1Document

The C1 document.

C1EDocument

The C1E document.

CEDocument

The CE document.

DDocument

The D document.

D1Document

The D1 document.

D1EDocument

The D1E document.

DEDocument

The DE document.

LDocument

The L document.

MDocument

The M document.

TDocument

The T document.

GenericDocumentRecognizerConfiguration

Prop	Type	Description
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
cameraModule	CameraModule	The preferred camera module (default - BACK)
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
cameraOverlayColor	string	Background color outside of the finder window.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
fieldsCountTextColor	string	Text color of the fields count label.
fieldConfidenceHighColor	string	Color of confidence value label background in details screen, when the field confidence level is high.
fieldConfidenceModerateColor	string	Color of confidence value label background in details screen, when the field confidence level is moderate.
fieldConfidenceLowColor	string	Color of confidence value label background in details screen, when the field confidence level is low.
fieldConfidenceTextColor	string	Color of confidence value label text in details.
tipTextColor	string	Color of tip text on scanning screen.
tipBackgroundColor	string	Color of tip background on scanning screen.
detailsBackgroundColor	string	The color of bottom sheet
detailsPrimaryColor	string	The color of text elements in bottom sheet
detailsActionColor	string	The color of Submit button
detailsSectionHeaderTextColor	string	Text color for section headers on the details screen. iOS only.
detailsSectionHeaderBackgroundColor	string	Background color for section headers on the details screen. iOS only.
cancelButtonTitle	string	Title of the cancel button.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
clearButtonTitle	string	String used for displaying amount of detected fields. Use %d for number formatting symbol.
submitButtonTitle	string	Text of the button which finishes the flow
fieldsCountText	string	String used for displaying amount of detected fields. Use %d for number formatting symbol.
confidenceValue	string	String that shows average confidence value of scanned document. Use %d as number formatting symbol.
scanBackSideTitle	string	String that asks user to scan back side of a document.
scanFrontSideTitle	string	String that asks user to scan front side of a document.
startScanningTitle	string	String that asks user to start scanning a document.
scannedEverythingTitle	string	String that notifies that both sides of document are scanned.
emptyValueTitle	string	String being displayed for empty values. iOS only.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
imageTitle	string	A title to show image content. Android only.
noDataTitle	string	String that notifies that nothing was scanned yet.
acceptedDocumentTypes	GenericDocumentType[]	Accepted document types. All other document types will be ignored. By default - All types
sharpnessAcceptanceFactor	number	Accepted minimal sharpness score. Images with a score less than that will be rejected with RecognitionStatus::ErrorTooBlurry. Default is 80. 0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.
fieldsDisplayConfiguration	FieldsDisplayConfiguration[]	Allows to configure the display configuration for fields.
documentsDisplayConfiguration	DocumentsDisplayConfiguration[]	Allows to configure the display configuration for documents.
excludedFieldTypes	string[]	List of secure fields which should be excluded from scanning process. All other fields will be scanned as usual. Field should be set ONLY as normalized field name. Example - [DePassport.BirthDate] or [DePassport.Birthplace]
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not.
flashButtonTitle	string	Title of the flash toggle button.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon	boolean	If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

FieldsDisplayConfiguration

Field display configuration object

Prop	Type	Description
normalizedFieldName	string	Complete list of available normalized field names is available in the documentation
defaultDisplayText	string	The display text of the field in the list
defaultDisplayState	FieldDisplayState	The default display state of a field in the RTU UI, could be hidden by default or visible by default.

DocumentsDisplayConfiguration

Field display configuration object

Prop	Type	Description
normalizedDocumentName	string	Complete list of available normalized document names is available in the documentation
defaultDisplayText	string	The display text of the document in the list

CheckRecognizerResult

The Check Recognizer Result Field

Prop	Type	Description
check	USACheckDocument | FRACheckDocument | KWTCheckDocument | AUSCheckDocument | INDCheckDocument | ISRCheckDocument | UnknownCheckDocument	Check Document
checkStatus	CheckStatus	The status of the operation
imageFileUri	string	The URI of the snapped Check Image
checkType	CheckStandard	The type of the recognized check

USACheckDocument

A check compatible with the ASC X9 standard used in the USA

Prop	Type	Description
auxiliaryOnUs	Field	Auxiliary On-Us
transitNumber	Field	Transit number
accountNumber	Field	Account number

FRACheckDocument

A check format commonly used in France

Prop	Type	Description
chequeNumber	Field	Cheque number
routingNumber	Field	Routing number
accountNumber	Field	Account number

KWTCheckDocument

A check format commonly used in Kuwait

Prop	Type	Description
chequeNumber	Field	Cheque number
sortCode	Field	Sort code
accountNumber	Field	Account number

AUSCheckDocument

A check compatible with the Australian Paper Clearing System cheque standard

Prop	Type	Description
extraAuxDomestic	Field	Extra auxiliary domestic
auxDomestic	Field	Auxiliary domestic
bsb	Field	BSB
accountNumber	Field	Account number
transactionCode	Field	Transaction code

INDCheckDocument

A check compatible with the CTS-2010 standard issued by the Reserve Bank of India in 2012

Prop	Type	Description
serialNumber	Field	Serial number
sortNumber	Field	Sort number
accountNumber	Field	Account number
transactionCode	Field	Transaction code

ISRCheckDocument

A check format commonly used in Israel

Prop	Type	Description
chequeNumber	Field	Cheque number
bankNumber	Field	Bank number
branchNumber	Field	Branch number
accountNumber	Field	Account number

UnknownCheckDocument

A check that doesn't conform to any supported standard

CheckRecognizerConfiguration

Prop	Type	Description
acceptedCheckStandards	CheckStandard[]	Accepted check standards. Optional, by default - all checks are accepted. With an empty list no filter is applied and all checks are accepted.
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraOverlayColor	string	Background color outside of the finder window.
cancelButtonTitle	string	Title of the cancel button.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
captureHighResolutionImage	boolean	Set high-resolution Check image capturing. If set to TRUE a high-resolution photo of the check is captured to run the recognition on. Upon successful recognition the recognition result also contains a high-resolution image of the check. If set to FALSE, the video frames will be used for recognition and result image delivery. The default value is TRUE.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
errorDialogStyle	DialogStyle	The style of the dialog/alert in case of error. iOS Only.
errorDialogButtonStyle	DialogButtonStyle	The style of the dialogs/alerts OK button in case of error. iOS Only.
errorAlertTitle	string	String being displayed as the title in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.
errorAlertMessage	string	String being displayed as the message in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.
errorAlertButtonText	string	String being displayed as the button text in the error alert that may occur when the recognition fails on captured high-resolution images. iOS only.
finderAspectRatio	AspectRatio	Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	Title of the flash toggle button. iOS only.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
userGuidanceBackgroundColor	string	The background color of the user guidance hints.
userGuidanceTextColor	string	The text color of the user guidance hints.
userGuidanceStringValues	CheckUserGuidanceStrings	Configuration that helps to override default hint values.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.

CheckUserGuidanceStrings

Configuration that helps to override default hint values.

Prop	Type	Description
startScanning	string	Text that is shown on camera open.
scanning	string	Text text that is shown when the camera is seeking for the document on the visible area, shown after the first result from the detector.
energySaving	string	Text text that is shown when energy saving is active.
capturing	string	Text that is shown when the camera snaps the image.
processing	string	Text that is shown when the detector tries to detect the document from the snapped image.

VinScannerResult

Prop	Type	Description
rawText	string	The scanned Vehicle Identification Number
confidenceValue	number	The scanned result confidence value.
validationSuccessful	boolean	Boolean that represents a successful validation

VinScannerConfiguration

Prop	Type	Description
cameraModule	CameraModule	The preferred camera module (default - BACK)
cameraOverlayColor	string	Background color outside of the finder window.
cancelButtonTitle	string	Title of the cancel button.
cancelButtonHidden	boolean	Whether the cancel button is hidden or not. iOS only.
enableCameraButtonTitle	string	Title of the button that opens the screen where the user can allow the usage of the camera by the app.
enableCameraExplanationText	string	Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
finderLineColor	string	Foreground color of the detection overlay.
finderLineWidth	number	Width of finder frame border. Default is 2.
finderTextHintColor	string	Foreground color of the description label.
flashButtonHidden	boolean	Controls whether the flash toggle button is hidden or not. iOS only.
flashButtonTitle	string	Title of the flash toggle button. iOS only.
flashEnabled	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
orientationLockMode	OrientationLockMode	UI Interface orientation lock mode
topBarBackgroundColor	string	The background color of the top toolbar.
topBarButtonsActiveColor	string	The color of all active toggle buttons in the toolbar.
topBarButtonsInactiveColor	string	The color of all inactive toggle buttons in the toolbar.
minimumNumberOfRequiredFramesWithEqualRecognitionResult	number	Minimum number of accumulated frames that have equal result
maximumNumberOfAccumulatedFrames	number	Maximum number of accumulated frames to inspect before actual result is returned
ocrResolutionLimit	number	The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower. 0 - do not rescale. Default value is 0.
useButtonsAllCaps	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
replaceCancelButtonWithIcon	boolean	If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
cameraPreviewMode	CameraPreviewMode	Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
touchToFocusEnabled	boolean	Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
aspectRatio	AspectRatio	The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height
guidanceText	string	User guidance hint text.
significantShakeDelay	number	Threshold used to pause the detection after significant movement occurred. Default = 0. Android only.

InitializeSDKResult

Prop	Type	Description
result	string	The result initialization message

ScanbotSdkConfiguration

Prop	Type	Description
loggingEnabled	boolean	Optional boolean flag to enable logging. See the "Logging" section below.
enableNativeLogging	boolean	Optional boolean flag that enables Scanbot SDK Core native logging (default is false, Android only).
licenseKey	string	Your license key for the Scanbot SDK. See the "License Key" section below.
storageImageQuality	number	Optional image quality value. It defines the quality factor of JPEG images. The value must be between 1 and 100, where 100 means maximum quality and largest file size. The recommended default value is 80 which is a good compromise between image file size and document legibility.
storageImageFormat	StorageImageFormat	Optional image format, either 'JPG' or 'PNG'. The recommended default value is 'JPG'. Please note that 'PNG' will result in larger image files! Also, the storageImageQuality value does not apply for 'PNG'.
storageBaseDirectory	string	Optional directory as file URI to override the default storage base directory of the Scanbot SDK. Refer to the section "Storage" for more details.
documentDetectorMode	DocumentDetectorMode	Optional mode for document detection.
fileEncryptionMode	FileEncryptionMode	Optional file encryption mode, 'AES128' or 'AES256'.
fileEncryptionPassword	string	Optional file encryption password. Refer to the section "Storage Encryption" for more details.
useCameraX	boolean	If set to true, Camera X will be used for the RTU-UI components (Android only). Default is true.
allowGpuAcceleration	boolean	If set to true, GPU Acceleration will be enabled for Barcode Scanner, Document Scanner and Generic Document Recognizer (Android only). Default is true.
allowXnnpackAcceleration	boolean	Enables/disables XNNPACK acceleration for TensorFlow ML models, which provides highly optimized implementations of floating-point neural network operators (Android only)

GetLicenseInfoResult

Prop	Type	Description
isLicenseValid	boolean	True if the license is valid, false otherwise
licenseStatus	LicenseStatus	The license status
licenseExpirationDate	number	The license expiration date in milliseconds

DetectBarcodesOnImageResult

Prop	Type	Description
barcodes	BarcodeResultField[]	The detected barcodes

DetectBarcodesOnImageArguments

Prop	Type	Description
imageFileUri	string	The input image file URI

DetectBarcodesOnImagesResult

Prop	Type	Description
results	DetectBarcodesOnImagesField[]	An array for which each element has a imageUri and the list of detected barcodes

DetectBarcodesOnImagesField

Detect Barcodes On Images Result Field

Prop	Type	Description
imageFileUri	string	The URI of the image file the barcodes have been detected on
barcodeResults	BarcodeResultField[]	The array of detected barcodes

DetectBarcodesOnImagesArguments

Prop	Type	Description
imageFileUris	string[]	The input image files URIs

ApplyImageFilterResult

Prop	Type	Description
imageFileUri	string	The URI of the filtered image

ApplyImageFilterOnPageResult

Result of applyImageFilterOnPage

GetImageDataResult

Prop	Type	Description
base64ImageData	string	The Base 64 encoded representation of the image data

RotateImageResult

Prop	Type	Description
imageFileUri	string	The URI of the rotated image

CreatePageResult

Result of createPage

RemovePageResult

Prop	Type	Description
operationResult	string	Operation Result

RotatePageResult

Result of rotatePage

SetDocumentImageResult

Result of setDocumentImage

DetectDocumentResult

Prop	Type	Description
documentImageFileUri	string	The URI of the document image file, if something is detected
polygon	PolygonPoint[]	The array of detected polygon points, if something is detected
detectionResult	DetectionStatus	The status of the detection

DetectDocumentOnPageResult

Result of detectDocumentOnPage

DocumentQualityAnalyzerResult

Prop	Type	Description
result	DocumentQuality	Quality of the analyzed document

ExtractImagesFromPdfResult

Prop	Type	Description
imageFilesUrls	string[]	The URIs of the extracted images

ExtractImagesFromPdfArguments

ExtractPagesFromPdfResult

Prop	Type	Description
pages	Page[]	The extracted pages

ExtractPagesFromPdfArguments

RecognizeCheckResult

Result of recognizeCheck

RecognizeMRZResult

Prop	Type	Description
recognitionSuccessful	boolean	True if the recognition was successful, false otherwise
documentType	MRZDocumentType	The recognized document type
checkDigitsCount	number	Total number of check digits as required by the travel document type
validCheckDigitsCount	number	Number of successfully validated check digits.
rawString	string	The raw string of the recognized machine readable zone.
mrz	MRZDocument	MRZ Document

RefreshImageUrisResult

Prop	Type	Description
pages	Page[]	The refreshed pages

GetOCRConfigsResult

Prop	Type	Description
languageDataPath	string	The OCR languages data path
installedLanguages	string[]	The installed OCR languages

GetFilteredDocumentPreviewUriResult

Prop	Type	Description
filteredDocumentPreviewUri	string	The URI of the filtered document preview image

PerformOCRResult

Prop	Type	Description
plainText	string	The OCR result as plain text
pdfFileUri	string	The URI of the PDF file
jsonData	any	The OCR result as JSON data

PerformOCRArguments

Prop	Type
imageFileUris	string[]
languages	string[]
options	{ outputFormat?: OCROutputFormat; engineMode?: OCREngineMode; }

CreatePDFResult

Prop	Type	Description
pdfFileUri	string	The URI of the generated PDF file

CreatePDFArguments

Prop	Type
imageFileUris	string[]
options	{ pageSize?: PDFPageSize; pageOrientation?: PDFPageOrientation; metadata?: PDFMetadata; }

PDFMetadata

Prop	Type
author	string
creator	string
title	string
subject	string
keywords	string

WriteTIFFResult

Prop	Type	Description
tiffFileUri	string	The URI of the output TIFF file

WriteTIFFArguments

Prop	Type
imageFileUris	string[]
options	{ oneBitEncoded?: boolean; dpi?: number; compression?: TIFFCompression; }

Type Aliases

ResultWrapper

status: Status & T

Status

'OK' | 'CANCELED'

DetectionStatus

Detection Status

'OK' | 'OK_BUT_TOO_SMALL' | 'OK_BUT_BAD_ANGLES' | 'OK_BUT_BAD_ASPECT_RATIO' | 'ERROR_NOTHING_DETECTED' | 'ERROR_TOO_DARK' | 'ERROR_TOO_NOISY'

PageImageSource

The page image source

'UNDEFINED' | 'MANUAL_SNAP' | 'AUTO_SNAP' | 'CAMERA_FRAME' | 'IMPORT'

ImageFilterType

The image filter types.

'NONE' | 'COLOR' | 'GRAYSCALE' | 'BINARIZED' | 'COLOR_DOCUMENT' | 'PURE_BINARIZED' | 'BACKGROUND_CLEAN' | 'BLACK_AND_WHITE' | 'OTSU_BINARIZATION' | 'DEEP_BINARIZATION' | 'EDGE_HIGHLIGHT' | 'LOW_LIGHT_BINARIZATION' | 'LOW_LIGHT_BINARIZATION_2' | 'PURE_GRAY'

CameraModule

Camera module to use

'FRONT' | 'BACK' | 'BACK_WIDEST'

CameraPreviewMode

Represents camera preview modes

'FIT_IN' | 'FILL_IN'

DocumentDetectorMode

Mode for document detection.

'ML_BASED' | 'EDGE_BASED'

OrientationLockMode

Applied interface orientation

'NONE' | 'PORTRAIT' | 'LANDSCAPE'

CapturePhotoQualityPrioritization

The prioritization of still image quality and capturing speed. Has no effect on devices prior to iOS 13.0. iOS only.

'SPEED' | 'BALANCED' | 'QUALITY'

BarcodeFormat

Barcode document format

'AZTEC' | 'CODABAR' | 'CODE_25' | 'CODE_39' | 'CODE_93' | 'CODE_128' | 'DATA_MATRIX' | 'EAN_8' | 'EAN_13' | 'ITF' | 'PDF_417' | 'QR_CODE' | 'MICRO_QR_CODE' | 'RSS_14' | 'RSS_EXPANDED' | 'UPC_A' | 'UPC_E' | 'MSI_PLESSEY' | 'IATA_2_OF_5' | 'INDUSTRIAL_2_OF_5' | 'USPS_INTELLIGENT_MAIL' | 'ROYAL_MAIL' | 'JAPAN_POST' | 'ROYAL_TNT_POST' | 'AUSTRALIA_POST' | 'DATABAR_LIMITED' | 'GS1_COMPOSITE'

AAMVARecordFieldType

AAMVA Record Field Type

'AUDIT_INFORMATION' | 'CARD_REVISION_DATE' | 'COMPLIANCE_TYPE' | 'COUNTRY_TERRITORY_OF_ISSUANCE' | 'COURT_RESTRICTION_CODE' | 'DATE_OF_BIRTH' | 'DOCUMENT_DISCRIMINATOR' | 'EYES_COLOR' | 'FAMILY_NAME' | 'FAMILY_NAME_TRUNCATION' | 'FEDERAL_COMMERCIAL_VEHICLE_CODES' | 'FIRST_NAME' | 'FIRST_NAMES_TRUNCATION' | 'FULL_NAME' | 'HAIR_COLOR' | 'HAZ_MAT_ENDORSEMENT_EXPIRY_DATE' | 'HEIGHT_IN_CM' | 'HEIGHT_IN_FEET_INCHES' | 'INVENTORY_CONTROL_NUMBER' | 'ISSUE_TIMESTAMP' | 'JURISDICTION_SPECIFIC' | 'JURISDICTION_SPECIFIC_RESTRICTION_CODE_DESCRIPTION' | 'JURISDICTION_SPECIFIC_VEHICLE_CLASSIFICATION_DESCRIPTION' | 'LAST_NAME' | 'LICENSE_CLASSIFICATION_CODE' | 'LICENSE_ENDORSEMENT_CODE' | 'LICENSE_EXPIRATION_DATE' | 'LICENSE_OR_ID_DOCUMENT_ISSUE_DATE' | 'LICENSE_OR_ID_NUMBER' | 'LICENSE_RESTRICTION_CODE' | 'LIMITED_DURATION_DOCUMENT_INDICATOR' | 'MAILING_CITY' | 'MAILING_JURISDICTION_CODE' | 'MAILING_POSTAL_CODE' | 'MAILING_STREET_ADDRESS_1' | 'MAILING_STREET_ADDRESS_2' | 'MEDICAL_INDICATOR_CODES' | 'MIDDLE_NAME_OR_INITIAL' | 'MIDDLE_NAMES_TRUNCATION' | 'NAME_PREFIX' | 'NAME_SUFFIX' | 'NON_RESIDENT_INDICATOR' | 'NUMBER_OF_DUPLICATES' | 'ORGAN_DONOR' | 'ORGAN_DONOR_INDICATOR' | 'PERMIT_CLASSIFICATION_CODE' | 'PERMIT_ENDORSEMENT_CODE' | 'PERMIT_EXPIRATION_DATE' | 'PERMIT_IDENTIFIER' | 'PERMIT_ISSUE_DATE' | 'PERMIT_RESTRICTION_CODE' | 'PHYSICAL_DESCRIPTION_WEIGHT_RANGE' | 'PLACE_OF_BIRTH' | 'PREFIX' | 'RACE_ETHNICITY' | 'RESIDENCE_CITY' | 'RESIDENCE_JURISDICTION_CODE' | 'RESIDENCE_POSTAL_CODE' | 'RESIDENCE_STREET_ADDRESS_1' | 'RESIDENCE_STREET_ADDRESS_2' | 'SEX' | 'SOCIAL_SECURITY_NUMBER' | 'STANDARD_ENDORSEMENT_CODE' | 'STANDARD_RESTRICTION_CODE' | 'STANDARD_VEHICLE_CLASSIFICATION' | 'SUFFIX' | 'UNDER_18_UNTIL' | 'UNDER_19_UNTIL' | 'UNDER_21_UNTIL' | 'UNIQUE_CUSTOMER_IDENTIFIER' | 'VETERAN_INDICATOR' | 'VIRGINIA_SPECIFIC_CLASS' | 'VIRGINIA_SPECIFIC_ENDORSEMENTS' | 'VIRGINIA_SPECIFIC_RESTRICTIONS' | 'WEIGHT_IN_KG' | 'WEIGHT_IN_LBS' | 'UNKNOWN'

BoardingPassDocumentFieldType

Boarding Pass Document Field Type

'AIRLINE_DESIGNATOR_OF_BOARDING_PASS_ISSUER' | 'AIRLINE_NUMERIC_CODE' | 'BAGGAGE_TAG_LICENSE_PLATE_NUMBERS' | 'CHECK_IN_SEQUENCE_NUMBER' | 'COMPARTMENT_CODE' | 'DATE_OF_BOARDING_PASS_ISSUANCE_JULIAN' | 'DATE_OF_FLIGHT_JULIAN' | 'DEPARTURE_AIRPORT_CODE' | 'DESTINATION_AIRPORT_CODE' | 'DOCUMENT_FORM_SERIAL_NUMBER' | 'DOCUMENT_TYPE' | 'FAST_TRACK' | 'FIRST_NON_CONSECUTIVE_BAGGAGE_TAG_LICENSE_PLATE_NUMBER' | 'FLIGHT_NUMBER' | 'FOR_INDIVIDUAL_AIRLINE_USE' | 'FREE_BAGGAGE_ALLOWANCE' | 'FREQUENT_FLYER_AIRLINE_DESIGNATOR' | 'FREQUENT_FLYER_NUMBER' | 'IDAD_INDICATOR' | 'INTERNATIONAL_DOCUMENTATION_VERIFICATION' | 'MARKETING_CARRIER_DESIGNATOR' | 'OPERATING_CARRIER_DESIGNATOR' | 'OPERATING_CARRIER_PNR_CODE' | 'PASSENGER_DESCRIPTION' | 'PASSENGER_STATUS' | 'SEAT_NUMBER' | 'SECOND_NON_CONSECUTIVE_BAGGAGE_TAG_LICENSE_PLATE_NUMBER' | 'SELECTEE_INDICATOR' | 'SOURCE_OF_BOARDING_PASS_ISSUANCE' | 'SOURCE_OF_CHECK_IN' | 'VERSION_NUMBER' | 'UNKNOWN'

GS1SystemElementValidationStatus

GS1 Element Validation Status

'VALID' | 'INVALID'

IDCardPDF417DocumentFieldType

ID Card PDF417 Document Field Type

'FIRST_NAME' | 'LAST_NAME' | 'DOCUMENT_CODE' | 'BIRTH_DATE' | 'DATE_ISSUED' | 'DATE_EXPIRED' | 'OPTIONAL_1' | 'UNKNOWN'

MedicalCertificateDocumentFieldType

Medical Certificate Document Field Type

'REQUIRES_CARE' | 'ACCIDENT' | 'INITIAL_CERTIFICATE' | 'RENEWED_CERTIFICATE' | 'WORK_ACCIDENT' | 'ASSIGNED_TO_ACCIDENT_INSURANCE_DOCTOR' | 'INCAPABLE_OF_WORK_SINCE' | 'INCAPABLE_OF_WORK_UNTIL' | 'DIAGNOSED_ON' | 'DOCUMENT_DATE' | 'BIRTH_DATE' | 'FIRST_NAME' | 'LAST_NAME' | 'DIAGNOSE' | 'HEALTH_INSURANCE_NUMBER' | 'INSURED_PERSON_NUMBER' | 'STATUS' | 'PLACE_OF_OPERATION_NUMBER' | 'DOCTOR_NUMBER' | 'UNKNOWN'

MedicalPlanPatientFieldType

Medical Plan Patient Field Type

'FIRST_NAME' | 'LAST_NAME' | 'TITLE' | 'PRE_NAME' | 'SUFFIX' | 'PATIENT_ID' | 'BIRTH_DATE' | 'GENDER' | 'WEIGHT' | 'HEIGHT' | 'CREATININE_VALUE' | 'ALLERGIES_AND_INTOLERANCES' | 'BREAST_FEEDING' | 'PREGNANT' | 'PATIENT_FREE_TEXT' | 'UNKNOWN'

MedicalPlanDoctorFieldType

Medical Plan Doctor Field Type

'ISSUER_NAME' | 'DOCTOR_NUMBER' | 'PHARMACY_ID' | 'HOSPITAL_ID' | 'STREET' | 'POSTAL_CODE' | 'PLACE' | 'TELEPHONE_NUMBER' | 'EMAIL' | 'ISSUING_DATE_AND_TIME' | 'UNKNOWN'

MedicalPlanStandardSubheadingFieldType

Medical Plan Standard Subheading Field Type

'KEY_WORDS' | 'SUBHEADING_FREE_TEXT'

MedicalPlanMedicineFieldType

Medical Plan Medicine Field Type

'PHARMACEUTICAL_NUMBER' | 'DRUG_NAME' | 'DOSAGE_FORM' | 'DOSAGE_FORM_FREE_TEXT' | 'MORNING' | 'MIDDAY' | 'EVENING' | 'NIGHT' | 'DOSAGE_FREE_TEXT' | 'DOSING_UNIT' | 'DOSING_UNIT_FREE_TEXT' | 'RELEVANT_INFO' | 'REASON_FOR_TREATMENT' | 'GENERAL_NOTES' | 'UNKNOWN'

MedicalPlanMedicineSubstanceFieldType

Medical Plan Medicine Substance Field Type

'ACTIVE_SUBSTANCE' | 'POTENCY' | 'UNKNOWN'

MedicalPlanPrescriptionFieldType

Medical Plan Prescription Field Type

'GENERAL_INFORMATION' | 'PRESCRIPTION_FREE_TEXT' | 'UNKNOWN'

SEPADocumentFieldType

SEPA Document Field Type

'SERVICE_TAG' | 'VERSION' | 'CHARACTER_SET' | 'IDENTIFICATION' | 'RECEIVER_IBAN' | 'RECEIVER_BIC' | 'RECEIVER_NAME' | 'AMOUNT' | 'PURPOSE' | 'REMITTANCE' | 'INFORMATION' | 'UNKNOWN'

SwissQRCodeDocumentFieldType

Swiss QR Code Document Field Type

'ADDITIONAL_BILLING_INFORMATION' | 'ADDITIONAL_INFO_TRAILER' | 'ADDITIONAL_INFO_UNSTRUCTURED' | 'ALTERNATIVE_PROCEDURE_PARAMETER' | 'AMOUNT' | 'CURRENCY' | 'DEBTOR_ADDRESS_TYPE' | 'DEBTOR_COUNTRY' | 'DEBTOR_NAME' | 'DEBTOR_PLACE' | 'DEBTOR_POSTAL_CODE' | 'DEBTOR_STREET_OR_ADDRESS_LINE_1' | 'DEBTOR_STREET_OR_ADDRESS_LINE_2' | 'DUE_DATE' | 'ENCODING' | 'FINAL_PAYEE_ADDRESS_TYPE' | 'FINAL_PAYEE_BUILDING_OR_ADDRESS_LINE_2' | 'FINAL_PAYEE_COUNTRY' | 'FINAL_PAYEE_NAME' | 'FINAL_PAYEE_PLACE' | 'FINAL_PAYEE_POSTAL_CODE' | 'FINAL_PAYEE_STREET_OR_ADDRESS_LINE_1' | 'IBAN' | 'PAYEE_ADDRESS_TYPE' | 'PAYEE_BUILDING_OR_ADDRESS_LINE_2' | 'PAYEE_COUNTRY' | 'PAYEE_NAME' | 'PAYEE_PLACE' | 'PAYEE_POSTAL_CODE' | 'PAYEE_STREET_OR_ADDRESS_LINE_1' | 'PAYMENT_REFERENCE' | 'PAYMENT_REFERENCE_TYPE' | 'UNKNOWN'

SwissQRCodeVersion

Swiss QR Code Version

'V1_0' | 'V2_0' | 'V2_1' | 'UNKNOWN'

VCardDocumentFormatFieldType

vCard Document Field Type

'ANNIVERSARY' | 'BIRTHDAY' | 'BUSY_TIME_URL' | 'CALENDAR_URI' | 'CALENDAR_URI_FOR_REQUESTS' | 'CATEGORIES' | 'CLIENT_PID_MAP' | 'CUSTOM' | 'DELIVERY_ADDRESS' | 'EMAIL' | 'FIRST_NAME' | 'GENDER' | 'GEO_LOCATION' | 'IMPP' | 'KIND' | 'LANGUAGES' | 'LOGO' | 'MEMBER' | 'NAME' | 'NICKNAME' | 'NOTE' | 'ORGANISATION' | 'PHOTO' | 'PRODUCT_ID' | 'PUBLIC_KEY' | 'RELATED' | 'REVISION' | 'ROLE' | 'SOUND' | 'SOURCE' | 'TELEPHONE_NUMBER' | 'TIME_ZONE' | 'TITLE' | 'UID' | 'URL' | 'VERSION' | 'XML' | 'UNKNOWN'

BarcodeDocumentFormat

Barcode document format

'AAMVA' | 'BOARDING_PASS' | 'DE_MEDICAL_PLAN' | 'MEDICAL_CERTIFICATE' | 'ID_CARD_PDF_417' | 'SEPA' | 'SWISS_QR' | 'VCARD' | 'GS1'

BarcodesExtensionFilter

A filter for extended EAN and UPC barcodes.

'NO_FILTER' | 'ONLY_WITH_EXTENSIONS' | 'ONLY_WITHOUT_EXTENSIONS'

EngineMode

Barcode scanner engine mode

'NEXT_GEN' | 'LEGACY'

Gs1HandlingMode

GS1 handling mode

'NONE' | 'PARSE' | 'VALIDATE' | 'DECODE'

MSIPlesseyChecksumAlgorithm

MSI plessey checksum algorithm

'NONE' | 'MOD_10' | 'MOD_11_IBM' | 'MOD_11_NCR' | 'MOD_1010' | 'MOD_1110_IBM' | 'MOD_1110_NCR'

CodeDensity

The expected density of QR codes in an image.

'LOW' | 'HIGH'

BarcodeDialogFormat

The barcode text format dialog.

'CODE' | 'TYPE_AND_CODE'

BlurEffect

The blur effect style. iOS only.

'EXTRA_LIGHT' | 'LIGHT' | 'DARK' | 'REGULAR' | 'PROMINENT' | 'SYSTEM_ULTRA_THIN_MATERIAL' | 'SYSTEM_THIN_MATERIAL' | 'SYSTEM_MATERIAL' | 'SYSTEM_THICK_MATERIAL' | 'SYSTEM_CHROME_MATERIAL' | 'SYSTEM_ULTRA_THIN_MATERIAL_LIGHT' | 'SYSTEM_THIN_MATERIAL_LIGHT' | 'SYSTEM_MATERIAL_LIGHT' | 'SYSTEM_THICK_MATERIAL_LIGHT' | 'SYSTEM_CHROME_MATERIAL_LIGHT' | 'SYSTEM_ULTRA_THIN_MATERIAL_DARK' | 'SYSTEM_THIN_MATERIAL_DARK' | 'SYSTEM_MATERIAL_DARK' | 'SYSTEM_THICK_MATERIAL_DARK' | 'SYSTEM_CHROME_MATERIAL_DARK'

BarcodeOverlayTextFormat

Barcode scanner engine mode

'NONE' | 'CODE' | 'CODE_AND_TYPE'

LicensePlateScanStrategy

Detector mode, classic (OCR based) or ML (machine learning based) approach.

'CLASSIC' | 'ML_BASED'

ValidationStatus

Barcode document format

'Invalid' | 'Valid'

GenericDocumentType

Supported document types

'DE_ID_CARD_FRONT' | 'DE_ID_CARD_BACK' | 'DE_PASSPORT' | 'DE_DRIVER_LICENSE_FRONT' | 'DE_DRIVER_LICENSE_BACK'

FieldDisplayState

Field display state in the RTU UI'HIDDEN' | 'VISIBLE_IF_NOT_EMPTY' | 'ALWAYS_VISIBLE'

CheckStatus

Check Status

'SUCCESS' | 'FAIL'

CheckStandard

Supported check standards.

'USA' | 'FRA' | 'KWT' | 'AUS' | 'IND' | 'ISR'

StorageImageFormat

Image format

'JPG' | 'PNG'

FileEncryptionMode

File encryption mode, 'AES128' or 'AES256'.

'AES128' | 'AES256'

LicenseStatus

The SDK license status

'Okay' | 'Trial' | 'Expired' | 'WrongOS' | 'Corrupted' | 'AppIDMismatch' | 'NotSet'

DocumentQuality

Enum that represents the analyzed text legibility on the images

'NO_DOCUMENT' | 'VERY_POOR' | 'POOR' | 'REASONABLE' | 'GOOD' | 'EXCELLENT'

MRZDocumentType

MRZ Document Type

'PASSPORT' | 'CREW_MEMBER_CERTIFICATE' | 'VISA' | 'ID_CARD' | 'SWISS_DRIVER_LICENSE' | 'UNDEFINED'

OCROutputFormat

'PLAIN_TEXT' | 'PDF_FILE' | 'RESULT_JSON' | 'FULL_OCR_RESULT'

OCREngineMode

'SCANBOT_OCR' | 'TESSERACT'

PDFPageSize

'A3' | 'A4' | 'A5' | 'B4' | 'B5' | 'COMM10' | 'CUSTOM' | 'EXECUTIVE' | 'LEGAL' | 'LETTER' | 'US4x6' | 'US4x8' | 'US5x7'

PDFPageOrientation

'PORTRAIT' | 'LANDSCAPE' | 'AUTO'

TIFFCompression

'NONE' | 'CCITTRLE' | 'CCITTFAX3' | 'CCITT_T4' | 'CCITTFAX4' | 'CCITT_T6' | 'LZW' | 'CCITTRLEW' | 'PACKBITS' | 'DEFLATE' | 'ADOBE_DEFLATE'

Want to scan longer than one minute?

Generate your free "no-strings-attached" Trial License and properly test the Scanbot SDK.

Get your free Trial License

What do you think of this documentation?

What can we do to improve it? Please be as detailed as you like.

---