blinkid-verify-core/com.microblink.blinkidverify.core.capture.session/BlinkIdVerifyScanningSettings

BlinkIdVerifyScanningSettings

@Serializable

data class BlinkIdVerifyScanningSettings @JvmOverloads constructor(val scanUnsupportedBack: Boolean? = null, val scanPassportDataPageOnly: Boolean? = null, val treatExpirationAsFraud: Boolean? = null, val screenAnalysisMatchLevel: MatchLevel? = null, val staticSecurityFeaturesMatchLevel: MatchLevel? = null, val barcodeAnomalyMatchLevel: MatchLevel? = null, val dataMatchMatchLevel: MatchLevel? = null, val imageQualitySettings: ImageQualitySettings? = null, val useCase: BlinkIdVerifyProcessingUseCase? = null, val photocopyMatchLevel: MatchLevel? = null, val photoForgeryMatchLevel: MatchLevel? = null, val generativeAiMatchLevel: MatchLevel? = null, val returnFullDocumentImage: Boolean? = null, val returnFaceImage: Boolean? = null, val returnSignatureImage: Boolean? = null, val redactionMode: RedactionMode? = null, val imageQualitySensitivity: MatchLevel? = null, val imageQualityRetryPolicy: ImageQualityRetryPolicy? = null, val cropAffectsVerdict: Boolean? = null, val verificationPolicy: VerifyVerificationPolicy? = null, val barcodeImageReturnEnabled: Boolean? = null) : Parcelable

Defines behavior for a BlinkID Verify session.

Constructors

@JvmOverloads

constructor(scanUnsupportedBack: Boolean? = null, scanPassportDataPageOnly: Boolean? = null, treatExpirationAsFraud: Boolean? = null, screenAnalysisMatchLevel: MatchLevel? = null, staticSecurityFeaturesMatchLevel: MatchLevel? = null, barcodeAnomalyMatchLevel: MatchLevel? = null, dataMatchMatchLevel: MatchLevel? = null, imageQualitySettings: ImageQualitySettings? = null, useCase: BlinkIdVerifyProcessingUseCase? = null, photocopyMatchLevel: MatchLevel? = null, photoForgeryMatchLevel: MatchLevel? = null, generativeAiMatchLevel: MatchLevel? = null, returnFullDocumentImage: Boolean? = null, returnFaceImage: Boolean? = null, returnSignatureImage: Boolean? = null, redactionMode: RedactionMode? = null, imageQualitySensitivity: MatchLevel? = null, imageQualityRetryPolicy: ImageQualityRetryPolicy? = null, cropAffectsVerdict: Boolean? = null, verificationPolicy: VerifyVerificationPolicy? = null, barcodeImageReturnEnabled: Boolean? = null)

Properties

barcodeAnomalyMatchLevel

val barcodeAnomalyMatchLevel: MatchLevel?

Threshold for barcode anomaly detection.

barcodeImageReturnEnabled

val barcodeImageReturnEnabled: Boolean?

Verify v3 extraction.barcodeModuleSettings.barcodeImageReturnEnabled.

cropAffectsVerdict

val cropAffectsVerdict: Boolean?

Verify v3 verification.settings.cropAffectsVerdict.

dataMatchMatchLevel

val dataMatchMatchLevel: MatchLevel?

Threshold for data consistency matching across document zones.

generativeAiMatchLevel

val generativeAiMatchLevel: MatchLevel?

Verify v3 verification.settings.generativeAiSensitivity.

imageQualityRetryPolicy

val imageQualityRetryPolicy: ImageQualityRetryPolicy?

Verify v3 verification.settings.imageQualityRetryPolicy.

imageQualitySensitivity

val imageQualitySensitivity: MatchLevel?

Verify v3 imageAssessment.imageQualitySensitivity.

imageQualitySettings

val imageQualitySettings: ImageQualitySettings?

Image quality constraints applied during scanning.

photocopyMatchLevel

val photocopyMatchLevel: MatchLevel?

Verify v3 verification.settings.photocopySensitivity.

photoForgeryMatchLevel

val photoForgeryMatchLevel: MatchLevel?

Verify v3 verification.settings.portraitForgerySensitivity.

redactionMode

val redactionMode: RedactionMode?

Verify v3 extraction.redactionSettings.globalMode.

returnFaceImage

val returnFaceImage: Boolean?

Verify v3 extraction.documentCaptureModuleSettings.faceImageExtractionEnabled.

returnFullDocumentImage

val returnFullDocumentImage: Boolean?

Verify v3 extraction.documentCaptureModuleSettings.documentImageReturnEnabled.

returnSignatureImage

val returnSignatureImage: Boolean?

Verify v3 extraction.vizModuleSettings.signatureImageExtractionEnabled.

scanPassportDataPageOnly

val scanPassportDataPageOnly: Boolean?

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.

scanUnsupportedBack

val scanUnsupportedBack: Boolean?

Indicates whether backside of unsupported document should be scanned also.

screenAnalysisMatchLevel

val screenAnalysisMatchLevel: MatchLevel?

Threshold for screen/spoof analysis checks.

staticSecurityFeaturesMatchLevel

val staticSecurityFeaturesMatchLevel: MatchLevel?

Threshold for static security feature verification.

treatExpirationAsFraud

val treatExpirationAsFraud: Boolean?

Whether an expired document should contribute to a fraud decision.