查询个人证书接口

1. 接口描述

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

此接口（DescribePersonCertificate）用于查询个人数字证书信息。
注：1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。
2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribePersonCertificate。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
UserInfo	是	UserThreeFactor	个人用户的三要素信息： 姓名 证件号 证件类型
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
SceneKey	否	String	证书使用场景，可以选择的场景值如下: E_PRESCRIPTION_AUTO_SIGN : 电子处方场景 OTHER : 通用场景 示例值：E_PRESCRIPTION_AUTO_SIGN

3. 输出参数

参数名称	类型	描述
Cert	String	证书的Base64
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询个人自动签证书

1.张三已开通自动签署服务 2.查询个人用户张三的自动签证书信息

输入示例

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

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "Agent": {},
    "UserInfo": {
        "IdCardType": "ID_CARD",
        "Name": "张三",
        "IdCardNumber": "37000019890303000X"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN"
}

输出示例

{
    "Response": {
        "Cert": "MIIFvDCCBKSgAwIBAgIKLEAAAAAAAeG/JDANBgkqhkiG9w0Sz+zaDmLEK2odEmlMwKdeNd0vRb47sp3jkUSs46FL7rblJ4puClqKF4FxkDMpgAH7Gt6wwaeejbj+r+EVSKjV2nkBAA6rgMZuY24vY3BzMBUGCiqBHIbvMgIBAR4EBwwFOTYwMDMwDQYJKoZIhvcNAQELBQADggEBAKuOn//LFHqcu2ec2VyNvgizNx5J1CuDjR4wZkTJTvy/ydNQnQpVZRKAfNQ1gz+QerNqrSVH//3tGk42rQGumDAv2vTGBU7lrs4/QCPSvBpQGgDYXuKU5LyNh80eVy7LyurRTlQT+t22DPjN5gjuk4UE5q8Hv5SO7q6mowHFG3+HLsi1K1TMrN151Ebi4TUzK0keiGYBqiK6/h6q4xSyTyPmy+SiNgmXiRYkWPdBJBckgDqw/7/qEXp1N9fswbrWYA/W5P6DjYDZDmApRsQkAYsBdxrAngTl3tOkZTFX8oFu2Hv+8oW5Y0jYLnGQ2NFl901d6cPnzcAXMs5nQhbY690=",
        "RequestId": "s169529xxxxx93567314"
    }
}

示例2 查询个人自动签证书-用户未开通自动签

1.张三没有开通自动签署服务 2.查询个人用户张三的自动签证书信息

输入示例

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

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "Agent": {},
    "UserInfo": {
        "IdCardType": "ID_CARD",
        "Name": "张三",
        "IdCardNumber": "37000019890303000X"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "OperationDenied",
            "Message": "个人未开通自动签"
        },
        "RequestId": "s169529xxxxx135883849"
    }
}

5. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter.EmptyParams	参数为空，请检查参数修改后重试。
OperationDenied	操作被拒绝。