生成个人更名链接

1. 接口描述

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

生成个人用户实名更名链接，个人用户点击此链接进入更名流程（若用户未完成实名认证，则直接进入实名页面实名后再进行更名）。此链接为通用链接，任何点击生成链接的用户将会被引导至小程序个人更名页面完成更名。

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateUserNameChangeUrl。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	操作人信息
Endpoint	否	String	要跳转的链接类型 HTTP：适用于短信通知或H5跳转的电子签小程序HTTP长链接 HTTP_SHORT_URL：适用于短信通知或H5跳转的电子签小程序HTTP短链接 APP：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径注：如果不传递，默认值是 HTTP 示例值：APP
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，点击后会跳转到腾讯电子签小程序进行签署 `注：` 生成的链路后面不能再增加参数，防止出错重复参数覆盖原有的参数示例值：https://essurl.cn/2n42Nd
ExpireTime	Integer	链接过期时间，为Unix时间戳（单位为秒）。示例值：1736416390
MiniAppId	String	小程序appid，用于半屏拉起电子签小程序，仅在 Endpoint 设置为 APP 的时候返回示例值：gh_da88f6188665
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成个人更名链接

生成个人通用更名链接

输入示例

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

{
    "Operator": {
        "UserId": "19561039c9***********32520fde6a",
        "ClientIp": "8.8.8.8"
    },
    "Endpoint": "HTTP",
    "UserData": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5LCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4="
}

输出示例

{
    "Response": {
        "ExpireTime": 1748247333,
        "MiniAppId": "",
        "RequestId": "s1747642533895017639",
        "UserVerifyUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=MP_PERSONAL_VERIFY&shortKey=yDttYU******bLXcb"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.BalanceNotEnough	套餐余额不足。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 生成个人更名链接​

输入示例​

输出示例​

5. 错误码​