data class DateResult<StringType>(val day: Int?, val month: Int?, val year: Int?, val originalString: StringType, val filledByDomainKnowledge: Boolean = false, val successfullyParsed: Boolean = true)

Represents the result of the date extraction.

DependentInfo

data class DependentInfo(val dateOfBirth: DateResult<StringResult?>?, val sex: StringResult?, val documentNumber: StringResult?, val fullName: StringResult?)

Information about the dependent.

DetailedCroppedImageResult

class DetailedCroppedImageResult : ImageBaseResult

Represents the result of the image crop transformation with additional details.

DocumentImageColorStatus

enum DocumentImageColorStatus : Enum<DocumentImageColorStatus>

DocumentImageColorStatus enum defines possible color statuses determined from scanned image.

DocumentOrientation

enum DocumentOrientation : Enum<DocumentOrientation>

DocumentOrientation enum defines possible card orientations.

DocumentRotation

enum DocumentRotation : Enum<DocumentRotation>

Represents the rotation of the document.

DriverLicenseDetailedInfo

data class DriverLicenseDetailedInfo<StringType>(val restrictions: StringType, val endorsements: StringType, val vehicleClass: StringType, val conditions: StringType, val vehicleClassesInfo: Array<VehicleClassInfo<StringType>>)

Represents detailed extracted information about the driver license.

FieldType

enum FieldType : Enum<FieldType>

Represents all possible field types that can be extracted from the document.

ImageAnalysisDetectionStatus

enum ImageAnalysisDetectionStatus : Enum<ImageAnalysisDetectionStatus>

ImageAnalysisDetectionStatus enum defines possible states of detection.

ImageAnalysisLightingStatus

enum ImageAnalysisLightingStatus : Enum<ImageAnalysisLightingStatus>

ImageAnalysisLightingStatus enum defines possible lighting statuses.

ImageBaseResult

interface ImageBaseResult

Represents base class of all image results.

ImageExtractionType

enum ImageExtractionType : Enum<ImageExtractionType>

Represents the types of images that can be extracted from the document.

InputImageAnalysisResult

@Serializable

data class InputImageAnalysisResult(val processingStatus: ProcessingStatus, val missingMandatoryFields: Array<FieldType>, val extractedFields: Array<FieldType>, val invalidCharacterFields: Array<FieldType>, val extraPresentFields: Array<FieldType>, val imageExtractionFailures: Array<ImageExtractionType>, val scanningSide: ScanningSide, val documentDetectionStatus: DetectionStatus, val documentLocation: Quadrilateral?, val documentClassInfo: DocumentClassInfo, val blurDetectionStatus: ImageAnalysisDetectionStatus, val glareDetectionStatus: ImageAnalysisDetectionStatus, val documentColorStatus: DocumentImageColorStatus, val documentMoireStatus: ImageAnalysisDetectionStatus, val faceDetectionStatus: ImageAnalysisDetectionStatus, val mrzDetectionStatus: ImageAnalysisDetectionStatus, val barcodeDetectionStatus: ImageAnalysisDetectionStatus, val realIDDetectionStatus: ImageAnalysisDetectionStatus, val documentLightingStatus: ImageAnalysisLightingStatus, val documentHandOcclusionStatus: ImageAnalysisDetectionStatus, val documentOrientation: DocumentOrientation, val documentRotation: DocumentRotation)

Represents the results of processing and analyzing an input image.

InputImageResult

class InputImageResult : ImageBaseResult

Repesents original image of the captured document, untransformed, as it was used in processing.

ParentInfo

data class ParentInfo(val firstName: StringResult?, val lastName: StringResult?)

ProcessingStatus

enum ProcessingStatus : Enum<ProcessingStatus>

Represents the status of the document processing.

RecognitionMode

enum RecognitionMode : Enum<RecognitionMode>

Represents possible recognition modes.

Rectangle

@Serializable

data class Rectangle(val x: Float, val y: Float, val width: Float, val height: Float)

Represents a rectangle.

ScanningSide

enum ScanningSide : Enum<ScanningSide>

Represents the current scanning side.

ScanningStatus

enum ScanningStatus : Enum<ScanningStatus>

Represents the different states of a scanning process.

SingleSideScanningResult

data class SingleSideScanningResult(val viz: VizResult?, val mrz: MrzResult?, val barcode: BarcodeResult?, val inputImage: InputImageResult?, val barcodeImage: CroppedImageResult?, val documentImage: CroppedImageResult?, val faceImage: DetailedCroppedImageResult?, val signatureImage: DetailedCroppedImageResult?)

Represents the result of scanning a single side of the document.

StringResult

data class StringResult(val values: Array<String>, val locations: Array<Rectangle?>, val sides: Array<ScanningSide?>)

Represents the multi-alphabet string result extracted from the OCR. The result contains the extracted strings, their locations, and the sides of the extracted strings.

VehicleClassInfo

data class VehicleClassInfo<StringType>(val vehicleClass: StringType, val licenceType: StringType, val effectiveDate: DateResult<StringType>?, val expiryDate: DateResult<StringType>?)

Represents the information about the vehicle class extraction.

Functions

toFormattedString

fun DateResult<StringResult>.toFormattedString(): String