Skip to content

Instantly share code, notes, and snippets.

@phillipwilhelm

phillipwilhelm/gist:e2edabad1d5c7a811e8e8547b15acb07

Forked from filipbec/gist:5998034874b119fab0e4
Created June 1, 2022 16:45
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save phillipwilhelm/e2edabad1d5c7a811e8e8547b15acb07 to your computer and use it in GitHub Desktop.
Save phillipwilhelm/e2edabad1d5c7a811e8e8547b15acb07 to your computer and use it in GitHub Desktop.
Download ZIP
Scannr - Keys for obtaining US Driver's license data
Raw
gistfile1.md

Keys for obtaining US Driver's license data

Standard for US Driver's Licenses defines 9 different barcode standards (AAMVA versions) with over 80 different fields encoded inside a barcode. Some fields exist on all barcode standards, other exist only on some. To standardize the API, we have structured the fields in the following sections:

  1. Determining AAMVA version
  2. Keys existing on all barcode versions
  3. Keys existing on some barcode versions
  4. Keys for accessing raw barcode results

Determining AAMVA version

  • kPPAamvaVersionNumber (string value "kPPAamvaVersionNumber") - Mandatory on all AAMVA driver's license versions. Specifies the version level of the PDF417 bar code format. Possible values are "0", "1", "2", "3", "4", "5", "6", "7", "8", and "Compact".

Keys existing on all standard barcode versions

Mandatory values

Personal data

  • kPPCustomerFamilyName (string value "kPPCustomerFamilyName") - Family name of the cardholder.
    • Mandatory on all barcode versions, including compact encoding.
  • kPPCustomerFirstName (string value "kPPCustomerFirstName") - First name of the cardholder.
    • Mandatory on all barcode versions, including compact encoding.
  • kPPDateOfBirth (string value "kPPDateOfBirth") - Date on which the cardholder was born. (MMDDCCYY format).
    • Mandatory on all barcode versions, including compact encoding.
  • kPPSex (string value "kPPSex") - Gender of the cardholder.
    • Mandatory on all barcode versions, including compact encoding.
    • 1 = male,
    • 2 = female.
  • kPPEyeColor (string value "kPPEyeColor") - Color of cardholder's eyes.
    • Mandatory on all barcode versions, including compact encoding. (ANSI D-20 codes)
    • BLK = Black
    • BLU = Blue
    • BRO = Brown
    • GRY = Gray
    • GRN = Green
    • HAZ = Hazel
    • MAR = Maroon
    • PNK = Pink
    • DIC = Dichromatic
    • UNK = Unknown
  • kPPHeight (string value "kPPHeight") - Height of cardholder. Possible values are either in inches or in centimeters.
    • Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact encoding. Optional on 01.
    • See also kPPHeightIn, kPPHeightCm
    • Inches (in): number of inches followed by " in" or " IN". Example. 6'1'' = "073 in"
    • Centimeters (cm): number of centimeters followed by " cm" or " CM". Example. 181 centimeters = "181 cm"
  • kPPAddressStreet (string value "kPPAddressStreet") - 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.
    • Mandatory on all standard barcode versions. Not defined on Compact encoding, where you must use kPPFullAddress.
  • kPPAddressCity (string value "kPPAddressCity") - City portion of the cardholder address.
    • Mandatory on all standard barcode versions. Not defined on Compact encoding, where you must use kPPFullAddress.
  • kPPAddressJurisdictionCode (string value "kPPAddressJurisdictionCode") - State portion of the cardholder address.
    • Mandatory on all standard barcode versions. Not defined on Compact encoding, where you must use kPPFullAddress.
  • kPPAddressPostalCode (string value "kPPAddressPostalCode") - 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.
    • Mandatory on all standard barcode versions. Not defined on Compact encoding, where you must use kPPFullAddress.

