AAMVA Barcode Result
Defined in package com.scandit.datacapture.id.capture
- AamvaBarcodeResult
class AamvaBarcodeResultAdded in version 6.6.0
Information obtained from the PDF417 barcode of an AAMVA-compliant personal identification document.
The ID Capture supports all versions of the Driver License and Identification Standard published by AAMVA (personal identification documents used, for example, in the US and Canada). Some pre-Standard barcodes (documents issued before 2000) may also be successfully parsed, if their format doesn’t differ much from the version 1 of the Standard. Encrypted barcodes issued in the US State of Georgia before 2012 are currently not supported.
- aamvaVersion
intgetAamvaVersion()Added in version 6.5.0
The version level of the PDF417 barcode format. See the AAMVA DL/ID Card Design Standard for more details.
- jurisdictionVersion
intgetJurisdictionVersion()Added in version 6.5.0
The jurisdiction specific version number of the implementation.
- iin
@NonNull String getIin()
Added in version 6.5.0
The 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
The 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”.
- hairColor
@Nullable String getHairColor()
Added in version 6.5.0
The hair color of the card holder.
- heightInch
@Nullable Integer getHeightInch()
Added in version 6.5.0
The height of the card holder in inches.
- heightCm
@Nullable Integer getHeightCm()
Added in version 6.5.0
The height of the card holder in centimeters.
- weightLbs
@Nullable Integer getWeightLbs()
Added in version 6.5.0
Thw weight of the card holder in pounds.
- weightKg
@Nullable 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.
- documentDiscriminatorNumber
@Nullable String getDocumentDiscriminatorNumber()
Added in version 6.5.0
The document discriminator number.
- 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.
- isRealId
booleanisRealId()Added in version 6.16.0
Returns true if the document is a Real ID.
- 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(other)
booleanequals(@Nullable Object other)Added in version 6.5.0
Indicates whether some other object is equal to this one.
- hashCode()
inthashCode()Added in version 6.5.0
Returns a hash code value for the object.