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.
EnrolmentEmailForm

Enrolment Form

Hosted enrolment forms support secure pass creation and retrieval flows. This section covers customer identification, access control, and form behavior used before wallet delivery.

Customer registration configuration

Customer registration captures identity before issuing a pass. Use it when a CRM or POS account must be created or updated first. It supports website enrolment and in-store QR-code registration.

Sign-in options (signinOptions)

signinOptions controls how returning customers are detected and handled. It can check for an existing session or route to a mobile sign-in journey based on device detection.

Complete options (completeOptions)

completeOptions is an ordered list of actions taken after successful registration. Each action has a type.

Type
What it does

AddToWallet

Presents Add to Wallet buttons. Supports autoDownloadPass and an optional post-download form.

Redirect

Redirects to a fixed URI. It supports Liquid variables, such as {{['id.y2.customerId']}}, in the destination URL.

RedirectToPass

Redirects to a named pass-download layout for immediate pass download.

Reset

Resets the form after a configured delay in seconds. Use this for shared in-store kiosks.

The Enrolment Form section covers the advanced configuration of the sign-up experience. When a customer submits their email address, TWC can automatically check whether they already exist in the system. If they do, an optional verification step — such as a one-time code or magic link — secures access before the pass is issued. If they don't, the form collects the remaining details and creates a new record. This prevents duplicate entries and keeps your customer database consistent, without requiring any additional development on your side.