AAMVA Barcode Result#
Defined under the namespace Scandit.Datacapture.Id
-
AAMVABarcodeResult
# class AAMVABarcodeResult
Added in version 6.8.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
# get aamvaVersion(): number
Added in version 6.8.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
# get jurisdictionVersion(): number
Added in version 6.8.0
A jurisdiction specific version number of the implementation.
-
iIN
# get iIN(): string
Added in version 6.8.0
Issuer Identification Number which uniquely identifies the issuing jurisdiction.
-
issuingJurisdiction
# get issuingJurisdiction(): string
Added in version 6.8.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
# get issuingJurisdictionIso(): string
Added in version 6.8.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”.
-
heightInch
# get heightInch(): number | null
Added in version 6.8.0
The height of the card holder in inches.
-
heightCm
# get heightCm(): number | null
Added in version 6.8.0
The height of the card holder in centimeters.
-
weightLbs
# get weightLbs(): number | null
Added in version 6.8.0
Thw weight of the card holder in pounds.
-
weightKg
# get weightKg(): number | null
Added in version 6.8.0
The weight of the card holder in kilograms.
-
placeOfBirth
# get placeOfBirth(): string | null
Added in version 6.8.0
The place of birth of the card holder.
-
documentDiscriminatorNumber
# get documentDiscriminatorNumber(): string | null
Added in version 6.8.0
The document discriminator number.
-
restrictionsCode
# get restrictionsCode(): string | null
Added in version 6.8.0
The restriction code.
-
endorsementsCode
# get endorsementsCode(): string | null
Added in version 6.8.0
The endorsement code.
-
cardRevisionDate
# get cardRevisionDate(): DateResult | null
Added in version 6.8.0
Card revision date.
-
middleName
# get middleName(): string | null
Added in version 6.8.0
The middle name of the card holder.
-
driverNameSuffix
# get driverNameSuffix(): string | null
Added in version 6.8.0
The name suffix of the card holder.
-
driverNamePrefix
# get driverNamePrefix(): string | null
Added in version 6.8.0
The name prefix of the card holder.
-
lastNameTruncation
# get lastNameTruncation(): string | null
Added in version 6.8.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
# get firstNameTruncation(): string | null
Added in version 6.8.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
# get middleNameTruncation(): string | null
Added in version 6.8.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
# get aliasFamilyName(): string | null
Added in version 6.8.0
Other family name by which cardholder is known.
-
aliasGivenName
# get aliasGivenName(): string | null
Added in version 6.8.0
Other given name by which cardholder is known.
-
aliasSuffixName
# get aliasSuffixName(): string | null
Added in version 6.8.0
Other suffix name by which cardholder is known.
-
barcodeDataElements
# get barcodeDataElements(): object<string, string>
Added in version 6.8.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.
-