003-GetMemberProfile

Function

Query Member Profile

Endpoint

• /v1/loyalty/profile

HTTP Method

• GET

Request Headers

• Authorization: Bearer {token}
• X-App-Key: {appKey}

Query Param

Field	Required	Type	Remark	Sample
ssoId	N	string	Unique identifier associated with the user data stored in SSO
emailId	N	string	Email id entered by the user
countryCode	N	string
mobileNo	N	string
memberId	N	string

Response Payload

{
  "status": 1,
  "message": "success",
  "errorCode": 0,
  "ssoId": "ssoId",
  "emailId": "emailId@example.com.cn",
  "mobileNo": "88888888",
  "memberId": "memberId",
  "title": "Dr",
  "name": "Test Name",
  "campaignCode": "",
  "nickname": "",
  "monthOfBirth": "01",
  "yearOfBirth": "2001",
  "dayOfBirth": "08",
  "referralCode": "",
  "languagePreference": "zh_HK",
  "activityInterest": [
    {
      "interestCode": "SPE"
    }
  ],
  "countryCode": "852",
  "eNewIndicator": true,
  "firstname": "",
  "lastname": "",
  "openIdUUID": "",
  "chineseName": "測試",
  "residentialArea": "",
  "province": "",
  "district": "",
  "childProfiles": [
    {
      "emailId": "emailId@example.com.cn",
      "mobileNo": "88888888",
      "dayOfBirth": "01",
      "monthOfBirth": "01",
      "yearOfBirth": "2024",
      "countryCode": "852",
      "firstname": "Name",
      "lastname": "Test",
      "childId": "CHILD00000001"
    }
  ]
}

Response

Field	Required	Type	Remark	Sample
status	Yes	number	status code of the api call, 1=success, 0=fail
message	Yes	string	detail message of the api call
errorCode	No	number
ssoId	No	string	Unique identifier associated with the user data stored in SSO
emailId	No	string	Email id entered by the user
mobileNo	No	string	Mobile No. without country code entered by the user, for example: 88888888	88888888
memberId	No	string	memberId
title	No	string
name	No	string	Full name of the user
campaignCode	No	string
nickname	No	string	Nick Name of the user
yearOfBirth	No	string
monthOfBirth	No	string
dayOfBirth	No	string	Birthday day of the user, with DD format
referralCode	No	string
languagePreference	No	string
activityInterest	No	Array		[{"interestCode":"SPE"}]
countryCode	No	string		852
eNewIndicator	No	string
firstname	No	string
lastname	No	string
openIdUUID	No	string
chineseName	No	string
residentialArea	No	string
province	No	string
district	No	string
childProfiles	No	array	child profile info
childProfiles.emailId	No	string
childProfiles.mobileNo	No	string
childProfiles.yearOfBirth	No	string
childProfiles.monthOfBirth	No	string
childProfiles.dayOfBirth	No	string
childProfiles.countryCode	No	string
childProfiles.firstname	No	string
childProfiles.lastname	No	string
childProfiles.childId	No	string

Error Codes

Status Code	Status Description
1	Internal Error
2	Member does not Exist
3	Missing Parameter
4	Invalid Input: [field name]
4100	Member not found
4199	Member Inactive