SecureElementCredential · IOS API REFERENCE

CredentialSession.Credential.InstanceInfo

struct · iOS 18.1+ · SDK 27.1

struct InstanceInfo

Information about an applet instance associated with a specific credential.

Members (8)

get · iOS 18.1+

securityDomainKeyInfo

TypeScript

get securityDomainKeyInfo(): ArrayBuffer

Swift declaration

let securityDomainKeyInfo: Data

A data blob which contains the security domain On-Board Generated Key (OBGK). This data has the information required to form a Secure Channel Protocol 3 (SCP03) channel between the user and the security domain.

get · iOS 18.1+

packageAID

TypeScript

get packageAID(): ArrayBuffer

Swift declaration

let packageAID: Data

The unique identifier of the package you use to install the instance. You can use the version encoded in this identifier to determine the version of the installed applet.

get · iOS 18.1+

instanceAID

TypeScript

get instanceAID(): ArrayBuffer

Swift declaration

let instanceAID: Data

The unique identifier for the applet instance. Use this identifier in ``CredentialSession/performWiredTransaction(using:over:instanceAID:)`` for UIKit or ``CredentialTransaction/performTransactionInWiredMode(using:instanceAID:)`` for SwiftUI, and when selecting this instance to perform data transceiving.

get · iOS 18.1+

instanceType

TypeScript

get instanceType(): CredentialSession_Credential_InstanceInfo_InstanceType

Swift declaration

let instanceType: CredentialSession.Credential.InstanceInfo.InstanceType

The instance type of this instance.

get · iOS 18.1+

lifeCycleState

TypeScript

get lifeCycleState(): ArrayBuffer

Swift declaration

let lifeCycleState: Data

Information about the state of the applet instance. The format of the data in this property is defined in Table 11-4 of GlobalPlatform Card Specification 2.2.1, and the Mobile Secure Element specification from the [Apple Business Register](https://register.apple.com/login).

get · iOS 18.1+

securityDomainAID

TypeScript

get securityDomainAID(): ArrayBuffer

Swift declaration

let securityDomainAID: Data

The unique identifier of the security domain you use to install the instance. Use this identifier when selecting the security domain to perform data transceive with, such as forming a Secure Channel Protocol 3 (SCP03) channel.

get · iOS 18.1+

securityDomainCounter

TypeScript

get securityDomainCounter(): Promise<number>

Swift declaration

var securityDomainCounter: Int { get async throws }

The authentication counter of the security domain. Accessing this property fetches the latest counter from the remote hardware. - The most common errors are: - ``ErrorCode/resourceUnavailable``: The system service is temporarily unavailable.

get · iOS 18.1+

moduleAID

TypeScript

get moduleAID(): ArrayBuffer

Swift declaration

let moduleAID: Data

The module identifier of the package with which this instance is associated. The combination of the package identifier and this identifier indicates what type the associated applet instance is.

Skipped declarations

No declarations were skipped in this snapshot.

All SecureElementCredential types →