> 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/api-reference/forms.md).

# Forms

The enrolment surface of The Wallet Crew. These endpoints power customer registration flows, store-aware redirects, and the store reference data that backs geolocation and attribution features.

The enrolment surface of The Wallet Crew. These endpoints power customer registration flows, store-aware redirects, and the store reference data that backs geolocation and attribution features.

### Customer

The `Customer` tag exposes the enrolment form backend. An enrolment form is the web page customers use to join a programme and receive their wallet pass. It sits between your acquisition channel (QR code, email link, website CTA, mobile app) and the pass template.

When a customer submits a form, The Wallet Crew:

1. Creates or updates a **customer profile** (equivalent to a loyalty account).
2. Validates consent and required fields.
3. Issues the wallet pass with the correct "Add to Wallet" experience for Apple or Google.

**Common use cases**

* Retail loyalty enrolment via in-store QR code at checkout.
* Post-purchase email link that opens a pre-filled form.
* Mobile app deep link that resolves identity without asking questions again.
* Clienteling tablet used by staff to enrol a customer on the spot.

> **Data quality tip**: Collect only the identifiers you need. Short forms convert better and produce fewer placeholder entries. Returning customers can be identified early via social sign-in or email check-in — avoiding duplicate profiles.

### Redirect

The `Redirect` tag manages short, tracked URLs and QR codes for enrolment journeys. A redirect wraps an enrolment form URL and injects parameters like `storeId`, language, or campaign source before forwarding the customer.

| Operation                        | Description                                                               |
| -------------------------------- | ------------------------------------------------------------------------- |
| List / create / update redirects | Manage the library of tracked entry points.                               |
| Generate QR code                 | Produce a printable QR for a redirect URL.                                |
| Track usage                      | Redirect events appear in the Insights database as `Redirect:Redirected`. |

A single enrolment form can have many redirects — one per store, one per campaign, one per channel — without duplicating form configuration. Attribution data flows through the `storeId` and custom parameters you attach to each redirect.

### Store

The `Store` tag manages the reference list of physical store locations. Store data is used in two places:

* **Enrolment attribution**: when a redirect carries a `storeId`, the matching store record is attached to the customer profile.
* **Geolocated notifications**: Apple Wallet and Google Wallet can surface a pass automatically when a customer is near a configured location.

| Field                    | Description                                                             |
| ------------------------ | ----------------------------------------------------------------------- |
| `name`                   | Display name shown on the pass or form.                                 |
| `address`                | Full address for display purposes.                                      |
| `latitude` / `longitude` | Coordinates used for geolocation triggers.                              |
| `externalId`             | Your internal store identifier, used to correlate with POS or CRM data. |

> Store data can be bulk-imported via flat file. See [Stores configuration guide](https://docs.thewalletcrew.io/configure/advanced-configuration/platform/data-and-integrations/stores).

### Authentication

All endpoints require an `X-API-KEY` header scoped to the tenant.

### Further reading

* [Enrolment form guide](https://docs.thewalletcrew.io/guides-enrolment/enrolment/enrolment-form) — UX patterns, data quality, GDPR compliance
* [Redirects guide](https://docs.thewalletcrew.io/guides-enrolment/enrolment/enrolment-form/redirect) — creating store-level QR codes
* [Stores guide](https://docs.thewalletcrew.io/guides-enrolment/enrolment/enrolment-form/stores) — importing and managing location data
* [Social sign-in](https://docs.thewalletcrew.io/guides-enrolment/enrolment/enrolment-form/social-sign-in) — Apple, Google, LINE, Facebook authentication


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.thewalletcrew.io/api-reference/forms.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.