AE Mobile Wiki

Glossary

Cross-vendor terminology reconciliation. Each concept has a canonical name plus per-vendor aliases — hover or scan to map terms across HID, Wavelynx, Apple, Google.

44 concepts · 10 categories

Provisioning(5)

Pass template / SKU

template-or-sku

Defines the credential type, artwork, metadata, and policy that apply to every pass issued under it. The issuer configures the template once; per-user issuance instantiates passes from it.

  • Wavelynx Pass template config
  • HID v2.2 Part Number
  • HID v3.x Pass Template
  • Apple UAP passTypeIdentifier
  • Google Pass Class
  • AE Card Template

Post-Provisioning Pass Update (PPPU)

pppu

HID's update mechanism for already-provisioned passes. Applied via PATCH /passes/{passId} on the v3.x Credential Management API. PPPU simplified the older state machine by removing intermediate REQUESTED / ACCEPTED states and applies uniformly to Apple and Google Wallet.

  • HID v3.x PPPU

Provisioning payload

provisioning-payload

The encrypted/signed bundle delivered from the issuer to the wallet platform during provisioning. Contains the credential's cryptographic material (wrapped per the wallet's key-wrapping spec), display fields (name, role, photo), and identifiers needed to instantiate the pass on-device.

  • Wavelynx Provisioning bundle (JWS-signed)
  • HID v3.x Pass payload
  • Apple UAP provisioningBundle

Provisioning unit

provisioning-unit

The atomic unit of credential issuance — what gets added to a wallet when a user taps "Add to Wallet". Each vendor names this differently, and HID has two competing names depending on which API generation you read.

  • HID v2.2 Mobile ID
  • HID v3.x Pass
  • Apple UAP Pass / provisioningBundle
  • Google Pass
  • AE Mobile Credential

User invitation

user-invitation

A one-time code or token distributed to a user that authorizes them to claim a credential on a device. HID's model centers on this; in Wavelynx's model the partner manages users directly so no invitation primitive exists at the vendor level.

  • HID v2.2 Invitation Code (16-char alphanumeric)
  • AE Invitation Email

Identifiers(6)

Correlation identifier

correlation-id

Request-scoped identifier carried in HTTP headers (or payload) for cross-system tracing during support investigations and asynchronous callback correlation.

  • Wavelynx correlationId (Wavelynx ↔ NXP scope)
  • HID v3.x CorrelationId (HTTP response header)
  • Apple UAP sharingInstanceIdentifier

Device-bound credential identifier

device-credential-id

Identifier scoped to a specific (credential × device) pair. Distinct from the pass identifier, which references the issuance instance. A single credential can have many device IDs over its lifetime if the user provisions to multiple devices or re-provisions after wipe.

  • Wavelynx VUID
  • HID v2.2 Credential Container ID
  • HID v3.x Credential Container ID
  • Apple UAP device-bound IDs

Eligible-user data sync

eligible-user-data

How the customer's identity system (Workday, Okta, Entra ID, etc.) tells the credential platform which users are eligible to receive credentials. Apple and Google have no concept of user eligibility — the issuer is responsible. HID accepts SCIM-formatted eligibility data; Wavelynx delegates to the partner.

  • HID v2.2 SCIM v2 eligibility payload

Federated identifier

federated-identifier

Wavelynx's design pattern: identifiers (VUID, PBID, device-bound IDs) are unique within a specific Wavelynx ↔ wallet-provider relationship but have no meaning outside it. They cannot be cross-referenced with third-party identifiers or end-user identity systems. Lets Wavelynx scope cardholder fields voluntarily — the credential can be fully anonymous.

Pass identifier

pass-id

Unique identifier for a single provisioned wallet pass instance. Used by issuer-side systems to reference and update a specific credential after issuance. Federated to the issuer↔wallet relationship — has no meaning outside that context.

  • Wavelynx PBID
  • HID v3.x passId
  • Apple UAP provisioningBundleIdentifier
  • Google passId

User model

user-model

How a vendor models the end user. Wavelynx is user-less by design — partners manage users and Wavelynx exposes only credential and group identifiers. HID exposes a SCIM v2-compliant user model (with HID extensions) but limits it to credential management; HID's User Management API is not consumed by other HID services.

  • Wavelynx federated identifiers only
  • HID v2.2 SCIM v2 + urn:hid:scim:api:ma:2.2:UserAction
  • HID v3.x SCIM v2 (limited)

Lifecycle states(6)

Active (lifecycle state)

state-active

Credential is provisioned, present on the user's device, and authenticatable at readers. The default operational state for a healthy credential.

  • Wavelynx ACTIVE
  • HID v2.2 ISSUED
  • HID v3.x ACTIVE
  • Apple active

Failed (lifecycle state)

state-failed

Issuance or revocation could not complete. Causes include offline device, expired auth tokens, or unrecoverable wallet errors.

  • HID v2.2 REVOKING_FAILURE
  • HID v3.x FAILED

