Customer
Member APIs reference
Summary
Get the user's basic profile information: their SkyJoyID, information, and balance
Methods
Customer Info
GET
https://api.skyjoy.vn/api-user/partner/v1/user-profile/{skyjoyId}
Path Parameters
skyjoyId*
string
Headers
Authorization*
string
Bearer <YOUR_ACCESS_TOKEN>
Content-Type*
string
application/json
{
"statusCode": 200,
"message": "SUCCESS",
"data": {
"skyjoyId": "SJ3609438573",
"dateOfBirth": "01-01-1990",
"dateOfJoin": "17-01-2023",
"email": "[email protected]",
"firstName": "NGUYEN VAN",
"lastName": "A",
"fullName": "NGUYEN VAN A",
"eKycStatus": "COMPLETE",
"status": "ACTIVE",
"phone": "+84979921380"
}
}
curl -X GET \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
'https://api.skyjoy.vn/api-user/partner/v1/user-profile/{skyjoyId}'
Customer Profile
GET
https://api.skyjoy.vn/api-user/partner/v1/user-profile-ext/{skyjoyId}
Path Parameters
skyjoyId*
string
Headers
Authorization*
string
Bearer <YOUR_ACCESS_TOKEN>
Content-Type*
string
application/json
{
"statusCode": 200,
"message": "SUCCESS",
"data": {
"enrollingSponsor": "SkyJoy",
"passportNumber": "P0XXXXXXX1",
"nationalId": "N0XXXXXXXX1",
"tierClass": "Diamond",
"skyjoyId": "SJ3609438573"
}
}
curl -X GET \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
'https://api.skyjoy.vn/api-user/partner/v1/user-profile-ext/{skyjoyId}'
Customer Lookup
GET
https://api.skyjoy.vn/api-user/partner/v2/user/lookup
Query Parameters
skyjoyId*
string
Required if documentId
is not present
documentId*
string
Required if skyjoyId
is not present
Headers
Authorization*
string
Bearer <YOUR_ACCESS_TOKEN>
Content-Type*
string
application/json
{
"statusCode": 200,
"message": "SUCCESS",
"data": {
"skyjoyId": "SJ0123456789",
"phone": "+84987654321",
"dateOfBirth": "01-01-1990",
"dateOfJoin": "17-01-2023",
"email": "[email protected]",
"firstName": "NGUYEN VAN",
"lastName": "A",
"fullName": "NGUYEN VAN A",
"eKycStatus": "COMPLETE" // COMPLETED, INCOMPLETE
}
}
curl --location 'https://api.skyjoy.vn/api-user/partner/v2/user/lookup?documentId=083182018655' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJMTnZVMjFKb0JSNkhXTmJMMkFZWkNiQ0lrVjdwRVIzb18wcnZTa1FMSnNnIn0.eyJleHAiOjE3NTM5MzE4ODUsImlhdCI6MTc1MTMzOTg4NSwianRpIjoiOTI4YzY0ZTEtM2RiOC00YTY4LWEwZWItZGZhNzZiMDk0ZjY3IiwiaXNzIjoiaHR0cHM6Ly9pZC51YXQuc2t5am95LmlvL3JlYWxtcy9sb3lhbHR5LXBhcnRuZXIiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiMGY0OTUwN2EtYzU4Zi00MWYwLWE0NmMtOTgxZjBkN2Y5NDgzIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiNGQ2ZjBkZWYtZDBmNy00NTBiLTkwNTktNTVmOGJlYTk3OWFiIiwic2Vzc2lvbl9zdGF0ZSI6IjFlNzIxOGZiLWJiNzAtNDMwNC05YTRkLTAyMjBlZTk0ODJiMyIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiIsImRlZmF1bHQtcm9sZXMtbG95YWx0eS1wYXJ0bmVyIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJlbWFpbCBwcm9maWxlIiwic2lkIjoiMWU3MjE4ZmItYmI3MC00MzA0LTlhNGQtMDIyMGVlOTQ4MmIzIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJuYW1lIjoiVmlra2kgUGFydG5lciIsInByZWZlcnJlZF91c2VybmFtZSI6ImJlX3Zpa2tpX3BhcnRuZXIiLCJnaXZlbl9uYW1lIjoiVmlra2kiLCJmYW1pbHlfbmFtZSI6IlBhcnRuZXIifQ.s-E5qvXLjXFmmIqXudLFIKHo_MOiw0Gc-CwmZAzYL0Ph2kRYfNrUOz-IYtGf-OMSn62Opr-15VoMiCIstNBxbICovT7NDm9Tj37vPen386p7UIJOA92UOwEfCmvtqJY_cG2wj1mUYSeha-C8e_KnhdepS8geu4RR4iBx-i6yDCwu9ssDPLz-YglXCkMPMh3OomVebVikGmMtLV-u5oeLcsPu92priK_bYRgkqqiRn92AQF6YEhi15SxI5hYw_-IESMjzIcnnthvtMeID9kVsL2i59geOznARbm521cToCNlldvdqrQ02jOW02d_lpJpQ7KUKH17G4kaXDwTmm1MXBg'
User Onboarding
POST
https://api.skyjoy.vn/api-user/partner/v1/user/onboard
Headers
Authorization*
string
Bearer <YOUR_ACCESS_TOKEN>
Content-Type*
string
application/json
Request Body
phone*
string
Phone number
fullName*
string
Full name
firstName
string
First name
lastName
string
Last name
gender*
string
Gender choose from [male, female, other]
birthday*
string
Birthday in ISO8601 format (YYYY-MM-DD)
string
Email address
isKYC*
boolean
Is KYC or not
idNumber*
string
ID number that is used for eKYC Required if passportNumber is null
passportNumber*
string
Passport number that is used for eKYC Required if idNumber is null
placeOfIssue*
string
Place of issue in eKYC document
placeOfBirth*
string
Place of birth in eKYC document
issueDate*
string
Identity Card or Passport issue date in ISO8601 format (YYYY-MM-DD)
expireDate*
string
Identity Card or Passport expire date in ISO8601 format (YYYY-MM-DD)
nationality*
string
Country code in ISO 3166-1 alpha-3 format
address*
string
Address in eKYC document
externalId*
string
Unique partner member ID
{
"statusCode": 200,
"message": "SUCCESS",
"data": {
"phone": "+84387255954",
"fullName": "Nguyen Van A",
"firstName": "Van A",
"lastName": "Nguyen",
"memberCode": "SJ0123456789",
"createdAt": "2024-02-21T08:29:21.686Z"
}
}
curl -X POST \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
-d '{"phone":"+84387255954","fullName":"Nguyen Van A","firstName":"Van A","lastName":"Nguyen","gender":"Nguyen","memberCode":"SJ84387255954","birthday":"1970-01-01","email":"[email protected]","isKYC":"true","idNumber":"0123456789","passportNumber":"0123456789","placeOfIssue":"CQLTTVHCXH","placeOfBirth":"Sai Gon","issueDate":"2023-08-09","expireDate":"2033-08-09","nationality":"VNM","address":"Q8, HCM, Viet Nam","externalId":"41987712"}' \
'https://api.skyjoy.vn/api-user/partner/v1/user/onboard'
Customer Balance
GET
https://api.skyjoy.vn/api-point/partner/v1/user-balance/{skyjoyId}
Path Parameters
skyjoyId*
string
Headers
Authorization*
string
Bearer <YOUR_ACCESS_TOKEN>
Content-Type*
string
application/json
{
"statusCode": 200,
"message": "SUCCESS",
"data": {
"skyjoyId": "SJ5408563422",
"totalPoint": 964
}
}
curl -X GET \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
'https://api.skyjoy.vn/api-point/partner/v1/user-balance/{skyjoyId}'
Link Account
POST
https://api.skyjoy.vn/api-user/partner/v1/user/link-member
Headers
Authorization*
string
Bearer <YOUR_ACCESS_TOKEN>
Content-Type*
string
application/json
Request Body
skyjoyId*
string
SkyJoy member ID
partnerMemberId*
string
Partner unique member ID
{
"statusCode": 200,
"message": "SUCCESS",
"data": {
"phone": "+84123456789",
"skyjoyId": "SJ0123456789"
}
}
curl -X POST \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
-d '{ "skyjoyId": "SJ2055871926", "partnerMemberId": "VK084282" }' \
'https://api.skyjoy.vn/api-user/partner/v1/user/link-member'
Unlink Account
POST
https://api.skyjoy.vn/api-user/partner/v1/user/unlink-member
Headers
Authorization*
string
Bearer <YOUR_ACCESS_TOKEN>
Content-Type*
string
application/json
Request Body
skyjoyId*
string
SkyJoy member ID
partnerMemberId*
string
Partner unique member ID
{
"statusCode": 200,
"message": "SUCCESS",
"data": true
}
curl -X POST \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
-d '{ "skyjoyId": "SJ2055871926", "partnerMemberId": "VK084282" }' \
'https://api.skyjoy.vn/api-user/partner/v1/user/unlink-member'
Last updated
Was this helpful?