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

# PKIdentityElement

An object that represents the elements an app requests from identity documents.

```
class PKIdentityElement
```

## Overview

If an app requests an element from a document type that doesn’t support it, the system ignores the element.

## Topics

### Getting identity elements

[`class var address: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/address)

An element that represents the user’s home address.

[`class var dateOfBirth: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/dateOfBirth)

An element that represents the user’s date of birth.

[`class var dhsTemporaryLawfulStatus: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/dhsTemporaryLawfulStatus)

Indicates whether the mobile document holder has temporary lawful status based on information from the U.S. Department of Homeland Security (DHS).

[`class var documentDHSComplianceStatus: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/documentDHSComplianceStatus)

[`class var documentIssueDate: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/documentIssueDate)

An element that represents the issue date of the document.

[`class var documentExpirationDate: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/documentExpirationDate)

An element that represents the expiration date of the document.

[`class var documentNumber: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/documentNumber)

An element that represents the document’s number, as the issuing authority defines.

[`class var drivingPrivileges: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/drivingPrivileges)

An element that represents the user’s driving privileges.

[`class var eyeColor: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/eyeColor)

The user’s eye color on record with the issuer.

[`class var familyName: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/familyName)

An element that represents the user’s family name.

[`class var givenName: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/givenName)

An element that represents the user’s given name.

[`class var hairColor: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/hairColor)

The user’s hair color on record with the issuer.

[`class var height: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/height)

The user’s height on record with the issuer.

[`class var issuingAuthority: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/issuingAuthority)

An element that represents the user’s issuing authority.

[`class var name: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/name)

The user’s full name.

[`class var nationality: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/nationality)

The mobile document holder’s nationality.

[`class var organDonorStatus: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/organDonorStatus)

The user’s organ donor status on record with the issuer.

[`class var placeOfBirth: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/placeOfBirth)

The place where the mobile document holder was born.

[`class var portrait: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/portrait)

An element that represents the user’s photo.

[`class var sex: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/sex)

An element that represents the document holder’s sex.

[`class var signatureUsualMark: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/signatureUsualMark)

The signature or usual mark of the mobile document holder.

[`class var weight: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/weight)

The user’s weight on record with the issuer.

[`class var veteranStatus: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/veteranStatus)

The user’s veteran status on record with the issuer.

[`class var signatureUsualMark: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/signatureUsualMark)

The signature or usual mark of the mobile document holder.

[`class var placeOfBirth: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/placeOfBirth)

The place where the mobile document holder was born.

[`class var nationality: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/nationality)

The mobile document holder’s nationality.

[`class var dhsTemporaryLawfulStatus: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/dhsTemporaryLawfulStatus)

Indicates whether the mobile document holder has temporary lawful status based on information from the U.S. Department of Homeland Security (DHS).

### Getting an age identity element

[`class var age: PKIdentityElement`](/documentation/PassKit/PKIdentityElement/age)

An element that represents the user’s age, in years.

[`class func age(atLeast: Int) -> Self`](/documentation/PassKit/PKIdentityElement/age(atLeast:))

Returns an element that represents the user’s age is at least the age you specify.

## Relationships

### Inherits From

[`NSObject-swift.class`](/documentation/ObjectiveC/NSObject-swift.class)

### Conforms To

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

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

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

[`NSCopying`](/documentation/Foundation/NSCopying)

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

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

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

---

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)