Capacitor-plugin-scanbot-sdk NPM

Scanbot Document and Barcode Scanner SDK for Capacitor

Add enterprise-grade document and barcode scanning as well as data capture functionalities to your app in no time

The Scanbot Document and Barcode Scanner SDK for Capacitor enables you to easily implement scanning, document creation, and data extraction functionalities for your apps on iOS and Android.

Access the available cameras on the mobile device, choose the interface, configure the settings, and let your users easily scan any document, barcode, or other data in your application.

Benefit from advanced machine-learning based features like automatic scanning, perspective correction, user guidance, automated cropping, multiple export formats like PDF, TIFF, JPEG; blur detection, image filters, encryption, and much more...

Check out the demo.

Documentation & Example App

To integrate this module into your application please follow the steps in our documentation and check out our example app.

Changelog

For a detailed list of the changes included in each version, please see the changelog.

Trial License

The Scanbot SDK will run without a license for one minute per session! To get an unrestricted, "no-strings-attached" 7-day trial license, please submit the Trial License Form on our website. If you need more time to test our SDK, you can also submit our Proof of Concept Form – giving you a free trial period of 30 days.

Please kindly note that a trial license can only be used in a development and staging environment. You are not allowed to publish your app to the App Store, Play Store or any 3rd party Android App Store with a trial license.

Free Developer Support

We provide free "no-strings-attached" developer support for the implementation & testing of the Scanbot SDK. If you encounter technical issues with integrating the Scanbot SDK or need advice on choosing the appropriate framework or features, please visit our Support Page.

Install

npm install capacitor-plugin-scanbot-sdk
npx cap sync

API

initializeSdk(...)
isSdkInitialized()
getLicenseInfo()
addListener('onLicenseError', ...)
removeAllListeners()
startDocumentScanner(...)
startMrzScanner(...)
startBarcodeScanner(...)
startTextDataScanner(...)
startGenericDocumentRecognizer(...)
startBatchBarcodeScanner(...)
startEHICScanner(...)
startLicensePlateScanner(...)
startMedicalCertificateScanner(...)
closeDocumentScanner()
closeMrzScanner()
closeBarcodeScanner()
closeTextDataScanner()
closeGenericDocumentRecognizer()
closeBatchBarcodeScanner()
closeEHICScanner()
closeLicensePlateScanner()
closeMedicalCertificateScanner()
startCroppingScreen(...)
startCroppingScreen(...)
closeCroppingScreen()
getStoredPageIds()
getPageImageUris(...)
getImageData(...)
getImageData(...)
getImageData(...)
createPage(...)
removePage(...)
removePage(...)
getPageById(...)
refreshImageUris(...)
rotatePage(...)
rotatePage(...)
applyImageFilterOnPage(...)
applyImageFilterOnPage(...)
setDocumentImage(...)
createPDF(...)
writeTIFF(...)
getOcrConfigs()
performOcr(...)
detectDocument(...)
detectDocumentOnPage(...)
detectDocumentOnPage(...)
estimateBlur(...)
recognizeCheckOnImage(...)
Interfaces
Type Aliases

initializeSdk(...)

initializeSdk(config: ScanbotSdkConfiguration) => Promise<{ result: string; }>

Initializes the Scanbot SDK with the given configuration object. To be called once before any other SDK function.

Param	Type	Description
`config`	ScanbotSdkConfiguration	the configuration object of the Scanbot SDK

Returns: Promise<{ result: string; }>

isSdkInitialized()

isSdkInitialized() => Promise<{ value: boolean; }>

Checks if the Scanbot SDK was initialized.

Returns: Promise<{ value: boolean; }>

getLicenseInfo()

getLicenseInfo() => Promise<LicenseInfo>

Returns info about the current license status.

Returns: Promise<LicenseInfo>

addListener('onLicenseError', ...)

addListener(eventName: 'onLicenseError', listenerFunc: (kind: { status: LicenseStatus; sdkFeature: SdkFeature; message: string; }) => void) => Promise<PluginListenerHandle>

Param	Type
`eventName`	'onLicenseError'
`listenerFunc`	(kind: { status: LicenseStatus; sdkFeature: SdkFeature; message: string; }) => void

Returns: Promise<PluginListenerHandle>

removeAllListeners()

removeAllListeners() => Promise<void>

startDocumentScanner(...)

startDocumentScanner(args?: { uiConfigs?: DocumentScannerConfiguration | undefined; } | undefined) => Promise<DocumentScannerResult>

Starts the document scanner RTU UI.

Param	Type	Description
`args`	{ uiConfigs?: DocumentScannerConfiguration; }	optional configuration object for the document scanner RTU UI

Returns: Promise<DocumentScannerResult>

startMrzScanner(...)

