cordova-plugin-pdf417
Version:
A small and powerful PDF417 barcode scanning library
1,249 lines (1,003 loc) • 1.11 MB
text/xml
<?xml version="1.0"?>
<doc>
<assembly>
"ManagedBridge"
</assembly>
<members>
<member name="P:Microblink.USDLRecognitionResult.Elements">
<summary>
String -> Object map of result elements.
</summary>
<remarks> Result data can
be retrieved from this map instead of using the specific
properties in IRecognitionResult implementing classes.
In the instances when specific property is not implemented
the only way of retrieving the data is via this map.
</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.Empty">
<summary>
Indicates if the result is empty
</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.Valid">
<summary>
Indicates if the result is valid
</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.Uncertain">
<summary>
true if returned data is uncertain.
</summary>
<remarks>
Only applicable if used with PDF417RecognizerSettings.UncertainScanMode set to true.
</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.RawData">
<summary>
Raw barcode data.
</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.StringData">
<summary>
String representation of data inside barcode.
</summary>
</member>
<member name="M:Microblink.USDLRecognitionResult.GetField(System.String)">
<summary />
</member>
<member name="P:Microblink.USDLRecognitionResult.kDataDiscriminator">
<summary>Optional on compact encoding.
Document discriminator.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kUniqueCustomerId">
<summary>Optional on AAMVA version 01.
A number or alphanumeric string used by some jurisdictions to identify a "customer" across multiple data bases.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kNonResident">
<summary>Optional on AAMVA version 01.
Non-Resident Indicator. "Y". Used by some jurisdictions to indicate holder of the document is a non-resident.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kMedicalIndicator">
<summary>Optional on AAMVA version 01.
Medical Indicator/Codes.
STATE SPECIFIC. Freeform; Standard "TBD"</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kHAZMATExpirationDate">
<summary>Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
Date on which the hazardous material endorsement granted by the document is
no longer valid. (MMDDCCYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kComplianceType">
<summary>Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
DHS required field that indicates compliance: "M" = materially compliant;
"F" = fully compliant; and, "N" = non-compliant.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAuditInformation">
<summary>Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
A string of letters and/or numbers that identifies when, where, and by whom a driver
license/ID card was made.</summary>
<remarks>If audit information is not used on the card or the MRT, it
must be included in the driver record.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kNumberOfDuplicates">
<summary>Optional on AAMVA version 01.
Number of duplicate cards issued for a license or ID if any.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kPermitIssueDate">
<summary>Optional on AAMVA version 01.
Driver Permit Issue Date. MMDDCCYY format. Date permit was issued.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kPermitIdentifier">
<summary>Optional on AAMVA version 01.
Type of permit.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kPermitExpirationDate">
<summary>Optional on AAMVA version 01.
Driver Permit Expiration Date. MMDDCCYY format. Date permit expires.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kIssueTimestamp">
<summary>Optional on AAMVA version 01.
Issue Timestamp. A string used by some jurisdictions to validate the document against their data base.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kLimitedDurationDocument">
<summary>Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
DHS required field that indicates that the cardholder has temporary lawful status = "1".</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kDocumentDiscriminator">
<summary>Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding</summary>
<remarks>Number must uniquely identify a particular document issued to that customer
from others that may have been issued in the past. This number may serve multiple
purposes of document discrimination, audit information number, and/or inventory control.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kCardRevisionDate">
<summary>Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
DHS required field that indicates date of the most recent version change or
modification to the visible format of the DL/ID (MMDDCCYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kInventoryControlNumber">
<summary>Optional on AAMVA 02, 03, 04, 05, 06, 07, 08
A string of letters and/or numbers that is affixed to the raw materials (card stock,
laminate, etc.) used in producing driver licenses and ID cards. (DHS recommended field)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kJurisdictionRestrictionCodeDescription">
<summary>Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kJurisdictionEndorsmentCodeDescription">
<summary>Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Text that explains the jurisdiction-specific code(s) that indicates additional
driving privileges granted to the cardholder beyond the vehicle class.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kJurisdictionVehicleClassificationDescription">
<summary>Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Text that explains the jurisdiction-specific code(s) for classifications
of vehicles cardholder is authorized to drive.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kBiometricData">
<summary>Optional on compact encodings.
Biometric data block</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kBiometricDataLength">
<summary>Optional on compact encodings.
Biometric data block length</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kBDBFormatType">
<summary>Optional on compact encodings.
BDB format type</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kBDBFormatOwner">
<summary>Optional on compact encodings.
BDB format owner</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kPortraitImage">
<summary>Optional on compact encoding.
Portrait image</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kImageType">
<summary>Optional on compact encoding.
Type of image</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kImageTimestamp">
<summary>Optional on compact encoding.
Portrait image timestamp</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAKADateOfBirth">
<summary>Optional on AAMVA 01. (MMDDCCYY format)
ALTERNATIVE DATES(S) given as date of birth.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kVeteran">
<summary>Optional on AAMVA 07, 08
Field that indicates that the cardholder is a veteran = "1"</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kOrganDonor">
<summary>Optional on AAMVA 06, 07, 08
Field that indicates that the cardholder is an organ donor = "1".</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAKASuffixName">
<summary>Optional on AAMVA 01, 03, 04, 05, 06, 07, 08 and Compact Encoding
Other suffix by which cardholder is known.</summary>
<remarks>The Suffix Code Portion, if submitted, can contain only the Suffix Codes shown in the following table (e.g., Andrew Johnson, III = JOHNSON@ANDREW@@3RD):
Suffix Meaning or Synonym
JR Junior
SR Senior or Esquire 1ST First
2ND Second
3RD Third
4TH Fourth
5TH Fifth
6TH Sixth
7TH Seventh
8TH Eighth
9TH Ninth</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAKAPrefixName">
<summary>Optional on AAMVA 01
ALTERNATIVE PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAKAGivenName">
<summary>Optional on AAMVA 01, 03, 04, 05, 06, 07, 08 and Compact Encoding
Other given name by which cardholder is known</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAKAFamilyName">
<summary>Optional on AAMVA 01, 03, 04, 05, 06, 07, 08 and Compact Encoding
Other family name by which cardholder is known.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAKAFullName">
<summary>Optional on AAMVA version 01, 02
Other name by which cardholder is known.</summary>
<remarks>ALTERNATIVE NAME(S) of the individual holding
the Driver License or ID. FORMAT same as defined in ANSI D20 Data Dictionary.
(Lastname@Firstname@MI@ suffix if any.)
(Machine, Mag Stripe uses ‘$’ and Bar Code uses ‘,’ in place of ‘@’)
Firstname, Middle Initial, Lastname (Human)
The Name field contains four portions, separated with the "@" delimiter: Last Name (required)
@ (required)
First Name (required)
@ (required if other name portions follow, otherwise optional)
Middle Name(s) (optional)
@ (required if other name portions follow, otherwise optional)
Suffix Code (optional)
@ (optional)</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAKASocialSecurityNumber">
<summary>Optional on AAMVA version 01.
Driver "AKA" Social Security Number. FORMAT SAME AS DRIVER SOC SEC NUM. ALTERNATIVE NUMBERS(S) used as SS NUM.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kSocialSecurityNumber">
<summary>Optional on AAMVA version 01.
The number assigned to an individual by the Social Security Administration.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kUnder21">
<summary>Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 21 years old. (MMDDCCYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kUnder19">
<summary>Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 19 years old. (MMDDCCYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kUnder18">
<summary>Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 18 years old. (MMDDCCYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kHeightCm">
<summary>Optional on AAMVA 01
Mandatory on Compact encoding
HEIGHT in CENTIMETERS</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kHeightIn">
<summary>Optional on AAMVA 01
Height (FT/IN)</summary>
<remarks>FEET (1st char); Inches (2nd and 3rd char).
Ex. 509 = 5 ft., 9 in.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kResidencePostalCode">
<summary>Optional on AAMVA version 01.
Driver Residence Postal Code.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kResidenceJurisdictionCode">
<summary>Optional on AAMVA version 01.
Driver Residence Jurisdiction Code.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kResidenceCity">
<summary>Optional on AAMVA version 01.
Driver Residence City</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kResidenceStreetAddress2">
<summary>Optional on AAMVA version 01.
Driver Residence Street Address 2.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kResidenceStreetAddress">
<summary>Optional on AAMVA version 01.
Driver Residence Street Address 1.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kCountryIdentification">
<summary>Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Country in which DL/ID is issued. U.S. = USA, Canada = CAN.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kNamePrefix">
<summary>Optional on AAMVA 01
PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kRaceEthnicity">
<summary>Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Codes for race or ethnicity of the cardholder, as defined in ANSI D20.</summary>
<remarks>Race:
Code Description
AI Alaskan or American Indian (Having Origins in Any of The Original Peoples of
North America, and Maintaining Cultural Identification Through Tribal
Affiliation of Community Recognition)
AP Asian or Pacific Islander (Having Origins in Any of the Original Peoples of
the Far East, Southeast Asia, or Pacific Islands. This Includes China, India,
Japan, Korea, the Philippines Islands, and Samoa)
BK Black (Having Origins in Any of the Black Racial Groups of Africa)
W White (Having Origins in Any of The Original Peoples of Europe, North Africa,
or the Middle East)
Ethnicity:
Code Description
H Hispanic Origin (A Person of Mexican, Puerto Rican, Cuban, Central or South
American or Other Spanish Culture or Origin, Regardless of Race)
O Not of Hispanic Origin (Any Person Other Than Hispanic)
U Unknown
</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kWeightKilograms">
<summary>Optional on AAMVA 01, 04, 05, 06, 07, 08 and Compact Encoding
Cardholder weight in kilograms Ex. 84 kg = "084"</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kWeightPounds">
<summary>Optional on AAMVA 01, 04, 05, 06, 07, 08
Cardholder weight in pounds Ex. 185 lb = "185"</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kWeightRange">
<summary>Optional on AAMVA 02, 03, 04, 05, 06, 07, 08
Indicates the approximate weight range of the cardholder:
0 = up to 31 kg (up to 70 lbs)
1 = 32 – 45 kg (71 – 100 lbs)
2 = 46 - 59 kg (101 – 130 lbs)
3 = 60 - 70 kg (131 – 160 lbs)
4 = 71 - 86 kg (161 – 190 lbs)
5 = 87 - 100 kg (191 – 220 lbs)
6 = 101 - 113 kg (221 – 250 lbs)
7 = 114 - 127 kg (251 – 280 lbs)
8 = 128 – 145 kg (281 – 320 lbs)
9 = 146+ kg (321+ lbs)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kPlaceOfBirth">
<summary>Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Country and municipality and/or state/province</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kSecurityVersion">
<summary>Mandatory on AMMVA Magnetic Stripe Encoding
Security version beeing used.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kFederalCommercialVehicleCodes">
<summary>Mandatory on AAMVA versions 02 and 03.
Federally established codes for vehicle categories, endorsements, and restrictions
that are generally applicable to commercial motor vehicles. If the vehicle is not a
commercial vehicle, "NONE" is to be entered.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kMiddleNameTruncation">
<summary>Mandatory on AAMVA 04, 05, 06, 07, 08
A code that indicates whether a field has been truncated (T), has not been
truncated (N), or – unknown whether truncated (U).</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kFirstNameTruncation">
<summary>Mandatory on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
A code that indicates whether a field has been truncated (T), has not been
truncated (N), or – unknown whether truncated (U).</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kFamilyNameTruncation">
<summary>Mandatory on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
A code that indicates whether a field has been truncated (T), has not been
truncated (N), or – unknown whether truncated (U).</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kFullAddress">
<summary>Mandatory on compact encoding.
Cardholder address.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kCustomerFullName">
<summary>Mandatory on AAMVA 01
NAME of the individual holding the Driver License or ID as defined in
ANSI D20 Data Dictionary. (Lastname@Firstname@MI@ suffix if any)</summary>
<remarks>
(Machine, Mag Stripe uses ‘$’ and Bar Code uses ‘,’ in place of ‘@’)
Firstname, Middle Initial, Lastname (Human)
The Name field contains four portions, separated with the "@" delimiter: Last Name (required)
@ (required)
First Name (required)
@ (required if other name portions follow, otherwise optional)
Middle Name(s) (optional)
@ (required if other name portions follow, otherwise optional)
Suffix Code (optional)
@ (optional)</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kHeight">
<summary>Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08
Height of cardholder.</summary>
<remarks>
Inches (in): number of inches followed by " in"
example. 6'1'' = "073 in"
Centimeters (cm): number of centimeters followed by " cm"
example. 181 centimeters="181 cm"</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kCustomerMiddleName">
<summary>Mandatory on AAMVA 04, 05, 06, 07, 08
Optional on 01.
Middle name(s) of the cardholder.</summary>
<remarks>In the case of multiple middle names they
shall be separated by a comma ",".</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kStandardRestrictionCode">
<summary>Optional on AAMVA 01, 02, 03, 04, 05, 06, 07 and 08
Standard restriction code(s) for cardholder.</summary>
<remarks> See codes in D20. This data element is a placeholder
for future efforts to standardize restriction codes.
Code Description
B Corrective Lenses
C Mechanical Devices (Special Brakes, Hand Controls, or Other Adaptive Devices)
D Prosthetic Aid
E Automatic Transmission
F Outside Mirror
G Limit to Daylight Only
H Limit to Employment
I Limited Other
J Other
K CDL Intrastate Only
L Vehicles without air brakes
M Except Class A bus
N Except Class A and Class B bus
O Except Tractor-Trailer
V Medical Variance Documentation Required
W Farm Waiver</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kStandardEndorsementCode">
<summary>Optional on AAMVA 01, 02, 03, 04, 05, 06, 07 and 08
Standard endorsement code(s) for cardholder.</summary>
<remarks> See codes in D20. This data element is a
placeholder for future efforts to standardize endorsement codes.
Code Description
H Hazardous Material - This endorsement is required for the operation of any vehicle
transporting hazardous materials requiring placarding, as defined by U.S.
Department of Transportation regulations.
L Motorcycles – Including Mopeds/Motorized Bicycles.
N Tank - This endorsement is required for the operation of any vehicle transporting,
as its primary cargo, any liquid or gaseous material within a tank attached to the vehicle.
O Other Jurisdiction Specific Endorsement(s) - This code indicates one or more
additional jurisdiction assigned endorsements.
P Passenger - This endorsement is required for the operation of any vehicle used for
transportation of sixteen or more occupants, including the driver.
S School Bus - This endorsement is required for the operation of a school bus. School bus means a
CMV used to transport pre-primary, primary, or secondary school students from home to school,
from school to home, or to and from school sponsored events. School bus does not include a
bus used as common carrier (49 CRF 383.5).
T Doubles/Triples - This endorsement is required for the operation of any vehicle that would be
referred to as a double or triple.
X Combined Tank/HAZ-MAT - This endorsement may be issued to any driver who qualifies for
both the N and H endorsements.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kStandardVehicleClassification">
<summary>Optional on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Standard vehicle classification code(s) for cardholder.</summary>
<remarks> This data element is a
placeholder for future efforts to standardize vehicle classifications.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kIssuingJurisdiction">
<summary>Optional on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
Mandatory on Compact Encoding</summary>
<remarks>
Jurisdictions may define a subfile to contain jurisdiction-specific information.
These subfiles are designated with the first character of “Z” and the second
character is the first letter of the jurisdiction's name. For example, "ZC" would
be the designator for a California or Colorado jurisdiction-defined subfile; "ZQ"
would be the designator for a Quebec jurisdiction-defined subfile. In the case of
a jurisdiction-defined subfile that has a first letter that could be more than
one jurisdiction (e.g. California, Colorado, Connecticut) then other data, like
the IIN or address, must be examined to determine the jurisdiction.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAddressStreet2">
<summary>Optional on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
On Compact encoding, use kFullAddress
Second line of street portion of the cardholder address.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kHairColor">
<summary>Optional on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Bald, black, blonde, brown, gray, red/auburn, sandy, white, unknown.</summary>
<remarks>If the issuing
jurisdiction wishes to abbreviate colors, the three-character codes provided in ANSI D20 must be
used.
Code Description
BAL Bald
BLK Black
BLN Blond
BRO Brown
GRY Grey
RED Red/Auburn
SDY Sandy
WHI White
UNK Unknown</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kCustomerIdNumber">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
The number assigned or calculated by the issuing authority.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kJurisdictionEndorsementCodes">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
Jurisdiction-specific codes that represent additional privileges
granted to the cardholder beyond the vehicle class (such as transportation of
passengers, hazardous materials, operation of motorcycles, etc.).</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kJurisdictionRestrictionCodes">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
Jurisdiction-specific codes that represent restrictions to driving
privileges (such as airbrakes, automatic transmission, daylight only, etc.).</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kJurisdictionVehicleClass">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
Jurisdiction-specific vehicle class / group code</summary>
<remarks> designating the type
of vehicle the cardholder has privilege to drive.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kJurisdictionVersionNumber">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Jurisdiction Version Number</summary>
<remarks>This is a decimal value between 00 and 99 that
specifies the jurisdiction version level of the PDF417 bar code format.
Notwithstanding iterations of this standard, jurisdictions implement incremental
changes to their bar codes, including new jurisdiction-specific data, compression
algorithms for digitized images, digital signatures, or new truncation
conventions used for names and addresses. Each change to the bar code format
within each AAMVA version (above) must be noted, beginning with Jurisdiction
Version 00.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kDocumentNonexpiring">
<summary>Optional on AAMVA Magnetic Stripe Encoding
Field that indicates that the driving and identification privileges granted by the
document are nonexpiring = "1".</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kDocumentExpirationMonth">
<summary>Optional on AAMVA Magnetic Stripe Encoding
Date on which the driving and identification privileges granted by the document are
no longer valid. (MMYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kDocumentExpirationDate">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Date on which the driving and identification privileges granted by the document are
no longer valid. (MMDDCCYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kDocumentIssueDate">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Date on which the document was issued. (MMDDCCYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kIssuerIdentificationNumber">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
Optional on Compact encoding</summary>
<remarks>This number uniquely identifies the issuing jurisdiction and can
be obtained by contacting the ISO Issuing Authority (AAMVA)</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAddressPostalCode">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
On compact encoding, use kFullAddress.</summary>
<remarks>Postal code portion of the cardholder address in the U.S. and Canada. If the
trailing portion of the postal code in the U.S. is not known, zeros will be used
to fill the trailing set of numbers up to nine (9) digits.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAddressJurisdictionCode">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
On compact encoding, use kFullAddress.</summary>
<remarks>State portion of the cardholder address.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAddressCity">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
On compact encoding, use kFullAddress.</summary>
<remarks>City portion of the cardholder address.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAddressStreet">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08
On compact encoding, use kFullAddress.</summary>
<remarks>Street portion of the cardholder address.
The place where the registered driver of a vehicle (individual or corporation) may be contacted such as a house number, street address etc.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kEyeColor">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact encoding
Color of cardholder's eyes.</summary>
<remarks>(ANSI D-20 codes)
Code Description
BLK Black
BLU Blue
BRO Brown
GRY Gray
GRN Green
HAZ Hazel
MAR Maroon
PNK Pink
DIC Dichromatic
UNK Unknown</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kSex">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact encoding
Gender of the cardholder. 1 = male, 2 = female.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kDateOfBirth">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact encoding
Date on which the cardholder was born. (MMDDCCYY format)</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kCustomerFirstName">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 and Compact encoding
First name of the cardholder.</summary>
</member>
<member name="P:Microblink.USDLRecognitionResult.kCustomerFamilyName">
<summary>Mandatory on AAMVA 01, 02, 03, 04, 05, 06, 07, 08 AND compact encoding.
Family name of the cardholder.</summary>
<remarks>(Family name is sometimes also called "last name" or "surname.")
Collect full name for record, print as many characters as possible on portrait side of DL/ID.</remarks>
</member>
<member name="P:Microblink.USDLRecognitionResult.kAamvaVersionNumber">
<summary>Mandatory on all AAMVA driver's license versions.
AAMVA Version Number.</summary>
<remarks>This is a decimal value between 00 and 99 that
specifies the version level of the PDF417 bar code format. Version "0" and "00"
is reserved for bar codes printed to the specification of the American Association
of Motor Vehicle Administrators (AAMVA) prior to the adoption of the AAMVA DL/ID-2000
standard. All bar codes compliant with the AAMVA DL/ID-2000 standard are designated
Version "01." All barcodes compliant with AAMVA Card Design Specification version
1.0, dated 09-2003 shall be designated Version "02." All barcodes compliant with
AAMVA Card Design Specification version 2.0, dated 03-2005 shall be designated
Version "03." All barcodes compliant with AAMVA Card Design Standard version 1.0,
dated 07-2009 shall be designated Version "04." All barcodes compliant with AAMVA
Card Design Standard version 1.0, dated 07-2010 shall be designated Version "05."
All barcodes compliant with AAMVA Card Design Standard version 1.0, dated 07- 2011
shall be designated Version "06". All barcodes compliant with AAMVA Card Design
Standard version 1.0, dated 06-2012 shall be designated Version "07". All barcodes
compliant with this current AAMVA standard shall be designated "08". Should a need
arise requiring major revision to the format, this field provides the means to
accommodate additional revision. "Compact" when Compact encoding is used.</remarks>
</member>
<member name="T:Microblink.USDLRecognitionResult">
<summary>
US driver's license recognition result
</summary>
</member>
<member name="M:photopay.DLRecognizer.setAutoScaleDetection(System.Boolean)">
Enables detecting the scale of the image before trying to read code29 and code 128 barcodes
@param autoScale
</member>
<member name="M:photopay.DLRecognizer.setUseTryHarder(System.Boolean)">
Enables to spent more time trying to read code39 and code128 barcodes
@param tryHarder
</member>
<member name="M:photopay.DLRecognizer.setAllowNullQuietZone(System.Boolean)">
Enables decoding of barcodes without quiet zone round the barcode
(e.g. text concatenated with barcode blocks)
@param allowNullQuietZone
</member>
<member name="M:photopay.DLRecognizer.setUseUncertainDecoding(System.Boolean)">
Enables decoding of barcodes where multiple rows are missing from the end of the barcode
(e.g. when more lines at the end of barcode are not printed, and there is not enough
error correction codewords left to compensate for missing rows)
@param useUncertainDecoding
</member>
<member name="M:photopay.DLRecognizer.resetResults">
Resets the best results in the whole chain
and clears history
</member>
<member name="M:photopay.DLRecognizer.recognize(photopay.RecognitionContext*!System.Runtime.CompilerServices.IsImplicitlyDereferenced)">
* Method fills the recognition result object with
* payment data recognized from given image
* Returns true if scanning was successful, false otherwise
</member>
<member name="F:photopay.Keys.kDataDiscriminator">
Optional on compact encoding.
Document discriminator.
</member>
<member name="F:photopay.Keys.kUniqueCustomerId">
Optional on AAMVA version 01.
A number or alphanumeric string used by some jurisdictions to identify a "customer" across multiple data bases.
</member>
<member name="F:photopay.Keys.kNonResident">
Optional on AAMVA version 01.
Non-Resident Indicator. "Y". Used by some jurisdictions to indicate holder of the document is a non-resident.
</member>
<member name="F:photopay.Keys.kMedicalIndicator">
Optional on AAMVA version 01.
Medical Indicator/Codes.
STATE SPECIFIC. Freeform; Standard "TBD"
</member>
<member name="F:photopay.Keys.kHAZMATExpirationDate">
Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
Date on which the hazardous material endorsement granted by the document is
no longer valid. (MMDDCCYY format)
</member>
<member name="F:photopay.Keys.kComplianceType">
Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
DHS required field that indicates compliance: "M" = materially compliant;
"F" = fully compliant; and, "N" = non-compliant.
</member>
<member name="F:photopay.Keys.kAuditInformation">
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
A string of letters and/or numbers that identifies when, where, and by whom a driver
license/ID card was made. If audit information is not used on the card or the MRT, it
must be included in the driver record.
</member>
<member name="F:photopay.Keys.kNumberOfDuplicates">
Optional on AAMVA version 01.
Number of duplicate cards issued for a license or ID if any.
</member>
<member name="F:photopay.Keys.kPermitIssueDate">
Optional on AAMVA version 01.
Driver Permit Issue Date. MMDDCCYY format. Date permit was issued.
</member>
<member name="F:photopay.Keys.kPermitIdentifier">
Optional on AAMVA version 01.
Type of permit.
</member>
<member name="F:photopay.Keys.kPermitExpirationDate">
Optional on AAMVA version 01.
Driver Permit Expiration Date. MMDDCCYY format. Date permit expires.
</member>
<member name="F:photopay.Keys.kIssueTimestamp">
Optional on AAMVA version 01.
Issue Timestamp. A string used by some jurisdictions to validate the document against their data base.
</member>
<member name="F:photopay.Keys.kLimitedDurationDocument">
Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
DHS required field that indicates that the cardholder has temporary lawful status = "1".
</member>
<member name="F:photopay.Keys.kDocumentDiscriminator">
Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Number must uniquely identify a particular document issued to that customer
from others that may have been issued in the past. This number may serve multiple
purposes of document discrimination, audit information number, and/or inventory control.
</member>
<member name="F:photopay.Keys.kCardRevisionDate">
Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
DHS required field that indicates date of the most recent version change or
modification to the visible format of the DL/ID (MMDDCCYY format)
</member>
<member name="F:photopay.Keys.kInventoryControlNumber">
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08
A string of letters and/or numbers that is affixed to the raw materials (card stock,
laminate, etc.) used in producing driver licenses and ID cards. (DHS recommended field)
</member>
<member name="F:photopay.Keys.kJurisdictionRestrictionCodeDescription">
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges.
</member>
<member name="F:photopay.Keys.kJurisdictionEndorsmentCodeDescription">
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Text that explains the jurisdiction-specific code(s) that indicates additional
driving privileges granted to the cardholder beyond the vehicle class.
</member>
<member name="F:photopay.Keys.kJurisdictionVehicleClassificationDescription">
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Text that explains the jurisdiction-specific code(s) for classifications
of vehicles cardholder is authorized to drive.
</member>
<member name="F:photopay.Keys.kBiometricData">
Optional on compact encodings.
Biometric data block
</member>
<member name="F:photopay.Keys.kBiometricDataLength">
Optional on compact encodings.
Biometric data block length
</member>
<member name="F:photopay.Keys.kBDBFormatType">
Optional on compact encodings.
BDB format type
</member>
<member name="F:photopay.Keys.kBDBFormatOwner">
Optional on compact encodings.
BDB format owner
</member>
<member name="F:photopay.Keys.kPortraitImage">
Optional on compact encoding.
Portrait image
</member>
<member name="F:photopay.Keys.kImageType">
Optional on compact encoding.
Type of image
</member>
<member name="F:photopay.Keys.kImageTimestamp">
Optional on compact encoding.
Portrait image timestamp
</member>
<member name="F:photopay.Keys.kAKADateOfBirth">
Optional on AAMVA 01. (MMDDCCYY format)
ALTERNATIVE DATES(S) given as date of birth.
</member>
<member name="F:photopay.Keys.kVeteran">
Optional on AAMVA 07, 08
Field that indicates that the cardholder is a veteran = "1"
</member>
<member name="F:photopay.Keys.kOrganDonor">
Optional on AAMVA 06, 07, 08
Field that indicates that the cardholder is an organ donor = "1".
</member>
<member name="F:photopay.Keys.kAKASuffixName">
Optional on AAMVA 01, 03, 04, 05, 06, 07, 08 and Compact Encoding
Other suffix by which cardholder is known.
The Suffix Code Portion, if submitted, can contain only the Suffix Codes shown in the following table (e.g., Andrew Johnson, III = JOHNSON@ANDREW@@3RD):
Suffix Meaning or Synonym
JR Junior
SR Senior or Esquire 1ST First
2ND Second
3RD Third
4TH Fourth
5TH Fifth
6TH Sixth
7TH Seventh
8TH Eighth
9TH Ninth
</member>
<member name="F:photopay.Keys.kAKAPrefixName">
Optional on AAMVA 01
ALTERNATIVE PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.
</member>
<member name="F:photopay.Keys.kAKAGivenName">
Optional on AAMVA 01, 03, 04, 05, 06, 07, 08 and Compact Encoding
Other given name by which cardholder is known
</member>
<member name="F:photopay.Keys.kAKAMiddleName">
Optional on AAMVA 01
ALTERNATIVE MIDDLE NAME(s) or INITIALS of the individual holding the Driver License or ID.
Hyphenated names acceptable, spaces between names acceptable, but no other
use of special symbols
</member>
<member name="F:photopay.Keys.kAKAFamilyName">
Optional on AAMVA 01, 03, 04, 05, 06, 07, 08 and Compact Encoding
Other family name by which cardholder is known.
</member>
<member name="F:photopay.Keys.kAKAFullName">
Optional on AAMVA version 01, 02
Other name by which cardholder is known. ALTERNATIVE NAME(S) of the individual holding
the Driver License or ID. FORMAT same as defined in ANSI D20 Data Dictionary.
(Lastname@Firstname@MI@ suffix if any.)
(Machine, Mag Stripe uses â€$’ and Bar Code uses â€,’ in place of â€@’)
Firstname, Middle Initial, Lastname (Human)
The Name field contains four portions, separated with the "@" delimiter: Last Name (required)
@ (required)
First Name (required)
@ (required if other name portions follow, otherwise optional)
Middle Name(s) (optional)
@ (required if other name portions follow, otherwise optional)
Suffix Code (optional)
@ (optional)
</member>
<member name="F:photopay.Keys.kAKASocialSecurityNumber">
Optional on AAMVA version 01.
Driver "AKA" Social Security Number. FORMAT SAME AS DRIVER SOC SEC NUM. ALTERNATIVE NUMBERS(S) used as SS NUM.
</member>
<member name="F:photopay.Keys.kSocialSecurityNumber">
Optional on AAMVA version 01.
The number assigned to an individual by the Social Security Administration.
</member>
<member name="F:photopay.Keys.kUnder21">
Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 21 years old. (MMDDCCYY format)
</member>
<member name="F:photopay.Keys.kUnder19">
Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 19 years old. (MMDDCCYY format)
</member>
<member name="F:photopay.Keys.kUnder18">
Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 18 years old. (MMDDCCYY format)
</member>
<member name="F:photopay.Keys.kHeightCm">
Optional on AAMVA 01
Mandatory on Compact encoding
HEIGHT in CENTIMETERS
</member>
<member name="F:photopay.Keys.kHeightIn">
Optional on AAMVA 01
Height (FT/IN)
FEET (1st char); Inches (2nd and 3rd char).
Ex. 509 = 5 ft., 9 in.
</member>
<member name="F:photopay.Keys.kResidencePostalCode">
Optional on AAMVA version 01.
Driver Residence Postal Code.
</member>
<member name="F:photopay.Keys.kResidenceJurisdictionCode">
Optional on AAMVA version 01.
Driver Residence Jurisdiction Code.
</member>
<member name="F:photopay.Keys.kResidenceCity">
Optional on AAMVA version 01.
Driver Residence City
</member>
<member name="F:photopay.Keys.kResidenceStreetAddress2">
Optional on AAMVA version 01.
Driver Residence Street Address 2.
</member>
<member name="F:photopay.Keys.kResidenceStreetAddress">
Optional on AAMVA version 01.
Driver Residence Street Address 1.
</member>
<member name="F:photopay.Keys.kCountryIdentification">
Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Country in which DL/ID is issued. U.S. = USA, Canada = CAN.
</member>
<member name="F:photopay.Keys.kNamePrefix">
Optional on AAMVA 01
PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.
</member>
<member name="F:photopay.Keys.kRaceEthnicity">
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Codes for race or ethnicity of the cardholder, as defined in ANSI D20.
Race:
Code Description
AI Alaskan or American Indian (Having Origins in Any of The Original Peoples of
North America, and Maintaining Cultural Identification Through Tribal
Affiliation of Community Recognition)
AP Asian or Pacific Islander (Having Origins in Any of the Original Peoples of
the Far East, Southeast Asia, or Pacific Islands. This Includes China, India,
Japan, Korea, the Philippines Islands, and Samoa)
BK Black (Having Origins in Any of the Black Racial Groups of Africa)
W White (Having Origins in Any of The Original Peoples of Europe, North Africa,
or the Middle East)
Ethnicity:
Code Description
H Hispanic Origin (A Person of Mexican, Puerto Rican, Cuban, Central or South
American or Other Spanish Culture or Origin, Regardless of Race)
O Not of Hispanic Origin (Any Person Other Than Hispanic) U Unknown
</member>
<member name="F:photopay.Keys.kWeightKilograms">
Optional on AAMVA 01, 04, 05, 06, 07, 08 and Compact Encoding
Cardholder weight in kilograms Ex. 84 kg = "084"
</member>
<member name="F:photopay.Keys.kWeightPounds">
Optional on AAMVA 01, 04, 05, 06, 07, 08
Cardholder weight in pounds Ex. 185 lb = "185"
</member>
<member name="F:photopay.Keys.kWeightRange">
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08
Indicates the approximate weight range of the cardholder:
0 = up to 31 kg (up to 70 lbs)
1 = 32 – 45 kg (71 – 100 lbs)
2 = 46 - 59 kg (101 – 130 lbs)
3 = 60 - 70 kg (131 – 160 lbs)
4 = 71 - 86 kg (161 – 190 lbs)
5 = 87 - 100 kg (191 – 220 lbs)
6 = 101 - 113 kg (221 – 250 lbs)
7 = 114 - 127 kg (251 – 280 lbs)
8 = 128 – 145 kg (281 – 320 lbs)
9 = 146+ kg (321+ lbs)
</member>
<member name="F:photopay.Keys.kPlaceOfBirth">
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
Country and municipality and/or state/province
</member>
<member name="F:photopay.Keys.kSecurityVersion">
Mandatory on AMMVA Magnetic Stripe Encoding
Security version beeing used.
</member>
<member name="F:photopay.Keys.kFederalCommercialVehicleCodes">
Mandatory on AAMVA versions 02 and 03.
Federally established codes for vehicle categories, endorsements, and restrictions
that are generally applicable to commercial motor vehicles. If the vehicle is not a
commercial vehicle, "NONE" is to be entered.
</member>
<member name="F:photopay.Keys.kMiddleNameTruncation">
Mandatory on AAMVA 04, 05, 06, 07, 08
A code that indicates whether a field has been truncated (T), has not been
truncated (N), or – unknown whether truncated (U).
</member>
<member name="F:photopay.Keys.kFirstNameTruncation">
Mandatory on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
A code that indicates whether a field has been truncated (T), has not been
truncated (N), or – unknown whether truncated (U).
</member>
<member name="F:photopay.Keys.kFamilyNameTruncation">
Mandatory on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
A code that indicates whether a field has been truncated (T), has not been
truncated (N), or – unknown whether truncated (U).
</member>
<member name="F:photopay.Keys.kFullAddress">
Mandatory on compact encoding.
Cardholder address.
</member>
<member name="F:photopay.Keys.kCustomerFullName">
Mandatory on AAMVA 01
NAME of the individual holding the Driver License or ID as defined in
ANSI D20 Data Dictionary. (Lastname@Firstname@MI@ suffix if any)
(Machine, Mag Stripe uses â€$’ and Bar Code uses â€,’ in place of â€@’)
Firstname, Middle Initial, Lastname (Human)
The Name field contains four portions, separated with the "@" delimiter: Last Name (required)
@ (required)
First Name (required)
@ (required if other name portions follow, otherwise optional)
Middle Name(s) (optional)
@ (required if other name portions follow, otherwise optional)
Suffix Code (optional)
@ (optional)
</member>
<member name="F:photopay.Keys.kHeight">
Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08
Height of cardholder.
Inches (in): number of inches followed by " in"
example. 6'1'' = "073 in"
Centimeters (cm): number of centimeters followed by " cm"
example. 181 centimeters="181 cm"
</member>
<member name="F:photopay.Keys.kCustomerMiddleName">
Mandatory on AAMVA 04, 05, 06, 07, 08
Optional on 01.
Middle name(s) of the cardholder. In the case of multiple middle names they
shall be separated by a comma ",".
</member>
<member name="F:photopay.Keys.kStandardRestrictionCode">
Optional on AAMVA 01, 02, 03, 04, 05, 06, 07 and 08
Standard restriction code(s) for cardholder. See codes in D20. This data element is a placeholder
for future efforts to standardize restriction codes.
Code Description
B Corrective Lenses
C Mechanical Devices (Special Brakes, Hand Controls, or Other Adaptive Devices)
D Prosthetic Aid
E Automatic Transmission
F Outside Mirror
G Limit to Daylight Only
H Limit to Employment
I Limited Other
J Other
K CDL Intrastate Only
L Vehicles without air brake