Android Scanbot SDK API reference/io.scanbot.sdk.documentdata

Package-level declarations

Types

data class AutoFocusConfiguration(var sensitivityThreshold: Double = 0.02) : DocumentDataExtractorConfigurationElement, Parcelable

Auto-focus configuration. The recognizer will ignore frames that are not focused. This option is enabled by default. This configuration has no effect in SINGLE_SHOT mode.

CompositeFieldValueSemantics

data class CompositeFieldValueSemantics(val overallFieldValueSemantics: ValueSemantics, val fieldDetails: List<FieldValueSemantics>) : Parcelable

Report of a logical field value semantics verification. If some logical field, e.g. expiry date is present in multiple places in the document, it can occur that some entries are semantically correct and some are semantically incorrect. This report shows the overall status of the logical field value semantics verification and details for each field that was verified.

ConsistencyVerificationReport

data class ConsistencyVerificationReport(val overallConsistency: ValueConsistency, val fieldDetails: List<FieldConsistencyVerificationReport>) : Parcelable

Report of the document consistency verification. Shows whether information in the fields that correspond to the same logical field is consistent.

DateValidationConfiguration

data class DateValidationConfiguration(var minYear: Int = 0, var maxYear: Int = 2999, var fieldTypeName: String) : DocumentDataExtractorConfigurationElement, Parcelable

Date validation configuration. This configuration element does not enable the scanning of any document types by itself. Add to recognizer configuration to require date validation checks for specific document types.

DeAddressParserConfiguration

data class DeAddressParserConfiguration(var documentTypes: List<String>, var binaryFileAddressDatabase: String = "") : DocumentDataExtractorConfigurationElement, Parcelable

German Address Field validation configuration. This configuration does not enable the scanning of any document types by itself. Add to recognizer configuration to require German Address validation checks for specific document types.

DefaultDocumentDataExtractor

class DefaultDocumentDataExtractor : DocumentDataExtractor

Default implementation for DocumentDataExtractor

DocumentDataAutoSnappingController

class DocumentDataAutoSnappingController(cameraView: IScanbotCameraView, frameHandler: DocumentDataExtractorFrameHandler, needDetachFromView: Boolean = false) : BaseAutoSnappingController<DocumentDataAutoSnappingController.Param>

Controls auto-snapping for document data extraction.

DocumentDataExtractionMode

enum DocumentDataExtractionMode : Enum<DocumentDataExtractionMode>

The extraction mode.

DocumentDataExtractionResult

data class DocumentDataExtractionResult(val status: DocumentDataExtractionStatus, val document: GenericDocument?, val documentDetectionResult: DocumentDetectionResult, val croppedImage: ImageRef? = null) : AutoCloseable, Parcelable

Contains the result of running the generic document extractor.

DocumentDataExtractionStatus

enum DocumentDataExtractionStatus : Enum<DocumentDataExtractionStatus>

The status of the extraction process.

DocumentDataExtractor

interface DocumentDataExtractor

Component to scan image, detect different documents of known types, perform image optimization, cropping and (optionally) fields detection and fields' data extraction

DocumentDataExtractorCommonConfiguration

data class DocumentDataExtractorCommonConfiguration(var acceptedDocumentTypes: List<String> = listOf( "DeIdCardFront", "DeIdCardBack", "DeHealthInsuranceCardFront", "DePassport", "DeResidencePermitFront", "DeResidencePermitBack", "EuropeanHealthInsuranceCard", "EuropeanDriverLicenseFront", "EuropeanDriverLicenseBack" )) : DocumentDataExtractorConfigurationElement, Parcelable

Convenience configuration element for enabling the scanning of multiple document types with a common configuration. Add to extractor configuration to enable the scanning of multiple document types.

DocumentDataExtractorConfiguration

data class DocumentDataExtractorConfiguration(var resultAccumulationConfig: ResultAccumulationConfiguration = ResultAccumulationConfiguration( ), var fieldExcludeList: List<String> = listOf( ), var configurations: List<DocumentDataExtractorConfigurationElement> = listOf( DocumentDataExtractorCommonConfiguration( ) ), var returnCrops: Boolean = false, var documentTrustMode: DocumentTrustMode = DocumentTrustMode.TRUSTED) : Parcelable

Configuration for the document data extractor.

DocumentDataExtractorConfigurationBuilder

class DocumentDataExtractorConfigurationBuilder

A builder class to help with assembling the configuration for DocumentDataExtractor.

DocumentDataExtractorConfigurationElement

sealed class DocumentDataExtractorConfigurationElement : Parcelable

Base class for all generic document configuration elements.

DocumentDataExtractorFrameHandler

