Verify with Wallet Document Requests
Review how your app uses identity and authorization APIs.
Overview
The data in this report shows calls to the PKIdentityAuthorizationController requestDocument API by apps requesting identity documents from Wallet.
Territories: Worldwide
Platforms: iOS, iPadOS. For more information about iOS and iPadOS, see the Platforms section in Data Completeness and Corrections.
Availability:
Daily: Every day.
History: On request, data is available beginning with iOS 17.4 and iPadOS 17.4.
Completeness: Data from devices that contribute to this report can arrive as late as 8 days after the date it generates on device. You can download recent data daily, but it might be incomplete, and data updates incrementally daily, until all late-arriving events are available.
Privacy:
Includes data from users who have opted to share their data with Apple and developers.
Individual rows will only appear if they have a value of 5 or more.
Data Context: You can analyze your data with additional context by comparing it with the data in the App Sessions Context report, which provides a count of unique devices that use your app on a specific day. For example, if your app performed an action detailed in this report on 10 unique devices on a specific day, and the App Sessions Context report shows there were 100 unique devices running your app that day, then you can approximate that 10% of the devices running your app performed that action.
Report Fields
Report Field | Description | Data Type |
|---|---|---|
Count | Number of times the event occurred |
|
Territory | Country or region in which the event occurred |
|
Date | Date when the event occurred |
|
Platform | OS version on the device on which the event occurred |
|
Device | Type of device on which the event occurred |
|
Build | Build of device on which event occurred |
|
Unique Devices | The count of unique devices |
|
Release Type | Type of software release |
|
Address | If set, the app requests the user’s address. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Age | If set, the app requests the user’s age. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Age At Least | If set, the app requests whether the user is above a certain age. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Age at Least Years | If the “ageAtLeast” element is populated, this is the age that the app requests. |
|
Date of Birth | If set, the app requests the user’s date of birth. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Document Expiration Date | If set, the app requests the expiration date of the user’s document. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Family Name | If set, the app requests the user’s family name. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Driving Privileges | If set, the app requests the user’s driving privileges. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Document Type | The type of document the app requests |
|
Document Number | If set, the app requests the document number of the user’s document. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Portrait | If set, the app requests the user’s portrait. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Outcome | Strings that describe the outcome of the requestDocument call |
|
Is Developer Test ID | If true, the document is a test ID instead of a real ID |
|
Issuing Authority | If set, the app requests the issuing authority of the user’s document. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Given Name | If set, the app requests the user’s given name. The value is the retention period specified by the app (-1 means “indefinite retention”, -2 means “no retention”). |
|
Glossary
Dimension | Value | Definition |
|---|---|---|
Document Type | drivers-license | A US driver’s license |
Outcome | success | Presentment succeeded |
Outcome | userCancelled | User cancelled the sheet |
Outcome | appCancelled | The app cancelled the sheet |
Outcome | validationFailed | The provided request was invalid |
Outcome | presentmentFailed | Some other error prevented presentment |
See Also
Framework Usage
AccessorySetupKit Accessory Picker SessionsAccessorySetupKit UsageAirPlay Discovery SessionsAnimoji Stickers SentApp Added to FocusApp Disk Space UsageApp Extended Launch UsageApp HangTracer UsageApp Runtime UsageApp Sessions ContextApplication Preferred Language SettingsARKit ARSession DurationARKit ARSession FailuresARKit Capture Frame Rate ThrottlingARKit Collaborative Session Features