License data

  • kPPDocumentIssueDate (string value "kPPDocumentIssueDate") - Date on which the document was issued. (MMDDCCYY format).
    • Mandatory on all barcode versions, including compact encoding.
  • kPPDocumentExpirationDate (string value "kPPDocumentExpirationDate") - Date on which the driving and identification privileges granted by the document are no longer valid. (MMDDCCYY format).
    • Mandatory on all barcode versions, including compact encoding.
  • kPPIssuerIdentificationNumber (string value "kPPIssuerIdentificationNumber") - This number uniquely identifies the issuing jurisdiction and can be obtained by contacting the ISO Issuing Authority (AAMVA).
    • Mandatory on all standard barcode formats, optional on compact encoding.
  • kPPJurisdictionVersionNumber (string value "kPPJurisdictionVersionNumber") - Jurisdiction Version Number: This is a number value between "0" and "99" that specifies the jurisdiction version level of the PDF417 bar code format.
    • Mandatory on all barcode versions, including compact encoding.
  • kPPJurisdictionVehicleClass (string value "kPPJurisdictionVehicleClass") - Jurisdiction-specific vehicle class / group code, designating the type of vehicle the cardholder has privilege to drive.
    • Mandatory on all standard barcode versions. Not defined on Compact encoding, which has no compatible field.
  • kPPJurisdictionRestrictionCodes (string value "kPPJurisdictionRestrictionCodes") - Jurisdiction-specific codes that represent restrictions to driving privileges (such as airbrakes, automatic transmission, daylight only, etc.).
    • Mandatory on all standard barcode versions. Not defined on Compact encoding, which has no compatible field.
  • kPPJurisdictionEndorsementCodes (string value "kPPJurisdictionEndorsementCodes") - 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.).
    • Mandatory on all standard barcode versions. Not defined on Compact encoding, which has no compatible field.
  • kPPCustomerIdNumber (string value "kPPCustomerIdNumber") - The number assigned or calculated by the issuing authority.
    • Mandatory on all barcode versions, including compact encoding.

Optional values

Personal data

  • kPPHairColor (string value "kPPHairColor") - 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.

    • Optional on all barcode versions, including compact encoding.
    • BAL = Bald
    • BLK = Black
    • BLN = Blond
    • BRO = Brown
    • GRY = Grey
    • RED = Red/Auburn
    • SDY = Sandy
    • WHI = White
    • UNK = Unknown

  • kPPNameSuffix (string value "kPPNameSuffix") - Name Suffix (If jurisdiction participates in systems requiring name suffix (PDPS, CDLIS, etc.), the suffix must be collected and displayed on the DL/ID).

    • Optional on all barcode versions, including compact encoding.
    • 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).

  • kPPAddressStreet2 (string value "kPPAddressStreet2") - Second line of street portion of the cardholder address.

    • Optional on all standard barcode versions. Not defined on Compact encoding, where you must use kPPFullAddress.

License data

  • kPPIssuingJurisdiction (string value "kPPIssuingJurisdiction") - 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 kPPIssuerIdentificationNumber, kPPAddressJurisdictionCode or kPPFullAddress must be examined to determine the jurisdiction.

    • Optional on all barcode versions, mandatory on Compact Encoding

  • kPPStandardVehicleClassification (string value "kPPStandardVehicleClassification") - Standard vehicle classification code(s) for cardholder. This data element is a placeholder for future efforts to standardize vehicle classifications.

    • Optional on all barcode versions, including compact encoding.

  • kPPStandardEndorsementCode (string value "kPPStandardEndorsementCode") - Standard endorsement code(s) for cardholder. This data element is a placeholder for future efforts to standardize endorsement codes.

    • Optional on all barcode versions, including compact encoding.
    • 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.

  • kPPStandardRestrictionCode (string value "kPPStandardRestrictionCode") - Standard restriction code(s) for cardholder. This data element is a placeholder for future efforts to standardize restriction codes.

    • Optional on all standard barcode versions. Not defined on Compact encoding, which has no compatible field.
    • 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

Keys existing on some barcode versions

Mandatory values

Personal data

  • kPPCustomerMiddleName (string value "kPPCustomerMiddleName") - Middle name(s) of the cardholder. In the case of multiple middle names they shall be separated by a comma ",".-
    • Mandatory on AAMVA version 04, 05, 06, 07, 08, optional on 01. On other standards middle name is included into value of kPPFirstName.
  • kPPHeightIn (string value "kPPHeightIn") - Height of cardholder. (FT/IN)
    • FEET (1st char); Inches (2nd and 3rd char). Example: 509 = 5 ft., 9 in.
    • Optional on 01.
    • See also kPPHeight, kPPHeightCm
  • kPPHeightCm (string value "kPPHeightCm") - Height of cardholder in centimeters.
    • Optional on 01.
    • See also kPPHeight, kPPHeightIn
  • kPPCustomerFullName (string value "kPPCustomerFullName") - Full name of the individual holding the Driver License or ID as defined in ANSI D20 Data Dictionary. (Lastname,Firstname,MI,suffix if any). This 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)
  • kPPFullAddress (string value "kPPFullAddress") - Cardholder address.
    • Mandatory on compact encoding.
  • kPPFamilyNameTruncation (string value "kPPFamilyNameTruncation") - A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).
    • Mandatory on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
  • kPPFirstNameTruncation (string value "kPPFirstNameTruncation") - A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).
    • Mandatory on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
  • kPPMiddleNameTruncation (string value "kPPMiddleNameTruncation") - A code that indicates whether a field has been truncated (T), has not been truncated (N), or – unknown whether truncated (U).
    • Mandatory on AAMVA 04, 05, 06, 07, 08

