Mobile document Data Element

Defined in framework ScanditIdCapture

MobileDocumentDataElement

Added in version 8.0.0

Represents data elements that can be requested from mobile identity documents (mdocs) compliant with ISO 18013-5 and AAMVA standards. These elements are used to specify which data fields the application intends to retain, as required by the IntentToRetain flag in ISO 18013-5 mdoc requests.

init
init(rawValue: UInt)

Added in version 8.0.0

Constructs a new instance from the raw value.

familyName

Added in version 8.0.0

The family name of the document holder. Part of the ISO 18013-5 namespace.

givenName

Added in version 8.0.0

The given name of the document holder. Part of the ISO 18013-5 namespace.

birthDate

Added in version 8.0.0

The date of birth of the document holder. Part of the ISO 18013-5 namespace.

issueDate

Added in version 8.0.0

The date of issue of the document. Part of the ISO 18013-5 namespace.

expiryDate

Added in version 8.0.0

The date of expiry of the document. Part of the ISO 18013-5 namespace.

issuingCountry

Added in version 8.0.0

The country that issued the document. Part of the ISO 18013-5 namespace.

issuingAuthority

Added in version 8.0.0

The authority that issued the document. Part of the ISO 18013-5 namespace.

documentNumber

Added in version 8.0.0

The unique document number. Part of the ISO 18013-5 namespace.

portrait

Added in version 8.0.0

The portrait image of the document holder. Part of the ISO 18013-5 namespace.

drivingPrivileges

Added in version 8.0.0

The driving privileges and categories. Part of the ISO 18013-5 namespace.

administrativeNumber

Added in version 8.0.0

An administrative number associated with the document. Part of the ISO 18013-5 namespace.

sexIso

Added in version 8.0.0

The sex of the document holder as defined by ISO standards. Part of the ISO 18013-5 namespace.

height

Added in version 8.0.0

The height of the document holder in centimeters. Part of the ISO 18013-5 namespace.

weight

Added in version 8.0.0

The weight of the document holder in kilograms. Part of the ISO 18013-5 namespace.

eyeColour

Added in version 8.0.0

The eye color of the document holder. Part of the ISO 18013-5 namespace.

hairColour

Added in version 8.0.0

The hair color of the document holder. Part of the ISO 18013-5 namespace.

birthPlace

Added in version 8.0.0

The place of birth of the document holder. Part of the ISO 18013-5 namespace.

residentAddress

Added in version 8.0.0

The resident address of the document holder. Part of the ISO 18013-5 namespace.

issuingJurisdiction

Added in version 8.0.0

The jurisdiction that issued the document. Part of the ISO 18013-5 namespace.

nationality

Added in version 8.0.0

The nationality of the document holder. Part of the ISO 18013-5 namespace.

nameSuffix

Added in version 8.0.0

A suffix for the name. Part of the AAMVA namespace.

familyNameTruncation

Added in version 8.0.0

Indicates whether the family name was truncated. Part of the AAMVA namespace.

givenNameTruncation

Added in version 8.0.0

Indicates whether the given name was truncated. Part of the AAMVA namespace.

akaFamilyName

Added in version 8.0.0

Also known as (AKA) family name. Part of the AAMVA namespace.

akaGivenName

Added in version 8.0.0

Also known as (AKA) given name. Part of the AAMVA namespace.

akaSuffix

Added in version 8.0.0

Also known as (AKA) name suffix. Part of the AAMVA namespace.

weightRange

Added in version 8.0.0

A range representing the weight of the document holder. Part of the AAMVA namespace.

raceEthnicity

Added in version 8.0.0

The race or ethnicity of the document holder. Part of the AAMVA namespace.

residentCounty

Added in version 8.0.0

The county of residence. Part of the AAMVA namespace.

sexAamva

Added in version 8.0.0

The sex of the document holder as defined by AAMVA standards. Part of the AAMVA namespace.

aamvaVersion

Added in version 8.0.0

The AAMVA version number. Part of the AAMVA namespace.

allCases
static var allCases: Array<MobileDocumentDataElement> { get }

Added in version 8.0.0

Returns all MobileDocumentDataElement values as an array.

description
var description: String { get }

Added in version 8.0.0

Returns a name for the given MobileDocumentDataElement.