提交申请出证报告任务
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
提交申请出证报告任务并返回报告ID。
注意：
- 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
- 操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。
- 合同流程必须所有参与方`已经签署完成`。
- 出证过程需一定时间，建议在`提交出证任务后的24小时之后`，通过获取出证报告任务执行结果接口进行查询执行结果和出证报告的下载URL。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateFlowEvidenceReport。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。 |
| FlowId | 是 | String | 合同流程ID，为32位字符串。 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
| ReportType | 否 | Integer | 指定申请的报告类型，可选类型如下：
示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReportId | String | 出证报告 ID，可用于获取出证报告任务执行结果查询出证任务结果和出证PDF的下载URL 注意：此字段可能返回 null，表示取不到有效值。 示例值：yDx****AyF |
| Status | String | 出证任务执行的状态, 状态含义如下：
示例值：EvidenceStatusExecuting |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建并返回签署报告
通过已完成签署的流程FlowId，发起出证请求，获取签署报告的ID。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowEvidenceReport
<公共请求参数>
{
"FlowId": "yDR0PU**********K5ccC",
"ReportType": 0,
"Operator": {
"UserId": "yDx************************AcC"
}
}
输出示例
{
"Response": {
"ReportId": "yDx************************AyF",
"RequestId": "s166*********616",
"Status": "EvidenceStatusSuccess"
}
}
示例2 创建并返回公证处核验报告
通过已完成签署的流程FlowId，发起出证请求，获取公证处核验报告的ID。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowEvidenceReport
<公共请求参数>
{
"FlowId": "yDSxWUUckptuwesgUyP5v6kRsvwZpybk",
"ReportType": 1,
"Operator": {
"UserId": "yDCNTUUckpv1c9kfUyDQKDg8u6pYFYer"
}
}
输出示例
{
"Response": {
"ReportId": "yDCNOUUckpv36reuUEbW4t68pFFHlxYa",
"RequestId": "s166*********616",
"Status": "EvidenceStatusSuccess"
}
}
示例3 错误示例：流程未签署完，请求出证失败
流程FlowId必须处于全部签署完成的状态，否则请求将无法成功。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowEvidenceReport
<公共请求参数>
{
"FlowId": "yDR0PU**********K5ccC",
"Operator": {
"UserId": "yDx************************AcC"
}
}
输出示例
{
"Response": {
"Error": {
"Code": "OperationDenied.FlowStatusForbid",
"Message": "当前流程状态不支持出证"
},
"RequestId": "s1692***********72"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.System | 系统错误，请稍后重试。 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter.FlowId | 缺少签署流程id，请检查修改后重试。 |
| OperationDenied.FlowStatusForbid | 签署流程状态不正确，请检查后重试。 |
| OperationDenied.Forbid | 禁止此项操作。 |
| OperationDenied.NotBelongSuperAdminOrLegalPerson | 不属于企业超管或者法人。 |
| OperationDenied.ProveNoQuota | 出证计费额度不足 |
| ResourceNotFound.Flow | 签署流程未找到，请检查参数。 |
| ResourceNotFound.FlowApprover | 签署流程的签署人不存在，请检查后重试。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |