Skip to main content

registerMember Call

Description​

Purpose​

This API call allows you to register new members into the loyalty program.

When to Use​

  • When a user opts into the loyalty program
  • When a customer is signing up via POS, kiosk, or online interface

Notes​

  • The member may automatically receive an SMS or email to complete registration or accept Terms & Conditions
  • Use at first customer contact to ensure all communication permissions are captured

Request Format​

Headers​

NameTypeRequiredDescription
x-source-typestring✅Type of source making the API call (POS, Web, etc.)
x-source-namestring✅Name of the client or integration system
x-pos-idstring✅Unique POS terminal ID
x-branch-idstring✅Identifier for the business branch/location

Body​

{
  "newMemberData": {
    "phoneNumber": "1234567890",
    "email": "member@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "allowedSMS": true,
    "allowedEmail": true,
    "termsOfUse": true,
    "gdpr": true,
    "birthday": "1990-01-01"
  }
}

Response Format​

Success Example​

{
  "status": "success",
  "data": {
    "member": {
      "phoneNumber": "1234567890",
      "email": "member@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "allowedSMS": true,
      "allowedEmail": true,
      "termsOfUse": true,
      "gdpr": true,
      "birthday": "1990-01-01"
    }
  }
}

Error Example​

{
  "status": "error",
  "error": {
    "code": "BAD_REQUEST",
    "message": "Missing required field: phoneNumber"
  }
}
  • Customer registration at POS or kiosk
  • Online sign-up for loyalty program
  • Capturing communication and GDPR consent upon registration