One Logo Pool Ball
ProximityReader · IOS API REFERENCE

MobileDriversLicenseDataRequest.Response.DocumentElements

struct · iOS 17.0+ · SDK 27.1

struct DocumentElements

A type that contains the document elements from a successful mobile driver's license data request.

Members (24)

get · iOS 17.0+

ageAtLeastElements

TypeScript
get ageAtLeastElements(): Record<number, boolean>
Swift declaration
let ageAtLeastElements: [Int : Bool]

A dictionary of values that indicate whether the document holder is at least the specified age. The key represents an age in years and the value is a Boolean value that indicates whether the document holder is at least that age.

get · iOS 26.4+

signatureUsualMarkData

TypeScript
get signatureUsualMarkData(): (ArrayBuffer) | null
Swift declaration
let signatureUsualMarkData: Data?

The signature or usual mark data of the identity document holder on record with the issuer.

get · iOS 17.0+

portraitData

TypeScript
get portraitData(): (ArrayBuffer) | null
Swift declaration
let portraitData: Data?

The portrait data of the mobile driver's license holder on record with the issuer.

get · iOS 17.0+

dateOfBirth

TypeScript
get dateOfBirth(): (_Foundation_DateComponents) | null
Swift declaration
let dateOfBirth: DateComponents?

The date of birth of the mobile driver's license holder.

get · iOS 26.4+

nationality

TypeScript
get nationality(): (string) | null
Swift declaration
let nationality: String?

The nationality of the identity document holder on record with the issuer.

get · iOS 26.0+

isOrganDonor

TypeScript
get isOrganDonor(): (boolean) | null
Swift declaration
let isOrganDonor: Bool?

A Boolean value indicating whether the identity document holder is an organ donor.

get · iOS 26.4+

placeOfBirth

TypeScript
get placeOfBirth(): (string) | null
Swift declaration
let placeOfBirth: String?

The birth place of the identity document holder on record with the issuer.

get · iOS 17.0+

documentNumber

TypeScript
get documentNumber(): (string) | null
Swift declaration
let documentNumber: String?

The document's number, as defined by the document's issuing authority.

get · iOS 17.0+

nameComponents

TypeScript
get nameComponents(): (_Foundation_PersonNameComponents) | null
Swift declaration
var nameComponents: PersonNameComponents? { get }

The mobile driver's license holder's name components.

get · iOS 17.0+

issuingAuthority

TypeScript
get issuingAuthority(): (MobileDriversLicenseDataRequest_Response_DocumentElements_IssuingAuthority) | null
Swift declaration
let issuingAuthority: MobileDriversLicenseDataRequest.Response.DocumentElements.IssuingAuthority?

The state or government that issued the identity document.

get · iOS 17.0+

documentIssueDate

TypeScript
get documentIssueDate(): (_Foundation_DateComponents) | null
Swift declaration
let documentIssueDate: DateComponents?

The document's issue date. This is usually the issue date of the corresponding physical document, if applicable.

get · iOS 17.0+

drivingPrivileges

TypeScript
get drivingPrivileges(): Array<MobileDriversLicenseDataRequest_Response_DocumentElements_DrivingPrivilege>
Swift declaration
let drivingPrivileges: [MobileDriversLicenseDataRequest.Response.DocumentElements.DrivingPrivilege]

The mobile driver's license holder's driving privileges.

get · iOS 17.0+

aamvaDrivingPrivileges

TypeScript
get aamvaDrivingPrivileges(): Array<MobileDriversLicenseDataRequest_Response_DocumentElements_AAMVADrivingPrivilege>
Swift declaration
let aamvaDrivingPrivileges: [MobileDriversLicenseDataRequest.Response.DocumentElements.AAMVADrivingPrivilege]

The mobile driver's license holder's AAMVA driving privileges.

get · iOS 17.0+

documentExpirationDate

TypeScript
get documentExpirationDate(): (_Foundation_DateComponents) | null
Swift declaration
let documentExpirationDate: DateComponents?

The document's expiration date. This is usually the expiration date of the corresponding physical document, if applicable.

get · iOS 17.2+

documentDHSComplianceStatus

TypeScript
get documentDHSComplianceStatus(): (MobileDriversLicenseDataRequest_Response_DocumentElements_DHSComplianceStatus) | null
Swift declaration
let documentDHSComplianceStatus: MobileDriversLicenseDataRequest.Response.DocumentElements.DHSComplianceStatus?

The document's DHS (U.S. Department of Homeland Security) compliance status. This is also known as the document's "REAL ID status".

get · iOS 17.0+

age

TypeScript
get age(): (number) | null
Swift declaration
let age: Int?

The mobile driver's license holder's age in years.

get · iOS 17.2+

sex

TypeScript
get sex(): (MobileDriversLicenseDataRequest_Response_DocumentElements_Sex) | null
Swift declaration
let sex: MobileDriversLicenseDataRequest.Response.DocumentElements.Sex?

The mobile driver's license holder's sex.

get · iOS 27.0+

name

TypeScript
get name(): (MobileDocumentHolderName) | null
Swift declaration
let name: MobileDocumentHolderName?

The mobile driver's license holder's name.

get · iOS 26.0+

height

TypeScript
get height(): (_Foundation_Measurement<_Foundation_UnitLength>) | null
Swift declaration
let height: Measurement<UnitLength>?

The mobile identity document holder's height on record with the issuer.

get · iOS 26.0+

weight

TypeScript
get weight(): (_Foundation_Measurement<_Foundation_UnitMass>) | null
Swift declaration
let weight: Measurement<UnitMass>?

The mobile identity document holder's weight on record with the issuer.

get · iOS 17.0+

address

TypeScript
get address(): (_Contacts_CNPostalAddress) | null
Swift declaration
var address: CNPostalAddress? { get }

The mobile driver's license holder's address on record with the issuer.

get · iOS 26.0+

eyeColor

TypeScript
get eyeColor(): (MobileDriversLicenseDataRequest_Response_DocumentElements_EyeColor) | null
Swift declaration
let eyeColor: MobileDriversLicenseDataRequest.Response.DocumentElements.EyeColor?

The mobile identity document holder's eye color on record with the issuer.

get · iOS 26.0+

hairColor

TypeScript
get hairColor(): (MobileDriversLicenseDataRequest_Response_DocumentElements_HairColor) | null
Swift declaration
let hairColor: MobileDriversLicenseDataRequest.Response.DocumentElements.HairColor?

The mobile identity document holder's hair color on record with the issuer.

get · iOS 26.0+

isVeteran

TypeScript
get isVeteran(): (boolean) | null
Swift declaration
let isVeteran: Bool?

A Boolean value indicating whether the identity document holder is a veteran.

Skipped declarations

No declarations were skipped in this snapshot.

All ProximityReader types →