blinkid-verify-core/com.microblink.blinkidverify.core.data.model.request/BlinkIdVerifyProcessingRequestOptions

BlinkIdVerifyProcessingRequestOptions

@Serializable
data class BlinkIdVerifyProcessingRequestOptions(val returnFullDocumentImage: Boolean? = null, val returnFaceImage: Boolean? = null, val returnSignatureImage: Boolean? = null, val treatExpirationAsFraud: Boolean? = null, val screenMatchLevel: MatchLevel? = null, val photocopyMatchLevel: MatchLevel? = null, val barcodeAnomalyMatchLevel: MatchLevel? = null, val photoForgeryMatchLevel: MatchLevel? = null, val staticSecurityFeaturesMatchLevel: MatchLevel? = null, val dataMatchMatchLevel: MatchLevel? = null, val blurMatchLevel: MatchLevel? = null, val glareMatchLevel: MatchLevel? = null, val lightingMatchLevel: MatchLevel? = null, val sharpnessMatchLevel: MatchLevel? = null, val handOcclusionMatchLevel: MatchLevel? = null, val dpiMatchLevel: MatchLevel? = null, val tiltMatchLevel: MatchLevel? = null, val imageQualityInterpretation: ImageQualityInterpretation? = null, val returnImageFormat: ImageFormat? = null, val anonymizationMode: AnonymizationMode? = null, sideMode: VerificationSideMode? = null)

Class representing options for document verification request. If nullable settings are not set, server defaults will be used.

Constructors

Link copied to clipboard
constructor(returnFullDocumentImage: Boolean? = null, returnFaceImage: Boolean? = null, returnSignatureImage: Boolean? = null, treatExpirationAsFraud: Boolean? = null, screenMatchLevel: MatchLevel? = null, photocopyMatchLevel: MatchLevel? = null, barcodeAnomalyMatchLevel: MatchLevel? = null, photoForgeryMatchLevel: MatchLevel? = null, staticSecurityFeaturesMatchLevel: MatchLevel? = null, dataMatchMatchLevel: MatchLevel? = null, blurMatchLevel: MatchLevel? = null, glareMatchLevel: MatchLevel? = null, lightingMatchLevel: MatchLevel? = null, sharpnessMatchLevel: MatchLevel? = null, handOcclusionMatchLevel: MatchLevel? = null, dpiMatchLevel: MatchLevel? = null, tiltMatchLevel: MatchLevel? = null, imageQualityInterpretation: ImageQualityInterpretation? = null, returnImageFormat: ImageFormat? = null, anonymizationMode: AnonymizationMode? = null, sideMode: VerificationSideMode? = null)

Properties

Link copied to clipboard
val anonymizationMode: AnonymizationMode? = null

Defines anonymization mode used on result. Server default is AnonymizationMode.FullResult.

Link copied to clipboard
val barcodeAnomalyMatchLevel: MatchLevel? = null

Defines barcode anomaly match level. Server default is MatchLevel.Level7.

Link copied to clipboard
val blurMatchLevel: MatchLevel? = null

Defines blur match level. Server default is MatchLevel.Level5.

Link copied to clipboard
val dataMatchMatchLevel: MatchLevel? = null

Defines data match match level. Server default is MatchLevel.Level5.

Link copied to clipboard
val dpiMatchLevel: MatchLevel? = null

Defines DPI match level. Server default is MatchLevel.Level5

Link copied to clipboard
val glareMatchLevel: MatchLevel? = null

Defines glare match level. Server default is MatchLevel.Level5.

Link copied to clipboard
val handOcclusionMatchLevel: MatchLevel? = null

Defines hand occlusion match level. Server default is MatchLevel.Level5.

Link copied to clipboard
val imageQualityInterpretation: ImageQualityInterpretation? = null

Defines image quality interpretation. Server default is ImageQualityInterpretation.HighConversion.

Link copied to clipboard
val lightingMatchLevel: MatchLevel? = null

Defines lighting match level. Server default is MatchLevel.Level5.

Link copied to clipboard
val photocopyMatchLevel: MatchLevel? = null

Defines photocopy feature match level. Server default is MatchLevel.Level5.

Link copied to clipboard
val photoForgeryMatchLevel: MatchLevel? = null

Defines photo forgery match level. Server default is MatchLevel.Level2.

Link copied to clipboard
val returnFaceImage: Boolean? = null

Defines whether face image should be extracted. Default is false.

Link copied to clipboard
val returnFullDocumentImage: Boolean? = null

Defines whether full document image should be extracted. Default is false.

Link copied to clipboard
val returnImageFormat: ImageFormat? = null

Defines return image type. Server default is ImageFormat.Jpg.

Link copied to clipboard
val returnSignatureImage: Boolean? = null

Defines whether signature image should be extracted. Default is false.

Link copied to clipboard
val screenMatchLevel: MatchLevel? = null

Defines screen feature match level. Server default is MatchLevel.Level5.

Link copied to clipboard
val sharpnessMatchLevel: MatchLevel? = null

Defines sharpness match level. Server default is MatchLevel.Level3.

Link copied to clipboard
val staticSecurityFeaturesMatchLevel: MatchLevel? = null

Defines static security features match level. Server default is MatchLevel.Level6.

Link copied to clipboard
val tiltMatchLevel: MatchLevel? = null

Defines tilt match level. Server default is MatchLevel.Level5.

Link copied to clipboard
val treatExpirationAsFraud: Boolean? = null

Defines whether expired documents are considered fraudulent. Default is false.

Functions

Link copied to clipboard
fun toCaptureSessionSettings(capturePolicy: CapturePolicy = CapturePolicy.Video, useCase: BlinkIdVerifyProcessingUseCase? = null, stepTimeoutDuration: Duration = 15000.milliseconds): VerifyCaptureSessionSettings