<!--
{
  "availability" : [
    "iOS: 18.0.0 -",
    "iPadOS: 18.0.0 -",
    "macCatalyst: 18.0.0 -",
    "visionOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "PassKit",
  "identifier" : "/documentation/PassKit/PKIdentityNationalIDCardDescriptor",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "PassKit (Apple Pay and Wallet)"
    ],
    "preciseIdentifier" : "c:objc(cs)PKIdentityNationalIDCardDescriptor"
  },
  "title" : "PKIdentityNationalIDCardDescriptor"
}
-->

# PKIdentityNationalIDCardDescriptor

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

```
class PKIdentityNationalIDCardDescriptor
```

## 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`](/documentation/PassKit/PKIdentityElement) with the ISO and JP namespace in the response.

> Note:
> You can retrieve elements specific to Japan only when you have set the API region to `JP`.

|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](https://developer.apple.com/wallet/get-started-with-verify-with-wallet/).

## Topics

### Setting region information

[`region`](/documentation/PassKit/PKIdentityNationalIDCardDescriptor/region)

A string used to specify the region associated with the ID.


---

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)