跳到主要内容

流程文件验签

1. 接口描述​

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

对流程的合同文件进行验证，判断文件是否合法。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelVerifyPdf。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，本接口不需要传递此参数。
FlowId是String流程ID
Agent否Agent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
Operator否UserInfo暂未开放

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": {
        "ProxyAppId": "id",
        "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
<公共请求参数>

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

输出示例​

{
    "Response": {
        "PdfVerifyResults": [
            {
                "CertNotAfter": 0,
                "CertNotBefore": 0,
                "CertSn": "",
                "ComponentHeight": 0,
                "ComponentPage": 0,
                "ComponentPosX": 0,
                "ComponentPosY": 0,
                "ComponentWidth": 0,
                "SignAlgorithm": "",
                "SignPlatform": "",
                "SignTime": 0,
                "SignType": 0,
                "SignerName": "",
                "VerifyResult": 0
            },
            {
                "CertNotAfter": 0,
                "CertNotBefore": 0,
                "CertSn": "",
                "ComponentHeight": 0,
                "ComponentPage": 0,
                "ComponentPosX": 0,
                "ComponentPosY": 0,
                "ComponentWidth": 0,
                "SignAlgorithm": "",
                "SignPlatform": "",
                "SignTime": 0,
                "SignType": 0,
                "SignerName": "",
                "VerifyResult": 0
            },
            {
                "CertNotAfter": 0,
                "CertNotBefore": 0,
                "CertSn": "",
                "ComponentHeight": 0,
                "ComponentPage": 0,
                "ComponentPosX": 0,
                "ComponentPosY": 0,
                "ComponentWidth": 0,
                "SignAlgorithm": "",
                "SignPlatform": "",
                "SignTime": 0,
                "SignType": 0,
                "SignerName": "",
                "VerifyResult": 0
            },
            {
                "CertNotAfter": 1646376026000,
                "CertNotBefore": 1646289626000,
                "CertSn": "1912050077215241",
                "ComponentHeight": 39.999969482422,
                "ComponentPage": 3,
                "ComponentPosX": 327.10998535156,
                "ComponentPosY": 321.78002929688,
                "ComponentWidth": 62.780029296875,
                "SignAlgorithm": "SHA1withRSA",
                "SignPlatform": "腾讯电子签",
                "SignTime": 1646289626000,
                "SignType": 0,
                "SignerName": "程英",
                "VerifyResult": 0
            },
            {
                "CertNotAfter": 1646376026000,
                "CertNotBefore": 1646289626000,
                "CertSn": "1912050077215241",
                "ComponentHeight": 12,
                "ComponentPage": 3,
                "ComponentPosX": 343.5299987793,
                "ComponentPosY": 404.7799987793,
                "ComponentWidth": 69.940002441406,
                "SignAlgorithm": "SHA1withRSA",
                "SignPlatform": "腾讯电子签",
                "SignTime": 1646289626000,
                "SignType": 0,
                "SignerName": "程英",
                "VerifyResult": 0
            },
            {
                "CertNotAfter": 1778601599000,
                "CertNotBefore": 1620835200000,
                "CertSn": "4c5a00000000000001839b86",
                "ComponentHeight": 0,
                "ComponentPage": 1,
                "ComponentPosX": 0,
                "ComponentPosY": 842,
                "ComponentWidth": 0,
                "SignAlgorithm": "SHA1withRSA",
                "SignPlatform": "腾讯电子签",
                "SignTime": 1646289627000,
                "SignType": 1,
                "SignerName": "深圳xxxx公司",
                "VerifyResult": 0
            }
        ],
        "RequestId": "9c683673-axxx2-648f67d46fad",
        "VerifyResult": 1
    }
}

5. 开发者资源​

腾讯云 API 平台​

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector​

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK​

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具​

6. 错误码​

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

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