One Logo Pool Ball
App Services · IOS API REFERENCE

ProximityReader

Read contactless physical and digital wallet cards using your iPhone.

138 types

488 callable entries

17 skipped

97% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

CustomerEngagement

enum · iOS 27.0+

CustomerEngagement.Address

struct · iOS 27.0+

CustomerEngagement.CustomerInfo

struct · iOS 27.0+

CustomerEngagement.ShoppingCart

struct · iOS 27.0+

CustomerEngagement.ShoppingCart.Item

struct · iOS 27.0+

CustomerEngagement.ShoppingCart.Summary

struct · iOS 27.0+

CustomerEngagement.ShoppingCart.Summary.LineItem

struct · iOS 27.0+

CustomerEngagement.ShoppingCart.Summary.LineItem.Value

enum · iOS 27.0+

CustomerEngagement.ShoppingCartToken

struct · iOS 27.0+

CustomerEngagement.SignUp

struct · iOS 27.0+

CustomerEngagement.Status

enum · iOS 27.0+

CustomerEngagement.Token

struct · iOS 27.0+

CustomerEngagementSession

class · iOS 27.0+

CustomerEngagementSession.Configuration

struct · iOS 27.0+

CustomerEngagementSession.ConsentOption

enum · iOS 27.0+

CustomerEngagementSession.CustomerConfiguration

struct · iOS 27.0+

CustomerEngagementSession.Error

enum · iOS 27.0+

CustomerEngagementSession.Event

enum · iOS 27.0+

CustomerEngagementSession.Field

enum · iOS 27.0+

CustomerEngagementSession.PeerClientType

enum · iOS 27.0+

CustomerEngagementSession.Purpose

enum · iOS 27.0+

CustomerEngagementSession.Token

struct · iOS 27.0+

MobileDocumentAnyOfDataRequest

struct · iOS 26.0+

MobileDocumentAnyOfDataRequest.Response

struct · iOS 26.0+

MobileDocumentAnyOfRawDataRequest

struct · iOS 26.0+

MobileDocumentAnyOfRawDataRequest.Response

struct · iOS 26.0+

MobileDocumentDataRequest

protocol · iOS 26.0+

MobileDocumentDataResponse

protocol · iOS 26.0+

MobileDocumentDisplayRequest

struct · iOS 26.0+

MobileDocumentDisplayRequest.Element

struct · iOS 26.0+

MobileDocumentDisplayRequest.Options

struct · iOS 26.0+

MobileDocumentDisplayRequest.Options.DocumentType

struct · iOS 26.0+

MobileDocumentDisplayRequest.Options.ValidationMode

struct · iOS 26.0+

MobileDocumentDisplayRequest.Response

struct · iOS 26.0+

MobileDocumentDisplayRequest.Response.ValidationOutcome

enum · iOS 26.0+

MobileDocumentHolderName

struct · iOS 27.0+

MobileDocumentRawDataRequest

protocol · iOS 26.0+

MobileDocumentReader

class · iOS 17.0+

MobileDocumentReader.Configuration

struct · iOS 17.0+

MobileDocumentReader.Token

struct · iOS 17.0+

MobileDocumentReaderError

enum · iOS 17.0+

MobileDocumentReaderSession

class · iOS 17.0+

MobileDocumentRequest

protocol · iOS 17.0+

MobileDriversLicenseDataRequest

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Element

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.AAMVADrivingPrivilege

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.AAMVADrivingPrivilege.VehicleClass

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.AAMVADrivingPrivilege.VehicleEndorsement

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.AAMVADrivingPrivilege.VehicleRestriction

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.DHSComplianceStatus

enum · iOS 17.2+

MobileDriversLicenseDataRequest.Response.DocumentElements.DrivingPrivilege

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.DrivingPrivilege.Code

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.EyeColor

enum · iOS 26.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.HairColor

enum · iOS 26.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.IssuingAuthority

struct · iOS 17.0+

MobileDriversLicenseDataRequest.Response.DocumentElements.Sex

enum · iOS 17.2+

MobileDriversLicenseDisplayRequest

struct · iOS 17.0+

MobileDriversLicenseDisplayRequest.Element

struct · iOS 17.0+

MobileDriversLicenseDisplayRequest.Options

struct · iOS 17.0+

MobileDriversLicenseDisplayRequest.Options.ValidationMode

struct · iOS 17.0+

MobileDriversLicenseDisplayRequest.Response

struct · iOS 17.0+

MobileDriversLicenseDisplayRequest.Response.ValidationOutcome

enum · iOS 17.0+

MobileDriversLicenseRawDataRequest

struct · iOS 17.0+

MobileDriversLicenseRawDataRequest.Element

struct · iOS 17.0+

MobileDriversLicenseRawDataRequest.Response

struct · iOS 17.0+

MobileNationalIDCardDataRequest

struct · iOS 18.0+

MobileNationalIDCardDataRequest.Element

struct · iOS 18.0+

MobileNationalIDCardDataRequest.Response

struct · iOS 18.0+

MobileNationalIDCardDataRequest.Response.DocumentElements

struct · iOS 18.0+

MobileNationalIDCardDataRequest.Response.DocumentElements.Sex

enum · iOS 18.0+

MobileNationalIDCardDisplayRequest

struct · iOS 18.0+

MobileNationalIDCardDisplayRequest.Element

struct · iOS 18.0+

MobileNationalIDCardDisplayRequest.Options

struct · iOS 18.0+

MobileNationalIDCardDisplayRequest.Options.ValidationMode

struct · iOS 18.0+

MobileNationalIDCardDisplayRequest.Response

struct · iOS 18.0+

MobileNationalIDCardDisplayRequest.Response.ValidationOutcome

enum · iOS 18.0+

MobileNationalIDCardRawDataRequest

