加签文件验签接口

1. 接口描述

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

对加签后的文件进行数字签名验证，判断数字签名是否有效。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：VerifyDigitFile。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	否	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
FileId	否	String	加签接口返回的文件Id 示例值：yDwcCUUgyg3tgmvhUEVzyNa15Zayy6Sf

3. 输出参数

参数名称	类型	描述
PdfResourceMd5	String	加签文件MD5哈希值 示例值：C39BBA405153FB9A0705BEF095351CBD
VerifyResult	Integer	验签结果代码，代码的含义如下： 1：文件验证成功。 2：文件验证失败。 示例值：1
VerifySerialNo	String	验签序列号, 为11为数组组成的字符串 示例值：17364056473214
VerifyDigitFileResults	Array of VerifyDigitFileResult	验签结果详情，每个签名域对应的验签结果。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 加签文件验证成功示例

1.填入加签后的文件Id，对文件进行验证

输入示例

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

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "FileId": "yDwFdUUckpsveo27UEQPEVo14KnASuGI"
}

输出示例

{
    "Response": {
        "PdfResourceMd5": "213CA8C1C84B7BAA73F6FD3959C2F079",
        "RequestId": "s1739352792186436957",
        "VerifyDigitFileResults": [
            {
                "CertNotAfter": 1754852419000,
                "CertNotBefore": 1723316419000,
                "CertSn": "2201c8e9cdd3abb6",
                "SignAlgorithm": "SHA256withRSA",
                "SignTime": 1737103505000,
                "SignType": 1,
                "SignerName": "ESS@XXXXX责任公司测试@662001"
            }
        ],
        "VerifyResult": 1,
        "VerifySerialNo": "17393527923979"
    }
}

5. 错误码

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

错误码	描述
InternalError	内部错误。