腾讯电子签获取个人用户实名链接

1. 接口描述

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

生成个人用户实名认证链接，个人用户点击此链接进入实名流程（若用户已完成实名认证，则直接进入成功页面）。用户点击此接口生成的链接完成实名认证后，其数据将通过企业引导个人实名认证后回调返回

注：调用此接口需要购买单独的实名套餐包。使用前请联系对接的客户经理沟通。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateUserVerifyUrl。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	操作人信息
Name	否	String	要实名的姓名示例值：真实姓名
IdCardNumber	否	String	要实名的身份证号码，身份证号码如果有x的话，统一传大写X 示例值：420520****8738
IdCardType	否	String	证件类型，支持以下类型，样式可以参考常见个人证件类型介绍 ID_CARD 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证) 注: 港澳居民来往内地通行证和港澳台居民居住证类型的签署人至少要过一次大陆的海关才能使用。示例值：ID_CARD
Mobile	否	String	要实名的手机号，兼容带+86的格式示例值：187****9032
JumpUrl	否	String	实名完之后的跳转链接，最大长度1000个字符。链接类型请参考跳转电子签H5。注：此参数仅支持 Endpoint 为 H5 或 H5_SHORT_URL 的时候传递示例值：https://essurl.cn/x9nvWU8fTg
Endpoint	否	String	要跳转的链接类型 HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接 HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接 APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径 H5：适用于跳转至电子签H5实名页面的长链接 H5_SHORT_URL：适用于跳转至电子签H5实名页面的短链接注：如果不传递，默认值是 APP 示例值：APP
AutoJumpBack	否	Boolean	签署完成后是否自动回跳 false：否, 实名完成不会自动跳转回来(默认) true：是, 实名完成会自动跳转回来注: 该参数只针对APP类型（第三方APP或小程序跳转电子签小程序）场景的实名链接有效手机应用APP 或微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考这个电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）示例值：false
UserData	否	String	在用户完成实名认证后，其自定义数据将通过企业引导个人实名认证后回调返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。示例值：MTIzNDU2Nzg5

3. 输出参数

参数名称	类型	描述
UserVerifyUrl	String	腾讯电子签小程序的实名认证链接。如果没有传递，默认值是 HTTP。链接的有效期均是 7 天。 1.如果EndPoint是APP：得到的链接类似于pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参考描述中的"跳转到小程序的实现" 2.如果EndPoint是HTTP：得到的链接类似于 https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d，点击后会跳转到腾讯电子签小程序进行签署 3.如果EndPoint是HTTP_SHORT_URL：得到的链接类似于https://essurl.cn/2n42Nd，点击后会跳转到腾讯电子签小程序进行签署 4.如果EndPoint是H5：得到的链接类似于 https://quick.test.qian.tencent.cn/guide?Code=yDUVJhsS5q&CodeType=xxx&shortKey=yDfrcb，点击后会跳转到腾讯电子签H5页面进行签署 5.如果EndPoint是H5_SHORT_URL：得到的链接类似于https://essurl.cn/2n42Nd，点击后会跳转到腾讯电子签H5页面进行签署 `注：` 生成的链路后面不能再增加参数，防止出错重复参数覆盖原有的参数示例值：https://essurl.cn/2n42Nd 示例值：https://essurl.cn/2n*42Nd
ExpireTime	Integer	链接过期时间，为Unix时间戳（单位为秒）。示例值：1736416390
MiniAppId	String	小程序appid，用于半屏拉起电子签小程序，仅在 Endpoint 设置为 APP 的时候返回示例值：gh_da88f6188665
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取c端用户实名跳转链接

获取c端用户实名链接

输入示例

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

{
    "Operator": {
        "UserId": "19561039c99fe825a934a132520fde6a",
        "ClientIp": "8.8.8.8"
    },
    "Name": "典子谦",
    "Endpoint": "HTTP_SHORT_URL",
    "IdCardType": "ID_CARD",
    "IdCardNumber": "420101XXXXXXXX4059",
    "Mobile": "13200000015"
}

输出示例

{
    "Response": {
        "ExpireTime": 1713080196,
        "MiniAppId": "",
        "RequestId": "s1712475396892401448",
        "UserVerifyUrl": "https://test.essurl.cn/RTo****6X6"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

获取个人用户实名链接

本页目录：