Package-level declarations

Types

Link copied to clipboard
data class AddressDetailedInfo(val street: String, val postalCode: String, val city: String, val jurisdiction: String)

Detailed information about the address.

Link copied to clipboard

Represents the type of the alphabet used in the document.

Link copied to clipboard
data class DataMatchFieldState(val fieldType: DataMatchFieldType, val state: DataMatchState)

Represents the state of the field in the data match.

Link copied to clipboard

Represents the type of the field used in data match.

Link copied to clipboard
class DataMatchResult(val statePerField: Array<DataMatchFieldState>)

Represents the result of the data match.

Link copied to clipboard

Represents the state of the data match.

Link copied to clipboard
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.

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

Information about the dependent.

Link copied to clipboard

DocumentImageColorStatus enum defines possible color statuses determined from scanned image.

Link copied to clipboard

DocumentOrientation enum defines possible card orientations.

Link copied to clipboard

Represents the rotation of the document.

Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard

ImageAnalysisDetectionStatus enum defines possible states of detection.

Link copied to clipboard

ImageAnalysisLightingStatus enum defines possible lighting statuses.

Link copied to clipboard

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

Link copied to clipboard
@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.

Link copied to clipboard

Represents the status of the document processing.

Link copied to clipboard

Represents possible recognition modes.

Link copied to clipboard
@Serializable
data class Rectangle(val x: Float, val y: Float, val width: Float, val height: Float)

Represents a rectangle.

Link copied to clipboard
data class ResultCompleteness(val scanningStatus: ScanningStatus, val vizExtracted: Boolean, val mrzExtracted: Boolean, val barcodeExtracted: Boolean, val documentImageExtracted: Boolean, val faceImageExtracted: Boolean, val signatureImageExtracted: Boolean)

Represents the completeness of the extraction process for a scanned document.

Link copied to clipboard

Represents the side of the document being scanned.

Link copied to clipboard

Represents the different states of a scanning process.

Link copied to clipboard
data class SingleSideScanningResult(val viz: VizResult?, val mrz: MrzResult?, val barcode: BarcodeResult?, val inputImage: InputImageResult?, val barcodeInputImage: InputImageResult?, val documentImage: CroppedImageResult?, val faceImage: DetailedCroppedImageResult?, val signatureImage: DetailedCroppedImageResult?)

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

Link copied to clipboard
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.

Link copied to clipboard
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.