Pending (lifecycle state)

state-pending

Initial state after issuance request, before the wallet has acknowledged receipt. Some vendors don't expose this state to partners.

  • Wavelynx PENDING
  • HID v2.2 (pre-issue, not exposed)
  • HID v3.x (pre-issue, not exposed)

Provisioning (lifecycle state)

state-provisioning

Issuance has begun and the wallet is processing the credential. Transient state — typically resolves to active within seconds.

  • HID v2.2 ISSUE_INITIATED
  • HID v3.x (PPPU in progress)

Revoked (lifecycle state)

state-revoked

Terminal state. Credential is no longer valid; on-device material removed at next sync. Wavelynx soft-deletes (status moves to DELETED while billing/audit fields remain); HID hard-revokes via revocation flow.

  • Wavelynx DELETED (soft-delete)
  • HID v2.2 REVOKED
  • HID v3.x CANCELLED
  • Apple removed

Suspended (lifecycle state)

state-suspended

Credential is paused — it remains on-device but doesn't authenticate at readers. Reversible via resume. HID v2.2 doesn't have a separate suspend state — the equivalent path goes through REVOKE_INITIATED.

  • Wavelynx SUSPENDED
  • HID v3.x (PPPU patch state)
  • Apple suspended

Credential formats(3)

Credential format

credential-format

The on-device data structure that an NFC reader actually authenticates against. Different vendors use different chip-emulation profiles. The device hardware doesn't care which vendor issued it — it cares which chip protocol the credential pretends to be.

  • Wavelynx DESFire (Apple) / DESFire EV2 via NXP MIFARE2GO (Google)
  • HID v3.x Seos
  • AE Mobile Credential

Seos

seos

HID's proprietary credential technology — the on-chip data structure and crypto suite used in HID-issued mobile credentials (and physical Seos cards). Apple Wallet's HID integration delivers a Seos credential payload that authenticates at HID readers.

  • HID v3.x Seos

Trusted Service Manager (TSM)

tsm

Intermediary HID infrastructure that brokers credential delivery between HID Origo and the wallet platforms. Sits between HID Origo and Apple Pay / Google in HID's deployment topology.

  • HID v3.x HID TSM

Key material(3)

Master key store

master-key-store

Where the issuer's master keys (from which per-credential keys are derived) are physically held. Best-practice is hardware-backed (HSM) with database-side keys wrapped by an external KMS. Wavelynx documents an HSM-rooted, KMS-wrapped, no-plaintext-at-rest pipeline; HID's public docs are silent on the equivalent — depth lives in NDA partner material.

  • Wavelynx HSM-rooted, KMS-wrapped Cloud SQL storage

Per-credential key diversification

key-diversification

Wavelynx's deterministic process for deriving a unique per-credential symmetric key from a per-partner-site master key. Diversified keys are never persisted — they're regenerated on demand. Compromise of any single issued credential does not compromise other credentials issued under the same master key.

  • Wavelynx Per-credential key diversification

Wrapped key material

wrapped-key-material

Symmetric credential keys delivered to the wallet platform in encrypted form, never as plaintext. Each wallet has a published key-wrapping spec the issuer must follow. The wallet's key-management infrastructure decrypts internally; the issuer never has access to the unwrapping key.

  • Wavelynx Wrapped per Apple's key-wrapping spec
  • AE authorizationBlobs (per AE diagrams — confirm equivalence)

Authentication & transport(5)

Application-ID (TPS-certified)

application-id-tps

Identifier HID issues to applications via the Technology Partner Service (TPS) certification program. Required header on every API call; HID will not accept calls from uncertified applications. AE has a TPS-certified Application-ID covering its mobile credential integrations.

  • HID v3.x Application-ID

Partner authentication

partner-auth

How an integrator authenticates to the credential provider's API. Both major vendors use OAuth 2.0 client_credentials at the foundation; HID adds a PKI certificate option for higher-assurance partners.

  • Wavelynx ECC P-256 signature → bearer JWT
  • HID v3.x OAuth 2.0 client_credentials + PKI cert option

Required custom headers

required-headers

Vendor-specific headers required on every API call beyond standard Authorization. HID requires Application-ID + Application-Version tied to Technology Partner Service certification — partners cannot call HID Origo without TPS-certified application identity.

  • Wavelynx x-api-key (webhooks); mTLS (partner)
  • HID v3.x Application-ID + Application-Version (TPS-certified)

System account format

system-account-format

HID Origo's machine-account naming convention for OAuth client_id values. Format is `{organization_id}-OSRV{random_string}` — encoding the tenancy in the account ID itself.

  • HID v3.x {organization_id}-OSRV{random_string}

Tenancy identifier

tenancy-id

The vendor-side primary key that scopes all of a partner's resources. Every API call carries it. Rate limits, billing, and webhook routing are all keyed on it.

  • Wavelynx partner_id
  • HID v3.x organizationId

