ProximityReader · IOS API REFERENCE

MobileNationalIDCardDataRequest

struct · iOS 18.0+ · SDK 27.1

struct MobileNationalIDCardDataRequest

A mobile national ID card request that retrieves elements from the holder and returns the validated document elements.

Members (8)

get · iOS 18.0+

retainedElements

TypeScript

get retainedElements(): Array<MobileNationalIDCardDataRequest_Element>

Swift declaration

var retainedElements: [MobileNationalIDCardDataRequest.Element]

The document elements you're requesting and intend to retain for an indefinite period of time.

set · iOS 18.0+

retainedElements

TypeScript

set retainedElements(value: Array<MobileNationalIDCardDataRequest_Element>)

Swift declaration

var retainedElements: [MobileNationalIDCardDataRequest.Element]

The document elements you're requesting and intend to retain for an indefinite period of time.

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+

nonRetainedElements

TypeScript

get nonRetainedElements(): Array<MobileNationalIDCardDataRequest_Element>

Swift declaration

var nonRetainedElements: [MobileNationalIDCardDataRequest.Element]

The document elements you're requesting and intend to retain no longer than necessary to process the result in realtime.

set · iOS 18.0+

nonRetainedElements

TypeScript

set nonRetainedElements(value: Array<MobileNationalIDCardDataRequest_Element>)

Swift declaration

var nonRetainedElements: [MobileNationalIDCardDataRequest.Element]

The document elements you're requesting and intend to retain no longer than necessary to process the result in realtime.

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, retainedElements?: Array<MobileNationalIDCardDataRequest_Element>, nonRetainedElements?: Array<MobileNationalIDCardDataRequest_Element>): MobileNationalIDCardDataRequest

Swift declaration

init(region: Locale.Region, retainedElements: [MobileNationalIDCardDataRequest.Element] = [], nonRetainedElements: [MobileNationalIDCardDataRequest.Element] = [])

Creates a mobile national ID card data request.

Skipped declarations

No declarations were skipped in this snapshot.

All ProximityReader types →