forked from PDF417/pdf417-phonegap
-
Notifications
You must be signed in to change notification settings - Fork 0
/
usdl_keys.js
910 lines (706 loc) · 27.5 KB
/
usdl_keys.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
//
// usdl_keys.js
// MicroBlink BlinkID library
//
// Created by Jurica Cerovec, Marko Mihovilic on 10/01/13.
// Copyright (c) 2015 MicroBlink. All rights reserved.
//
//pragma mark - Keys for obtaining data on driver's licenses
//==============================================================/
//============== 1. DETERMINING BARCODE VERSION ================/
//==============================================================/
/**
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".
*/
var kPPDocumentType = "Document Type";
/**
Mandatory on all driver's licenses.
AAMVA Version Number: This is a decimal value between 0 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.
If document type is not "AAMVA", this field defines version number of the
given document type's standard.
*/
var kPPStandardVersionNumber = "Standard Version Number";
//==============================================================/
//========== 2. PERSONAL DATA KEYS ===========/
//==============================================================/
/**
Mandatory on all AAMVA, Magnetic and Compact barcodes.
Family name of the cardholder. (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.
*/
var kPPCustomerFamilyName = "Customer Family Name";
/**
Mandatory on all AAMVA, Magnetic and Compact barcodes.
First name of the cardholder.
*/
var kPPCustomerFirstName = "Customer First Name";
/**
Mandatory on all AAMVA, Magnetic and Compact barcodes.
Full name of the individual holding the Driver License or ID.
The Name field contains up to 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 (optional)
, (optional)
If indvidual has more than one middle name they are separated with space.
*/
var kPPCustomerFullName = "Customer Name";
/**
Mandatory on all AAMVA, Magentic and Compact barcodes.
Date on which the cardholder was born. (MMDDCCYY format)
*/
var kPPDateOfBirth = "Date of Birth";
/**
Mandatory on all AAMVA, Magentic barcodes.
Optional on Compact barcodes.
Gender of the cardholder. 1 = male, 2 = female.
*/
var kPPSex = "Sex";
/**
Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 barcodes.
Optional on AAMVA 01, Magnetic and Compact barcodes.
Color of cardholder's eyes. (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
*/
var kPPEyeColor = "Eye Color";
/**
Mandatory on all AAMVA and Magnetic barcodes.
On compact barcodes, use kFullAddress.
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.
*/
var kPPAddressStreet = "Address - Street 1";
/**
Mandatory on all AAMVA and Magnetic barcodes.
On compact barcodes, use kFullAddress.
City portion of the cardholder address.
*/
var kPPAddressCity = "Address - City";
/**
Mandatory on all AAMVA and Magnetic barcodes.
On compact barcodes, use kFullAddress.
State portion of the cardholder address.
*/
var kPPAddressJurisdictionCode = "Address - Jurisdiction Code";
/**
Mandatory on all AAMVA and Magnetic barcodes.
On compact barcodes, use kFullAddress.
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 can be used
to fill the trailing set of numbers up to nine (9) digits.
*/
var kPPAddressPostalCode = "Address - Postal Code";
/**
Mandatory on all AAMVA and Magnetic barcodes.
Optional on Compact barcodes.
Full address of the individual holding the Driver License or ID.
The full address field contains up to four portions, separated with the "," delimiter:
Street Address (required)
, (required if other address portions follow, otherwise optional)
City (optional)
, (required if other address portions follow, otherwise optional)
Jurisdiction Code (optional)
, (required if other address portions follow, otherwise optional)
ZIP - Postal Code (optional)
*/
var kPPFullAddress = "Full Address";
/**
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"
*/
var kPPHeight = "Height";
/**
Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.
Optional on AAMVA 01 and Magnetic barcodes.
Height of cardholder in Inches.
Example: 5'9'' = "69".
*/
var kPPHeightIn = "Height in";
/**
Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 Compact barcodes.
Optional on AAMVA 01 and Magnetic barcodes.
Height of cardholder in Centimeters.
Example: 180 Centimeters = "180".
*/
var kPPHeightCm = "Height cm";
/**
Mandatory on AAMVA 04, 05, 06, 07, 08.
Optional on AAMVA 01, 02, 03, Magnetic and Compcat barcodes.
Middle name(s) of the cardholder. In the case of multiple middle names they
shall be separated by space " ".
*/
var kPPCustomerMiddleName = "Customer Middle Name";
/**
Optional on all AAMVA, Magnetic and Compact barcodes.
Bald, black, blonde, brown, gray, red/auburn, sandy, white, unknown. 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
*/
var kPPHairColor = "Hair color";
/**
Mandatory on AAMVA 02 barcodes.
Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes.
Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.),
the suffix must be collected and displayed on the DL/ID and in the MRT).
- JR (Junior)
- SR (Senior)
- 1ST or I (First)
- 2ND or II (Second)
- 3RD or III (Third)
- 4TH or IV (Fourth)
- 5TH or V (Fifth)
- 6TH or VI (Sixth)
- 7TH or VII (Seventh)
- 8TH or VIII (Eighth)
- 9TH or IX (Ninth)
*/
var kPPNameSuffix = "Name Suffix";
/**
Optional on all AAMVA and Compact barcodes.
Other name by which cardholder is known. ALTERNATIVE NAME(S) of the individual
holding the Driver License or ID.
The Name field contains up to four portions, separated with the "," delimiter:
AKA Last Name (required)
, (required)
AKA First Name (required)
, (required if other name portions follow, otherwise optional)
AKA Middle Name(s) (optional)
, (required if other name portions follow, otherwise optional)
AKA Suffix (optional)
, (optional)
If indvidual has more than one AKA middle name they are separated with space.
*/
var kPPAKAFullName = "Alias / AKA Name";
/**
Optional on all AAMVA and Compact barcodes.
Other family name by which cardholder is known.
*/
var kPPAKAFamilyName = "Alias / AKA Family Name";
/**
Optional on all AAMVA and Compact barcodes.
Other given name by which cardholder is known
*/
var kPPAKAGivenName = "Alias / AKA Given Name";
/**
Optional on all AAMVA and Compact barcodes.
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
*/
var kPPAKASuffixName = "Alias / AKA Suffix Name";
/**
Mandatory on AAMVA 02 barcodes.
Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes.
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)
*/
var kPPWeightRange = "Weight Range";
/**
Mandatory on AAMVA 02 barcodes.
Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes.
Cardholder weight in pounds Example: 185 lb = "185"
*/
var kPPWeightPounds = "Weight (pounds)";
/**
Mandatory on AAMVA 02 barcodes.
Optional on AAMVA 01, 03, 04, 05, 06, 07, 08, Magnetic and Compact barcodes.
Cardholder weight in kilograms Example: 84 kg = "084"
*/
var kPPWeightKilograms = "Weight (kilograms)";
/**
Mandatory on all AAMVA and Compact barcodes
The number assigned or calculated by the issuing authority.
*/
var kPPCustomerIdNumber = "Customer ID Number";
/**
Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes.
Optional on Compact barcodes.
A code that indicates whether a field has been truncated (T), has not been
truncated (N), or – unknown whether truncated (U).
*/
var kPPFamilyNameTruncation = "Family name truncation";
/**
Mandatory on AAMVA 04, 05, 06, 07, 08 barcodes.
Optional on Compact barcodes.
A code that indicates whether a field has been truncated (T), has not been
truncated (N), or – unknown whether truncated (U).
*/
var kPPFirstNameTruncation = "First name truncation";
/**
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).
*/
var kPPMiddleNameTruncation = "Middle name truncation";
/**
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes
Country and municipality and/or state/province
*/
var kPPPlaceOfBirth = "Place of birth";
/**
Optional on all AAMVA barcodes
On Compact barcodes, use kFullAddress
Second line of street portion of the cardholder address.
*/
var kPPAddressStreet2 = "Address - Street 2";
/**
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes
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
*/
var kPPRaceEthnicity = "Race / ethnicity";
/**
Optional on AAMVA 01
PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.
*/
var kPPNamePrefix = "Name Prefix";
/**
Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes.
Country in which DL/ID is issued. U.S. = USA, Canada = CAN.
*/
var kPPCountryIdentification = "Country Identification";
/**
Optional on AAMVA version 01.
Driver Residence Street Address 1.
*/
var kPPResidenceStreetAddress = "Driver Residence Street Address";
/**
Optional on AAMVA version 01.
Driver Residence Street Address 2.
*/
var kPPResidenceStreetAddress2 = "Driver Residence Street Address 2";
/**
Optional on AAMVA version 01.
Driver Residence City
*/
var kPPResidenceCity = "Driver Residence City";
/**
Optional on AAMVA version 01.
Driver Residence Jurisdiction Code.
*/
var kPPResidenceJurisdictionCode = "Driver Residence Jurisdiction Code";
/**
Optional on AAMVA version 01.
Driver Residence Postal Code.
*/
var kPPResidencePostalCode = "Driver Residence Postal Code";
/**
Optional on AAMVA 01 barcodes.
Full residence address of the individual holding the Driver License or ID.
The full address field contains up to four portions, separated with the "," delimiter:
Residence Street Address (required)
, (required if other address portions follow, otherwise optional)
Residence City (optional)
, (required if other address portions follow, otherwise optional)
Residence Jurisdiction Code (optional)
, (required if other address portions follow, otherwise optional)
Residence ZIP - Residence Postal Code (optional)
*/
var kPPResidenceFullAddress = "Driver Residence Full Address";
/**
Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 18 years old. (MMDDCCYY format)
*/
var kPPUnder18 = "Under 18 Until"; // nakon verzije 05
/**
Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 19 years old. (MMDDCCYY format)
*/
var kPPUnder19 = "Under 19 Until"; // nakon verzije 05
/**
Optional on AAMVA 05, 06, 07, 08
Date on which the cardholder turns 21 years old. (MMDDCCYY format)
*/
var kPPUnder21 = "Under 21 Until"; // nakon verzije 05
/**
Optional on AAMVA version 01.
The number assigned to an individual by the Social Security Administration.
*/
var kPPSocialSecurityNumber = "Social Security Number";
/**
Optional on AAMVA version 01.
Driver "AKA" Social Security Number. FORMAT SAME AS DRIVER SOC SEC NUM. ALTERNATIVE NUMBERS(S) used as SS NUM.
*/
var kPPAKASocialSecurityNumber = "Alias / AKA Social Security Number";
/**
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
*/
var kPPAKAMiddleName = "Alias / AKA Middle Name"; // samo 01
/**
Optional on AAMVA 01
ALTERNATIVE PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.
*/
var kPPAKAPrefixName = "Alias / AKA Prefix Name"; // samo 01
/**
Optional on AAMVA 06, 07, 08
Field that indicates that the cardholder is an organ donor = "1".
*/
var kPPOrganDonor = "Organ Donor Indicator";
/**
Optional on AAMVA 07, 08
Field that indicates that the cardholder is a veteran = "1"
*/
var kPPVeteran = "Veteran Indicator";
/**
Optional on AAMVA 01. (MMDDCCYY format)
ALTERNATIVE DATES(S) given as date of birth.
*/
var kPPAKADateOfBirth = "Alias / AKA Date of Birth";; // samo za 01
//==============================================================/
//========== 3. LICENSE DATA KEYS ============/
//==============================================================/
/**
Mandatory on all AAMVA, Magnetic and Compact barcodes.
This number uniquely identifies the issuing jurisdiction and can
be obtained by contacting the ISO Issuing Authority (AAMVA)
*/
var kPPIssuerIdentificationNumber = "Issuer Identification Number";
/**
Mandatory on all AAMVA, Magnetic and Compact barcodes.
If document is non expiring than "Non expiring" is written in this field.
Date on which the driving and identification privileges granted by the document are
no longer valid. (MMDDCCYY format)
*/
var kPPDocumentExpirationDate = "Document Expiration Date";
/**
Mandatory on all AAMVA and Compact barcodes.
Optional on Magnetic barcodes.
Jurisdiction Version Number: This is a decimal value between 0 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.
*/
var kPPJurisdictionVersionNumber = "Jurisdiction Version Number";
/**
Mandatory on all AAMVA and Magnetic barcodes.
Jurisdiction-specific vehicle class / group code, designating the type
of vehicle the cardholder has privilege to drive.
*/
var kPPJurisdictionVehicleClass = "Jurisdiction-specific vehicle class";
/**
Mandatory on all AAMVA barcodes.
Optional on Magnetic barcodes.
Jurisdiction-specific codes that represent restrictions to driving
privileges (such as airbrakes, automatic transmission, daylight only, etc.).
*/
var kPPJurisdictionRestrictionCodes = "Jurisdiction-specific restriction codes";
/**
Mandatory on all AAMVA barcodes.
Optional on Magnetic barcodes.
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.).
*/
var kPPJurisdictionEndorsementCodes = "Jurisdiction-specific endorsement codes";
/**
Mandatory on all AAMVA and Compact barcodes.
Date on which the document was issued. (MMDDCCYY format)
*/
var kPPDocumentIssueDate = "Document Issue Date";
/**
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.
*/
var kPPFederalCommercialVehicleCodes = "Federal Commercial Vehicle Codes";
/**
Optional on all AAMVA barcodes.
Mandatory on Compact barcodes.
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.
*/
var kPPIssuingJurisdiction = "Issuing jurisdiction";
/**
Optional on all AAMVA barcodes.
Mandatory on Compact barcodes.
Standard vehicle classification code(s) for cardholder. This data element is a
placeholder for future efforts to standardize vehicle classifications.
*/
var kPPStandardVehicleClassification = "Standard vehicle classification";
/**
Optional on all AAMVA barcodes.
Standard endorsement code(s) for cardholder. 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.
*/
var kPPStandardEndorsementCode = "Standard endorsement code";
/**
Optional on all AAMVA barcodes
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 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
*/
var kPPStandardRestrictionCode = "Standard restriction code";
/**
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes
Text that explains the jurisdiction-specific code(s) for classifications
of vehicles cardholder is authorized to drive.
*/
var kPPJurisdictionVehicleClassificationDescription = "Jurisdiction-specific vehicle classification description";
/**
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes
Text that explains the jurisdiction-specific code(s) that indicates additional
driving privileges granted to the cardholder beyond the vehicle class.
*/
var kPPJurisdictionEndorsmentCodeDescription = "Jurisdiction-specific endorsment code description";
/**
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes
Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges.
*/
var kPPJurisdictionRestrictionCodeDescription = "Jurisdiction-spacific restriction code description";
/**
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)
*/
var kPPInventoryControlNumber = "Inventory control number";
/**
Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes
DHS required field that indicates date of the most recent version change or
modification to the visible format of the DL/ID (MMDDCCYY format)
*/
var kPPCardRevisionDate = "Card Revision Date";
/**
Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Magnetic barcodes.
Optional and Compact barcodes
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.
*/
var kPPDocumentDiscriminator = "Document Discriminator";
/**
Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes
DHS required field that indicates that the cardholder has temporary lawful status = "1".
*/
var kPPLimitedDurationDocument = "Limited Duration Document Indicator";
/**
Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact barcodes
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.
*/
var kPPAuditInformation = "Audit information";
/**
Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes
DHS required field that indicates compliance: "M" = materially compliant;
"F" = fully compliant; and, "N" = non-compliant.
*/
var kPPComplianceType = "Compliance Type";
/**
Optional on AAMVA version 01.
Issue Timestamp. A string used by some jurisdictions to validate the document against their data base.
*/
var kPPIssueTimestamp = "Issue Timestamp";
/**
Optional on AAMVA version 01.
Driver Permit Expiration Date. MMDDCCYY format. Date permit expires.
*/
var kPPPermitExpirationDate = "Driver Permit Expiration Date";
/**
Optional on AAMVA version 01.
Type of permit.
*/
var kPPPermitIdentifier = "Permit Identifier";
/**
Optional on AAMVA version 01.
Driver Permit Issue Date. MMDDCCYY format. Date permit was issued.
*/
var kPPPermitIssueDate = "Driver Permit Issue Date";
/**
Optional on AAMVA version 01.
Number of duplicate cards issued for a license or ID if any.
*/
var kPPNumberOfDuplicates = "Number of Duplicates";
/**
Optional on AAMVA 04, 05, 06, 07, 08 and Compact barcodes
Date on which the hazardous material endorsement granted by the document is
no longer valid. (MMDDCCYY format)
*/
var kPPHAZMATExpirationDate = "HAZMAT Endorsement Expiration Date";
/**
Optional on AAMVA version 01.
Medical Indicator/Codes.
STATE SPECIFIC. Freeform; Standard "TBD"
*/
var kPPMedicalIndicator = "Medical Indicator/Codes";
/**
Optional on AAMVA version 01.
Non-Resident Indicator. "Y". Used by some jurisdictions to indicate holder of the document is a non-resident.
*/
var kPPNonResident = "Non-Resident Indicator";
/**
Optional on AAMVA version 01.
A number or alphanumeric string used by some jurisdictions to identify a "customer" across multiple data bases.
*/
var kPPUniqueCustomerId = "Unique Customer Identifier";
/**
Optional on compact encoding.
Document discriminator.
*/
var kPPDataDiscriminator = "Data discriminator";
/**
Optional on Magnetic barcodes.
Month on which the driving and identification privileges granted by the document are
no longer valid. (MMYY format)
*/
var kPPDocumentExpirationMonth = "Document Expiration Month";
/**
Optional on Magnetic barcodes.
Field that indicates that the driving and identification privileges granted by the
document are nonexpiring = "1".
*/
var kPPDocumentNonexpiring = "Document Nonexpiring";
/**
Optional on Magnetic barcodes.
Security version beeing used.
*/
var kPPSecurityVersion = "Security Version";
//==============================================================/
//====== 4. KEYS FOR ACCESSING RAW BARCODE RESULTS =============/
//==============================================================/
/**
Raw pdf417 result
*/
var kPPPdf417 = "kPPPdf417";
/**
Raw code128 result
*/
var kPPCode128 = "kPPCode128";
/**
Raw code39 result
*/
var kPPCode39 = "kPPCode39";