data class DocumentData(val docType: String? = null, val country: String? = null, val surname: String? = null, val firstName: String? = null, val docNumber: String? = null, val nationality: String? = null, val dateOfBirth: String? = null, val sex: String? = null, val dateOfExpiration: String? = null, val optionalData1: String? = null, val optionalData2: String? = null, val rawData: String? = null)

Describes the formatted extracted contents of a document.

DocumentExtraction

@Serializable

data class DocumentExtraction(val mrz: Mrz? = null, val extractedData: DocumentData? = null, val extractedDataCorners: ExtractedDataCorners? = null)

Describes the contents extracted from a document.

DocumentIqaCheck

enum DocumentIqaCheck : Enum<DocumentIqaCheck>

Supported document quality checks.

ExifUtil

object ExifUtil

Utility class for writing EXIF data to JPGs.

ExtractedDataCorners

@Serializable

data class ExtractedDataCorners(val optionalData1Corners: Array<Array<IntArray>> = emptyArray())

Describes supplemental information about the supported and available mrz data elements.

FaceIqaCheck

enum FaceIqaCheck : Enum<FaceIqaCheck>

Supported face quality checks.

Frame

interface Frame

Wrapper over a camera frame, containing the image dimensions, rotation of the image in regards to the device natural orientation, the image format and byte data. NOTE: Frames must be closed after use.

FrameImage

interface FrameImage

Wrapper over Image and Image.Plane that provides access to the image data through one or more buffers.

FrameUtil

object FrameUtil

Utility class for interacting with Frame and FrameImage instances.

LicenseException

class LicenseException(val message: String) : Exception

Thrown to indicate that there is a problem with the license. These include:

LicenseUtil

class LicenseUtil

Utility class to evaluate licensed features.

LifecycleUtil

object LifecycleUtil

Utility class for getting the LifecycleOwner from a Context.

LiveDataUtil

object LiveDataUtil

Utility class for adding one time observers to LiveData.

MibiData

object MibiData

Singleton to keep track of MiBi data and UXP events associated with a session.

MiSnapCameraInfo

@Serializable

data class MiSnapCameraInfo(val supportsAutoAnalysis: Boolean, val supportsAutoFocus: Boolean, val supportsTorch: Boolean, val supportedPreviewSize: Size, val supportedImageAnalysisSize: Size, val supportedPictureSize: Size, val deviceHardwareLevel: String, val facingDirection: String, val supportedImageAnalysisHighResolutionSize: Size? = null, val supportedPictureHighResolutionSize: Size? = null)

Consolidates the interpreted results of what the camera supports according to specific business logic.

MiSnapMibiData

@Serializable

data class MiSnapMibiData(val mibiData: String, val deviceInfo: MibiData.DeviceInfo, val sessionInfo: List<MibiData.SessionInfo>)

Describes analytics information about a MiSnap session.

MiSnapSettings

@Serializable

class MiSnapSettings(val useCase: MiSnapSettings.UseCase, val license: String) : Cloneable

The main configuration object across all the MiSnap SDK capabilities.

Mrz

@Serializable

sealed class Mrz

Marker interface for MRZs.

Mrz1Line

@Serializable

data class Mrz1Line(val mrzString: String) : Mrz

30 characters of 1-line MRZ.

MrzData

@Serializable

data class MrzData(val documentNumber: String, val dateOfBirth: String, val dateOfExpiry: String, val country: String, val documentCode: String, val optionalData1: String = "<<<<<<<<<<<<<<") : Mrz

MRZ containing document number, date of birth (YYMMdd), date of expiry (YYMMdd), 3-letter country code, 2-letter document code, and 14-letter optionalData1.

OrientationUtil

object OrientationUtil

Utility class for querying the device's orientation.

UserAction

@Serializable

sealed class UserAction

Represents an action that the user must perform to meet the Frame quality criteria.

ValidationUtil

object ValidationUtil

Utility class for validating the data in a Mrz.