startMrzScanner(configuration: MrzScannerConfiguration) => Promise<MrzResult>

Starts the Mrz scanner RTU UI.

Param	Type	Description
`configuration`	MrzScannerConfiguration	the configuration object for the Mrz scanner RTU UI

Returns: Promise<MrzResult>

startBarcodeScanner(...)

startBarcodeScanner(args: { barcodeTypes?: BarcodeFormat[]; }) => Promise<BarcodeResult>

Starts the barcode scanner RTU UI.

Param	Type	Description
`args`	{ barcodeTypes?: BarcodeFormat[]; }	configuration object, containing the optional barcode types that should be recognized

Returns: Promise<BarcodeResult>

startTextDataScanner(...)

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

Starts the text data scanner RTU UI.

Param	Type	Description
`configuration`	TextDataScannerConfiguration	the configuration object for the text data scanner RTU UI

Returns: Promise<TextDataScannerResult>

startGenericDocumentRecognizer(...)

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

Starts the generic document recognizer RTU UI.

Param	Type	Description
`configuration`	GenericDocumentRecognizerConfiguration	the configuration object for the document detection RTU UI

Returns: Promise<GenericDocumentRecognizerResult>

startBatchBarcodeScanner(...)

startBatchBarcodeScanner(configuration: BatchBarcodeScannerConfiguration) => Promise<BarcodeResult>

Starts the batch barcode scanner RTU UI.

Param	Type	Description
`configuration`	BatchBarcodeScannerConfiguration	the configuration object for the batch barcode scanner RTU UI

Returns: Promise<BarcodeResult>

startEHICScanner(...)

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

Starts the European Health Insurance Card scanner RTU UI.

Param	Type	Description
`configuration`	HealthInsuranceCardScannerConfiguration	the configuration object for the health insurance card scanner RTU UI

Returns: Promise<HealthInsuranceCardScannerResult>

startLicensePlateScanner(...)

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

Starts the license plate scanner RTU UI.

Param	Type	Description
`configuration`	LicensePlateScannerConfiguration	the configuration object for the license plate scanner RTU UI

Returns: Promise<LicensePlateScannerResult>

startMedicalCertificateScanner(...)

startMedicalCertificateScanner(configuration: MedicalCertificateRecognizerConfiguration) => Promise<MedicalCertificateScannerResult>

Starts the medical certificate scanner RTU UI.

Param	Type	Description
`configuration`	MedicalCertificateRecognizerConfiguration	the configuration object for the medical certificate scanner RTU UI

Returns: Promise<MedicalCertificateScannerResult>

closeDocumentScanner()

closeDocumentScanner() => Promise<void>

Force closes the document scanner RTU UI.

closeMrzScanner()

closeMrzScanner() => Promise<void>

Force closes the Mrz scanner RTU UI.

closeBarcodeScanner()

closeBarcodeScanner() => Promise<void>

Force closes the barcode scanner RTU UI.

closeTextDataScanner()

closeTextDataScanner() => Promise<void>

Force closes the text data scanner RTU UI.

closeGenericDocumentRecognizer()

closeGenericDocumentRecognizer() => Promise<void>

Force closes the generic document recognizer RTU UI.

closeBatchBarcodeScanner()

closeBatchBarcodeScanner() => Promise<void>

Force closes the batch barcode scanner RTU UI.

closeEHICScanner()

closeEHICScanner() => Promise<void>

Force closes the European Health Insurance Card scanner RTU UI.

closeLicensePlateScanner()

closeLicensePlateScanner() => Promise<void>

Force closes the license plate scanner RTU UI.

closeMedicalCertificateScanner()

closeMedicalCertificateScanner() => Promise<void>

Force closes the license plate scanner RTU UI.

startCroppingScreen(...)

startCroppingScreen(args: { pageId: string; config?: CroppingScreenConfiguration; }) => Promise<CroppingResult>

Starts the cropping screen RTU UI.

Param	Type	Description
`args`	{ pageId: string; config?: CroppingScreenConfiguration; }	the page or pageId to be cropped and an optional configuration object

Returns: Promise<CroppingResult>

startCroppingScreen(...)

startCroppingScreen(args: { page: Page; config?: CroppingScreenConfiguration; }) => Promise<CroppingResult>

Starts the cropping screen RTU UI.

Param	Type	Description
`args`	{ page: Page; config?: CroppingScreenConfiguration; }	the page or pageId to be cropped and an optional configuration object

Returns: Promise<CroppingResult>

closeCroppingScreen()

closeCroppingScreen() => Promise<void>

Force closes the cropping screen RTU UI.

getStoredPageIds()

getStoredPageIds() => Promise<{ pageIds: string[]; }>

Returns: Promise<{ pageIds: string[]; }>

getPageImageUris(...)

