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?countryCode={countryCode}&phoneNumber={phoneNumber}

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: "1019317844027415630"

nameSTRING

Profile name

Example: "Oska"

emailSTRING

Profile email

Example: "[email protected]"

nricSTRING

IC Number

Example: ""

passportSTRING

Passport number (empty if not applicable)

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: ""

genderSTRING

Gender

Example: ""

stateSTRING

Member state (empty if not set)

Example: ""

referralCodeSTRING

Member's referral code (empty if not set)

Example: ""

birthDateSTRING

User Birth Date

Example: "2010-02-01T07:45:13Z"

loyaltyPointINTEGER

Loyalty point balance

Example: 12561

creditINTEGER

Credit balance

Example: 40

countryCodeSTRING

Country code of member contact number

Example: "60"

phoneNumberSTRING

Phone number of member

Example: "187824152"

profileImageURLSTRING

Member profile image URL

Example: "https://storage.googleapis.com/rm-sandbox-asset/img/avatar.png"

hasPinCodeBOOLEAN

User Pin

Example: true

memberTierOBJECT

Member tier details (null if not tiered)

keySTRING

Member tier key (internal usage)

Example: "EhQKCE1lcmNoYW50EJXVzd3wraqTORIdChFMb3lhbHR5TWVtYmVyVGllchCzz874m57FiRY"

labelSTRING

Member tier label

Example: "Diamond"

minimumPointINTEGER

Minimum loyalty point required for this tier

Example: 10000

descriptionARRAY

Member tier description

Example: ["Diamond"]

discountOBJECT

Tier discount details (null if none)

createdAtDATETIME

Tier creation date time

Example: "2020-05-28T03:55:21Z"

updatedAtDATETIME

Tier last update date time

Example: "0001-01-01T00:00:00Z"

statusSTRING

Profile Status

Example: "ACTIVE"

createdDateTimeDATETIME

Creation date time

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

codeSTRING

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

Example: "SUCCESS"