> For the complete documentation index, see [llms.txt](https://docs.thewalletcrew.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thewalletcrew.io/developers-guides/integration-guides/wallet/enrolment-flows.md).

# Enrolment flows

Understand how enrolment flows and connector events create Apple Wallet and Google Wallet passes, and when customer identifiers are attached to a pass.

An enrolment flow is the moment a pass is created and linked to a real customer or business record. This is where external identifiers are attached to the pass for the first time. That step matters because later renders depend on those identifiers to fetch live data from source systems.

Enrolment is not a later synchronization step. The pass is created during the flow itself, then the wallet artifact can be built from that new pass record. If identifiers are missing or incorrect at enrolment time, connector-driven data will be missing on later renders.

<details>

<summary><strong>Real-world examples</strong></summary>

* A loyalty signup flow creates a pass after a customer account is created in a CRM.
* A ticket purchase flow creates a pass after checkout and attaches the ticket ID.
* A membership renewal flow creates a replacement pass and links it to the existing customer record.

</details>

## What an enrolment flow does

An enrolment flow creates a pass and attaches the minimum data needed for future renders.

In practice, that usually means:

1. A source system or frontend flow identifies the customer or transaction.
2. The flow creates a pass or triggers pass creation.
3. External identifiers are attached to the pass at creation time.
4. The pass can then be rendered for wallet installation.

The pass record created during enrolment stores identifiers, optional additional data, and internal platform fields, see [Pass data and sync](https://docs.thewalletcrew.io/developers-guides/pass-architecture/pass-data-and-sync.md).

## Common enrolment patterns

### Cinto SDK flow

The Cinto SDK is the JavaScript SDK that renders the Add to Wallet button on a website. It is the main option when a custom web or app flow needs to create passes directly during enrolment.

This pattern is common when a frontend already controls signup, checkout, registration, or profile completion. The SDK creates the pass as part of that flow and provides the external identifiers needed later by connectors.

Use the [Cinto SDK documentation](https://docs.thewalletcrew.io/guides-enrolment/enrolment/on-your-website.md) for the implementation flow.

### Backend-driven enrolment (custom API)

Use this pattern when a backend creates the customer, order, membership, or ticket record. The external identifiers must exist in that backend before pass creation.

Call `POST /passes` with those identifiers to create the pass. See [Pass lifecycle API → Creating a pass](https://docs.thewalletcrew.io/developers-guides/integration-guides/wallet/pass-lifecycle.md).

Build the delivery URL with an external identifier signed with a `{key}.hmac` value. See [Pass delivery URLs](https://docs.thewalletcrew.io/guides-enrolment/enrolment/download-pages.md).

### Built-in enrolment form

The platform also includes a built-in enrolment form with a pass step.

This pattern is useful when the project wants a hosted enrolment flow rather than a fully custom implementation. The same rule still applies: the pass is created during the flow, and identifiers must be available at that moment.

### Source-driven creation

Some projects create passes from a source-side event rather than from a user-facing form. In that model, an external system event, such as customer creation, order confirmation, or subscription activation, triggers pass creation through a connector, and the customer installs the pass later. Connector-triggered creation is the right pattern when pass issuance should follow a system event rather than a user action in a custom frontend.

The connector must provide the external identifiers at creation, see [What must exist at creation time](#what-must-exist-at-creation-time). If a pass is not created, the first place to inspect is the upstream event and the connector path that handles it. If the pass exists but later renders show blank fields, the first place to inspect is the external identifiers stored on the pass.

Webhooks make it easier to observe lifecycle events such as pass creation and installation, see [Webhooks](https://docs.thewalletcrew.io/developers-guides/integration-guides/webhooks.md).

## What must exist at creation time

The most important input at enrolment time is the set of external identifiers.

Without them, connectors cannot locate the correct customer, order, membership, or ticket record during later renders. A pass without useful identifiers behaves like an isolated record with no reliable way to fetch source data. Without the `tenant.pass:write` scope, `POST /passes` refuses the request when no identifier is left after proof validation (see [Pass lifecycle](https://docs.thewalletcrew.io/developers-guides/integration-guides/wallet/pass-lifecycle.md)).

Additional data can also be set at creation time when a value must live on the pass itself. This is useful for pass-level overrides or values that do not exist in any source system.

Use the [Cinto SDK documentation](https://docs.thewalletcrew.io/guides-enrolment/enrolment/on-your-website.md) for implementation details when the flow creates passes directly, and use [Pass data and sync](https://docs.thewalletcrew.io/developers-guides/pass-architecture/pass-data-and-sync.md) for how identifiers and additional data are used later.

## What happens after enrolment

After enrolment, wallet content changes only when a render trigger happens, see [How a pass is rendered](https://docs.thewalletcrew.io/developers-guides/pass-architecture/how-a-pass-is-rendered.md). Use [Getting started with the API](https://docs.thewalletcrew.io/developers-guides/integration-guides/getting-started-with-the-api.md) for the first update calls.

## Validation checklist

A valid enrolment flow should confirm three things.

* The pass is created successfully.
* The expected external identifiers exist on the pass.
* A later render can retrieve source data using those identifiers.
* For source-driven creation, the pass is created exactly once for that event.

A fast validation pattern is to create a test pass, inspect the identifiers in the admin console, then trigger a render or push update and confirm that connector-backed fields resolve correctly.

## FAQ

<details>

<summary><strong>Can external identifiers be attached later if they were missing at enrolment time?</strong></summary>

Yes. `PATCH /passes` accepts `identifiers` and merges them with the existing ones: a blank value removes an identifier. The flat file import can change identifiers too. A flow is still more reliable when identifiers are correct when the pass is created.

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.thewalletcrew.io/developers-guides/integration-guides/wallet/enrolment-flows.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