getPageImageUris(args: { preview: boolean; kind: PageFileType; pageIds: string[]; }) => Promise<{ uris: (string | undefined)[]; }>

gets the uris of the requested pages

Param	Type
`args`	{ preview: boolean; kind: PageFileType; pageIds: string[]; }

Returns: Promise<{ uris: (string)[]; }>

getImageData(...)

getImageData(args: { pageId: string; }) => Promise<{ base64ImageData: string; }>

Returns the base64 encoded image data of the requested page.

Param	Type	Description
`args`	{ pageId: string; }	the pageId for which the image data should be returned

Returns: Promise<{ base64ImageData: string; }>

getImageData(...)

getImageData(args: { page: Page; }) => Promise<{ base64ImageData: string; }>

Returns the base64 encoded image data of the requested page.

Param	Type	Description
`args`	{ page: Page; }	the page for which the image data should be returned

Returns: Promise<{ base64ImageData: string; }>

getImageData(...)

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

Returns the base64 encoded image data of the requested image file.

Param	Type	Description
`args`	{ imageFileUri: string; }	the uri of the image file for which the image data should be returned

Returns: Promise<{ base64ImageData: string; }>

createPage(...)

createPage(args: { originalImageFileUri: string; }) => Promise<Page>

Creates a new page from the image at the given image file uri.

Param	Type	Description
`args`	{ originalImageFileUri: string; }	the uri of the image file from which the page should be created

Returns: Promise<Page>

removePage(...)

removePage(args: { pageId: string; }) => Promise<void>

Removes the page with the given pageId from the storage.

Param	Type	Description
`args`	{ pageId: string; }	the pageId of the page that should be removed

removePage(...)

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

Removes the given page from the storage.

Param	Type	Description
`args`	{ page: Page; }	the page that should be removed

getPageById(...)

getPageById(args: { pageId: string; }) => Promise<Page>

Returns the page with the given pageId.

Param	Type	Description
`args`	{ pageId: string; }	the pageId of the page that should be returned

Returns: Promise<Page>

refreshImageUris(...)

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

Refreshes the image uris of the given pages.

Param	Type	Description
`args`	{ pages: Page[]; }	the pages for which the image uris should be refreshed

Returns: Promise<{ pages: Page[]; }>

rotatePage(...)

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

Rotates the page with the given pageId by 90° the given amount of times.

Param	Type	Description
`args`	{ pageId: string; times: number; }	The pageId of the page to be rotated and the amount of times it should be rotated 90°

Returns: Promise<{ page: Page; }>

rotatePage(...)

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

Rotates the page by 90° the given amount of times.

Param	Type	Description
`args`	{ page: Page; times: number; }	The page to be rotated and the amount of times it should be rotated 90°

Returns: Promise<{ page: Page; }>

applyImageFilterOnPage(...)

applyImageFilterOnPage(args: { pageId: string; filter: ImageFilter; }) => Promise<Page>

Applies the given image filter on the page with the given pageId.

Param	Type	Description
`args`	{ pageId: string; filter: ImageFilter; }	The pageId of the page on which the image filter should be applied and the image filter to be applied

Returns: Promise<Page>

applyImageFilterOnPage(...)

applyImageFilterOnPage(args: { page: Page; filter: ImageFilter; }) => Promise<Page>

Applies the given image filter on the page.

Param	Type	Description
`args`	{ page: Page; filter: ImageFilter; }	The page on which the image filter should be applied and the image filter to be applied

Returns: Promise<Page>

setDocumentImage(...)

setDocumentImage(args: { page: Page; imageUri: string; }) => Promise<Page>

Sets the document image of the page to the image at the given image file uri.

Param	Type	Description
`args`	{ page: Page; imageUri: string; }	The page for which the image should be set and the image uri of the image that should be set

Returns: Promise<Page>

createPDF(...)

createPDF(args: { imageFileUris: string[]; pageSize: PDFPageSize; }) => Promise<{ pdfFileUri: string; }>

Creates a PDF from the given images. In the format of the given page size.

Param	Type	Description
`args`	{ imageFileUris: string[]; pageSize: PDFPageSize; }	The images from which the PDF should be created and the page size of the PDF

Returns: Promise<{ pdfFileUri: string; }>

writeTIFF(...)

writeTIFF(args: { imageFileUris: string[]; options: { oneBitEncoded?: boolean; dpi?: number; compression?: TIFFCompression; }; }) => Promise<{ tiffFileUri: string; }>

Writes the given images to a TIFF file.

Param	Type	Description
`args`	{ imageFileUris: string[]; options: { oneBitEncoded?: boolean; dpi?: number; compression?: TIFFCompression; }; }	the images to be written to the TIFF file and the options for the TIFF file

Returns: Promise<{ tiffFileUri: string; }>