struct · iOS 18.0+

MobileNationalIDCardRawDataRequest.Element

struct · iOS 18.0+

MobileNationalIDCardRawDataRequest.Response

struct · iOS 18.0+

MobilePhotoIDDataRequest

struct · iOS 26.0+

MobilePhotoIDDataRequest.Element

struct · iOS 26.0+

MobilePhotoIDDataRequest.Response

struct · iOS 26.0+

MobilePhotoIDDataRequest.Response.DocumentElements

struct · iOS 26.0+

MobilePhotoIDDataRequest.Response.DocumentElements.IssuingAuthority

struct · iOS 26.0+

MobilePhotoIDDataRequest.Response.DocumentElements.Sex

enum · iOS 26.0+

MobilePhotoIDRawDataRequest

struct · iOS 26.0+

MobilePhotoIDRawDataRequest.Element

struct · iOS 26.0+

MobilePhotoIDRawDataRequest.Response

struct · iOS 26.0+

PaymentCardReader

class · iOS 15.4+

PaymentCardReader.Event

enum · iOS 16.0+

PaymentCardReader.Options

struct · iOS 15.4+

PaymentCardReader.Token

struct · iOS 15.4+

PaymentCardReader.Token.RawValue

typealias · iOS 15.4+

PaymentCardReader.UpdateEvent

enum · iOS 15.4+ · Deprecated in iOS 16.0

PaymentCardReaderError

enum · iOS 15.4+

PaymentCardReaderSession

class · iOS 15.4+

PaymentCardReaderSession.Event

enum · iOS 15.4+ · Deprecated in iOS 16.0

PaymentCardReaderSession.PINToken

struct · iOS 16.0+

PaymentCardReaderSession.PINToken.RawValue

typealias · iOS 16.0+

PaymentCardReaderSession.ReadError

enum · iOS 15.4+

PaymentCardReaderStore

struct · iOS 18.4+

PaymentCardReaderStore.StoreError

enum · iOS 18.4+

PaymentCardReadResult

struct · iOS 15.4+

PaymentCardReadResult.CardEffectiveState

enum · iOS 18.4+

PaymentCardReadResult.CardExpirationState

enum · iOS 18.4+

PaymentCardReadResult.ID

typealias · iOS 15.4+

PaymentCardReadResult.ReadOutcome

enum · iOS 16.4+

PaymentCardTransactionRequest

struct · iOS 15.4+

PaymentCardTransactionRequest.PaymentCycle

enum · iOS 18.0+

PaymentCardTransactionRequest.TransactionAmountDescription

enum · iOS 18.0+

PaymentCardTransactionRequest.TransactionType

enum · iOS 15.4+

PaymentCardVerificationRequest

struct · iOS 15.4+

PaymentCardVerificationRequest.Reason

enum · iOS 15.4+

ProximityReaderDiscovery

class · iOS 18.0+

ProximityReaderDiscovery.Content

struct · iOS 18.0+

ProximityReaderDiscovery.Content.ID

typealias · iOS 18.0+

ProximityReaderDiscovery.ContentError

enum · iOS 18.0+

ProximityReaderDiscovery.Topic

enum · iOS 18.0+

ProximityReaderDiscovery.Topic.Payment

enum · iOS 18.0+

StoreAndForwardBatch

struct · iOS 18.4+

StoreAndForwardBatch.ID

typealias · iOS 18.4+

StoreAndForwardBatch.StoredPaymentCardReadResult

struct · iOS 18.4+

StoreAndForwardBatch.StoredPaymentCardReadResult.ID

typealias · iOS 18.4+

StoreAndForwardBatchDeletionToken

struct · iOS 18.4+

StoreAndForwardBatchDeletionToken.RawValue

typealias · iOS 18.4+

StoreAndForwardPaymentCardReaderSession

class · iOS 18.4+

StoreAndForwardStatus

struct · iOS 18.4+

VASReadResult

struct · iOS 15.4+

VASReadResult.ID

typealias · iOS 15.4+

VASReadResult.ReadEntry

struct · iOS 15.4+

VASReadResult.ReadEntry.ID

typealias · iOS 15.4+

VASReadResult.ReadEntry.Status

enum · iOS 15.4+

VASReadResult.ReadEntry.Status.RawValue

typealias · iOS 15.4+

VASRequest

class · iOS 15.4+

VASRequest.Merchant

struct · iOS 15.4+

VASRequest.Merchant.ID

typealias · iOS 15.4+

Skipped declarations

17 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

MobileDocumentReaderSession.requestDocument(_:)

This declaration needs Swift generic type arguments. (no canonical witness for Request)

MobileDocumentRequest.driversLicenseData(retaining:notRetaining:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.nationalIDCardData(region:retaining:notRetaining:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.photoIDData(retaining:notRetaining:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.displayDocument(_:options:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.displayDriversLicense(_:options:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.nationalIDCard(region:_:options:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.driversLicenseRawData(retaining:notRetaining:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.driversLicenseRawData(retaining:notRetaining:issuerIdentifiers:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.nationalIDCardRawData(region:retaining:notRetaining:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.nationalIDCardRawData(region:retaining:notRetaining:issuerIdentifiers:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.photoIDRawData(retaining:notRetaining:)

This protocol needs associated types that cannot yet cross the bridge.

MobileDocumentRequest.photoIDRawData(retaining:notRetaining:issuerIdentifiers:)

This protocol needs associated types that cannot yet cross the bridge.

protocol implementation MobileDocumentDataRequest

inherited protocol graph unavailable

protocol implementation MobileDocumentDataResponse

inherited protocol graph unavailable

protocol implementation MobileDocumentRawDataRequest

inherited protocol graph unavailable

protocol implementation MobileDocumentRequest

This protocol needs associated types that cannot yet cross the bridge.