blinkid-verify-core/com.microblink.blinkidverify.core.settings

Package-level declarations

Types

class BlinkIdVerifyServiceSettings(val verificationServiceBaseUrl: String, val token: String?, val requestTimeout: RequestTimeout = RequestTimeout.DEFAULT, val mbClientSdkName: String? = null, val mbClientSdkVersion: String? = null, val mbRunnerVersion: String? = null)

Settings for the verification service.

CroppedImageSettings

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.

DetailedFieldType

data class DetailedFieldType(val fieldType: FieldType, val alphabetType: AlphabetType) : Parcelable

Represents the detailed field type.

DocumentFilter

data class DocumentFilter(var country: CountryId? = null, var region: RegionId? = null, var type: DocumentTypeId? = null) : Parcelable

Represents the document filter.

DocumentNumberRedactionSettings

data class DocumentNumberRedactionSettings(val prefixDigitsVisible: UByte, val suffixDigitsVisible: UByte) : Parcelable

Represents the document number redaction settings.

OtaResourcesConfig

data class OtaResourcesConfig(val checkForUpdates: Boolean = true, val strict: Boolean = false, val serviceUrl: String = defaultOtaDownloadUrl, val localFolder: String = defaultOtaResourcesLocalFolder, val requestTimeout: RequestTimeout = RequestTimeout.DEFAULT) : Parcelable

Configuration for over-the-air (OTA) resource downloads and local storage.

RecognitionModeFilter

@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.

RedactionMode

enum RedactionMode : Enum<RedactionMode>

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

RedactionSettings

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.

RedactionSettingsResolver

interface RedactionSettingsResolver : Parcelable

Resolves RedactionSettings for a given document class.

ResourcesConfig

data class ResourcesConfig(val download: Boolean = true, val serviceUrl: String = defaultResourceDownloadUrl, val localFolder: String = defaultResourcesLocalFolder, val requestTimeout: RequestTimeout = RequestTimeout.DEFAULT) : Parcelable

Configuration for SDK resource downloads and local storage.

ScanningSettings

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.

SensitivityLevel

enum SensitivityLevel : Enum<SensitivityLevel>

Represents the sensitivity levels for document quality analysis.