Version 2.1.1792967583 · latest Download OpenAPI Markdown

Verification codes

No authentication needed. Sends email or SMS codes for binding at registration, password reset and second-factor login; SMS needs a captcha.

verify-codesUser accountsAuthentication: No auth1 endpoints

Send verification code

POST/api/v2/verify-codes
Authentication: No auth

Request body application/json

FieldTypeRequiredDescription
accountstring— Login name (required for login)
captcha_codestring— Characters shown in the captcha image (required when sending SMS)
captcha_idstring— Captcha id (required when sending SMS)
channelstringRequired Delivery channel: email or sms
Values ["email","sms"]
purposestringRequired Purpose: bind (registration or rebinding), reset_password, or login (second factor)
Values ["bind","reset_password","login"]
targetstring— Email or phone number (required for bind and reset_password)

Verification codes object

FieldTypeRequiredDescription
accountstring— Login name (required for login)
captcha_codestring— Characters shown in the captcha image (required when sending SMS)
captcha_idstring— Captcha id (required when sending SMS)
channelstringRequired Delivery channel: email or sms
Values ["email","sms"]
expires_ininteger— Validity in seconds
purposestringRequired Purpose: bind (registration or rebinding), reset_password, or login (second factor)
Values ["bind","reset_password","login"]
resend_ininteger— Seconds before the code can be resent
targetstring— Email or phone number (required for bind and reset_password)
tostring— Masked recipient address