BlinkIdScanningSettings class

Represents the configurable settings for scanning a document.

This class defines various parameters and policies related to the scanning process, including image quality handling, data extraction and anonymization, along with options for frame processing and image extraction.

Annotations
  • @JsonSerializable()

Constructors

BlinkIdScanningSettings.new()
Represents the configurable settings for scanning a document.
BlinkIdScanningSettings.fromJson(Map<String, dynamic> json)
factory

Properties

allowUncertainFrontSideScan bool
Indicates whether scanning can continue to the next side despite an uncertain front-side scan.
getter/setter pair
anonymizationMode AnonymizationMode
The mode of anonymization applied to the document.
getter/setter pair
blurDetectionLevel DetectionLevel
The level of blur detection in the document image.
getter/setter pair
combineResultsFromMultipleInputImages bool
Indicates whether the aggregation of data from multiple images is enabled.
getter/setter pair
croppedImageSettings CroppedImageSettings
Configures the image processing settings during the scanning process.
getter/setter pair
customDocumentAnonymizationSettings List<DocumentAnonymizationSettings>?
Redact fields for specific document class.
getter/setter pair
customDocumentRules List<DocumentRules>?
Defines custom rules for specific document class.
getter/setter pair
enableBarcodeScanOnly bool
Enables barcode recognition to proceed even if the initial VIZ extraction fails.
getter/setter pair
enableCharacterValidation bool
Indicates whether character validation is enabled.
getter/setter pair
glareDetectionLevel DetectionLevel
The level of glare detection in the document image.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
inputImageMargin double
Defines the minimum required margin (in percentage) between the edge of the input image and the document.
getter/setter pair
maxAllowedMismatchesPerField int
The maximum allowed mismatches per field during data matching.
getter/setter pair
recognitionModeFilter RecognitionModeFilter
The filter for recognition modes.
getter/setter pair
returnInputImages bool
Indicates whether input images should be returned.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scanCroppedDocumentImage bool
Process only cropped document images. 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.
getter/setter pair
scanPassportDataPageOnly bool
Indicates whether only the passport data page should be scanned.
getter/setter pair
scanUnsupportedBack bool
Indicates whether backside of unsupported document should be scanned also.
getter/setter pair
skipImagesOccludedByHand bool
Indicates whether images occluded by hand should be rejected.
getter/setter pair
skipImagesWithBlur bool
Indicates whether images with blur in the document image should be skipped.
getter/setter pair
skipImagesWithGlare bool
Indicates whether images with glare in the document image should be skipped.
getter/setter pair
skipImagesWithInadequateLightingConditions bool
Indicates whether images with inadequate lighting conditions should be rejected.
getter/setter pair
tiltDetectionLevel DetectionLevel
The level of allowed detected tilt of the document in the image.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited