概述
欢迎使用「用户文档」API 服务 📄
本接口提供用户文档信息的获取与管理功能,支持以下操作:
- 文档类型查询
- 用户权限校验
- 数据格式标准化
请求方法
方法 | 路径 | 描述 |
---|---|---|
GET | /zh/api/user_doc | 获取用户文档列表 |
POST | /zh/api/user_doc | 上传新文档 |
DELETE | /zh/api/user_doc/{id} | 删除指定文档 |
参数说明
必须参数
user_id
(字符串): 用户唯一标识符doc_type
(枚举): 文档类型(身份证_ID_Card / 学历_Education / 财务_Finance)
可选参数
page
(整数): 分页参数,默认值为 1per_page
(整数): 每页数量,默认值为 10
响应示例
{
"status": "success",
"data": [
{
"id": "doc_12345",
"type": "身份证_ID_Card",
"upload_time": "2023-09-20T14:23:00Z"
}
]
}
使用示例
💻 示例代码:
curl -X GET "https://api.example.com/zh/api/user_doc?user_id=U123456789&doc_type=身份证_ID_Card"
注意事项
🔒 请确保:
- 所有操作均在合法授权范围内
- 文档内容符合《个人信息保护法》要求
- 参数需进行严格校验(如:
user_id
必须为 18 位数字)