License data

  • kPPCountryIdentification (string value "kPPCountryIdentification") - Country in which DL/ID is issued. U.S. = USA, Canada = CAN.
    • Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPDocumentDiscriminator (string value "kPPDocumentDiscriminator") - 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.
    • Mandatory on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPFederalCommercialVehicleCodes (string value "kPPFederalCommercialVehicleCodes") - 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.
    • Mandatory on AAMVA versions 02 and 03.

Optional values

Personal data

  • kPPRaceEthnicity (string value "kPPRaceEthnicity") - Codes for race or ethnicity of the cardholder, as defined in ANSI D20.
    • Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
    • Race
    • 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
    • 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
  • kPPPlaceOfBirth (string value "kPPPlaceOfBirth") - Country and municipality and/or state/province
    • Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPWeightRange (string value "kPPWeightRange") - Indicates the approximate weight range of the cardholder:
    • Optional on AAMVA 02, 03, 04, 05, 06, 07, 08
    • 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)
  • kPPWeightPounds (string value "kPPWeightPounds") - Cardholder weight in pounds Ex. 185 lb = "185"
    • Optional on AAMVA 01, 04, 05, 06, 07, 08
  • kPPWeightKilograms (string value "kPPWeightKilograms") - Cardholder weight in kilograms Ex. 84 kg = "084"
    • Optional on AAMVA 01, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPNamePrefix (string value "kPPNamePrefix") - PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.
    • Optional on AAMVA 01
  • kPPResidenceStreetAddress (string value "kPPResidenceStreetAddress") - Driver Residence Street Address.
    • Optional on AAMVA version 01.
  • kPPResidenceStreetAddress2 (string value "kPPResidenceStreetAddress2") - Driver Residence Street Address 2.
    • Optional on AAMVA version 01.
  • kPPResidenceCity (string value "kPPResidenceCity") - Driver Residence City
    • Optional on AAMVA version 01.
  • kPPResidenceJurisdictionCode (string value "kPPResidenceJurisdictionCode") - Driver Residence Jurisdiction Code.
    • Optional on AAMVA version 01.
  • kPPResidencePostalCode (string value "kPPResidencePostalCode") - Driver Residence Postal Code.
    • Optional on AAMVA version 01.
  • kPPUnder18 (string value "kPPUnder18") - Date on which the cardholder turns 18 years old. (MMDDCCYY format)
    • Optional on AAMVA 05, 06, 07, 08
  • kPPUnder19 (string value "kPPUnder19") - Date on which the cardholder turns 19 years old. (MMDDCCYY format)
    • Optional on AAMVA 05, 06, 07, 08
  • kPPUnder21 (string value "kPPUnder21") - Date on which the cardholder turns 21 years old. (MMDDCCYY format)
    • Optional on AAMVA 05, 06, 07, 08
  • kPPSocialSecurityNumber (string value "kPPSocialSecurityNumber") - The number assigned to an individual by the Social Security Administration.
    • Optional on AAMVA version 01.
  • kPPAKASocialSecurityNumber (string value "kPPAKASocialSecurityNumber") - Driver "AKA" Social Security Number. FORMAT SAME AS DRIVER SOC SEC NUM. ALTERNATIVE NUMBERS(S) used as SS NUM.
    • Optional on AAMVA version 01.
  • kPPAKAFullName (string value "kPPAKAFullName") - 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.) This 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)
  • kPPAKAFamilyName (string value "kPPAKAFamilyName") - Other family name by which cardholder is known.
    • Optional on AAMVA 01, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPAKAMiddleName (string value "kPPAKAMiddleName") - 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
    • Optional on AAMVA 01
  • kPPAKAGivenName (string value "kPPAKAGivenName") - Other given name by which cardholder is known
    • Optional on AAMVA 01, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPAKAPrefixName (string value "kPPAKAPrefixName") - ALTERNATIVE PREFIX to Driver Name. Freeform as defined by issuing jurisdiction.
    • Optional on AAMVA 01
  • kPPAKASuffixName (string value "kPPAKASuffixName") - 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):
    • JR = Junior
    • SR = Senior or Esquire 1ST First
    • 2ND = Second
    • 3RD = Third
    • 4TH = Fourth
    • 5TH = Fifth
    • 6TH = Sixth
    • 7TH = Seventh
    • 8TH = Eighth
    • 9TH = Ninth
  • kPPOrganDonor (string value "kPPOrganDonor") - Field that indicates that the cardholder is an organ donor = "1".
    • Optional on AAMVA 06, 07, 08
  • kPPVeteran (string value "kPPVeteran") - Field that indicates that the cardholder is a veteran = "1"
    • Optional on AAMVA 07, 08
  • kPPAKADateOfBirth (string value "kPPAKADateOfBirth") - ALTERNATIVE DATES(S) given as date of birth. (MMDDCCYY format)
    • Optional on AAMVA 01
  • kPPImageTimestamp (string value "kPPImageTimestamp") - Portrait image timestamp
    • Optional on compact encoding.
  • kPPImageType (string value "kPPImageType") - Type of image
    • Optional on compact encoding.
  • kPPPortraitImage (string value "kPPPortraitImage") - Portrait image
    • Optional on compact encoding.
  • kPPBDBFormatOwner (string value "kPPBDBFormatOwner") - BDB format owner
    • Optional on compact encoding.
  • kPPBDBFormatType (string value "kPPBDBFormatType") - BDB format type
    • Optional on compact encoding.
  • kPPBiometricData (string value "kPPBiometricData") - Biometric data block
    • Optional on compact encoding.

