blinkid-core/com.microblink.blinkid.core.result.barcode/BarcodeElementKey

BarcodeElementKey

enum BarcodeElementKey : Enum<BarcodeElementKey>

Represents the fields present in the barcode. Currently this is only used for AAMVACompliant documents.

Entries

Mandatory on all driver's licenses. All barcodes which are using 3-track magnetic stripe encoding used in the interest of smoothing a transition from legacy documents shall be designated as "Magnetic". All barcodes which are using compact encoding compliant with ISO/IEC 18013-2 shall be designated as "Compact". All barcodes (majority) compliant with Mandatory PDF417 Bar Code of the American Association of Motor Vehicle Administrators (AAMVA) Card Design Standard from AAMVA DL/ID-2000 standard to DL/ID-2013 shall be designated as "AAMVA".

StandardVersionNumber

Mandatory on all driver's licenses.

CustomerFamilyName

Mandatory on all AAMVA, Magnetic and Compact barcodes.

CustomerFirstName

Mandatory on all AAMVA, Magnetic and Compact barcodes.

CustomerFullName

Mandatory on all AAMVA, Magnetic and Compact barcodes.

DateOfBirth

Mandatory on all AAMVA, Magnetic and Compact barcodes.

Sex

Mandatory on all AAMVA, Magnetic barcodes. Optional on Compact barcodes.

EyeColor

Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 barcodes. Optional on AAMVA 01, Magnetic and Compact barcodes.

AddressStreet

Mandatory on all AAMVA and Magnetic barcodes.

AddressCity

Mandatory on all AAMVA and Magnetic barcodes.

AddressJurisdictionCode

Mandatory on all AAMVA and Magnetic barcodes.

AddressPostalCode

Mandatory on all AAMVA and Magnetic barcodes.

FullAddress

Mandatory on all AAMVA and Magnetic barcodes. Optional on Compact barcodes.

Height

Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes. Optional on AAMVA 01 and Magnetic barcodes.

HeightIn

Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes. Optional on AAMVA 01 and Magnetic barcodes.

HeightCm

Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 Compact barcodes. Optional on AAMVA 01 and Magnetic barcodes.

CustomerMiddleName

Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes. Optional on AAMVA 01, 02, 03, Magnetic and Compcat barcodes.

HairColor

Optional on all AAMVA, Magnetic and Compact barcodes.

NameSuffix

Mandatory on AAMVA 02 barcodes. Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes.

AKAFullName

Optional on all AAMVA and Compact barcodes.

AKAFamilyName

Optional on all AAMVA and Compact barcodes.

AKAGivenName

Optional on all AAMVA and Compact barcodes.

AKASuffixName

Optional on all AAMVA and Compact barcodes.

WeightRange

Mandatory on AAMVA 02 barcodes. Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes.

WeightPounds

Mandatory on AAMVA 02 barcodes. Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes.

WeightKilograms

Mandatory on AAMVA 02 barcodes. Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes.

CustomerIdNumber

Mandatory on all AAMVA and Compact barcodes.

FamilyNameTruncation

Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes. Optional on Compact barcodes.

FirstNameTruncation

Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes. Optional on Compact barcodes.

MiddleNameTruncation

Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes.

PlaceOfBirth

Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.

AddressStreet2

Optional on all AAMVA barcodes.

RaceEthnicity

Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.

NamePrefix

Optional on AAMVA 01 barcodes.

CountryIdentification

Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.

ResidenceStreetAddress

Optional on AAMVA version 01.

ResidenceStreetAddress2

Optional on AAMVA version 01.

ResidenceCity

Optional on AAMVA version 01.

ResidenceJurisdictionCode

Optional on AAMVA version 01.

ResidencePostalCode

Optional on AAMVA 01 barcodes.

ResidenceFullAddress

Optional on AAMVA 01 barcodes.

Under18

Optional on AAMVA 05, 06, 07, 08 barcodes.

Under19

Optional on AAMVA 05, 06, 07, 08 barcodes.

Under21

Optional on AAMVA 05, 06, 07, 08 barcodes.

SocialSecurityNumber

Optional on AAMVA version 01.

AKASocialSecurityNumber

Optional on AAMVA version 01.

AKAMiddleName

Optional on AAMVA 01 barcodes.

AKAPrefixName

Optional on AAMVA 01 barcodes.

OrganDonor

Optional on AAMVA 01, 06, 07, 08 barcodes.

Veteran

Optional on AAMVA 07, 08 barcodes.

AKADateOfBirth

Optional on AAMVA 01. (MMDDCCYY format)

IssuerIdentificationNumber

Mandatory on all AAMVA, Magnetic and Compact barcodes.

DocumentExpirationDate

Mandatory on all AAMVA, Magnetic and Compact barcodes.

JurisdictionVersionNumber

Mandatory on all AAMVA and Compact barcodes. Optional on Magnetic barcodes.

JurisdictionVehicleClass

Mandatory on all AAMVA and Magnetic barcodes.

JurisdictionRestrictionCodes

Mandatory on all AAMVA barcodes. Optional on Magnetic barcodes.

JurisdictionEndorsementCodes

Mandatory on all AAMVA barcodes. Optional on Magnetic barcodes.

DocumentIssueDate

Mandatory on all AAMVA and Compact barcodes.

FederalCommercialVehicleCodes

Mandatory on AAMVA versions 02 and 03.

IssuingJurisdiction

Optional on all AAMVA barcodes. Mandatory on Compact barcodes.

StandardVehicleClassification

Optional on all AAMVA barcodes. Mandatory on Compact barcodes.

IssuingJurisdictionName

Optional on all AAMVA and Magnetic barcodes.

StandardEndorsementCode

Optional on all AAMVA barcodes.

StandardRestrictionCode

Optional on all AAMVA barcodes.

JurisdictionVehicleClassificationDescription

Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.

JurisdictionEndorsmentCodeDescription

Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.

JurisdictionRestrictionCodeDescription

Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.

InventoryControlNumber

Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 barcodes.

CardRevisionDate

Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes.

DocumentDiscriminator

Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Magnetic barcodes. Optional and Compact barcodes.

LimitedDurationDocument

Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes.

AuditInformation

Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.

ComplianceType

Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes.

IssueTimestamp

Optional on AAMVA version 01 barcodes.

PermitExpirationDate

Optional on AAMVA version 01 barcodes.

PermitIdentifier

Optional on AAMVA version 01 barcodes..

PermitIssueDate

Optional on AAMVA version 01 barcodes..

NumberOfDuplicates

Optional on AAMVA version 01.

HAZMATExpirationDate

Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes.

MedicalIndicator

Optional on AAMVA version 01.

NonResident

Optional on AAMVA version 01.

UniqueCustomerId

Optional on AAMVA version 01.

DataDiscriminator

Optional on compact barcodes.

DocumentExpirationMonth

Optional on Magnetic barcodes.

DocumentNonexpiring

Optional on Magnetic barcodes.

SecurityVersion

Optional on Magnetic barcodes.

Properties

entries

val entries: EnumEntries<BarcodeElementKey>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): BarcodeElementKey

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<BarcodeElementKey>

Returns an array containing the constants of this enum type, in the order they're declared.