This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.
ArchitectureReference

Structure

Understand how pass data is organized in The Wallet Crew, including identifiers, metadata, additional data, and external data.

Structure

This page explains how pass data is organized in The Wallet Crew. It shows which values are stored on the pass record, which values stay in connected systems, and when to use each field type.

The Wallet Crew follows a privacy-first model. Personal data is not stored by default. The platform stores external identifiers and, when needed, limited non-sensitive values such as metadata or additional data.

Real-world examples
  • A loyalty pass can use a CRM customer ID as an external identifier, a storeId as metadata, and a campaign message as additional data.

  • A ticketing pass can use a ticket ID from the ticketing system, a venue metadata field for segmentation, and a seat-upgrade note as additional data.

  • A membership pass can combine several identifiers when data comes from more than one system, such as Shopify, Klaviyo, and an internal CRM.

What a pass contains

A pass is built from several data blocks. Each block serves a different purpose.

  • General information describes the pass record itself.

  • External identifiers connect the pass to other systems.

  • Metadata supports segmentation and targeting.

  • Additional data enriches the pass when no source system provides the value.

  • External data shows the source data used to build the pass.

General information

The general section contains the core record details for the pass. It includes the creation date, the last update date, Apple Wallet and Google Wallet status, and the pass type.

The pass type is the only value in this section that can be changed manually.

Pass general information, including creation date, update date, wallet status, and pass type

General information helps confirm the current state of the pass and the template it uses.

External identifiers

External identifiers connect a pass to one or more connected systems. They make it possible to fetch the data needed to build the pass without storing that personal data in The Wallet Crew.

A single pass can contain several identifiers. Each identifier maps to a specific integration point, such as Shopify, Klaviyo, or Cegid Y2.

List of external identifiers attached to a pass

Identifiers are stored as key-value pairs. This makes it possible to attach the right reference for each source system.

Form used to add an external identifier to a pass

Use external identifiers when a pass must stay linked to a source system.

Metadata

Metadata is used to segment passes. It helps group passes by operational or marketing criteria.

For example, a storeId metadata field can separate passes by location. This makes it possible to target a push notification to passes linked to one store only.

Metadata fields used to segment passes

Use metadata when the value must support filtering, targeting, or reporting.

Additional data

Additional data is optional pass-level information. It is not required to create the pass and is not intended for segmentation.

This data is useful when a value does not exist in a connected system but still improves the wallet experience. A custom welcome message is a common example.

Additional data attached to a pass for wallet enrichment

Use additional data when the value enriches the pass but does not need to drive audience selection.

External data

External data shows the source information used to build the pass. It helps verify which values were collected and which connected system provided them.

This view is useful for validation and troubleshooting. It makes it easier to confirm that the pass receives the expected data before or after an update.

External data used to build a pass and its source systems

Use external data to inspect the raw source values behind a pass.

Choosing the right field type

Choosing the right field type keeps the pass model clean and maintainable.

  • Use external identifiers to connect the pass to a source system.

  • Use metadata to segment passes.

  • Use additional data to enrich selected passes.

  • Use external data to validate the source payload.

FAQ

Does The Wallet Crew store personal data on the pass record?

Not by default. The Wallet Crew stores external identifiers and can store limited non-sensitive values when needed, such as metadata or additional data.

What is the difference between metadata and additional data?

Metadata is designed for segmentation. Additional data is designed for pass enrichment. If a value must be used for targeting or filtering, it belongs in metadata.

Can one pass be connected to several systems?

Yes. A single pass can contain several external identifiers. Each identifier can represent a different connected system.

Last updated