Register Loyalty Member

Register a new loyalty member under the merchant. Returns the new member's profile record.

When to Use

▾

Use this endpoint when:

• Onboarding a new customer to your loyalty program
• Registering a member during checkout flow

How to Use

▾

Endpoint

POST/v3/loyalty/member

POST member details (name, country code, phone, email, NRIC, etc.) to create the record. The response includes the new member's key.

---

Request Parameters

▾

nameSTRINGrequired

Member name

Example: "Oska"

countryCodeSTRINGrequired

Country code of member contact number

Example: "60"

phoneNumberSTRINGrequired

Phone number of member

Example: "1878241234"

emailSTRINGrequired

Email address of member

Example: "[email protected]"

nricSTRINGrequired

IC Number

Example: "950711011234"

birthDateSTRINGrequired

Member Birth Date

Example: "1995-07-11T00:00:00Z"

genderSTRINGrequired

Gender

Example: "MALE"

pointINTEGERrequired

Loyalty Point

Example: 0

addressOBJECTrequired

Refer to explanation below

Example: (Refer to explanation below)

Response Parameters

▾

itemOBJECT

Profile object

idSTRING

Profile ID

Example: "1784527845457513850"

nameSTRING

Profile name

Example: "Oska"

emailSTRING

Profile email

Example: "[email protected]"

nricSTRING

IC Number

Example: "950711011234"

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

stateSTRING

Member state (empty if not set)

Example: ""

referralCodeSTRING

Member's referral code (empty if not set)

Example: ""

birthDateSTRING

User Birth Date

Example: "1995-07-11T00:00:00Z"

loyaltyPointINTEGER

Loyalty point balance

Example: 0

creditINTEGER

Credit balance

Example: 0

countryCodeSTRING

Country code of member contact number

Example: "60"

phoneNumberSTRING

Phone number of member

Example: "1878241234"

profileImageURLSTRING

Member profile image URL

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

hasPinCodeBOOLEAN

User Pin

Example: false

memberTierSTRING

Member Tier Point

Example: null

statusSTRING

Profile Status

Example: "ACTIVE"

createdDateTimeDATETIME

Creation date time

Example: "2026-07-20T06:10:45.121999175Z"

codeSTRING

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

Example: "SUCCESS"