<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "ProximityReader",
  "identifier" : "/documentation/ProximityReader",
  "metadataVersion" : "0.1.0",
  "role" : "Framework",
  "symbol" : {
    "kind" : "Framework",
    "modules" : [
      "ProximityReader"
    ],
    "preciseIdentifier" : "ProximityReader"
  },
  "title" : "ProximityReader"
}
-->

# ProximityReader

Read contactless physical and digital wallet cards using your iPhone.

## Overview

The ProximityReader framework supports *Tap to Pay on iPhone*, which
allows a person’s iPhone to act as a point-of-sale device without
additional hardware. ProximityReader also supports the reading of loyalty cards
from the Wallet app. Use this framework to initiate the payment process
from your app.

The use of this framework requires you to coordinate with a participating
payment service provider that is Level 3 certified.
Contact your payment provider and work with them to set up a workflow for
handling payments. When you’re ready, contact Apple and request the entitlement
you need to integrate Tap to Pay on iPhone support into your app.
For information on requesting this entitlement, see [Setting up Tap to Pay on iPhone](/documentation/ProximityReader/setting-up-the-entitlement-for-tap-to-pay-on-iPhone).

> Note: Tap to Pay on iPhone follows the PCI CPoC Standard, which uses
> Level 2 certified payment kernels and a user interface for reading contactless
> payment cards.

## Topics

### Payment card reader

[Setting up Tap to Pay on iPhone](/documentation/ProximityReader/setting-up-the-entitlement-for-tap-to-pay-on-iPhone)

Request and configure the required entitlement to support Tap to Pay on iPhone.

[Adding support for Tap to Pay on iPhone to your app](/documentation/ProximityReader/adding-support-for-tap-to-pay-on-iphone-to-your-app)

Configure your app to use Tap to Pay on iPhone to read contactless payment cards.

[`PaymentCardReader`](/documentation/ProximityReader/PaymentCardReader)

An object you use to configure Tap to Pay on iPhone on the current device.

[`PaymentCardReaderSession`](/documentation/ProximityReader/PaymentCardReaderSession)

The object you use to start reading a contactless payment or loyalty card.

### Payment requests

[`PaymentCardTransactionRequest`](/documentation/ProximityReader/PaymentCardTransactionRequest)

A request for a contactless purchase or refund that includes the purchase amount and currency information.

[`PaymentCardVerificationRequest`](/documentation/ProximityReader/PaymentCardVerificationRequest)

A request to verify details for a contactless payment card.

[`PaymentCardReadResult`](/documentation/ProximityReader/PaymentCardReadResult)

The result of a payment card read operation.

### Store and Forward mode

[`StoreAndForwardBatch`](/documentation/ProximityReader/StoreAndForwardBatch)

A structure that stores the data to send to the payment service provider to process.

[`StoreAndForwardBatchDeletionToken`](/documentation/ProximityReader/StoreAndForwardBatchDeletionToken)

A secure token that you use to delete a Store and Forward batch.

[`StoreAndForwardPaymentCardReaderSession`](/documentation/ProximityReader/StoreAndForwardPaymentCardReaderSession)

The object you use to start reading a contactless payment or loyalty card in Store and Forward mode.

[`StoreAndForwardStatus`](/documentation/ProximityReader/StoreAndForwardStatus)

A structure that describes the Store and Forward session status.

[`PaymentCardReaderStore`](/documentation/ProximityReader/PaymentCardReaderStore)

A structure that manages the store that contains all the Store and Forward reads.

### Loyalty card requests

[Accepting loyalty passes from Wallet](/documentation/ProximityReader/accepting-loyalty-passes-from-wallet)

Set up the necessary components so your app can begin using Tap to Pay on iPhone to read and issue loyalty passes.

[`VASRequest`](/documentation/ProximityReader/VASRequest)

A request to read a contactless loyalty card and retrieve loyalty program
identifiers for the person.

[`VASReadResult`](/documentation/ProximityReader/VASReadResult)

The result of a request to read loyalty card information.

### Merchant discovery

[`ProximityReaderDiscovery`](/documentation/ProximityReader/ProximityReaderDiscovery)

An object that presents a UI with information about how to use
Tap to Pay on iPhone.

