Aamva Barcode Result#

Defined in package com.scandit.datacapture.id.capture

AamvaBarcodeResult#
class AamvaBarcodeResult

Added in version 6.6.0

The ID Capture supports scanning all versions of the AAMVA Driver License/Identification specification (2000, 2003, 2005, 2009, 2010, 2011, 2012, 2013, 2016) used for example in USA or Canada. Some pre-specification codes (before 2000) can also be parsed if they are not far from version 1 standard. Encrypted codes issued in Georgia before 2012 are also currently not supported. More information you can find in http://www.aamva.org/.

aamvaVersion#
int getAamvaVersion()

Added in version 6.5.0

Corresponds to the version of the specifications that is implemented in the code: 0=pre-specification, 1=2000, 2=2003, 3=2005, 4=2009, 5=2010, 6=2011, 7=2012, 8=2013, 9=2016.

jurisdictionVersion#
int getJurisdictionVersion()

Added in version 6.5.0

A jurisdiction specific version number of the implementation.

iin#
@NonNull String getIin()

Added in version 6.5.0

Issuer Identification Number which uniquely identifies the issuing jurisdiction.

issuingJurisdiction#
@NonNull String getIssuingJurisdiction()

Added in version 6.5.0

A human readable name of the issuing jurisdiction (for example: an issuing state, territory or federal district for USA, or an issuing province or territory for Canada ).

issuingJurisdictionIso#
@NonNull String getIssuingJurisdictionIso()

Added in version 6.5.0

An ISO code of the issuing jurisdiction (for example: an issuing state, territory or federal district for USA, or an issuing province or territory for Canada).

Note

The returned value will only contain the jurisdiction specific code: for instance for California the returned value would be “CA” and not “US-CA”.

eyeColor#
@Nullable String getEyeColor()

Added in version 6.5.0

The eye color of the card holder.

hairColor#
@Nullable String getHairColor()

Added in version 6.5.0

The hair color of the card holder.

heightInch#
Integer getHeightInch()

Added in version 6.5.0

The height of the card holder in inches.

heightCm#
Integer getHeightCm()

Added in version 6.5.0

The height of the card holder in centimeters.

weightLbs#
Integer getWeightLbs()

Added in version 6.5.0

Thw weight of the card holder in pounds.

weightKg#
Integer getWeightKg()

Added in version 6.5.0

The weight of the card holder in kilograms.

placeOfBirth#
@Nullable String getPlaceOfBirth()

Added in version 6.5.0

The place of birth of the card holder.

race#
@Nullable String getRace()

Added in version 6.5.0

The race of the card holder.

documentDiscriminatorNumber#
@Nullable String getDocumentDiscriminatorNumber()

Added in version 6.5.0

The document discriminator number.

vehicleClass#
@Nullable String getVehicleClass()

Added in version 6.5.0

The vehicle classification.

restrictionsCode#
@Nullable String getRestrictionsCode()

Added in version 6.5.0

The restriction code.

endorsementsCode#
@Nullable String getEndorsementsCode()

Added in version 6.5.0

The endorsement code.

cardRevisionDate#
@Nullable DateResult getCardRevisionDate()

Added in version 6.5.0

Card revision date.

middleName#
@Nullable String getMiddleName()

Added in version 6.5.0

The middle name of the card holder.

driverNameSuffix#
@Nullable String getDriverNameSuffix()

Added in version 6.5.0

The name suffix of the card holder.

driverNamePrefix#
@Nullable String getDriverNamePrefix()

Added in version 6.5.0

The name prefix of the card holder.

lastNameTruncation#
@Nullable String getLastNameTruncation()

Added in version 6.5.0

The last name truncation. A code that indicates whether a field has been truncated (‘T’), has not been truncated (‘N’), unknown whether truncated (‘U’), or the information is not present in the document (null).

firstNameTruncation#
@Nullable String getFirstNameTruncation()

Added in version 6.5.0

The first name truncation. A code that indicates whether a field has been truncated (‘T’), has not been truncated (‘N’), unknown whether truncated (‘U’), or the information is not present in the document (null).

middleNameTruncation#
@Nullable String getMiddleNameTruncation()

Added in version 6.5.0

The middle name truncation. A code that indicates whether a field has been truncated (‘T’), has not been truncated (‘N’), unknown whether truncated (‘U’), or the information is not present in the document (null).

aliasFamilyName#
@Nullable String getAliasFamilyName()

Added in version 6.5.0

Other family name by which cardholder is known.

aliasGivenName#
@Nullable String getAliasGivenName()

Added in version 6.5.0

Other given name by which cardholder is known.

aliasSuffixName#
@Nullable String getAliasSuffixName()

Added in version 6.5.0

Other suffix name by which cardholder is known.

barcodeDataElements#
@NonNull Map<@NonNull String, @NonNull String> getBarcodeDataElements()

Added in version 6.6.0

The mappings between all the barcode data element IDs and their values. The keys of this collection are the element IDs as defined in the AAMVA Driver License/Identification specification. For example, the specification defines a data element “Customer First Name” with the ID “DAC”. Therefore if a scanned barcode contains a string “DACMICHAEL”, then this collection will contain a mapping with “DAC” as the key and “MICHAEL” as the value. This collection contains all the data elements of the barcode - including those that are exposed also explicitly as fields of this class.

See DL/ID for all the possible keys and their meaning.

equals(obj)#
boolean equals(@Nullable Object obj)

Added in version 6.5.0

Indicates whether some other object is equal to this one.

hashCode()#
int hashCode()

Added in version 6.5.0

Returns a hash code value for the object.