实名认证 API 文档
概述
实名认证功能支持多种认证方式,用于验证用户的真实身份。系统支持以下认证类型:
业务流程图
认证状态流转
证件图片认证流程
用户端接口
1. 身份证认证 POST /user/identity_verification/id_card
功能说明
提交身份证认证申请。根据 cert_type 参数选择认证方式:
- API 自动认证:
IDENTITY_CARD、RESIDENCE_HK_MC、RESIDENCE_TAIWAN - 人工审核:
ID_CARD_MANUAL
请求参数
upload_image_ids 说明:
- 仅当
cert_type=ID_CARD_MANUAL时必填 - 数组长度:1-5 个
- 图片必须是当前用户通过
/upload_image接口上传的
请求示例
API 自动认证:
人工审核认证:
响应示例
API 认证成功:
人工审核已提交:
错误响应
2. 取消认证申请 POST /user/identity_verification/cancel
功能说明
取消当前用户待审核的证件图片认证申请。仅支持取消 ID_CARD_MANUAL 类型且状态为 pending 的认证。
请求参数
无需参数。
响应示例
取消成功:
错误响应
3. 获取认证信息 POST /user/identity_verification/info
功能说明
获取当前用户的实名认证信息(脱敏显示)。
请求参数
无需参数。
响应示例
4. 获取认证历史 POST /user/identity_verification/history
功能说明
获取当前用户的所有认证历史记录。
请求参数
无需参数。
响应示例
关联接口
以下接口在创建/更新时也支持 ID_CARD_MANUAL 认证方式:
提现账户接口
POST /user/withdraw_account/create
创建提现账户时,如果用户未完成实名认证,可以使用 ID_CARD_MANUAL 方式提交认证。
POST /user/withdraw_account/update
更新提现账户时,如果用户未完成实名认证,可以使用 ID_CARD_MANUAL 方式提交认证。
请求参数(认证相关):
注意:当 cert_type=ID_CARD_MANUAL 时,接口会返回 ok: false 并提示等待审核,不会立即创建/更新提现账户。用户需要等待审核通过后再次操作。
后台管理接口
注意:以下接口位于
/internal路由组,使用内部 API 认证。
1. 审核通过 POST /internal/identity_verification/approve
功能说明
管理员审核通过证件图片认证申请。审核通过后:
- 认证记录状态更新为
verified - 用户
is_identity_verified更新为true - 用户
identity_verification_status变为verified
请求参数
请求示例
响应示例
错误响应
2. 审核拒绝 POST /internal/identity_verification/reject
功能说明
管理员审核拒绝证件图片认证申请。
请求参数
请求示例
响应示例
用户信息中的认证状态
identity_verification_status 字段
在用户信息接口 (/user/info) 返回中,新增 identity_verification_status 字段,前端只需判断此字段即可:
响应示例
数据模型
认证类型 (verification_type)
认证状态 (status)
证件类型 (cert_type)
完整调用流程示例
场景1:API 自动认证
场景2:证件图片认证(人工审核)
场景3:取消认证申请
注意事项
- 图片上传:使用
/upload_image接口上传证件图片,不会压缩原图 - 图片归属验证:系统会验证
upload_image_ids中的图片是否属于当前用户 - 重复提交限制:用户有待审核的认证时,无法提交新的认证申请
- 取消后可重新提交:取消认证后,用户可以重新提交认证申请
- 审核拒绝后可重新提交:认证被拒绝后,用户可以重新提交认证申请
错误码
错误响应格式:

