# How to Create Passes via API in The Wallet Crew
This guide shows how to create wallet passes from your own systems (CRM, e-commerce, ticketing, POS, or backend). You will configure a pass template, call the API to create a pass, then retrieve a link your customers can open to install it.
Real-world examples
* Create a loyalty card right after a signup form is completed.
* Generate event tickets after payment confirmation, then update them for seat changes.
* Create membership cards and update tier/expiry after each renewal.
## Prerequisites
Before proceeding, ensure you have the following:
1. **The Wallet Crew Platform Activated:** Your Wallet Crew account and platform should be active.
2. **API Key Generated:** Generate an API key from The Wallet Crew admin console ([API Key](https://docs.thewalletcrew.io/configure/platform/api-key)).
3. **Pass Type Template Configured:** Create and configure a pass type template in The Wallet Crew Wallet.
4. **Variables Assigned:** Assign variables in the pass type to match wallet fields in Apple and Google Wallet that will be populated via the API call.
{% hint style="info" %}
You’ll need two values at API call time: your `tenantId` (in the URL path) and your `passType` (template name).
{% endhint %}
## Step-by-Step Guide
### Step 1: Configure The Wallet Crew
1. **Create a Pass Type Template:**
* Navigate to the [Pass Type section](https://admin.thewalletcrew.io/tenant/~/passTypes){target="\_blank"|title="Pass Type"} in the admin console.
* Define a new pass type and configure fields as required.
2. **Define Variables:**
* Map variables to the pass type fields. **These variables will be populated by the API calls.**
3. **Generate an API Key:**
* [Access the API settings in the admin console](https://admin.thewalletcrew.io/tenant/~/settings/security/apiKeys){target="\_blank"|title="API Key"} and generate a key for authentication.
### Step 2: Access the API
1. **Connect to Swagger UI or Postman Collection:**
* Swagger URL: [The Wallet Crew Swagger UI](https://admin.thewalletcrew.io/api/swagger/index.html)
2. **Authenticate Using the API Key:**
* Add the API key to the `X-API-KEY` header of your requests.
* Click **Authorize**, then enter your API key (for example, in Swagger).
### Step 3: Create a Pass via API
1. **Test the `POST` Method:**
* Endpoint: `POST /api/{tenantId}/passes?passType={passType}`
* Required Parameters:
* `tenantId`: Your tenant identifier (in the URL path).
* `passType`: The template name you created (query parameter).
* Request Body:
* Select application/json format:
{% hint style="info" %}
For the complete request/response schema, see the [Pass API reference](https://docs.thewalletcrew.io/develop/guides/wallet/broken-reference).
{% endhint %}
* Example:
2. **Successful Response:**
* You will receive a `passId` in the response. Example:
### Step 4: View or Download the Pass
1. **Admin Console:**
* Go to the Wallet section and filter by `passId` to view, edit, or download the pass.
2. **Pass URL:**
* A common approach is to redirect users to a hosted view page: `GET /api/{tenantId}/passes/{passId}/view`.
* Use the QR code to add the pass to Apple Wallet or Google Wallet.
## Tips and Best Practices
1. **Examples for Different Pass Types:**
* **Loyalty Card:**
```json
{
"identifiers": {"customerId": "12345"},
"additionalData": {"points": 150}
}
```
* **Event Ticket:**
```json
{
"identifiers": {"eventId": "concert2024"},
"additionalData": {"seat": "A12"}
}
```
* **Coupon:**
```json
{
"extensions": {"couponCode": "DISCOUNT10"}
}
```
2. **Testing:**
* Always test API calls in a staging environment before going live.
* Staging url:
3. **Error Handling:**
* Ensure proper handling of API errors, such as authentication failures or invalid parameters.
## FAQ
Should I use Authorization or X-API-KEY?
Use `X-API-KEY`. This is the API key header used by The Wallet Crew API reference.
What is passType?
`passType` is the template name you created in The Wallet Crew. It controls design and which variables are available on the pass.
What should I store on my side?
Store the returned `passId`. It is the stable identifier you will use to retrieve, update, or notify the same pass later.
## Conclusion
Creating passes via The Wallet Crew API enables seamless integration with third-party systems and enhances the user experience. By following this guide, you can configure The Wallet Crew, create and manage passes, and retrieve them efficiently. For more advanced use cases, explore additional articles in the Knowledge Base.
---
# Agent Instructions: 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:
```
GET https://docs.thewalletcrew.io/develop/guides/wallet/how-to-create-passes-via-api-in-the-wallet-crew.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.