1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
客户可以主动调用生成实名链接去做C端用户实名，会对实名的用户进行打标记为调用链接客户的用户
使用场景：
用户集成场景
使用限制：
此接口需要购买单独的实名套餐包方可调用，如有需求请联系对接人员评估
默认接口请求频率限制：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 |
| IdCardType | 否 | String | 证件类型，目前只支持身份证类型：ID_CARD |
| Mobile | 否 | String | 要实名的手机号，兼容带+86的格式 |
| Endpoint | 否 | String | 要跳转的链接类型 - HTTP： 跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型 ，此时返回长链 (默认类型) - HTTP_SHORT_URL： 跳转电子签小程序的http_url,短信通知或者H5跳转适合此类型，此时返回短链 - APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型 如果不传递，默认值是 APP 示例值：APP |
| AutoJumpBack | 否 | Boolean | 签署完成后是否自动回跳
注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景 的实名链接有效 2. 手机应用APP 或 微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考这个 3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制） |
| UserData | 否 | String | 在用户完成实名认证后，其自定义数据将通过企业引导个人实名认证后回调返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。 示例值：MTIzNDU2Nzg5 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| UserVerifyUrl | String | 腾讯电子签小程序的实名认证链接。 如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。 - 如果EndPoint是APP， 得到的链接类似于pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0, 用法可以参考描述中的"跳转到小程序的实现" - 如果EndPoint是HTTP， 得到的链接类似于https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d，点击后会跳转到腾讯电子签小程序进行签署 - 如果EndPoint是HTTP_SHORT_URL， 得到的链接类似于https://essurl.cn/2n**42Nd，点击后会跳转到腾讯电子签小程序进行签署 注： 生成的链路后面不能再增加参数 示例值：https://essurl.cn/2n**42Nd |
| ExpireTime | Integer | 链接过期时间 |
| MiniAppId | String | 小程序appid，用于半屏拉起电子签小程序， 仅在 Endpoint 设置为 APP 的时候返回 |
| 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": "wxa023b292fd19d41d",
"RequestId": "s1712475396892401448",
"UserVerifyUrl": "https://test.essurl.cn/RTo2UBE6X6"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。