OTP Verification Guide - How to Validate One-Time Passwords Securely

POST https://otp.api.engagelab.cc/v1/verifications

采用 HTTP 基本认证的验证方式，在 HTTP Header（头）里加 Authorization：

Authorization: Basic ${base64_auth_string}

          Authorization: Basic ${base64_auth_string}

此代碼塊在浮窗中顯示

上述 base64_auth_string 的生成算法为：base64(dev_key:dev_secret)

POST /v1/verifications HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

          POST /v1/verifications  HTTP/1.1  
Content-Type: application/json  
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

此代碼塊在浮窗中顯示

{ "message_id": "1725407449772531712", "verify_code": "667090" }

          {
    "message_id": "1725407449772531712",
    "verify_code": "667090"
}

此代碼塊在浮窗中顯示

参数	类型	选项	说明
message_id	String	必填	验证码对应的消息id，由 /messages 接口返回
verify_code	String	必填	需要校验的验证码

字段	类型	选项	描述
message_id	String	必填	验证码对应的消息id，由 /v1/messages 接口返回
verify_code	String	必填	需要校验的验证码
verified	Boolean	必填	校验结果，true表示校验成功，false表示校验失败

{ "message_id": "1725407449772531712", "verify_code": "667090", "verified": true }

          {
    "message_id": "1725407449772531712",
    "verify_code": "667090",
    "verified": true
}

此代碼塊在浮窗中顯示

注意，对同一消息的验证码进行校验请求，若验证码校验成功，再次请求本校验接口，则接口将返回失败，提示为本消息校验码已完成校验；即不支持对验证成功后的验证码再次进行验证。

http 状态码为 4xx 或者 5xx，响应体包含字段如下：

字段	类型	选项	描述
code	int	必填	错误码，详见错误码说明
message	String	必填	错误详情

{ "code": 3003, "message": "verify code has expired" }

          {
    "code": 3003,
    "message": "verify code has expired"
}

此代碼塊在浮窗中顯示

错误码	http code	说明
1000	500	内部错误
2001	401	鉴权失败，未携带正确的 token
2002	401	鉴权失败，token已过期或已被禁用
2004	403	无调用此 API 的权限
3001	400	请求参数格式无效，请检查是否符合参数格式的 JSON 内容
3002	400	请求参数有误，请检查请求参数是否符合要求
3003	400	验证码过期或已验证，对于该错误码的响应，需要重新下发新的验证码消息
4001	400	该消息不存在

驗證碼校驗