getOcrConfigs()

getOcrConfigs() => Promise<{ languageDataPath: string; installedLanguages: string[]; }>

Returns info about the installed OCR languages and the path to the language data.

Returns: Promise<{ languageDataPath: string; installedLanguages: string[]; }>

performOcr(...)

performOcr(args: { images: string[]; languages: string[]; outputFormat?: OCROutputFormat; }) => Promise<{ plainText?: string; pdfFileUri?: string; jsonData?: any; }>

Performs OCR on the given images.

Param	Type	Description
`args`	{ images: string[]; languages: string[]; outputFormat?: OCROutputFormat; }	The images on which OCR should be performed, the languages to be used and the output format

Returns: Promise<{ plainText?: string; pdfFileUri?: string; jsonData?: any; }>

detectDocument(...)

detectDocument(args: { imageFileUri: string; quality?: number; }) => Promise<DocumentDetectionResult>

Detects the document on the given image file.

Param	Type	Description
`args`	{ imageFileUri: string; quality?: number; }	The image file uri on which the document should be detected and the quality of the detection (0-100)

Returns: Promise<DocumentDetectionResult>

detectDocumentOnPage(...)

detectDocumentOnPage(args: { pageId: string; }) => Promise<Page>

Detects the document on the page with the given pageId.

Param	Type	Description
`args`	{ pageId: string; }	The page on which the document should be detected

Returns: Promise<Page>

detectDocumentOnPage(...)

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

Detects the document on the given page.

Param	Type	Description
`args`	{ page: Page; }	The page on which the document should be detected

Returns: Promise<Page>

estimateBlur(...)

estimateBlur(args: { imageFileUri: string; }) => Promise<{ blur: number; }>

Estimates the blur of the image file at the given uri.

Param	Type	Description
`args`	{ imageFileUri: string; }	The uri of the image file for which the blur should be estimated

Returns: Promise<{ blur: number; }>

recognizeCheckOnImage(...)

recognizeCheckOnImage(args: RecognizeCheckOnImageArgs) => Promise<CheckRecognizerResult>

Recognizes the check on the given image file.

Param	Type	Description
`args`	RecognizeCheckOnImageArgs	The uri of the image file on which the check should be recognized and the supported check standards

Returns: Promise<CheckRecognizerResult>

Interfaces

ScanbotSdkConfiguration

Prop	Type	Description
`version`	string	A version of the configuration object
`screen`	string	The configuration object should be applied for this screen
`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 `false`.
`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)

LicenseInfo

Prop	Type
`isLicenseValid`	boolean
`licenseStatus`	LicenseStatus
`licenseExpirationDate`	number

PluginListenerHandle

Prop	Type
`remove`	() => Promise<void>

DocumentScannerResult

Prop	Type	Description
`status`	Status	The status of the document scanner.
`pages`	Page[]	The detected pages.

Page

Prop	Type	Description
`pageId`	string	A string identifying the page in the internal page file storage
`polygon`	Point[]	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 (either the document scanner or `detectDocument()`)
`pageImageSource`	PageImageSource	The image source (MANUAL_SNAP, AUTO_SNAP, CAMERA_FRAME) or UNKNOWN if the image has been imported or the source is unknown.
`filter`	ImageFilter	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

Point

Prop	Type
`x`	number
`y`	number

Size

