Table of contents
Swift
Objective-C

Parse Drivers License

How to Enable Drivers License Parsing

  1. Add code parser task.

    "CodeParserTaskSettingOptions": [
      {
        "Name": "parse-drivers-license",
        "CodeSpecifications": [
          "AAMVA_DL_ID",
          "AAMVA_DL_ID_WITH_MAG_STRIPE",
          "SOUTH_AFRICA_DL"
        ]
      }
    ]
    
  2. Add semantic processing options and specify the target ROI to reference.

    "SemanticProcessingOptions": [
      {
        "Name": "sp-drivers-license",
        "ReferenceObjectFilter": {
          "ReferenceTargetROIDefNameArray": [
            "roi-drivers-license"
          ]
        },
        "TaskSettingNameArray": [
          "parse-drivers-license"
        ]
      }
    ]
    
  3. Add the semantic processing option names to your template.

    "CaptureVisionTemplates": [
      {
        "Name": "ReadDriversLicense",
        "ImageROIProcessingNameArray": [
          "roi-drivers-license"
        ],
        "SemanticProcessingNameArray": [
          "sp-drivers-license"
        ]
      }
    ]
    

How to Receive Parsed Results

When semantic processing is enabled, parsed data is delivered through the same capture-result flow as other outputs. Use the result receiving patterns described in Receive Results and then read the parsed output together with the barcode result returned for the current capture session.

Common Fields

Field Name Description
CodeType Code type, always has value “AAMVA_DL_ID”
AAMVAVersionNumber AAMVA Version Number
fullName Full name of cardholder
lastName Last name of cardholder
givenName Given name of cardholder
firstName First name of cardholder
middleName Middle name of cardholder
street_1 Street portion of the cardholder address
street_2 Second line of street portion of the cardholder address
city City portion of the cardholder address
postalCode Postal code portion of the cardholder address
licenseNumber License/ID Number
vehicleClass Jurisdiction-specific vehicle class / Driver License Classification Code
expirationDate Expiration Date
birthDate Date of Birth
sex Sex
issuedDate Date on which the document was issued

View more Drivers License fields.

This page is compatible for: