Get Profile

Retrieve a loyalty member's full profile — name, contact, tier, loyalty point balance, and credit balance — by their phone number.

When to Use

▾

Use this endpoint when:

• Displaying a member's profile and point balance
• Looking up a member before applying loyalty discounts

How to Use

▾

Endpoint

GET/v3/loyalty/me

GET with countryCode and phoneNumber as query parameters.

---

Request Parameters

▾

Pass countryCode and phoneNumber as query parameters.

Response Parameters

▾

itemOBJECT

Profile object

idSTRING

Profile ID

Example: ""

keySTRING

Profile Key (Internal Usage)

Example: "EhIKBk1lbWJlchDOuOKz24XWkg4SGQoNTWVtYmVyUHJvZmlsZRDl-MTxiPOPjzY"

nameSTRING

Profile name

Example: "yussuf"

emailSTRING

Profile email

Example: "[email protected]"

nricSTRING

IC Number

Example: ""

birthDateSTRING

User Birth Date (YYYY:MM:DD)

Example: "0001-01-01"

genderSTRING

Gender

Example: ""

addressOBJECT

Refer to explanation below

addressLine1STRING

Address 1

Example: ""

addressLine2STRING

Address 2

Example: ""

postcodeSTRING

Postcode

Example: ""

citySTRING

City

Example: ""

stateSTRING

State

Example: ""

countrySTRING

Country

Example: ""

memberTierSTRING

Member Tier Point

Example: null

totalLoyaltyPointINTEGER

Total Loyalty Point

Example: 0

hasPinCodeBOOLEAN

User Pin

Example: false

loyaltyPointBalanceINTEGER

Total Point Balance left

Example: 0

spendingPointINTEGER

Point Spend

Example: 0

creditBalanceINTEGER

Credit Balance

Example: 10160

statusSTRING

Profile Status

Example: "ACTIVE"

createdAtDATETIME

Creation date time

Example: "2018-10-19T03:39:47Z"

updatedAtDATETIME

Last update date time

Example: "2020-06-29T10:14:33Z"

codeSTRING

Successfully call this endpoint. If fail, will return error code object (Refer Appendix 1: Error Codes)

Example: "SUCCESS"