# Wellpass Admission: Get started

This guide provides a step-by-step workflow for integrating Wellpass corporate fitness memberships into your gym's admission process. For more detail, see the [Wellpass Admission overview](/wellpass/admission/overview).

Integration requests
Given our limited capacity for onboarding new partners, we cannot guarantee that every partner can be connected on this flow. Applications may take a while to be screened and prioritised. Submit a partner inquiry through the [partner contact form](https://docs.google.com/forms/d/e/1FAIpQLSceIzvFniqwIG97dgG2YkYqZO5uu3JLO9pmGCzNFK6OMaF4Vw/viewform).

## What you'll learn

- How to create Wellpass member accounts in your MMS
- How to assign RFID cards to Wellpass members
- How to validate admissions for corporate fitness memberships
- How to identify expiring Wellpass memberships


## Workflow overview

```
Wellpass member visits gym
         ↓
Staff creates account with TAN
         ↓
Staff assigns RFID card
         ↓
Member presents their credential at the turnstile
         ↓
MMS validates corporate fitness membership
         ↓
Access granted/denied
```

## Step 1: Create Wellpass member account

When a Wellpass member visits your gym for the first time, they'll provide a **TAN (Temporary Access Number)** - a 9-digit code that links their gym account to their existing EGYM account. The member can retrieve their TAN from the Wellpass mobile app or their account settings on the Wellpass website.

Create the member account with `membershipType: CORPORATE_FITNESS` and include the TAN:

```shell curl
curl -i -X POST \
  https://mms.api.ed.ts.egym.coffee/api/v2/accounts \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "email": "member@company.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "FEMALE",
    "membership": {
      "membershipId": "WP-12345",
      "membershipType": "CORPORATE_FITNESS",
      "verificationTAN": "123456789",
      "startOfContract": "2024-01-15"
    }
  }'
```

TAN is required
The `verificationTAN` field is **mandatory** for Wellpass members. Without it, the account cannot be linked to the member's existing EGYM profile. The TAN is required to link the accounts. You do not need to store it after the accounts are linked.

**Common issues:**

- **TAN conflict** - If the TAN is already associated with a different account, see [Conflict Resolution](/mms-api-v2/tutorials/conflicts-resolution#409-wellpass-tan-conflict)


## Step 2: Assign RFID card

After creating the account, assign an RFID card to the Wellpass member just like you would for regular members:

```shell curl
curl -i -X PUT \
  'https://mms.api.ed.ts.egym.coffee/api/v2/accounts/{accountId}/rfids' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "rfids": [
      {
        "rfid": "string",
        "tagFormat": "HITAG1"
      }
    ]
  }'
```

The member will use this RFID card to check in at your gym's turnstile and access lockers.

## Step 3: Validate admission

Every time a Wellpass member enters, your MMS **must** validate their corporate fitness membership status. This ensures:

- The membership hasn't expired
- Your gym is in the Wellpass network
- Plus1 guests are authorized (if applicable)


Use the member admission validation endpoint:

```shell curl
curl -i -X POST \
  'https://mms.api.ed.ts.egym.coffee/api/v2/accounts/{accountId}/admissions' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
```

**Important response fields:**

- **Success (200)** - Member can access the gym
- **`firstAdmission: true`** - This is the member's first admission; provide onboarding (gym tour, house rules, privacy policy)
- **Error codes** - Specific reasons for denial (see error codes below)


### Admission after Wellpass app verification

Some gyms require Wellpass members to check in with the Wellpass app before they scan their RFID card. Where this is switched on,
an admission request for a member without a recent app check-in is denied with error code `admissionDeniedInAppCheckinRequired`, and your MMS must keep the door closed.
The member can open the Wellpass app, check in, and scan again.

EGYM switches this on per gym. Handle the error code even if none of your gyms use it yet.

### Plus1 program

Most gyms accept Plus1 members, guests brought by Wellpass members. Admission validation works the same for Plus1 guests as regular Wellpass members.

If your gym doesn't participate in the Plus1 program, Plus1 admissions will be denied with error code `corporateFitnessGymNotInNetworkPlus1`.

## Step 4: Monitor expiring memberships

Proactively identify Wellpass members whose corporate fitness benefits are ending soon:

```shell curl
curl -i -X GET \
  'https://mms.api.ed.ts.egym.coffee/api/v2/accounts/corporate-fitness?endDateFrom=2022-09-22&endDateTo=2022-09-23' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
```

This allows you to:

- Offer regular gym memberships to members whose benefits are ending
- Resume any paused regular memberships
- Update access to your branded member app


**Best practice:** Query weekly for memberships ending in the next 30 days.

## Wellpass error codes

Your integration must handle these corporate fitness-specific error codes:

| Error Code | Meaning | Action |
|  --- | --- | --- |
| `corporateFitnessMembershipExpired` | Membership has ended | Deny access; member should contact Wellpass |
| `corporateFitnessMembershipNotStarted` | Start date is in the future | Deny access; inform member of start date |
| `corporateFitnessGymNotInNetwork` | Your gym isn't a Wellpass partner | Deny access; membership not valid at your location |
| `corporateFitnessGymNotInNetworkPlus1` | Your gym doesn't participate in Plus1 | Deny access for Plus1 guests |
| `admissionDeniedInAppCheckinRequired` | Gym requires an in-app Wellpass check-in | Deny access; ask the member to check in via the Wellpass app, then scan again |


For complete error code details, see [Error Codes documentation](/mms-api-v2/errors).

## Best practices

1. **Always validate admissions** - Don't skip the admission validation endpoint for Wellpass members
2. **Handle first admission** - Provide onboarding when `firstAdmission: true`
3. **Monitor expiring memberships** - Set up automated weekly reports
4. **Train staff** - Ensure staff understand the TAN requirement and Plus1 rules
5. **Display clear error messages** - Translate API error codes into user-friendly messages


## Related resources

- [Wellpass Admission overview](/wellpass/admission/overview) - Wellpass membership integration details
- [Conflict Resolution](/mms-api-v2/tutorials/conflicts-resolution#409-wellpass-tan-conflict) - Handling TAN conflicts
- [Error Codes](/mms-api-v2/errors) - Complete error code reference
- [EGYM Member Account Concept](/mms-api-v2/member-account-concept) - Understanding account structure
- [Wellpass Admission API reference](/wellpass/admission/api-reference) - Relevant MMS API V2 operations