Webhooks(5)

Webhook authentication

webhook-auth

How the receiver verifies a webhook came from the vendor. Wavelynx uses a static x-api-key header (with optional mutual TLS pinning). HID lets the partner pick: Basic Auth header or an API Key header with a custom header name + secret.

  • Wavelynx x-api-key (static) + optional TLS pin
  • HID v3.x Basic Auth OR API Key (custom header name + secret)

Webhook delivery shape

webhook-shape

How many events ship per HTTP request. Wavelynx fires one event per POST with retry-on-failure semantics. HID batches multiple events per POST and stores undelivered events server-side for partners to poll-recover.

  • Wavelynx One event per POST
  • HID v3.x Batch — multiple events per POST

Webhook failure handling

webhook-failure-handling

What happens when a webhook delivery fails. Wavelynx retries on 5xx and timeout, with a deduplicating message_id. HID does not retry — failed events are persisted in HID's Event Management API for the partner to fetch on their own schedule.

  • Wavelynx Retry on 5xx/timeout, message_id for dedup
  • HID v3.x Persist to Event Management API for poll-recovery

Webhook payload specification

webhook-spec

The wire-format spec a vendor's webhooks conform to. Wavelynx ships a custom JSON envelope; HID adopted CloudEvents (the CNCF spec) and delivers events in batches.

  • Wavelynx Custom JSON
  • HID v3.x CloudEvents — application/cloudevents-batch+json

Webhook subscription model

webhook-subscription

How partners register interest in events. Wavelynx uses one static URL plus a key per partner. HID uses filter-based subscriptions — partners register URL + filterId, where filterId references which event types they want.

  • Wavelynx Static URL + key per partner
  • HID v3.x Filter-based — register URL + filterId

Apple platform(4)

Enhanced Contactless Polling (ECP)

ecp

Apple's proprietary extension to ISO/IEC 14443. Lets readers broadcast configuration and capability information in the polling loop before any back-and-forth communication, so an Apple device can route to the right credential applet automatically. Required for Apple Wallet access-control deployments.

  • Apple Enhanced Contactless Polling

Express Mode

express-mode

Apple device feature that allows the credential to authenticate without the user unlocking the device or opening Wallet. Tap-and-go. Disabled when TRA is configured on the reader. iPhone-default-on, Watch-default-off.

  • Apple Express Mode

Power Reserve Mode

power-reserve-mode

When the iPhone or Apple Watch enters low-battery shutdown, recent devices keep enough reserve power to authenticate stored credentials for up to ~5 hours. Critical for after-hours access scenarios where the user has a dead phone but still needs to enter the building.

  • Apple Power Reserve Mode

Terminal Requested Authentication (TRA)

tra

Reader-side configuration that forces the Apple device to require user authentication (Face ID, Touch ID, or passcode) before the credential is presented. Used to enable a 2FA enforcement model on high-security doors. Configured per-reader, not per-credential.

  • Apple Terminal Requested Authentication

Google platform(3)

Collector ID

collector-id

Identifier the NFC reader transmits to the Android device on each Smart Tap. The device looks up the corresponding Redemption Issuer ID to decide which credential to present.

  • Google Collector ID

Google Wallet — no user-initiated provisioning

google-no-user-init

Structural feature gap vs. Apple Wallet. Google Wallet does not support user-initiated provisioning — every credential must be pushed by an admin who issues a token the user redeems. Same gap applies to suspend / resume from the wallet UI: those user-initiated paths don't exist on Google.

  • Google admin-only token redemption

Smart Tap

smart-tap

Google's proprietary NFC protocol for delivering data from an Android device's wallet to an NFC reader. Encrypted via keys negotiated at channel-establishment. Counterpart to Apple's ECP/VAS ecosystem.

  • Google Smart Tap

Alert Enterprise components(4)

AE Wallet App

ae-wallet-app

AE's mobile-native client (iOS, Android). Optional in the integration topology — web-based provisioning can substitute for it, but the app provides the smoother in-device "Add to Wallet" experience.

  • AE AE Wallet App

AE Web (provisioning UI)

ae-web

Browser-based provisioning surface. Used when the AE Wallet App isn't installed — typically for first-time provisioning to a device the user opens via an emailed invitation link.

  • AE AE Web

Guardian NFC Cloud Service

guardian-nfc-cloud

AE's cloud orchestration layer between Guardian and the credential providers. Hosts per-vendor connectors (HID, Wavelynx, LEGIC), the webhook receiver, and the Mobile Credentials Service. Multiple AE diagrams refer to this layer by other names — this is the canonical one.

  • AE AE NFC Cloud / Guardian Mobile Cloud Service / Mobile Cloud Service

Guardian Platform

guardian-platform

AE's PIAM (Physical Identity & Access Management) platform — the source of truth for identities and access rights. Initiates mobile credential requests based on user identity, role, and access policy. Self-service request UI lives here.

  • AE Guardian
Verifying access