License data

  • kPPJurisdictionVehicleClassificationDescription (string value "kPPJurisdictionVehicleClassificationDescription") - Text that explains the jurisdiction-specific code(s) for classifications of vehicles cardholder is authorized to drive.
    • Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPJurisdictionEndorsmentCodeDescription (string value "kPPJurisdictionEndorsmentCodeDescription") - Text that explains the jurisdiction-specific code(s) that indicates additional driving privileges granted to the cardholder beyond the vehicle class.
    • Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPJurisdictionRestrictionCodeDescription (string value "kPPJurisdictionRestrictionCodeDescription") - Text describing the jurisdiction-specific restriction code(s) that curtail driving privileges.
    • Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPInventoryControlNumber (string value "kPPInventoryControlNumber") - 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)
    • Optional on AAMVA 02, 03, 04, 05, 06, 07, 08
  • kPPCardRevisionDate (string value "kPPCardRevisionDate") - DHS required field that indicates date of the most recent version change or modification to the visible format of the DL/ID (MMDDCCYY format)
    • Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
  • kPPLimitedDurationDocument (string value "kPPLimitedDurationDocument") - DHS required field that indicates that the cardholder has temporary lawful status = "1".
    • Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
  • kPPIssueTimestamp (string value "kPPIssueTimestamp") - Issue Timestamp. A string used by some jurisdictions to validate the document against their data base.
    • Optional on AAMVA version 01.
  • kPPPermitExpirationDate (string value "kPPPermitExpirationDate") - Driver Permit Expiration Date. MMDDCCYY format. Date permit expires.
    • Optional on AAMVA version 01.
  • kPPPermitIdentifier (string value "kPPPermitIdentifier") - Type of permit.
    • Optional on AAMVA version 01.
  • kPPPermitIssueDate (string value "kPPPermitIssueDate") - Driver Permit Issue Date. MMDDCCYY format. Date permit was issued.
    • Optional on AAMVA version 01.
  • kPPNumberOfDuplicates (string value "kPPNumberOfDuplicates") - Number of duplicate cards issued for a license or ID if any.
    • Optional on AAMVA version 01.
  • kPPAuditInformation (string value "kPPAuditInformation") - 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.
    • Optional on AAMVA 02, 03, 04, 05, 06, 07, 08 and Compact Encoding
  • kPPComplianceType (string value "kPPComplianceType") - DHS required field that indicates compliance: "M" = materially compliant; "F" = fully compliant; and, "N" = non-compliant.
    • Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
  • kPPHAZMATExpirationDate (string value "kPPHAZMATExpirationDate") - Date on which the hazardous material endorsement granted by the document is no longer valid. (MMDDCCYY format)
    • Optional on AAMVA 04, 05, 06, 07, 08 and Compact Encoding
  • kPPMedicalIndicator (string value "kPPMedicalIndicator") - Medical Indicator/Codes. STATE SPECIFIC. Freeform; Standard "TBD"
    • Optional on AAMVA version 01.
  • kPPNonResident (string value "kPPNonResident") - Non-Resident Indicator. "Y". Used by some jurisdictions to indicate holder of the document is a non-resident.
    • Optional on AAMVA version 01.
  • kPPUniqueCustomerId (string value "kPPUniqueCustomerId") - A number or alphanumeric string used by some jurisdictions to identify a "customer" across multiple data bases.
    • Optional on AAMVA version 01.
  • kPPDataDiscriminator (string value "kPPDataDiscriminator") - Document discriminator.
    • Optional on compact encoding.

Keys for accessing raw barcode results

  • kPPPdf417 (string value "kPPPdf417") - Raw pdf417 result
    • Mandatory for all USDL data
  • kPPCode128 (string value "kPPCode128") - Raw code128 result
    • Optional, on US driver's licenses which have Code128 barcode printed
  • kPPCode39 (string value "kPPCode39") - Raw code39 result
    • Optional, on US driver's licenses which have Code39 barcode printed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment