blinkid-verify-core/com.microblink.blinkidverify.core.data.model.result

Package-level declarations

Types

@Serializable

data class AdditionalInfo(val frontProcessingStatus: VerifyProcessingStatus?, val backProcessingStatus: VerifyProcessingStatus?, val recognitionMode: RecognitionMode, val firstSideAdditionalProcessingInfo: AdditionalProcessingInfo?, val secondSideAdditionalProcessingInfo: AdditionalProcessingInfo?)

Contains additional information about the document extraction process.

BlinkIdVerifyCaptureResult

@Serializable

data class BlinkIdVerifyCaptureResult(val frontCameraFrame: EncodedImage?, val backCameraFrame: EncodedImage?, val barcodeCameraFrame: EncodedImage?, captureSessionSettings: VerifyCaptureSessionSettings, sessionId: String)

BlinkIdVerifyEndpointResponse

@Serializable

data class BlinkIdVerifyEndpointResponse(val processingStatus: DocumentVerificationProcessingStatus, val verification: VerifyCheck?, val checks: List<VerifyCheck>?, val processIndicators: List<ProcessIndicator>?, val extraction: ExtractionResult?, val messages: List<VerifyResponseMessage>?, val runtime: VerifyRuntime?, val images: List<ImageResult>?, val optionsUsed: BlinkIdVerifyProcessingRequestOptions?, val useCaseUsed: BlinkIdVerifyProcessingUseCase?)

Class representing the result of the document verification.

Bounds

@Serializable

data class Bounds(val x: Double, val y: Double, val width: Double, val height: Double)

Represents the rectangular boundaries of an element within a document.

DetailDictionary

@Serializable

data class DetailDictionary(val segments: List<Segment>?)

Additional information structured as a key value pairs in a map containing String and DetailValue.

DetailValue

@Serializable

sealed class DetailValue

Represents a value with a specific data type for details within a document processing result.

Dimensions

@Serializable

data class Dimensions(val width: Float?, val height: Float?)

Represents the width and height of the element.

DocumentVerificationProcessingStatus

enum DocumentVerificationProcessingStatus : Enum<DocumentVerificationProcessingStatus>

Status of completed document verification process on the server.

EncodedImage

@Serializable

data class EncodedImage(val jpegBytes: ByteArray, val orientation: ImageRotation)

Represents an image encoded as JPEG data along with its orientation.

ImageResult

@Serializable

data class ImageResult(val name: String, val base64: String)

Represents an image result, encoded as a Base64 string.

IndicatorResult

enum IndicatorResult : Enum<IndicatorResult>

Indicates the outcome of the check, such as pass, fail, or not performed.

IndicatorType

enum IndicatorType : Enum<IndicatorType>

Specifies the category or type of check being performed.

LocationInfo

@Serializable

data class LocationInfo(val topLeftCorner: Point2df?, val dimensions: Dimensions?)

Represents information about the location of an element within a document or image.

MessageStatus

@Serializable

enum MessageStatus : Enum<MessageStatus>

Represents the status or severity of a message within the verification process.

Point2df

@Serializable

data class Point2df(val x: Float?, val y: Float?)

Represents the coordinates of the point of the element.

ProcessIndicator

@Serializable

data class ProcessIndicator(val name: String, val type: IndicatorType, val result: IndicatorResult)

Represents an indicator of a specific check or step during a document processing flow.

Result

@Serializable

@SerialName(value = "Result")

data class Result(val field: String?, val details: DetailDictionary?, val results: List<Result>?) : VerifyResult

Base result instance for document verification, extends VerifyResult.

Segment

@Serializable

data class Segment(val result: CheckResult, val type: String, val bounds: Bounds)

Represents a segment of a document that has been analyzed during the verification process.

Side

enum Side : Enum<Side>

VerifyDateResult

@Serializable

@SerialName(value = "DateResult")

data class VerifyDateResult(val field: String?, val details: DetailDictionary?, val results: List<VerifyResult>?, val day: Int?, val month: Int?, val year: Int?, val successfullyParsed: Boolean?, val filledByDomainKnowledge: Boolean?, val originalResult: String) : VerifyResult

Date instance of the result, extends VerifyResult.

VerifyDetailedDateResult

@Serializable

@SerialName(value = "DetailedDateResult")

data class VerifyDetailedDateResult(val field: String?, val details: DetailDictionary?, val results: List<VerifyResult>?, val day: Int?, val month: Int?, val year: Int?, val successfullyParsed: Boolean?, val filledByDomainKnowledge: Boolean?, val originalResult: List<VerifyResult>?) : VerifyResult

Detailed date instance of the result, extends VerifyResult.

VerifyDetailedStringResult

@Serializable

@SerialName(value = "DetailedStringResult")

data class VerifyDetailedStringResult(val field: String?, val details: DetailDictionary?, val results: List<VerifyResult>?, val value: String, val location: LocationInfo?, val script: VerifyScript, val side: Side) : VerifyResult

Detailed string instance of the result, extends VerifyResult.

VerifyResponseMessage

@Serializable

data class VerifyResponseMessage(val code: String, val message: String, val status: MessageStatus)

Represents a response message from the verification process.

VerifyResult

@Serializable

sealed class VerifyResult

Sealed class representing base result for verify extraction fields received as part of the document verification result.

VerifyRuntime

@Serializable

data class VerifyRuntime(val startedOn: String?, val finishedOn: String?, val elapsedMs: ULong?, val serviceVersion: String?, val runnerVersion: String?, val runnerInstanceIndex: Int?, val wrapperVersion: String?, val extractionRecognizerVersion: String?, val verificationRecognizerVersion: String?, val clientSdkName: String?, val clientSdkVersion: String?)

Detailed information about the entire document verification process containing details about time and duration, versions, and the client.

VerifyStringResult

@Serializable

@SerialName(value = "StringResult")

data class VerifyStringResult(val field: String?, val details: DetailDictionary?, val results: List<VerifyResult>?, val value: String) : VerifyResult

String instance of the result, extends VerifyResult.

VizResult

@Serializable

data class VizResult(val front: List<VerifyResult>, val back: List<VerifyResult>)

Extraction results from the document verification request. Separated into front and back lists of VerifyResult for each document side.