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

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.

Constructors

BlinkIdVerifyEndpointResponse

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

Properties

val checks: List<VerifyCheck>?

val extraction: ExtractionResult?

An entity housing all extracted data.

val images: List<ImageResult>?

A collection of images extracted from the extraction processes.

val messages: List<VerifyResponseMessage>?

Informational messages provided to users, such as suggestions for improvement.

val optionsUsed: BlinkIdVerifyProcessingRequestOptions?

All document verification processing options used in verification.

processIndicators

val processIndicators: List<ProcessIndicator>?

A collection of indicators, while not influencing the final score, can offer insight into the level of certainty associated with it.

processingStatus

val processingStatus: DocumentVerificationProcessingStatus

Indicates the overall processing status of the entire verification process.

val runtime: VerifyRuntime?

Contains runtime information.

val useCaseUsed: BlinkIdVerifyProcessingUseCase?

All document verification processing use cases used in verification.

val verification: VerifyCheck?

Contains compiled data summarizing the overall verification process.