core/com.miteksystems.misnap.core/MibiData/DocumentSessionInfo

DocumentSessionInfo

@Serializable

data class DocumentSessionInfo(val docType: String? = null, val classificationType: String? = null, val mrzExtracted: Boolean? = null, val optionalDataRedacted: Boolean? = null, val enhancedManual: Boolean? = null, val mode: String? = null, val fourCorners: Array<IntArray>? = null, val deviceOrientation: String? = null, val documentOrientation: String? = null, val warnings: List<String>? = null, val jpegQuality: Int? = null, val totalDuration: Long, val autoTries: Int? = null, val manualTries: Int? = null, val iqasRequired: Boolean? = null) : MibiData.SessionInfo

Information about a Document session.

Constructors

DocumentSessionInfo

constructor(docType: String? = null, classificationType: String? = null, mrzExtracted: Boolean? = null, optionalDataRedacted: Boolean? = null, enhancedManual: Boolean? = null, mode: String? = null, fourCorners: Array<IntArray>? = null, deviceOrientation: String? = null, documentOrientation: String? = null, warnings: List<String>? = null, jpegQuality: Int? = null, totalDuration: Long, autoTries: Int? = null, manualTries: Int? = null, iqasRequired: Boolean? = null)

Properties

val autoTries: Int? = null

The number of times the user attempted the session in auto mode.

classificationType

val classificationType: String? = null

deviceOrientation

val deviceOrientation: String? = null

The device orientation, values: "Landscape", "Portrait".

val docType: String? = null

The document type used in the session, values: "Check_Front", "Check_Back", "ID_Front", "ID_Back", "Passport", "Generic".

documentOrientation

val documentOrientation: String? = null

The document orientation, values: "Landscape", "Portrait".

val enhancedManual: Boolean? = null

Whether "enhanced manual" mode was requested or not.

val fourCorners: Array<IntArray>? = null

The four corner data of the document as a 2D array.

val iqasRequired: Boolean? = null

Linked to the value of MiSnapSettings.Analysis.Document.prioritizeDocumentExtractionOverImageQuality

val jpegQuality: Int? = null

The jpeg quality value from 0 to 100 applied to the final image.

val manualTries: Int? = null

The number of times the user attempted the session in manual mode.

val mode: String? = null

The session mode at the time of completion, values: "Auto", "Manual", "ForcedAuto".

val mrzExtracted: Boolean? = null

Whether MRZ data was extracted or not.

optionalDataRedacted

val optionalDataRedacted: Boolean? = null

Whether BSN was redacted out of applicable NLD documents or not.

open override val totalDuration: Long

The total duration of the session in milliseconds.

open override val type: String

The type of the session, values: "Document", "Barcode", "Face", "NFC", "Voice".

val warnings: List<String>? = null

A list of strings with warnings about the IQAs of the final image.