Check an Email

Checks whether an email address is available.

Request URL

GET {base_url}/uc-user/api/v1/users/check-email

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
Query parameters
Parameter Required Type Description
email Yes String The email address to check.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Boolean Whether the email address is available. true indicates that the email address is available, and false indicates that the email address is already taken.

Example

Request example

GET /uc-user/api/v1/users/check-email?email=aitdoc-b2-new@mailstar.top HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwiYXBwX2tleSI6Im9icWJUSWd1ZkJ5d3ZCNmF0VURmVDZpeDJvUlhUb0wzIiwiZ3JhbnRfdHlwZSI6Im9wZW5hcGkiLCJjbGllbnRfZXh0Ijp7ImRlc2NyaXB0aW9uIjoi56ys5LiJ5pa55ZCI5L2c5LyZ5Ly05bqU55SoIiwicGFydG5lciI6IuekuuS-i-WQiOS9nOS8meS8tCJ9LCJjbGllbnRfdHlwZSI6Im9wZW5hcGkiLCJleHAiOjE3OTIwNzU4MzksImlhdCI6MTc5MjA1NDIzOSwianRpIjoiNmIxNTdhMTItOTc3Mi00ZTQ3LWIzNDEtZGMzMzhlMzcwYWFkIiwiY2xpZW50X2lkIjoibm92by1vcGVuLXBsYXRmb3JtIiwidXNlcl9leHQiOnsicm9sZUlkcyI6WzNdLCJzdHlwZSI6IkFETUlOIiwidGVuYW50Q29kZSI6bnVsbCwidHlwZSI6IlBfQUNDT1VOVCIsInVzZXJJZCI6MjA4NTMxNTk0ODg0OTgyNzg0MiwiZW1haWwiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidXNlcm5hbWUiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidWNJZCI6MjA4NTMxNTk0ODI4Nzc5MTEwNn19.bayAAcd25Y7rW9a0eWF0uHP6IBJHaiG5PfnclIIB-JOHY-WVQM_zGlBe8EinHuvzpvDnF9VtPtW_5VN_RvYCmRFjxRtHU8ygl-ktznZpqtMZSAmXeBnJJkhCzPeM6eS7mF29dk5l016E2PUiDgXqsG5ZS-e_r1SCaNHdqLik60AQDoyiKVT7hDTSaXaVqD2NmDdjm3S2-hClC8VB0NdnPot0qd-Kv6CrVDnZ5TuMdAQ0cm_qG81PLxB4To4kwqyi_G2LBcYiqoFfZXK6BMJo2_N4xP7bEvcZ5HT1Qy2s1yW42jk5kkvjfhUFfrvZcswoFuuLuw870ngG_ahD95xV7A

Response example

HTTP/1.1 200 OK
{
  "result": true,
  "requestId": "25713109e088e79ce6206183d6fd7ad6",
  "code": "200",
  "message": "SUCCESS"
}