memberShortcode Call

Description

Purpose

This endpoint provides operations to send, retrieve, or generate a temporary identification code for a member. These codes are used to secure member identification in various channels, such as SMS, email, or partner integrations.

When to Use

• When a member logs into online or self-service solutions and requires a secure identification method
• When an external source needs to display or generate a code or token for secure identification

📝 Notes

• If a member identifier (phone number or email) is provided, a temporary code will be sent to the member
• The code can be sent via SMS/email or displayed (e.g., QR)
• Only one identifier (phone or email) should be provided
• This code can later be used in endpoints such as getMemberDetails for verification

Request Format

Headers

Name	Type	Required	Description
x-source-type	string	✅	Source type (POS, Web, etc.)
x-source-name	string	✅	Name of the client system or integration
x-pos-id	string	✅	Unique POS terminal ID
x-branch-id	string	✅	Branch/location identifier

Body

{
  "member": {
    "phoneNumber": "123456789"
  },
  "action": "send"
}

• member: Member identifier (phone or email) – only one required
• action: One of send, get, or verify

Response Format

{
  "status": "success",
  "data": {}
}

Error Example

{
  "status": "error",
  "error": {
    "code": "MEMBER_NOT_FOUND",
    "message": "Member not found",
    "details": {
      "phoneNumber": "123456789"
    }
  }
}

Related Use Cases

• Logging into kiosks or mobile apps using short codes
• Verifying member identity securely before transactions
• Integrating with third-party systems for authentication