blinkid-core/com.microblink.blinkid.core.result.classinfo/DocumentClassInfo

DocumentClassInfo

@Serializable

@SerialName(value = "DocumentClassInfo")

data class DocumentClassInfo(val country: DocumentClassInfo.Country?, val region: DocumentClassInfo.Region?, val documentType: DocumentClassInfo.DocumentType?, val countryName: String?, val isoAlpha3CountryCode: String?, val isoAlpha2CountryCode: String?, val isoNumericCountryCode: String?)

Represents the document class information.

Classification values keep both a strongly-typed ID (when known at SDK build time) and a rawValue string. For OTA-supported documents the ID may be null while rawValue is still populated. A missing country/region/document type is represented by a null nested value (e.g. when the native value would be "NONE").

Constructors

DocumentClassInfo

constructor(country: DocumentClassInfo.Country?, region: DocumentClassInfo.Region?, documentType: DocumentClassInfo.DocumentType?, countryName: String?, isoAlpha3CountryCode: String?, isoAlpha2CountryCode: String?, isoNumericCountryCode: String?)

Types

object Companion

@Serializable

@SerialName(value = "DocumentClassCountry")

data class Country(val id: CountryId?, val rawValue: String)

Document country classification, with optional strongly-typed ID and raw string value.

@Serializable

@SerialName(value = "DocumentClassDocumentType")

data class DocumentType(val id: DocumentTypeId?, val rawValue: String)

Document type classification, with optional strongly-typed ID and raw string value.

@Serializable

@SerialName(value = "DocumentClassRegion")

data class Region(val id: RegionId?, val rawValue: String)

Document region classification, with optional strongly-typed ID and raw string value.

Properties

val country: DocumentClassInfo.Country?

The document country.

val countryName: String?

The name of the country that issued the scanned document.

val documentType: DocumentClassInfo.DocumentType?

The document type.

isoAlpha2CountryCode

val isoAlpha2CountryCode: String?

The 2 letter ISO code of the country that issued the scanned document.

isoAlpha3CountryCode

val isoAlpha3CountryCode: String?

The 3 letter ISO code of the country that issued the scanned document.

isoNumericCountryCode

val isoNumericCountryCode: String?

The ISO numeric code of the country that issued the scanned document.

val region: DocumentClassInfo.Region?

The document region.