获取个人用户认证证书图片

1. 接口描述

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

获取个人用户认证证书图片下载URL

个人用户认证证书图片样式如下图

注:

只能获取个人用户证明图片, 企业员工的暂不支持
处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreatePersonAuthCertificateImage。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
UserName	是	String	个人用户名称
IdCardType	是	String	证件类型，支持以下类型 ID_CARD : 居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
IdCardNumber	是	String	证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。
SceneKey	否	String	自动签使用的场景值, 可以选择的场景值如下: E_PRESCRIPTION_AUTO_SIGN : 电子处方场景 OTHER : 通用场景注: `不传默认为处方单场景，即E_PRESCRIPTION_AUTO_SIGN` 示例值：E_PRESCRIPTION_AUTO_SIGN

3. 输出参数

参数名称	类型	描述
AuthCertUrl	String	个人用户认证证书图片下载URL，`有效期为5分钟`，超过有效期后将无法再下载。示例值：https://file.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=fcb0d640136f8f47d28e3f4cd5fb8bac321**da99b18e29d28807fc8e
ImageCertId	String	个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号。该编号会合成到个人用户证书证明图片。注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动` 注意：此字段可能返回 null，表示取不到有效值。示例值：23090411***877319694
SerialNumber	String	CA供应商下发给用户的证书编号，在证书到期后自动续期后此证书编号会发生变动，且不会合成到个人用户证书证明图片中。注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下。` 注意：此字段可能返回 null，表示取不到有效值。示例值：2206EB**4597742
ValidFrom	Integer	CA证书颁发时间，格式为Unix标准时间戳（秒）该时间格式化后会合成到个人用户证书证明图片注意：此字段可能返回 null，表示取不到有效值。
ValidTo	Integer	CA证书有效截止时间，格式为Unix标准时间戳（秒）该时间格式化后会合成到个人用户证书证明图片注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建个人用户证明证书图片

创建个人用户证明证书图片

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "UserName": "典子谦",
    "IdCardType": "ID_CARD",
    "IdCardNumber": "620000198802020000"
}

输出示例

{
    "Response": {
        "AuthCertUrl": "https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=522d****6cb5",
        "RequestId": "69c19f7e7240",
        "SerialNumber": "23090411***877319694",
        "ValidFrom": 1692788219,
        "ValidTo": 1724324219
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 创建个人用户证明证书图片​

输入示例​

输出示例​

5. 错误码​