blinkid-core/com.microblink.blinkid.core.session

Package-level declarations

Types

data class BlinkIdProcessResult(val inputImageAnalysisResult: InputImageAnalysisResult, val resultCompleteness: ResultCompleteness)

Represents the overall result of the document processing pipeline.

BlinkIdScanningResult

data class BlinkIdScanningResult(val documentClassInfo: DocumentClassInfo, val dataMatchResult: DataMatchResult?, val firstName: StringResult?, val lastName: StringResult?, val fullName: StringResult?, val additionalNameInformation: StringResult?, val localizedName: StringResult?, val fathersName: StringResult?, val mothersName: StringResult?, val maidenName: StringResult?, val address: StringResult?, val additionalAddressInformation: StringResult?, val additionalOptionalAddressInformation: StringResult?, val placeOfBirth: StringResult?, val nationality: StringResult?, val race: StringResult?, val religion: StringResult?, val profession: StringResult?, val maritalStatus: StringResult?, val husbandName: StringResult?, val legalStatus: StringResult?, val parentsInfo: List<ParentInfo>?, val residentialStatus: StringResult?, val employer: StringResult?, val sex: StringResult?, val sponsor: StringResult?, val bloodType: StringResult?, val documentNumber: StringResult?, val personalIdNumber: StringResult?, val documentAdditionalNumber: StringResult?, val documentOptionalAdditionalNumber: StringResult?, val additionalPersonalIdNumber: StringResult?, val issuingAuthority: StringResult?, val documentSubtype: StringResult?, val remarks: StringResult?, val residencePermitType: StringResult?, val manufacturingYear: StringResult?, val vehicleType: StringResult?, val vehicleOwner: StringResult?, val eligibilityCategory: StringResult?, val specificDocumentValidity: StringResult?, val visaType: StringResult?, val dateOfBirth: DateResult<StringResult?>?, val dateOfIssue: DateResult<StringResult?>?, val dateOfExpiry: DateResult<StringResult?>?, val dateOfExpiryPermanent: Boolean?, val dateOfEntry: DateResult<StringResult?>?, val effectiveDate: DateResult<StringResult?>?, val countryCode: StringResult?, val certificateNumber: StringResult?, val nationalInsuranceNumber: StringResult?, val driverLicenseDetailedInfo: DriverLicenseDetailedInfo<StringResult?>?, val localityCode: StringResult?, val municipalityCode: StringResult?, val municipalityOfRegistration: StringResult?, val pollingStationCode: StringResult?, val registrationCenterCode: StringResult?, val sectionCode: StringResult?, val socialSecurityStatus: StringResult?, val workRestriction: StringResult?, val stateCode: StringResult?, val stateName: StringResult?, val cardAccessNumber: StringResult?, val dependentsInfo: List<DependentInfo>?, val subResults: List<SingleSideScanningResult>)

Represents the results of scanning a document.

BlinkIdScanningSession

class BlinkIdScanningSession : AutoCloseable

BlinkIdSessionSettings

data class BlinkIdSessionSettings(val inputImageSource: InputImageSource = InputImageSource.Video, val scanningMode: ScanningMode = ScanningMode.Automatic, val scanningSettings: ScanningSettings = ScanningSettings()) : Parcelable

Represents the configuration settings for a scanning session.

DetectionStatus

enum DetectionStatus : Enum<DetectionStatus>

Represents the status of the document detection process.

InputImageSource

enum InputImageSource : Enum<InputImageSource>

Represents the source type of an image.

ProcessCallAfterDocumentScanned

class ProcessCallAfterDocumentScanned : RuntimeException

Exception that is thrown when the scanning has already been completed and the process() method is called.

ResetCallAfterResultRetrieved

class ResetCallAfterResultRetrieved : RuntimeException

Exception that is thrown when the result has already been retrieved from the scanning session and the restartSession() method is called.

ResolveNextStepCallAfterDocumentScanned

class ResolveNextStepCallAfterDocumentScanned : RuntimeException

Exception that is thrown when the scanning has already been completed and the resolveCurrentStep() method is called.

ResultRetrievedException

class ResultRetrievedException : RuntimeException

Exception that is thrown when the result has already been retrieved from the scanning session and the restartSession() method is called.

ScanAlreadyCompletedException

class ScanAlreadyCompletedException : RuntimeException

Exception that is thrown when the scanning has already been completed and the process() method is called.

ScanningMode

enum ScanningMode : Enum<ScanningMode>

Represents the mode of document scanning.