# 查询用户实名API

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：cityservice_getmedrealname

查询老年患者实名信息

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cityservice/getmedrealname?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：134

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "app_id",
    "类型": "string",
    "必填": "是",
    "说明": "业务方appid"
  },
  {
    "参数名": "open_id",
    "类型": "string",
    "必填": "是",
    "说明": "微信用户openid"
  },
  {
    "参数名": "wxmed_authcode",
    "类型": "string",
    "必填": "是",
    "说明": "实名信息code，对应url中的wxmed_authcode，有效期10分钟"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "cipher_real_name",
    "类型": "string",
    "说明": "加密后的实名信息，base64后的加密信息"
  },
  {
    "参数名": "cipher_algorithm",
    "类型": "string",
    "说明": "加密算法，默认：AES_256_ECB_PKCS7Padding"
  },
  {
    "参数名": "key_version",
    "类型": "number",
    "说明": "实名信息加密key版本号，初始版本号为0，用于识别后续密钥更换升级"
  },
  {
    "参数名": "app_id",
    "类型": "string",
    "说明": "业务方appid"
  },
  {
    "参数名": "open_id",
    "类型": "string",
    "说明": "微信用户openid"
  }
]
```

## 4. 注意事项

用户实名数据属于敏感信息，不能以明文形式传输，所以平台返回的实名信息是经过对称加密后的base64字符串，平台会给进驻的每家医院分配长度为32位(256bit)密钥，解密后可获得明文，默认使用的加解密算法为：AES_256_ECB_PKCS7Padding；解密示例代码[下载](https://share.weiyun.com/HPYWwdQU)

**解密后的实名明文**

``` json
{"real_name":"张三","id_card_no":"45088100000000","id_card_type":1,"phone":"13800000138","timestamp":1661420431,"phone_country_code":"86"}
```

**实名信息字段说明**

| 字段         | 字段名   | 类型   | 是否必填 | 说明                                                         |
| ------------ | -------- | ------ | -------- | ------------------------------------------------------------ |
| real_name    | 姓名     | string | 是       |                                                              |
| id_card_no   | 证件号   | string | 是       |                                                              |
| id_card_type | 证件类型 | int32  | 是       | 1 居民身份证；
4 澳门居民往来内地通行证；
5 台湾居民往来内地通行证；
6香港居民往来内地通行证。 |
| phone        | 电话号码 | string | 是       |                                                              |
| timestamp    | 时间戳   | int64  | 是       |                                                              |

## 5. 代码示例

请求示例

``` JSON
{
  "app_id": "wx23dde3xd34569cba",
  "open_id": "ont-9vr_is4GBmeuh_xy1YHidhgY",
  "wxmed_authcode": "BMUewIb9qr2GMDeInZKOBg.."
}
```

返回示例

```json
{
  "app_id":"",
  "openid_id":""
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "0",
    "错误描述": "ok",
    "解决方案": "ok"
  },
  {
    "错误码": "11200",
    "错误描述": "wxmed_authcode expired",
    "解决方案": ""
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。