Contents

PKIdentityPhotoIDDescriptor

An object you use to request information from a user’s photo ID or equivalent document.

Declaration

class PKIdentityPhotoIDDescriptor

Mentioned in

Discussion

Use this class to help create a digital ID in Wallet, which is an Apple issued ID credential based on government-issued ICAO compliant passport. This ID is available to use in person, within apps, and on the web.

For the elements you request, the response contains the corresponding elements present in the user’s identity document. The following table shows the mapping from PKIdentityElement to elements in the PKIdentityPhotoIDDescriptor. If the PKIdentityElement corresponds to more than one of the mobile doc elements, all of the elements are returned.

Identity element

ISO 23220_1 namespace

Description

familyNameElement

family_name_unicode, family_name_latin1

Last name, surname, or primary identifier, of the holder.

givenNameElement

given_name_unicode, given_name_latin1

First name(s), other name(s), or secondary identifier, of the holder.

portraitElement

portrait

Portrait data as specified in ISO/IEC 18013-2:2020, C.4.5.

addressElement

resident_address_unicode, resident_city_unicode, resident_city_latin1, resident_postal_code, resident_country

The place where the ID holder resides and may be contacted.

issuingAuthority

issuing_authority_unicode, issuing_subdivision, issuing_country

The issuer of the digital ID credential.

documentIssueDateElement

issue_date

The issue date for the underlying physical ID.

documentExpirationDateElement

expiry_date

Date when the ID expires (Note: This is intended to be the date of the underlying physical document, if appropriate. The mdoc-specific dates are included in the ValidityInfo within the MSO.)

documentNumberElement

document_number

The number assigned or calculated by the issuing authority.

sexElement

sex_unicode

The ID holder’s sex using values as defined in ISO/IEC 5218.

dateOfBirthElement

birth_date_unicode

The date when the ID holder was born.

ageElement

age_in_years

The age of the ID holder.

ageThresholdElement

age_over_NN

Age attestation used to convey to a verifier, in a data-minimized fashion, if the holder is older than a specified age.

See Also

Identity passes and authorization