Skip to content
Integration with Wellpass/
Wellpass check-in workflo...
Last updated

Wellpass check-in workflow

This guide provides a step-by-step workflow for integrating Wellpass corporate fitness memberships into your gym's check-in process. For comprehensive details on Wellpass integration, see the Wellpass integration guide.

What you'll learn

  • How to create Wellpass member accounts in your MMS
  • How to assign RFID cards to Wellpass members
  • How to validate check-ins 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 checks in at 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:

curl -i -X POST \
  https://one-mms-service.ext-1.test.co.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.

Common issues:

  • TAN conflict - If the TAN is already associated with a different account, see Conflict Resolution

Step 2: Assign RFID card

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

curl -i -X PUT \
  'https://one-mms-service.ext-1.test.co.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 check-ins

Every time a Wellpass member checks in, 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:

curl -i -X POST \
  'https://one-mms-service.ext-1.test.co.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 check-in; provide onboarding (gym tour, house rules, privacy policy)
  • Error codes - Specific reasons for denial (see error codes below)

Plus1 program

Most gyms accept Plus1 members - guests brought by Wellpass members. Check-in validation works the same for Plus1 guests as regular Wellpass members.

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

Step 4: Monitor expiring memberships

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

curl -i -X GET \
  'https://one-mms-service.ext-1.test.co.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 CodeMeaningAction
corporateFitnessMembershipExpiredMembership has endedDeny access; member should contact Wellpass
corporateFitnessMembershipNotStartedStart date is in the futureDeny access; inform member of start date
corporateFitnessGymNotInNetworkYour gym isn't a Wellpass partnerDeny access; membership not valid at your location
corporateFitnessGymNotInNetworkPlus1Your gym doesn't participate in Plus1Deny access for Plus1 guests

For complete error code details, see Error Codes documentation.

Best practices

  1. Always validate check-ins - 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
Previous page
Next page