Prop	Type
`width`	number
`height`	number

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 (1 second).
`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 null.
`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 no. Default is true.
`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.
`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. Optional, default is Fit-In.
`cancelButtonTitle`	string	Title of the cancel button.
`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.
`ignoreBadAspectRatio`	boolean	Sets whether to ignore the net.doo.snap.lib.detector.DetectionResult.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.
`interfaceOrientation`	UIInterfaceOrientationMask	Orientation lock mode of the UI, the camera preview, and the output images. By default the orientation is not locked.
`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.
`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 net.doo.snap.lib.detector.DetectionResult.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 net.doo.snap.lib.detector.DetectionResult.OK.
`polygonLineWidth`	number	Width of the detected document outline.
`shutterButtonAutoInnerColor`	string	The foreground color of the shutter button in auto-snapping mode.
`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.
`shutterButtonManualInnerColor`	string	The foreground color of the shutter button in manual mode.
`shutterButtonManualOuterColor`	string	The background color of the shutter button in manual mode.
`textHintBadAngles`	string	Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ANGLES
`textHintBadAspectRatio`	string	Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ASPECT_RATIO
`textHintNothingDetected`	string	Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.ERROR_NOTHING_DETECTED
`textHintOK`	string	Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.OK
`textHintTooDark`	string	Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.ERROR_TOO_DARK
`textHintTooNoisy`	string	Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.ERROR_TOO_NOISY
`textHintTooSmall`	string	Text hint that will be shown when the current detection status is net.doo.snap.lib.detector.DetectionResult.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.
`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
`forceMaxSnappingSize`	boolean	Set whether camera should force maximum possible size of snapped picture or use maximum size that available with the same aspect ratio as preview default is false Android only

DocumentScannerAccessibilityConfiguration

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.
`pageCounterButtonAccessibilityHint`	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.

MrzResult

Prop	Type	Description
`status`	Status	The status of the result.

MrzScannerConfiguration

Prop	Type	Description
`version`	string	A version of the configuration object
`screen`	string	The configuration object should be applied for this screen
`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`	FinderAspectRatio	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.
`flashButtonTitle`	string	Title of the flash toggle button.
`flashEnabled`	boolean	Controls whether the flash should be initially enabled. The default value is FALSE.
`orientationLockMode`	OrientationLockType	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
`autoCancelTimeout`	number	Time in seconds until the screen is automatically cancelled. Set to 0 to disable automatic cancellation. Defaults to 0 (disabled). iOS only.

FinderAspectRatio

Prop	Type
`width`	number
`height`	number

BarcodeResult

Prop	Type
`status`	Status
`barcodes`	BarcodeResultField[]

BarcodeResultField

Prop	Type	Description
`type`	BarcodeFormat	The barcode format.
`text`	string	The raw text encoded in the barcode.
`textWithExtension`	string	The raw text with extension encoded in the barcode
`rawBytes`	number[]	The array of raw bytes contained in the barcode.

TextDataScannerResult

Prop	Type
`status`	Status
`result`	{ text: string; confidence: number; }

TextDataScannerConfiguration

Prop	Type	Description
`version`	string	A version of the configuration object
`screen`	string	The configuration object should be applied for this screen
`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.
`flashButtonTitle`	string	Title of the flash toggle button.
`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
`supportedLanguages`	string[]	Languages on which the recognition will be run. ISO 639-1 or RFC4646 for special languages that are not available for ISO 639-1
`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
`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`	FinderAspectRatio	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.
`textFilterStrategy`	TextFilterStrategy	Recognition strategy for the text.
`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'

GenericDocumentRecognizerResult

Prop	Type	Description
`documentType`	GenericDocumentType	The type of the scanned document The type of the scanned document.
`status`	Status	The status of the scan The status of the recognition.
`fields`	GenericDocumentFields	The list of document fields The data extracted from the scanned document. Available fields are listed in {@link GenericDocumentFields}

DeDriverLicenseResult

Prop	Type	Description
`birthDate`	GenericDocumentField	The date of birth of the License owner
`birthplace`	GenericDocumentField	The place of birth of the License owner
`expiryDate`	GenericDocumentField	The expiry date of the License
`givenNames`	GenericDocumentField	The geven names of the License owner
`id`	GenericDocumentField	The id Present on the License
`issueDate`	GenericDocumentField	The issuing date of the License
`issuingAuthority`	GenericDocumentField	The issuing authority of the License
`licenseCategories`	GenericDocumentField	The raw categories for which the License owner is permitted to drive. See {@link DriverLicenseCategories}
`photoImageUri`	string	The URI to the image of the photo of the License owner.
`signatureImageUri`	string	The URI to the image of the signature of the License owner.
`surname`	GenericDocumentField	The surname of the License owner
`restrictions`	GenericDocumentField	The restrictions to driving privileges for the License owner
`categories`	DriverLicenseCategories	The vehicle categories for which the License owner is permitted to drive.

GenericDocumentField

Prop	Type	Description
`text`	string	The text of the detected field. The text that was detected.
`confidence`	number	The confidence in the accuracy of the detected Text. The confidence in the correctness of the detected text

DriverLicenseCategories

Prop	Type	Description
`a`	DriverLicenseCategory	The field contains information about the category A
`a1`	DriverLicenseCategory	The field contains information about the category A1
`a2`	DriverLicenseCategory	The field contains information about the category A2
`b`	DriverLicenseCategory	The field contains information about the category B
`b1`	DriverLicenseCategory	The field contains information about the category B1
`be`	DriverLicenseCategory	The field contains information about the category BE
`c`	DriverLicenseCategory	The field contains information about the category C
`c1`	DriverLicenseCategory	The field contains information about the category C1
`c1e`	DriverLicenseCategory	The field contains information about the category C1E
`ce`	DriverLicenseCategory	The field contains information about the category CE
`d`	DriverLicenseCategory	The field contains information about the category D
`d1`	DriverLicenseCategory	The field contains information about the category D1
`d1e`	DriverLicenseCategory	The field contains information about the category D1E
`de`	DriverLicenseCategory	The field contains information about the category DE
`l`	DriverLicenseCategory	The field contains information about the category L
`m`	DriverLicenseCategory	The field contains information about the category M
`t`	DriverLicenseCategory	The field contains information about the category T

DriverLicenseCategory

Prop	Type	Description
`restrictions`	GenericDocumentField	The field contains information about the restrictions
`validFrom`	GenericDocumentField	The field contains information about the valid from date
`validUntil`	GenericDocumentField	The field contains information about the valid until date

DePassportResult

Prop	Type	Description
`birthDate`	GenericDocumentField	The date of birth of the Passport owner
`birthplace`	GenericDocumentField	The place of birth of the Passport owner
`countryCode`	GenericDocumentField	The country code of the Passport
`expiryDate`	GenericDocumentField	The date of expiry of the Passport
`gender`	GenericDocumentField	The gender of the Passport owner
`givenNames`	GenericDocumentField	The given names of the Passport owner
`id`	GenericDocumentField	The id Present on the Passport
`issueDate`	GenericDocumentField	The issuing date of the Passport
`issuingAuthority`	GenericDocumentField	The issuing authority of the Passport
`maidenName`	GenericDocumentField	The maiden name of the Passport owner
`nationality`	GenericDocumentField	The nationality of the Passport owner
`passportType`	GenericDocumentField	The type of passport
`photoImageUri`	string	The URI to image of the photo of the Passport owner.
`rawMrz`	GenericDocumentField	The raw MRZ data of the Passport
`signatureImageUri`	string	The URI to image of the signature of the Passport owner.
`surname`	GenericDocumentField	The surname of the Passport owner
`mrz`	MrzDocumentResult	The parsed MRZ data of the Passport

MrzDocumentResult

Prop	Type	Description
`birthDate`	GenericDocumentField	The Birth Date of the document owner.
`checkDigits`	GenericDocumentField[]	The Check Digit for the MRZ data.
`documentNumber`	GenericDocumentField	The document number in the MRZ data.
`expiryDate`	GenericDocumentField	The Expiry Date of the document.
`gender`	GenericDocumentField	The Gender of the document owner.
`givenNames`	GenericDocumentField	The given names of the document owner.
`issuingAuthority`	GenericDocumentField	The issuing authority of the document.
`nationality`	GenericDocumentField	The nationality of the document owner
`optional1`	GenericDocumentField	The optional data of the document owner
`optional2`	GenericDocumentField	The optional data of the document owner
`surname`	GenericDocumentField	The surname of the document owner
`travelDocType`	GenericDocumentField	The type of the document
`travelDocTypeVariant`	GenericDocumentField	The variant of the document

DeIdCardResult

Prop	Type	Description
`birthDate`	GenericDocumentField	The Birth Date of the German ID owner.
`birthplace`	GenericDocumentField	The Birth Place of the German ID owner.
`expiryDate`	GenericDocumentField	The Date of Expiry of the German ID.
`givenNames`	GenericDocumentField	The Given Names of the German ID owner.
`id`	GenericDocumentField	The ID Number of the German ID.
`maidenName`	GenericDocumentField	The Maiden Name of the German ID owner.
`nationality`	GenericDocumentField	The Nationality of the German ID owner.
`pin`	GenericDocumentField	The PIN number of the German ID owner.
`photoImageUri`	string	The URI to the image of the photo of the German ID owner.
`signatureImageUri`	string	The URI to the image of the signature of the German ID owner.
`surname`	GenericDocumentField	The Surname of the German ID owner.
`address`	GenericDocumentField	The Address of the German ID owner.
`eyeColor`	GenericDocumentField	The Eye color of the German ID owner.
`height`	GenericDocumentField	The Height of the German ID owner.
`issueDate`	GenericDocumentField	The issue date of the German ID.
`issuingAuthority`	GenericDocumentField	The issuing authority of the German ID.
`pseudonym`	GenericDocumentField	The pseudonyms of of the German ID owner
`rawMrz`	GenericDocumentField	The raw MRZ result.

GenericDocumentRecognizerConfiguration

Prop	Type	Description
`version`	string	A version of the configuration object
`screen`	string	The configuration object should be applied for this screen
`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

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

