AilaDLScanObject

Since 3.0.0

Object representing a scanned driver's license barcode.

Declaration

Objective-C

@interface AilaDLScanObject : AilaScanObject
@property (nonatomic) AilaCodeType type;
@property (nonatomic) NSString *data;
@property (nonatomic) NSString *rawData;
@end

Swift

class AilaDLScanObject : AilaScanObject {
    var type: AilaCodeType
    var data: String
    var rawData: String
}

Description

This object is returned as part of the scanCallback upon a successful driver's license scan when dlParsingMode is enabled. It extends AilaScanObject with an additional rawData property containing the unparsed PDF417 barcode string.

Properties

type

Since 3.0.0

Always AilaCodeTypePDF417 for driver's license scans.

Type: AilaCodeType

data

Since 3.0.0

Returns the parsed data from the driver's license in a JSON string.

Type: NSString / String

All possible keys:

Names: firstName, middleNames, lastName, givenNameAlias, lastNameAlias,
       suffixAlias, suffix

Dates: expirationDate, issueDate, birthdate, hazmatExpirationDate,
       revisionDate, underEighteenUtilDate, underNineteenUtilDate,
       underTwentyOneUtilDate

Appearance: race, gender, eyeColor, height, weight, hairColor

Location: placeOfBirth, streetAddress, streetAddressTwo, city, state,
          postalCode, country

Meta Data: version, licenseNumber, documentId, auditInformation,
           inventoryControlNumber, complianceType, isOrganDonor,
           isVeteran, isTemporaryDocument

Codes: federalVehicleCode, standardVehicleClass, standardRestrictionCode,
       standardEndorsementCode, jurisdictionVehicleClass,
       jurisdictionRestrictionCode, jurisdictionEndorsementCode,
       jurisdictionVehicleDescription, jurisdictionRestrictionDescription,
       jurisdictionEndorsementDescription

Date Format: YYYY-MM-DDTHH:MM:SSZ

Any keys not found in the parsed data will not appear in the JSON string.

rawData

Since 3.0.0

Returns the raw string from the pdf417 barcode.

Type: NSString / String

This is the unparsed PDF417 string as read from the driver's license.

Methods

typeDescription

Since 3.0.0

Returns the descriptive text "pdf417".

Returns: NSString / String

Usage Example

Objective-C

config.dlParsingMode = AilaDLParsingModeOn;
config.scanCallback = ^(NSArray<AilaScanObject *> *results) {
    for (AilaScanObject *scan in results) {
        if ([scan isKindOfClass:[AilaDLScanObject class]]) {
            AilaDLScanObject *dlScan = (AilaDLScanObject *)scan;

            // Get parsed JSON data
            NSString *jsonData = dlScan.data;
            NSData *data = [jsonData dataUsingEncoding:NSUTF8StringEncoding];
            NSDictionary *parsed = [NSJSONSerialization JSONObjectWithData:data
                                                                  options:0
                                                                    error:nil];

            NSString *firstName = parsed[@"firstName"];
            NSString *lastName = parsed[@"lastName"];
            NSString *licenseNumber = parsed[@"licenseNumber"];
            NSString *expirationDate = parsed[@"expirationDate"];

            NSLog(@"Name: %@ %@", firstName, lastName);
            NSLog(@"License: %@, Expires: %@", licenseNumber, expirationDate);

            // Get raw PDF417 string
            NSString *rawDL = dlScan.rawData;
            NSLog(@"Raw Data: %@", rawDL);
        }
    }
};

Swift

config.dlParsingMode = .on
config.scanCallback = { results in
    for scan in results {
        if let dlScan = scan as? AilaDLScanObject {
            // Get parsed JSON data
            let jsonData = dlScan.data
            if let data = jsonData.data(using: .utf8),
               let parsed = try? JSONSerialization.jsonObject(with: data) as? [String: Any] {

                let firstName = parsed["firstName"] as? String
                let lastName = parsed["lastName"] as? String
                let licenseNumber = parsed["licenseNumber"] as? String
                let expirationDate = parsed["expirationDate"] as? String

                print("Name: \(firstName ?? "") \(lastName ?? "")")
                print("License: \(licenseNumber ?? ""), Expires: \(expirationDate ?? "")")
            }

            // Get raw PDF417 string
            let rawDL = dlScan.rawData
            print("Raw Data: \(rawDL)")
        }
    }
}

See Also

• AilaDLParsingMode - Enable driver's license parsing
• AilaScanObject - Base scan object
• Supported Formats - DL data fields