---
title: PKAddIdentityDocumentMetadata
framework: passkit
role: symbol
role_heading: Class
path: passkit/pkaddidentitydocumentmetadata
---

# PKAddIdentityDocumentMetadata

The object for specifying the metadata necessary to provision identity documents.

## Declaration

```swift
class PKAddIdentityDocumentMetadata
```

## Overview

Overview After creating a PKAddIdentityDocumentMetadata object, you can verify whether an identity document already exists for the specified issuingCountryCode and  documentType. important: This class requires a special entitlement from Apple. Your app needs to include that entitlement before you can use this API. The following example shows how to create a metadata object: let previewIdentityPass = PKAddPassMetadataPreview(                   passThumbnail: passThumbnail,                   localizedDescription: localizedDescription               )

let identityMetadata = PKAddIdentityDocumentMetadata(     provisioningCredentialIdentifier: credentialIdentifier,     sharingInstanceIdentifier: sharingInstanceIdentifier,     cardTemplateIdentifier: templateIdentifier,     issuingCountryCode: "US",     documentType: .mDL,     previewIdentityPass: previewIdentityPass )

## Topics

### Creating metadata for identity documents

- [init(provisioningCredentialIdentifier:sharingInstanceIdentifier:cardTemplateIdentifier:issuingCountryCode:documentType:preview:)](passkit/pkaddidentitydocumentmetadata/init(provisioningcredentialidentifier:sharinginstanceidentifier:cardtemplateidentifier:issuingcountrycode:documenttype:preview:).md)

### Checking identity document types

- [PKAddIdentityDocumentType](passkit/pkaddidentitydocumenttype.md)

### Previewing identity document metadata

- [preview](passkit/pkaddidentitydocumentmetadata/preview.md)

## Relationships

### Inherits From

- [PKIdentityDocumentMetadata](passkit/pkidentitydocumentmetadata.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)

## 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)
- [PKAddIdentityDocumentConfiguration](passkit/pkaddidentitydocumentconfiguration.md)
- [PKAddIdentityDocumentType](passkit/pkaddidentitydocumenttype.md)
- [JPKIPassContents](passkit/jpkipasscontents.md)
- [PKAddIdentityDocumentConfiguration](passkit/pkaddidentitydocumentconfiguration.md)
- [PKAddPassMetadataPreview](passkit/pkaddpassmetadatapreview.md)
- [PKIdentityDocumentMetadata](passkit/pkidentitydocumentmetadata.md)
- [PKIdentityNationalIDCardDescriptor](passkit/pkidentitynationalidcarddescriptor.md)
- [PKJapanIndividualNumberCardMetadata](passkit/pkjapanindividualnumbercardmetadata.md)