### Mobile document reader

[Adopting the Verifier API in your iPhone app](/documentation/ProximityReader/adopting-the-verifier-api-in-your-iphone-app)

Configure and test ID Verifier support in your app for reading mobile documents.

[Generating reader tokens for the Verifier API](/documentation/ProximityReader/generating-reader-tokens-for-the-verifier-api)

Configure your server to generate reader tokens to prepare a device for mobile document reading.

[Checking IDs with the Verifier API](/documentation/ProximityReader/checking-ids-with-the-verifier-api)

Read and verify mobile driver’s license, photo ID, and National ID information without any additional hardware.

[`MobileDocumentReader`](/documentation/ProximityReader/MobileDocumentReader)

An object for configuring mobile document reading on the current device.

[`MobileDocumentReaderSession`](/documentation/ProximityReader/MobileDocumentReaderSession)

The object you use to start reading a mobile document.

### Mobile document requests

[`MobileDriversLicenseDisplayRequest`](/documentation/ProximityReader/MobileDriversLicenseDisplayRequest)

A mobile driver’s license request that retrieves elements from the holder
and displays the results onscreen for visual inspection.

[`MobileDriversLicenseDataRequest`](/documentation/ProximityReader/MobileDriversLicenseDataRequest)

A mobile driver’s license request that retrieves elements from the holder and returns the validated document elements.

[`MobileDriversLicenseRawDataRequest`](/documentation/ProximityReader/MobileDriversLicenseRawDataRequest)

A mobile driver’s license request which retrieves elements from the holder and returns the raw response data for processing.

[`MobileNationalIDCardDisplayRequest`](/documentation/ProximityReader/MobileNationalIDCardDisplayRequest)

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

[`MobileNationalIDCardDataRequest`](/documentation/ProximityReader/MobileNationalIDCardDataRequest)

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

[`MobileNationalIDCardRawDataRequest`](/documentation/ProximityReader/MobileNationalIDCardRawDataRequest)

A mobile national ID card request which retrieves elements from the holder and returns the raw response data for processing.

[`MobileDocumentDisplayRequest`](/documentation/ProximityReader/MobileDocumentDisplayRequest)

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

[`MobileDocumentRequest`](/documentation/ProximityReader/MobileDocumentRequest)

A type that represents a mobile document request.

[`MobileDocumentDataRequest`](/documentation/ProximityReader/MobileDocumentDataRequest)

A type that represents a mobile document data request.

[`MobileDocumentRawDataRequest`](/documentation/ProximityReader/MobileDocumentRawDataRequest)

A type that represents a mobile document raw data request.

[`MobilePhotoIDDataRequest`](/documentation/ProximityReader/MobilePhotoIDDataRequest)

A photo ID request that retrieves elements from the holder and returns the validated document elements.

[`MobilePhotoIDRawDataRequest`](/documentation/ProximityReader/MobilePhotoIDRawDataRequest)

A photo ID request which retrieves elements from the holder and returns the raw response data for processing.

[`MobileDocumentAnyOfDataRequest`](/documentation/ProximityReader/MobileDocumentAnyOfDataRequest)

A type that describes a data request for any mobile document from a group of requests.

[`MobileDocumentAnyOfRawDataRequest`](/documentation/ProximityReader/MobileDocumentAnyOfRawDataRequest)

A type that describes a raw data request for any mobile document from a group of requests.

### Tap to Share

[Adding support for Tap to Share to your app](/documentation/ProximityReader/adding-support-for-tap-to-share-to-your-app)

Request and share customer information on device.

[`CustomerEngagement`](/documentation/ProximityReader/CustomerEngagement)

An enumeration of the shared data between the merchant and customer.

[`CustomerEngagementSession`](/documentation/ProximityReader/CustomerEngagementSession)

The object you use to share and request customer information.

### Errors

[`PaymentCardReaderError`](/documentation/ProximityReader/PaymentCardReaderError)

An error type that indicates problems with the configuration of the reader.

[`MobileDocumentReaderError`](/documentation/ProximityReader/MobileDocumentReaderError)

An error type that indicates problems when preparing a mobile document reader session and performing document requests.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)