/member/shortCode

Overview

This endpoint is used to send, retrieve, or verify a short identification code associated with a member. These codes are used for secure identity confirmation across channels such as SMS, email, or embedded displays (e.g., kiosks, QR codes).

When to Use This Endpoint

Use this endpoint in the following cases:

• A member accesses a self-service solution and needs to verify their identity
• A partner system requires a secure one-time code for authentication
• You want to support short-code based logins without traditional credentials

Key Considerations

• Only one identifier must be sent: phoneNumber or email
• The action must be one of: "send", "get", or "verify"
• Codes may be delivered via SMS/email or displayed depending on the channel
• The same short code can later be validated through the /member/details endpoint

Request Details

Method & URL

POST /member/shortCode

See API Servers for the base URL to use in place of {{server}}.

Headers

Header	Type	Required	Description
x-api-key	string	Yes	API key for authentication
x-source-type	string	Yes	Origin of the request (POS, Web, etc.)
x-source-name	string	Yes	Name of the integration or client system
x-pos-id	string	Yes	Unique POS terminal identifier
x-branch-id	string	Yes	Branch or location identifier

Request Example

curl --location --request POST 'https://{{server}}/v1/member/shortCode' --header 'Content-Type: application/json' --header 'x-api-key: {{api-key}}' --header 'x-source-type: POS' --header 'x-source-name: kiosk_01' --header 'x-pos-id: POS001' --header 'x-branch-id: BR001' --data-raw '{
  "member": {
    "phoneNumber": "123456789"
  },
  "action": "send"
}'

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

Body

Field	Description	Type	Mandatory
member	Object representing the member identifier	Member	N
action	Action to be taken: send, get, or verify	string	Y

Success Response

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

Response

Field	Description	Type	Mandatory
status	Status of the response	string	Y
data	Returned data (if any)	object	N
error	Error object (for failed requests)	Error	N

Error Response Examples

Member Not Found

{
  "status": "error",
  "error": {
    "code": "203",
    "message": "Cannot find any member with the given identifier!"
  }
}

Invalid Phone Format

{
  "status": "error",
  "error": {
    "code": "1001",
    "message": "phoneNumber is not allowed",
    "path": "body.phoneNumber"
  }
}

Error Codes

Code	Description
203	Member not found
901	Invalid member object for the given action
902	Invalid or missing action
905	Error generating short code

Field Reference

Field	Type	Description
member.phoneNumber	string	Optional. Phone number of the member
member.email	string	Optional. Email of the member
action	string	Required. One of send, get, or verify

Related Use Cases

• Enabling login to kiosks, mobile apps, or web sessions with a short code
• Authenticating members prior to checkout or benefit redemption
• Connecting third-party systems to perform identity verification