DocumentCaptureModuleSettings

The sensitivity of blur detection in the document image. Defines the severity of blur detected in the document image, as defined in SensitivityLevel. Values range from Off (detection NotAvailable) to higher sensitivity levels of blur detection. Low – less sensitive to blur; if something is detected as blur, it is almost certainly actual blur, but some amount of blur may not be detected at all. High – highly sensitive to blur; it may detect as blur even something that only resembles blur. Defaults to SensitivityLevel.Mid.

Indicates whether the document image should be returned. Defaults to false.

The DPI value for the cropped document, face and signature image. Allowed minimal value is 100 and maximum value is 400. Defaults to 250.

The extension factor for the cropped document image. Applicable only to document images. Allowed minimal value is 0.0 and maximum value is 1.0. Defaults to 0f.

Enables the extraction of the document's face image. If face image is present on the document, an extraction becomes mandatory if supported. For supported documents, the requirement for its presence is determined by document rules. For unsupported documents, presence is optional. Defaults to false.

If set to true, face image presence will be mandatory for the scanned document. For Automatic ScanningMode, document side with the face image must be scanned first. In case of a timeout and advancement to the next step in the scanning flow, if a face image is detected on the scanned side but cannot be extracted, the presence requirement is considered fulfilled. As a result, face image extraction will no longer be a requirement to complete the scan on next side. Defaults to false.

The sensitivity of glare detection in the document image. Defines the severity of glare detected in the document image, as defined in SensitivityLevel. Values range from Off (detection NotAvailable) to higher sensitivity levels of glare detection. Low – less sensitive to glare; if something is detected as glare, it is almost certainly actual glare, but some amount of glare may not be detected at all. High – highly sensitive to glare; it may detect as glare even something that only resembles glare. Defaults to SensitivityLevel.Mid.

Indicates whether images with detected blur should be rejected. A value of true means images with detected blur will be excluded from further processing. If blur is detected, ProcessingStatus will be ImagePreprocessingFailed. A value of false means images will be processed even if blur is detected, and the blur status will be reported in the ProcessResult. Defaults to true.

Indicates whether images with detected glare should be rejected. A value of true means images with detected glare will be excluded from further processing. If glare is detected, ProcessingStatus will be ImagePreprocessingFailed. A value of false means images will be processed even if glare is detected, and the glare status will be reported in the ProcessResult. Defaults to true.

Indicates whether images occluded by hand should be rejected. A value of true means images occluded by hand will be excluded from further processing to prevent occluded images from being used - If hand occlusion is detected ProcessingStatuswill be ImagePreprocessingFailedand hand occlusion status will be reported in the ProcessResultThis setting is applicable only if inputImageCropped= false. Defaults to true`.

Indicates whether images with poor lighting conditions should be rejected. Poor lighting conditions are represented as either TooBright or TooDark document images, as defined in the ImageAnalysisLightingStatus enum. A value of true means images with poor lighting conditions will be excluded from further processing to prevent images with inadequate lighting from being used - If poor light conditions are detected ProcessingStatus will be ImagePreprocessingFailed and lighting status will be reported in the ProcessResult. Defaults to true.

Indicates whether the input image is already cropped and perspective-corrected. Requires the input image to consist solely of the cropped document image with perspective correction applied. This only applies to images from Photo input image source - for images from Video input image source, setting will be ignored. Defaults to false.

Defines the minimum required margin (in percentage) between the edge of the input image and the document. This setting is implemented to comply with regulations in certain countries that mandate documents to be stored with adequate margins in the image. Default value is 0.02f (also recommended value). The setting is applicable only when using images from Video source The setting is not applicable if inputImageCropped = true (it will be ignored). Allowed minimal value is 0.0 and maximum value is 1.0.

Indicates whether input images should be returned in the result. Save the input images at the moment of the data extraction or timeout. This significantly increases memory consumption. The scanning performance is not affected. Defaults to false.

Indicates whether only the passport data page should be scanned. Scan only the data page ( page containing MRZ ) of the passport. If set to false, it will be required to scan the second page of certain passports. Defaults to true.

Indicates whether the back side scan should be skipped if the document supports only image capture on that side. Some documents have a back side that is supported but contains no extractable data (no MRZ, Barcode, etc.). These sides will be "captured only". If set to true (default), the scanning process will stop after the front side for such documents. If set to false, the back side will be captured, even though no data extraction is performed. Defaults to true.

The sensitivity of allowed detected tilt of the document in the image. Defines the severity of allowed detected tilt of the document in the image, as defined in SensitivityLevel. Values range from Off (detection NotAvailable) to higher sensitivity levels of allowed tilt. Low – less sensitive to tilt. High – highly sensitive to tilt. Defaults to SensitivityLevel.Mid.

Enables the scanning and processing of unsupported document types. A document is considered unsupported if its classification result is OTHER. Defaults to false.