Skip to main content

InputImageAnalysisResult

@microblink/blinkid


@microblink/blinkid / InputImageAnalysisResult

Type Alias: InputImageAnalysisResult

InputImageAnalysisResult = object

Represents the results of processing and analyzing an input image.

This structure contains the status of the processing, along with detailed results from detection, document quality, and information about the document analysis performed on the input image.

Properties

barcodeDetectionStatus

barcodeDetectionStatus: ImageAnalysisDetectionStatus

The status of barcode detection


blurDetectionStatus

blurDetectionStatus: ImageAnalysisDetectionStatus

The status of blur detection


documentClassInfo

documentClassInfo: DocumentClassInfo

Information about the document class


documentColorStatus

documentColorStatus: DocumentImageColor

The color status of the document image


documentDetectionStatus

documentDetectionStatus: DetectionStatus

The status of the document detection


documentHandOcclusionStatus

documentHandOcclusionStatus: ImageAnalysisDetectionStatus

The status of hand occlusion detection in the document image


documentLightingStatus

documentLightingStatus: ImageAnalysisLightingStatus

The status of lighting conditions in the document image


documentLocation?

optional documentLocation: Quadrilateral

The location of the detected document within an image


documentMoireStatus

documentMoireStatus: ImageAnalysisDetectionStatus

The status of moire pattern detection in the document image


documentOrientation

documentOrientation: DocumentOrientation

The orientation of the document


documentRotation

documentRotation: DocumentRotation

The rotation of the document in the frame


extractedFields

extractedFields: FieldType[]

List of fields that were extracted from the document


extraPresentFields

extraPresentFields: FieldType[]

List of fields that weren't expected on the document but were present


faceDetectionStatus

faceDetectionStatus: ImageAnalysisDetectionStatus

The status of face detection


glareDetectionStatus

glareDetectionStatus: ImageAnalysisDetectionStatus

The status of glare detection


imageExtractionFailures

imageExtractionFailures: ImageExtractionType[]

List of failed image extractions


invalidCharacterFields

invalidCharacterFields: FieldType[]

List of fields that contained characters which were not expected in that field


missingMandatoryFields

missingMandatoryFields: FieldType[]

List of fields that were expected on the document but were missing


mrzDetectionStatus

mrzDetectionStatus: ImageAnalysisDetectionStatus

The status of MRZ detection


processingStatus

processingStatus: ProcessingStatus

Status of the processing


realIDDetectionStatus

realIDDetectionStatus: ImageAnalysisDetectionStatus

The status of real ID detection


scanningSide

scanningSide: ScanningSide

Side of the document being scanned