电子合同API开发文档 v5

验证pdf文档密码是否正确

接口地址:https://api.1dq.com/v5/Tool/checkFileEncryptionPassword.json

请求方式:POST

参数位置:body

权限控制:支持

接口版本: v5.0

在线工具:API在线调试接口

接口描述:
如果pdf设置了密码,可以通过此接口验证pdf文档密码是否正确

请求参数

除去下列参数中,需要在header中添加公共参数,详见公共请求参数

参数名 是否必填 长度 类型 默认值 描述 示范
file_id 36 STRING -
文档id
signed-30bfb87dd63a4c7a5f720dbbbd7c2b2b-9808d27b-0004
password 50 STRING -
密码
111222

请求示范

 POST https://api.1dq.com/v5/Tool/checkFileEncryptionPassword.json
 {
    "file_id": "signed-30bfb87dd63a4c7a5f720dbbbd7c2b2b-9808d27b-0004",
    "password": "111222"
}

返回结果

参数名 是否必填 长度 类型 默认值 描述 示范
code 1-10 long 业务状态码 200
msg 2-64 string 结果描述 请求成功
data - 结果集 -

成功示范

{
    "code": 200,
    "msg": "验证通过",
    "data": []
}

失败示范

{
    "code": 404,
    "msg": "文档已加密,但密码不正确",
    "data": []
}

状态码

状态码 说明 备注
200 success -

其他备注

暂无

附件一 接口示范代码