Skip to content
Last updated

Wellpass integration guide

This comprehensive guide explains how to integrate Wellpass (formerly Qualitrain) corporate fitness memberships with your gym's member management system. For a quick-start workflow overview, see the Wellpass check-in workflow guide.

Quick start vs comprehensive guide

New to Wellpass? Start with the Wellpass check-in workflow for a step-by-step walkthrough. This guide provides comprehensive technical details, edge cases, and advanced configuration options.

What is Wellpass?

Wellpass is a corporate fitness program that allows employees to access a network of gyms as part of their employer's health benefits. When a Wellpass member visits your gym, they need to be registered in your MMS and linked to their existing EGYM account using a verification TAN.

Key concepts

  • Wellpass members have existing EGYM accounts - They've already registered with Wellpass/EGYM
  • TAN (Temporary Access Number) - A 9-digit code that links your local gym account to the member's EGYM account
  • Corporate fitness membership - A special membership type (CORPORATE_FITNESS) with specific validation rules
  • Plus1 program - Allows Wellpass members to bring a guest; participation is optional per gym

Integration overview

Wellpass integration requires three key technical components:

  1. Account creation with TAN verification - Link local MMS accounts to existing EGYM accounts using a 9-digit TAN
  2. Corporate fitness membership type - Use membershipType: CORPORATE_FITNESS with special validation rules
  3. Check-in validation - Validate membership status at every gym entry

For the complete workflow, see the Wellpass check-in workflow guide.

Creating a Wellpass member account

When a Wellpass member visits your gym for the first time, they'll provide a TAN code. Use this code to create their account with the CORPORATE_FITNESS membership type.

Required field: verificationTAN

verificationTAN is mandatory for Wellpass

The verificationTAN field is required when creating or updating a member account with membershipType: CORPORATE_FITNESS. This 9-digit code uniquely identifies the Wellpass member and links their gym account to their existing EGYM account.

Example: Create Wellpass member account

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": "jane.doe@company.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "gender": "FEMALE",
    "membership": {
      "membershipId": "WP-12345",
      "membershipType": "CORPORATE_FITNESS",
      "verificationTAN": "123456789",
      "startOfContract": "2024-01-15"
    }
  }'

Important notes:

  • membershipType must be CORPORATE_FITNESS
  • verificationTAN is the 9-digit code from the Wellpass app or website
  • Member can retrieve their TAN from the Wellpass mobile app or account settings
  • The TAN is short-lived and used only during account creation
  • Save the returned accountId for future operations
  • startOfContract is still required field, but could be used as starting date of Wellpass member in a gym

Understanding corporateFitness data

When you retrieve a Wellpass member account, the response includes a corporateFitness object with additional membership details.

CorporateFitness fields

The corporateFitness object is read-only and returned automatically for accounts with membershipType: CORPORATE_FITNESS:

{
  "accountId": "f756ae43-c932-5a02-b42b-b4752f73er12",
  "email": "jane.doe@company.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "membership": {
    "membershipId": "WP-12345",
    "membershipType": "CORPORATE_FITNESS",
    "startOfContract": "2024-01-15",
    "corporateFitness": {
      "startTimestamp": "2024-02-01T00:00:00Z",
      "endTimestamp": "2024-12-31T23:59:59Z"
    }
  }
}

Field descriptions:

  • startTimestamp - When the corporate fitness membership begins (if in the future). Not returned for active/past memberships.
  • endTimestamp - When the corporate fitness membership ends (if defined). Used to identify expiring memberships.
corporateFitness vs startOfContract
  • membership.startOfContract is the date the member joined your gym
  • corporateFitness.startTimestamp is when their Wellpass membership becomes active (may be different)
  • corporateFitness.endTimestamp is when their Wellpass benefit ends
Previous page
Next page