BatchBarcodeScannerConfiguration

Prop	Type	Description
`version`	string	A version of the configuration object
`screen`	string	The configuration object should be applied for this screen
`acceptedDocumentFormats`	BarcodeDocumentFormat[]	An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
`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 (1.0; 3.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`	FinderAspectRatio	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.
`flashButtonTitle`	string	String being displayed on the flash button.
`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.
`focusLockPosition`	number	The position of the lens. Values can be between 0.0f (minimum focusing distance) and 1.0f (maximum focusing distance). The value will be clamped to 0.0f, 1.0f. The default value is 0.0.
`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.
`gs1DecodingEnabled`	boolean	When set to `true`, the scanner assumes that the barcode can be a GS1 barcode. Turn it off, if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29). The default value is `true`. NOTE - Currently works for CODE128 barcodes only!
`msiPlesseyChecksumAlgorithm`	MSIPlesseyChecksumAlgorithm	The checksum algorithm for MSI Plessey barcodes. The default value is Mod10.
`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.
`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.
`decodeStacks1D`	number	Number of stacks to split a 1D barcode crop before extracting scanlines. For stacked RSS barcodes, this should be set to the numbers of stacks with which the barcode was printed. For other barcodes, the default of 1 is good enough. Setting it higher will slighty increase frame times, improve performance on hard barcodes and possibly increase the number of false positives.
`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.
`overlayConfiguration`	SelectionOverlayConfiguration	The selection overay 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 3.0.

SelectionOverlayConfiguration

Barcode Selection Overlay configuration

Prop	Type	Description
`overlayEnabled`	boolean	Whether the barcode selection overlay is enabled 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.

HealthInsuranceCardScannerResult

Prop	Type	Description
`status`	Status	The status of the scanning process.
`fields`	{ type: string; value: string; confidence: number; }[]	The detected health insurance card fields.

HealthInsuranceCardScannerConfiguration

Prop	Type	Description
`version`	string	A version of the configuration object
`screen`	string	The configuration object should be applied for this screen
`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.
`flashButtonTitle`	string	Title of the flash toggle button.
`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

LicensePlateScannerResult

Prop	Type	Description
`status`	Status	`'OK'` if the License Plate was scanned, `'CANCELED'` if the user canceled the scanner UI.
`licensePlate`	string	The License Plate detected by the scanner
`confidence`	number	Confidence in the accuracy of the detection (0 - 100)
`countryCode`	string	The Country Code on the License Plate as detected by the scanner
`rawText`	string	The entire raw text detected on the License Plate by the scanner
`isValidationSuccessful`	boolean	'true' if the validation of the scanned license plate was successful, 'false' otherwise - iOS only.

LicensePlateScannerConfiguration

Prop	Type	Description
`version`	string	A version of the configuration object
`screen`	string	The configuration object should be applied for this screen
`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 heigth of the view finder. Defaults to 150.0. iOS Only.
`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.
`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.
`confirmationDialogConfirmButtonFilled`	boolean	Allows to set if the confirm button should be filled. Defaults to TRUE.
`confirmationDialogConfirmButtonFilledTextColor`	string	Allows to set a text color of the filled button. See `confirmationDialogConfirmButtonFilled`.
`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

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.

MedicalCertificateScannerResult

Prop	Type	Description
`status`	Status	`'OK'` if the Medical Certificate was scanned, `'CANCELED'` if the user canceled the scanner UI.
`formType`	MedicalCertificateFormType	The Medical Certificate Form Type
`imageFileUri`	string	Image file uri of the captured Medical Certificate
`patientData`	{ insuranceProvider?: string; firstName?: string; lastName?: string; address1?: string; address2?: string; diagnose?: string; healthInsuranceNumber?: string; insuredPersonNumber?: string; status?: string; placeOfOperationNumber?: string; doctorNumber?: string; unknown?: string; }	The extracted patient data
`dates`	{ incapableOfWorkSince?: MedicalCertificateDateField; incapableOfWorkUntil?: MedicalCertificateDateField; diagnosedOn?: MedicalCertificateDateField; childNeedsCareFrom?: MedicalCertificateDateField; childNeedsCareUntil?: MedicalCertificateDateField; birthDate?: MedicalCertificateDateField; documentDate?: MedicalCertificateDateField; unknown?: MedicalCertificateDateField; }	The extracted dates data
`checkboxes`	{ initialCertificate?: MedicalCertificateCheckboxField; renewedCertificate?: MedicalCertificateCheckboxField; workAccident?: MedicalCertificateCheckboxField; assignedToAccidentInsuranceDoctor?: MedicalCertificateCheckboxField; accident?: MedicalCertificateCheckboxField; accidentNo?: MedicalCertificateCheckboxField; requiresCare?: MedicalCertificateCheckboxField; requiresCareNo?: MedicalCertificateCheckboxField; insuredPayCase?: MedicalCertificateCheckboxField; finalCertificate?: MedicalCertificateCheckboxField; otherAccident?: MedicalCertificateCheckboxField; unknown?: MedicalCertificateCheckboxField; }	The extracted checkboxes data. It contains information about the medical form checkboxes type and whether they are checked or not.

MedicalCertificateDateField

Prop	Type	Description
`validationConfidence`	number	The conficende in the validity of this Field.
`recognitionConfidence`	number	The confidence of the date field recognition.
`dateString`	string	The date as a string.

MedicalCertificateCheckboxField

Prop	Type	Description
`isChecked`	boolean	Whether the checkbox was checked(True) or unchecked(False).
`confidence`	number	The confidence of the checkbox recognition.

MedicalCertificateRecognizerConfiguration

Prop	Type	Description
`version`	string	A version of the configuration object
`screen`	string	The configuration object should be applied for this screen
`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.
`flashButtonTitle`	string	Title of the flash toggle button.
`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. iOS only.
`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
`finderAspectRatio`	FinderAspectRatio	Aspect ratio of the view finder (width \ height). Set to nil of no view finder should be displayed. iOS only.
`finderSecondaryAspectRatio`	FinderAspectRatio	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.