class DocumentDataExtractorFrameHandler(documentDataExtractor: DocumentDataExtractor, documentDataExtractionMode: DocumentDataExtractionMode = DocumentDataExtractionMode.LIVE) : FrameHandler

Performs document extraction on camera preview frames. Outputs results via DocumentDataExtractorFrameHandler.ResultHandler.

DocumentDataFrameExtractionParameters

data class DocumentDataFrameExtractionParameters(var mode: DocumentDataExtractionMode = DocumentDataExtractionMode.LIVE) : Parcelable

Parameters for the extraction process.

DocumentTrustMode

enum DocumentTrustMode : Enum<DocumentTrustMode>

Level of trust in the authenticity of the extracted document.

DocumentVerificationReport

data class DocumentVerificationReport(val overallVerificationStatus: DocumentVerificationStatus, val consistencyVerificationReport: ConsistencyVerificationReport, val semanticsVerificationReport: SemanticsVerificationReport, val suspiciousDataVerificationReport: SuspiciousDataVerificationReport, val invalidDataVerificationReport: InvalidDataVerificationReport) : Parcelable

Report of the document verification.

DocumentVerificationStatus

enum DocumentVerificationStatus : Enum<DocumentVerificationStatus>

Overall status of the document verification.

EuropeanHealthInsuranceCardConfiguration

data class EuropeanHealthInsuranceCardConfiguration(var expectedCountry: EuropeanHealthInsuranceCardIssuingCountry? = null) : DocumentDataExtractorConfigurationElement, Parcelable

European Health Insurance Card (EHIC) configuration element. Add to extractor configuration to scan EHICs.

EuropeanHealthInsuranceCardIssuingCountry

enum EuropeanHealthInsuranceCardIssuingCountry : Enum<EuropeanHealthInsuranceCardIssuingCountry>

European Health Insurance Card (EHIC) issuing country.

FieldConsistencyVerificationReport

data class FieldConsistencyVerificationReport(val fieldType: CommonFieldType, val consistency: ValueConsistency, val fieldFullNames: List<String>) : Parcelable

Report of the field consistency verification.

FieldInvalidDataVerificationReport

data class FieldInvalidDataVerificationReport(val fieldFullName: String, val isInvalid: Boolean) : Parcelable

Report which shows whether the data in the field that can be validated is valid.

FieldSuspiciousDataVerificationReport

data class FieldSuspiciousDataVerificationReport(val fieldFullName: String, val isSuspicious: Boolean) : Parcelable

Report of the suspicious data field verification.

FieldValueSemantics

data class FieldValueSemantics(val fieldFullName: String, val invalidSemantics: Boolean) : Parcelable

Report of the field value semantics verification.

GlareDetectionConfiguration

data class GlareDetectionConfiguration(var glareDetectionThreshold: Double = 0.5) : DocumentDataExtractorConfigurationElement, Parcelable

Glare detection configuration. The recognizer will detect whether fields are obstructed by glare. This feature is enabled by default. This configuration has no effect in SINGLE_SHOT mode.

InvalidDataVerificationReport

data class InvalidDataVerificationReport(val overallIsInvalid: Boolean, val fieldDetails: List<FieldInvalidDataVerificationReport>) : Parcelable

Report of the field validation verification.

MrzFallbackConfiguration

data class MrzFallbackConfiguration(var acceptedCountries: List<String> = listOf( ), var acceptedMRZTypes: List<MrzDocumentType> = listOf( )) : DocumentDataExtractorConfigurationElement, Parcelable

MRZ fallback configuration element. This configuration element does not enable the scanning of any document types by itself. Add to extractor configuration to enable recognizing the MRZ only, specifically for documents that are otherwise not supported. Note that this may enable scanning of documents that were not enabled through the accepted document types.

SemanticsVerificationReport

data class SemanticsVerificationReport(val overallInvalidSemantics: Boolean, val expiryDateSemantics: CompositeFieldValueSemantics, val issueDateSemantics: CompositeFieldValueSemantics, val birthDateSemantics: CompositeFieldValueSemantics, val issueDateBeforeExpiryDate: ValueSemantics, val birthDateBeforeIssueDate: ValueSemantics, val birthDateBeforeExpiryDate: ValueSemantics) : Parcelable

Report of the document value semantics verification.

SuspiciousDataVerificationReport

data class SuspiciousDataVerificationReport(val overallSuspiciousData: Boolean, val fieldDetails: List<FieldSuspiciousDataVerificationReport>) : Parcelable

Report of the suspicious data document verification.

ValueConsistency

enum ValueConsistency : Enum<ValueConsistency>

The status of the consistency verification.

ValueSemantics

enum ValueSemantics : Enum<ValueSemantics>

The result of the value semantics verification.