QueryMemberProfile
Function
Query Member Profile
Endpoint
- /v1/member/profile
HTTP Method
- POST
Request Headers
- Authorization: Bearer {token}
- X-App-Key: {appKey}
Request Payload
- query with memberId
{
"searchType": "memberId",
"searchValue": "xxx"
}
- query with email
{
"searchType": "email",
"searchValue": "email@example.com"
}
- query with mobile
{
"searchType": "mobile",
"searchValue": "88888888",
"countryCode": "852"
}
- query with kdp member number
{
"searchType": "kdp",
"searchValue": "kdp member number"
}
Request Parameters
| Field | Required | Type | Remark | Sample |
|---|---|---|---|---|
| searchType | Yes | string | Search Type: memberId、email、mobile、kdp | mobile |
| searchValue | Yes | string | Search Value | 88888888 |
| countryCode | No | string | phone country code | 852 |
Response Payload
{
"status": 1,
"errorCode": 0,
"message": "success",
"memberId":"xxx",
"title": "Dr",
"languagePreference": "en",
"nickname": "",
"firstname": "",
"lastname": "",
"chineseName": "",
"kdpMemberNumber":"10012275255"
}
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 | ||
| memberId | Yes | string | memberId | |
| title | No | string | title | Dr |
| languagePreference | No | string | languagePreference | en |
| firstname | No | string | firstname | |
| lastname | No | string | lastname | |
| chineseName | No | string | chineseName | |
| kdpMemberNumber | No | string | kdp member number | 10012275255 |
Error Codes
| Status Code | Status Description |
|---|---|
| 1 | Internal Error |
| 3 | Missing Parameter |
| 4100 | Member not found |
| 4199 | Member Inactive |