CroppingResult

Prop	Type	Description
`status`	Status	The status of the cropping operation.
`page`	Page	The cropped page.

CroppingScreenConfiguration

Prop	Type	Description
`hintTitle`	string	String being displayed as a hint. Empty by default.
`hintTitleColor`	string	Text color of the hint title.
`backgroundColor`	string	Background color of the main screen.
`bottomBarBackgroundColor`	string	Background color of the bottom toolbar.
`bottomBarButtonsColor`	string	Color of the titles of all buttons in the bottom toolbar (Rotate button).
`cancelButtonTitle`	string	Title of the cancel button.
`doneButtonTitle`	string	Title of the Done button.
`polygonColor`	string	Default color of the cropping outline.
`polygonColorMagnetic`	string	Outline color of magnetically snapped edges.
`polygonLineWidth`	number	Width of the cropping outline.
`rotateButtonTitle`	string	Title of the Rotate button.
`topBarBackgroundColor`	string	Background color of the top toolbar.
`topBarButtonsColor`	string	Color of the titles of all buttons in the top toolbar (Cancel and Done buttons).
`topBarTitle`	string	Title in the top bar (iOS only).
`titleColor`	string	Color of the title in the top bar (iOS only).
`detectButtonTitle`	string	Title of the Detect button.
`resetButtonTitle`	string	Title of the Reset button.
`rotateButtonHidden`	boolean	Controls whether the Rotate button is hidden or not.
`detectResetButtonHidden`	boolean	Controls whether the Detect/Reset button is hidden or not.
`interfaceOrientation`	UIInterfaceOrientationMask	UI orientation lock mode: PORTRAIT, LANDSCAPE, etc. By default the UI is not locked.
`useButtonsAllCaps`	boolean	Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
`accessibilityConfiguration`	CroppingScreenAccessibilityConfiguration	Allows you to customize the accessibility configuration for the Cropping Screen UI.
`topAndBottomButtonsSwapped`	boolean	Defines if the top and bottom buttons are swapped. Default is false.

