Contents

Verify With Wallet Document Request Availability

Review how your app uses identity and authorization APIs to check document request availability

Overview

The data in this report shows calls to the PKIdentityAuthorizationController’s canRequestDocument API from apps, to check whether identity document requests are available.

  • 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

integer

Territory

Country or region in which the event occurred

string

Date

Date when the event occurred

string

Platform

OS version on the device on which the event occurred

string

Device

Type of device on which the event occurred

string

Build

Build of device on which event occurred

string

Unique Devices

The count of unique devices

integer

Release Type

Type of software release

string

Document Type

Strings that describe the type of document the app requests

string

Is Developer Test ID

If true, the response from the API is based on a test ID instead of a real ID

boolean

Outcome

Strings that describe the outcome of the API call

string

Glossary

Dimension

Value

Definition

Document Type

“driversLicense”

A US driver’s license

Outcome

“success”

canRequestDocument returned true

Outcome

“missingDocument”

canRequestDocument returned false because no document was present on the device

Outcome

“missingEntitlement”

canRequestDocument returned false because the requesting app was not entitled for this call

Outcome

“notLoggedInWithPasscode”

canRequestdocument returned false because the user was not logged into iCloud with a passcode set

See Also

Framework Usage