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

# PKAddIdentityDocumentMetadata

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

```
class PKAddIdentityDocumentMetadata
```

## Overview

After creating a [`PKAddIdentityDocumentMetadata`](/documentation/PassKit/PKAddIdentityDocumentMetadata) object, you can verify whether an identity document already exists for the specified [`issuingCountryCode`](/documentation/PassKit/PKIdentityDocumentMetadata/issuingCountryCode) and  [`documentType`](/documentation/PassKit/PKIdentityDocumentMetadata/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:

```swift
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

[`-  initWithProvisioningCredentialIdentifier:sharingInstanceIdentifier:cardTemplateIdentifier:issuingCountryCode:documentType:preview:`](/documentation/PassKit/PKAddIdentityDocumentMetadata/init(provisioningCredentialIdentifier:sharingInstanceIdentifier:cardTemplateIdentifier:issuingCountryCode:documentType:preview:))

Creates the identity document metadata with parameters that the issuer’s server configures to indicate the specific product instance to provision.

### Checking identity document types

[`PKAddIdentityDocumentType`](/documentation/PassKit/PKAddIdentityDocumentType)

Classifications that reflect the type of identity document.

### Previewing identity document metadata

[`preview`](/documentation/PassKit/PKAddIdentityDocumentMetadata/preview)

A preview object containing the necessary information to represent the pass during provisioning.

## Relationships

### Conforms To

[`Hashable`](/documentation/Swift/Hashable)

[`CustomStringConvertible`](/documentation/Swift/CustomStringConvertible)

[`CVarArg`](/documentation/Swift/CVarArg)

[`Equatable`](/documentation/Swift/Equatable)

[`CustomDebugStringConvertible`](/documentation/Swift/CustomDebugStringConvertible)

[`NSObjectProtocol`](/documentation/ObjectiveC/NSObjectProtocol)

### Inherits From

[`PKIdentityDocumentMetadata`](/documentation/PassKit/PKIdentityDocumentMetadata)

---

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)