ProximityReader · IOS API REFERENCE

MobileNationalIDCardDisplayRequest

struct · iOS 18.0+ · SDK 27.1

struct MobileNationalIDCardDisplayRequest

A mobile national ID card request that retrieves elements from the holder and displays the results onscreen for visual inspection.

Members (8)

static · iOS 18.0+

isSupportedRegion

TypeScript

static isSupportedRegion(region: _Foundation_Locale_Region): boolean

Swift declaration

static func isSupportedRegion(_ region: Locale.Region) -> Bool

Returns a Boolean value that indicates whether you can make a request for the specified region.

get · iOS 18.0+

region

TypeScript

get region(): _Foundation_Locale_Region

Swift declaration

var region: Locale.Region

The region of the document you're requesting.

set · iOS 18.0+

region

TypeScript

set region(value: _Foundation_Locale_Region)

Swift declaration

var region: Locale.Region

The region of the document you're requesting.

init · iOS 18.0+

init

TypeScript

static init(region: _Foundation_Locale_Region, elements?: Array<MobileNationalIDCardDisplayRequest_Element>, options?: MobileNationalIDCardDisplayRequest_Options): MobileNationalIDCardDisplayRequest

Swift declaration

init(region: Locale.Region, elements: [MobileNationalIDCardDisplayRequest.Element] = [], options: MobileNationalIDCardDisplayRequest.Options = .init())

Creates a new mobile national ID card display request.

get · iOS 18.0+

options

TypeScript

get options(): MobileNationalIDCardDisplayRequest_Options

Swift declaration

var options: MobileNationalIDCardDisplayRequest.Options

An object that customizes how to perform a display request.

set · iOS 18.0+

options

TypeScript

set options(value: MobileNationalIDCardDisplayRequest_Options)

Swift declaration

var options: MobileNationalIDCardDisplayRequest.Options

An object that customizes how to perform a display request.

get · iOS 18.0+

elements

TypeScript

get elements(): Array<MobileNationalIDCardDisplayRequest_Element>

Swift declaration

var elements: [MobileNationalIDCardDisplayRequest.Element]

The document elements you're requesting. - Note: A request isn't considered valid if the list of elements is empty, contains duplicates, or contains both ``Element/age`` and ``Element/ageAtLeast(_:)``. If you call ``MobileDocumentReaderSession/requestDocument(_:)`` with an invalid request, the framework throws an ``MobileDocumentReaderError/invalidRequest`` error.

set · iOS 18.0+

elements

TypeScript

set elements(value: Array<MobileNationalIDCardDisplayRequest_Element>)

Swift declaration

var elements: [MobileNationalIDCardDisplayRequest.Element]

Skipped declarations

No declarations were skipped in this snapshot.

All ProximityReader types →