跳到主要内容

合同验签

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，为32位字符串。
Agent否Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId


第三方平台子客企业和员工必须已经经过实名认证

3. 输出参数​

参数名称类型描述
VerifyResultInteger验签结果代码，代码的含义如下：

  • 1：文件未被篡改，全部签名在腾讯电子签完成。
  • 2：文件未被篡改，部分签名在腾讯电子签完成。
  • 3：文件被篡改。
  • 4：异常：文件内没有签名域。(如果合同还没有签署也会返回此代码)
  • 5：异常：文件签名格式错误。
PdfVerifyResultsArray of PdfVerifyResult验签结果详情，所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
VerifySerialNoString验签序列号, 为11为数组组成的字符串
PdfResourceMd5String合同文件MD5哈希值
示例值：C39BBA405153FB9A0705BEF095351CBD
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 验证不通过​

验证不通过

输入示例​

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

{
    "FlowId": "yDSLWUUckposmpkvUyb9xvpEQeni94od",
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    }
}

输出示例​

{
    "Response": {
        "VerifyResult": 4,
        "PdfVerifyResults": [],
        "VerifySerialNo": "16992543927198",
        "PdfResourceMd5": "708BE88A797843094A74FA10ABF08F01",
        "RequestId": "e5064ef6-4743-461a-9024-3120576f3f6b"
    }
}

示例2 验证通过​

示例-验证通过

输入示例​

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

{
    "FlowId": "yDSLVUUckpo1c11xUxtOq8cvKy24by9M",
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    }
}

输出示例​

{
    "Response": {
        "VerifyResult": 1,
        "PdfVerifyResults": [
            {
                "VerifyResult": 1,
                "SignPlatform": "腾讯电子签",
                "SignerName": "ESS@典子谦示例企业@382919",
                "SignTime": 1699252042000,
                "SignAlgorithm": "SHA1withRSA",
                "CertSn": "6c8e2911fadf70ea",
                "CertNotBefore": 1699006057000,
                "CertNotAfter": 1730542057000,
                "SignType": 0,
                "ComponentPosX": 361.0799865722656,
                "ComponentPosY": 481.6199951171875,
                "ComponentWidth": 119,
                "ComponentHeight": 13.70001220703125,
                "ComponentPage": 1
            },
            {
                "VerifyResult": 1,
                "SignPlatform": "腾讯电子签",
                "SignerName": "ESS@典子谦示例企业@382919",
                "SignTime": 1699252040000,
                "SignAlgorithm": "SHA1withRSA",
                "CertSn": "6c8e2911fadf70ea",
                "CertNotBefore": 1699006057000,
                "CertNotAfter": 1730542057000,
                "SignType": 0,
                "ComponentPosX": 361.0799865722656,
                "ComponentPosY": 359.45001220703125,
                "ComponentWidth": 119,
                "ComponentHeight": 119,
                "ComponentPage": 1
            },
            {
                "VerifyResult": 1,
                "SignPlatform": "腾讯电子签",
                "SignerName": "ESS@张三@37000019890303000X@808854",
                "SignTime": 1699252071000,
                "SignAlgorithm": "SHA1withRSA",
                "CertSn": "1000000000087449",
                "CertNotBefore": 1681301253000,
                "CertNotAfter": 1712837253000,
                "SignType": 0,
                "ComponentPosX": 193.55999755859375,
                "ComponentPosY": 43.90997314453125,
                "ComponentWidth": 86,
                "ComponentHeight": 43,
                "ComponentPage": 1
            },
            {
                "VerifyResult": 1,
                "SignPlatform": "腾讯电子签",
                "SignerName": "ESS@张三@37000019890303000X@808854",
                "SignTime": 1699252071000,
                "SignAlgorithm": "SHA1withRSA",
                "CertSn": "1000000000087449",
                "CertNotBefore": 1681301253000,
                "CertNotAfter": 1712837253000,
                "SignType": 0,
                "ComponentPosX": 177.05999755859375,
                "ComponentPosY": 90.25,
                "ComponentWidth": 119,
                "ComponentHeight": 13.70001220703125,
                "ComponentPage": 1
            }
        ],
        "VerifySerialNo": "16992543927198",
        "PdfResourceMd5": "708BE88A797843094A74FA10ABF08F01",
        "RequestId": "80c66dcb-fc07-48d4-8914-eb0171bbf1ac"
    }
}

5. 错误码​

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

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