Contents

PKIdentityNationalIDCardDescriptor

An object for requesting information from a user’s national ID card.

Declaration

class PKIdentityNationalIDCardDescriptor

Mentioned in

Discussion

For the elements you request, the response contains the corresponding elements present in the user’s identity document. The table below maps the elements you request using PKIdentityElement with the ISO and JP namespace in the response.

Identity element

ISO namespace

JP namespace

givenName

full_name_unicode

familyName

full_name_unicode

portrait

portrait

address

resident_address_unicode, local_gov_code_unicode

documentNumber

individual_number_unicode

sex

sex

sex_unicode

age

age_in_years

dateOfBirth

birth_date

birth_date_unicode

age(atLeast: XX)

age_over_XX

This API requires a special entitlement issued by Apple. After you receive the entitlement, configure your Xcode project to use it:

  1. Add the entitlement to the property list specified in your target.

  2. In the entitlements.plist for the entitlement, add a new document-types item.

  3. Add a new element string.

Building an app with this entitlement requires macOS 13 or later. For more information about the entitlement, see Getting started with the Verify with Wallet API.

Topics

Setting region information

See Also

Identity passes and authorization