Package-level declarations

Types

Link copied to clipboard
data class CroppedImageSettings(var dotsPerInch: UShort, @FloatRange(from = 0.0, to = 1.0) var extensionFactor: Float = 0.0f, var returnDocumentImage: Boolean = false, var returnFaceImage: Boolean = false, var returnSignatureImage: Boolean = false) : Parcelable

Represents the image cropping settings.

Link copied to clipboard
data class DetailedFieldType(val fieldType: FieldType, val alphabetType: AlphabetType) : Parcelable

Represents the detailed field type.

Link copied to clipboard

Represents the different levels of detection sensitivity.

Link copied to clipboard
data class DocumentFilter(var country: Country? = null, var region: Region? = null, var type: Type? = null) : Parcelable

Represents the document filter.

Link copied to clipboard
data class DocumentNumberRedactionSettings(val prefixDigitsVisible: UByte, val suffixDigitsVisible: UByte) : Parcelable

Represents the document number redaction settings.

Link copied to clipboard
@ApiStatus.Experimental
data class RecognitionModeFilter(var enableMrzId: Boolean = true, var enableMrzVisa: Boolean = true, var enableMrzPassport: Boolean = true, var enablePhotoId: Boolean = true, var enableBarcodeId: Boolean = true, var enableFullDocumentRecognition: Boolean = true) : Parcelable

Represents the configuration used to enable/disable recognition of specific document groups.

Link copied to clipboard

RedactionMode is used to define level of redaction performed on recognizer result.

Link copied to clipboard
data class RedactionSettings(val redactionMode: RedactionMode = RedactionMode.FullResult, val fields: List<FieldType>, val documentNumberRedactionSettings: DocumentNumberRedactionSettings?, val redactMrz: Boolean = false, val redactBarcode: Boolean = false) : Parcelable

Represents the document redaction settings.

Link copied to clipboard

Resolves RedactionSettings for a given document class.

Link copied to clipboard
data class ScanningSettings(val documentCaptureModule: DocumentCaptureModuleSettings? = DocumentCaptureModuleSettings(), val barcodeModule: BarcodeModuleSettings? = BarcodeModuleSettings(), val mrzModule: MrzModuleSettings? = MrzModuleSettings(), val vizModule: VizModuleSettings? = VizModuleSettings(), val maxAllowedMismatchesPerField: UInt) : Parcelable

Represents the configurable settings for scanning a document.

Link copied to clipboard

Represents the sensitivity levels for document quality analysis.