Overview#
n general, when a client creates an E-pass or a Membership for their end users, DragonPass will automatically create a User in the backend. Each User is uniquely identified by the clientUserId.If the client continues to create additional E-pass or Membership records using the same clientUserId, all of them will be associated with the same User.After creating an E-Pass or registering a Membership, clients may need to modify user information (e.g., name, email address, phone number).This API provides a secure and efficient way to perform such updates. → Use the /users/update endpoint to update user details on the DragonPass platform.All E-Passes and Memberships under the same user will automatically use the updated information for all subsequent usage.
Update User Information - Request
{
"clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
"firstName": "DragonPass",
"lastName": "DragonPass",
"phoneNumber": "8081966002",
"callingCode": "44",
"email": "developer@dragonpass.com"
}
The response returns:
Update User Information - Response
{
"code": 0,
"data": {
"clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
"firstName": "DragonPass",
"lastName": "DragonPass",
"phoneNumber": "8081966002",
"callingCode": "44",
"email": "developer@dragonpass.com"
}
}
User Profile
clientUserId: U12345
E-Pass: 8888666600000001, 8888666600000002
Initial Information
First Name: John
Last Name: Smith
Action
The client calls the Update User Information API to change the name to John Wick.
Result
8888666600000001 → name updated to John Wick
8888666600000002 → name updated to John WickAll E-Passes under user U12345 will now use the new name for subsequent usage.
Retrieve User Information - Request
{
"clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A"
}
Retrieve User Information - Response
{
"code": 0,
"data": {
"clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
"firstName": "DragonPass",
"lastName": "DragonPass",
"phoneNumber": "8081966002",
"callingCode": "44",
"email": "developer@dragonpass.com",
"creationDate": "2028-12-31T23:59:59+00:00"
}
}
Retrieve User E-passes List#
→ Use the /users/ePasses endpoint to retrieve the list of E-passes associated with a specific user on the DragonPass platform.Retrieve User E-passes List - Request
{
"clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
"status": 1,
"pageSize": 10,
"pageNumber": 1
}
Retrieve User E-passes List - Response
{
"code": 0,
"data": {
"pagination": {
"pageSize": 10,
"pageNumber": 1,
"totalNumber": 2
},
"ePassesList": [
{
"module": 1,
"ePassId": "1788000066668888",
"status": 1
},
{
"module": 1,
"ePassId": "1788000066668888",
"status": 1
}
]
}
}
Retrieve User Memberships List#
→ Use the /users/memberships endpoint to retrieve the list of memberships associated with a specific user on the DragonPass platform.Retrieve User Memberships List - Request
{
"clientUserId": "3EF5D065-76F8-4D3E-801A-B329D15F461A",
"status": 1,
"pageSize": 10,
"pageNumber": 1
}
Retrieve User Memberships List - Response
{
"code": 0,
"data": {
"pagination": {
"pageSize": 10,
"pageNumber": 1,
"totalNumber": 2
},
"membershipsList": [
{
"membershipId": "8888000066668888",
"status": 1
},
{
"membershipId": "8888000066668880",
"status": 2
}
]
}
}
Delete A User#
→ Use the /users/delete endpoint to delete an existing user and their associated membership(s) or E-pass(es) from the DragonPass platform.Once DragonPass receives a user deletion request, all user information will be permanently deleted, and any membership(s) or E-pass(es) linked to the user will be delinked.This action is irreversible, please ensure the request is correct before proceeding.
