Skip to main content

Check if the username is registered (queryUserNameStatus)

The queryUserNameStatus API is used to verify if a username is already registered with LI PASS.

Request parameters

ParametersTypeDescriptionNote
user_namestringUsername for loginRequired

Request sample

accountApi.queryUserNameStatus(
{
user_name:'xxx',
}
).then((res) => {
console.log(res);
});

Response parameters

ParametersTypeDescription
retnumberReturn code
0: Request successful
!=0: Request failed, refer to msg for detailed results
msgstringResult Explanation
seqstringSequence number of the data stream message
username_availablestringUsername availability
0: Unavailable
1: Available

Response sample

{
msg: "Success",
ret: 0,
seq: "1638239867-0180225865-009373-0000002944",
username_available: 1,
}