跳到主要内容

核验验证码

注意

尽管发送接口返回了验证码(code),让自行核验成为可能,我们仍建议你调用核验接口完成核验,以保证安全性。

核验验证码接口

  • 接口描述:核验验证码是否正确
  • 接口地址:https://onlyid.net/api/open/verify-otp
  • 请求方式:POST
  • 内容类型:application/json

请求参数:

参数是否必需含义
recipient接收人,手机号或电子邮箱
clientId你的应用ID
clientSecret你的应用Secret
code尝试比对的验证码

成功时响应字段:

字段含义
result核验结果,固定值:success

请求示例:

POST https://onlyid.net/api/open/verify-otp HTTP/1.1
Content-Type: application/json
{
"recipient": "13612345678",
"clientId": "98d44b4a3543db79",
"clientSecret": "8d08fbbd89a547df8bda56eba12fac2e",
"code": "581305"
}

验证码核验成功,响应报文示例:

HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success"
}

验证码核验失败,响应报文示例:

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"error": "验证码错误或超过有效期"
}

验证码失效规则:

  • 成功验证过一次后立即失效。
  • 验证失败次数达到限制立即失效。
  • 验证码超时未完成验证自然过期。
  • 生成了新验证码后,旧验证码自动失效。