---
title: PKIdentityNationalIDCardDescriptor
framework: passkit
role: symbol
role_heading: Class
path: passkit/pkidentitynationalidcarddescriptor
---

# PKIdentityNationalIDCardDescriptor

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

## Declaration

```swift
class PKIdentityNationalIDCardDescriptor
```

## Mentioned in

Requesting identity data from a Wallet pass Configuring your environment for the Verify with Wallet API

## Discussion

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. note: You can retrieve elements specific to Japan only when you have set the API region to JP.  |  |   |  |   |  |   |  |   |  |   |  |   |  |   |  |   |  |   |  |  This API requires a special entitlement issued by Apple. After you receive the entitlement, configure your Xcode project to use it: Add the entitlement to the property list specified in your target. In the entitlements.plist for the entitlement, add a new document-types item. 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

- [region](passkit/pkidentitynationalidcarddescriptor/region.md)

## Relationships

### Inherits From

- [NSObject](objectivec/nsobject-swift.class.md)

### Conforms To

- [CVarArg](swift/cvararg.md)
- [CustomDebugStringConvertible](swift/customdebugstringconvertible.md)
- [CustomStringConvertible](swift/customstringconvertible.md)
- [Equatable](swift/equatable.md)
- [Hashable](swift/hashable.md)
- [NSObjectProtocol](objectivec/nsobjectprotocol.md)
- [PKIdentityDocumentDescriptor](passkit/pkidentitydocumentdescriptor.md)

## See Also

### Identity passes and authorization

- [Requesting identity data from a Wallet pass](passkit/requesting-identity-data-from-a-wallet-pass.md)
- [Configuring your environment for the Verify with Wallet API](passkit/configuring-your-environment-for-the-verify-with-wallet-api.md)
- [Verifying Wallet identity requests](passkit/verifying-wallet-identity-requests.md)
- [PKIdentityPhotoIDDescriptor](passkit/pkidentityphotoiddescriptor.md)
- [PKIdentityAnyOfDescriptor](passkit/pkidentityanyofdescriptor.md)
- [PKIdentityDriversLicenseDescriptor](passkit/pkidentitydriverslicensedescriptor.md)
- [PKAddIdentityDocumentMetadata](passkit/pkaddidentitydocumentmetadata.md)
- [PKAddIdentityDocumentConfiguration](passkit/pkaddidentitydocumentconfiguration.md)
- [PKAddIdentityDocumentType](passkit/pkaddidentitydocumenttype.md)
- [JPKIPassContents](passkit/jpkipasscontents.md)
- [PKAddIdentityDocumentConfiguration](passkit/pkaddidentitydocumentconfiguration.md)
- [PKAddPassMetadataPreview](passkit/pkaddpassmetadatapreview.md)
- [PKIdentityDocumentMetadata](passkit/pkidentitydocumentmetadata.md)
- [PKJapanIndividualNumberCardMetadata](passkit/pkjapanindividualnumbercardmetadata.md)