查询H5签署认证人脸视频

1. 接口描述

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

该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。

1. 该接口仅适用于在H5端签署的合同，在通过视频认证后获取人脸视频。
2. 该接口不支持小程序端的签署人脸视频获取。
3. 请在签署完成后的三天内获取人脸视频，过期后将无法获取。

注意：该接口需要开通白名单，请联系客户经理开通后使用。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSignFaceVideo。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。使用此接口时，必须填写userId。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
FlowId	是	String	合同流程ID，为32位字符串。 示例值：yDCNsUUckpvqwg3kUyIemOrwQm9ltij5
SignId	是	String	签署参与人在本流程中的编号ID(每个流程不同)，可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。 示例值：yDxjNUUgydjfeklxUuO4zjEBgCqAHMKu
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
VideoData	DetectInfoVideoData	核身视频结果。 注意：此字段可能返回 null，表示取不到有效值。
IntentionQuestionResult	IntentionQuestionResult	意愿核身问答模式结果。若未使用该意愿核身功能，该字段返回值可以不处理。 注意：此字段可能返回 null，表示取不到有效值。
IntentionActionResult	IntentionActionResult	意愿核身点头确认模式的结果信息，若未使用该意愿核身功能，该字段返回值可以不处理。 注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询签署认证人脸视频结果

1. 个人用户在H5端完成合同签署，通过视频问答模式认证。
2. 所需白名单已经开通。
3. 在签署完成后的三天内获取人脸视频。

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "FlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "SignId": "yDCNOUUckpv3ecwcUECtq4n1jXPLxLq7"
}

输出示例

{
    "Response": {
        "IntentionQuestionResult": {
            "AsrResult": [
                "同意"
            ],
            "ResultCode": [
                "0"
            ],
            "Video": "AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB"
        },
        "RequestId": "s1709628366717791449",
        "VideoData": {
            "LiveNessVideo": "AAAAHGZ0eXBpc281AAAAAWlzb21pc281aGxzZgAAB"
        }
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。