跳到主要内容

流程文件验签

1. 接口描述

接口请求域名: essbasic.tencentcloudapi.com 。

对流程的合同文件进行数字签名验证,判断文件是否被篡改。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelVerifyPdf。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
FlowIdString流程ID
AgentAgent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。

3. 输出参数

参数名称类型描述
VerifyResultInteger验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
PdfVerifyResultsArray of PdfVerifyResult验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例-验证不通过

示例-验证不通过

输入示例

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelVerifyPdf
<公共请求参数>

{
"Operator": {
"OpenId": "testxxxx_test1"
},
"FlowId": "yDRvzUUgxxxxygxxxx4zjEuYdDnsxeT",
"Agent": {
"ProxyOperator": {
"OpenId": "test1_xxxxx_test1"
},
"AppId": "7f3497f01xxxa35e0984a9657b0ec",
"ProxyOrganizationOpenId": "test1_cxxxx_organization1"
}
}

输出示例

{
"Response": {
"PdfVerifyResults": [],
"RequestId": "8709904xxxxxx7-d1bc7420345f",
"VerifyResult": 4
}
}

示例2 示例-验证通过

示例-验证通过

输入示例

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelVerifyPdf
<公共请求参数>

{
"Agent": {
"AppId": "yDwftUUwurrf2UEzGFaDwrXLPJYGIA7E",
"ProxyOperator": {
"OpenId": "eddisonchen"
},
"ProxyAppId": "yDwFoUUyw3z5lUEi3kYK8mfxkDTjdxQH",
"ProxyOrganizationId": "yDxj5UUpt8vrbUy0fKyKRq5QqcP9pOg1"
},
"FlowId": "yDwh0UUfy1xxbUEq8gZ2w0AhzSoRFnQv",
"Operator": {
"OpenId": "eddisonchen"
}
}

输出示例

{
"Response": {
"PdfVerifyResults": [
{
"CertNotAfter": 1716370504000,
"CertNotBefore": 1684748104000,
"CertSn": "59c409xxxxxxxxxxxxxxxxxxxxxxdf5c36cf",
"ComponentHeight": 119,
"ComponentPage": 1,
"ComponentPosX": 210.5,
"ComponentPosY": 221,
"ComponentWidth": 119,
"SignAlgorithm": "SHA1withRSA",
"SignPlatform": "腾讯电子签",
"SignTime": 1690278683000,
"SignType": 0,
"SignerName": "XXXXXXXXXX测试有限公司",
"VerifyResult": 0
},
{
"CertNotAfter": 1716370504000,
"CertNotBefore": 1684748104000,
"CertSn": "59c409xxxxxxxxxxxxxxxxxxxxxxdf5c36cf",
"ComponentHeight": 13.70001220703125,
"ComponentPage": 1,
"ComponentPosX": 210.5,
"ComponentPosY": 343.1499938964844,
"ComponentWidth": 119,
"SignAlgorithm": "SHA1withRSA",
"SignPlatform": "腾讯电子签",
"SignTime": 1690277903000,
"SignType": 0,
"SignerName": "XXXXXXXXXX测试有限公司",
"VerifyResult": 0
}
],
"RequestId": "8a8ba2e4-XXXX-XXXX-8dfcf4eb9bb3",
"VerifyResult": 1
}
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码描述
InternalError内部错误。
InvalidParameter.ParamError参数错误。
OperationDenied操作被拒绝。
OperationDenied.ErrNoResourceAccess无资源访问权限。
ResourceNotFound资源不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。