Skip to main content
POST
请求 OTP 验证码

授权

Authorization
string
header
必填

会话 JWT(来自注册/登录)或 API key(pk_...)。 也接受 X-API-Key: <token> 作为替代请求头。

请求体

application/json
action
enum<string>
必填
可用选项:
login,
payout,
crypto_withdrawal,
transfer,
banking_operation,
card_reveal,
api_key_create,
member_add,
phone_change
channel
enum<string>

可选的发送渠道。若省略,服务器将根据成员的 OTP 偏好解析渠道,并以组织默认值为后备。值不区分大小写。

可用选项:
sms,
whatsapp,
email,
totp

响应

挑战已创建;验证码正在发送。解析后的 channel 及其掩码后的目标(phone)会在响应体中返回。

challenge_id
string<uuid>
account_id
string<uuid>
action
enum<string>
可用选项:
login,
payout,
crypto_withdrawal,
transfer,
banking_operation,
card_reveal,
api_key_create,
member_add,
phone_change
channel
enum<string>
可用选项:
sms,
whatsapp,
email,
totp
phone
string

验证码发送到的掩码目标(手机号或邮箱),TOTP 则为 authenticator_app。

status
enum<string>
可用选项:
pending,
verified,
consumed,
expired
created_at
string<date-time>
expires_at
string<date-time>
verified_at
string<date-time>
consumed_at
string<date-time>