CroppingScreenAccessibilityConfiguration

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 label for the rotate button.
`rotateButtonAccessibilityHint`	string	Text, that is used as an accessibility hint for the rotate button.

DocumentDetectionResult

Prop	Type	Description
`detectionResult`	DetectionStatus	The status of the detection
`polygon`	Polygon	The polygon of the detected document on the original image
`documentImageFileUri`	string	The image of the detected document

Polygon

Prop	Type
`points`	{ x: number; y: number; }[]

CheckRecognizerResult

Prop	Type
`checkType`	CheckType
`imageFileUri`	string
`status`	CheckRecognizerResultStatus
`fields`	CheckRecognizerFields

USACheckResult

Prop	Type
`accountNumber`	CheckRecognizerField
`auxiliaryOnUs`	CheckRecognizerField
`transitNumber`	CheckRecognizerField

CheckRecognizerField

Prop	Type	Description
`value`	GenericDocumentField	The detected field.
`validationStatus`	CheckRecognizerFieldValidationStatus	The validation status of the field.

FRACheckResult

Prop	Type
`accountNumber`	CheckRecognizerField
`chequeNumber`	CheckRecognizerField
`routingNumber`	CheckRecognizerField

KWTCheckResult

Prop	Type
`accountNumber`	CheckRecognizerField
`chequeNumber`	CheckRecognizerField
`sortCode`	CheckRecognizerField

AUSCheckResult

Prop	Type
`accountNumber`	CheckRecognizerField
`auxDomestic`	CheckRecognizerField
`bsb`	CheckRecognizerField
`extraAuxDomestic`	CheckRecognizerField
`transactionCode`	CheckRecognizerField

INDCheckResult

Prop	Type
`accountNumber`	CheckRecognizerField
`serialNumber`	CheckRecognizerField
`sortNumber`	CheckRecognizerField
`transactionCode`	CheckRecognizerField

UnknownCheckResult

RecognizeCheckOnImageArgs

Prop	Type	Description
`imageFileUri`	string	The input image file URI.
`acceptedCheckStandards`	CheckType[]	An optional array of check types that act as a detection filter. By default all supported document formats will be detected.