# 校验实名信息

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

接口英文名：checkrealnameinfo

业务方页面获得code之后，需要通过该接口进行实名信息的校验。校验完成后，业务方再根据具体情况，完成自有的业务流程。

城市服务实名信息校验流程请参考[此文档](/miniprogram/dev/platform-capabilities/cityservice/cityservice-checkrealnameinfo.md)

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/intp/realname/checkrealnameinfo?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

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

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

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "是",
    "说明": "用户在业务方下的openid，与申请权限时提供的业务方的小程序appid保持一致"
  },
  {
    "参数名": "real_name",
    "类型": "string",
    "必填": "是",
    "说明": "需要校验的姓名"
  },
  {
    "参数名": "cred_id",
    "类型": "string",
    "必填": "是",
    "说明": "需要校验的证件号"
  },
  {
    "参数名": "cred_type",
    "类型": "string",
    "必填": "是",
    "说明": "默认为1，即身份证，目前暂只支持身份证"
  },
  {
    "参数名": "code",
    "类型": "string",
    "必填": "是",
    "说明": "通过小程序回跳获取的code参数"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码",
    "枚举": "-"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误描述",
    "枚举": "-"
  },
  {
    "参数名": "verify_openid",
    "类型": "string",
    "说明": "openid 验证结果，有多个结果时用分号;连接",
    "枚举": "枚举值"
  },
  {
    "参数名": "verify_real_name",
    "类型": "string",
    "说明": "real_name\t校验结果，当verify_openid 为V_OP_NM_MA 时返回",
    "枚举": "枚举值"
  }
]
```

## 4. 枚举信息

### Res.verify_openid `Enum`

openid 验证结果，有多个结果时用分号;连接

```json
[
  {
    "枚举值": "V_OP_NA",
    "描述": "用户暂未实名认证"
  },
  {
    "枚举值": "V_OP_NM_MA",
    "描述": "用户与姓名匹配"
  },
  {
    "枚举值": "V_OP_NM_UM",
    "描述": "用户与姓名不匹配"
  }
]
```

### Res.verify_real_name `Enum`

real_name	校验结果，当verify_openid 为V_OP_NM_MA 时返回

```json
[
  {
    "枚举值": "V_NM_ID_MA",
    "描述": "姓名与证件号匹配"
  },
  {
    "枚举值": "V_NM_ID_UM",
    "描述": "姓名与证件号不匹配"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

本接口无代码示例

## 7. 错误码

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

```json
[
  {
    "错误码": "1005",
    "错误描述": "invalid appid"
  },
  {
    "错误码": "80111",
    "错误描述": "实名校验code不存在"
  },
  {
    "错误码": "80113",
    "错误描述": "无效code"
  }
]
```

## 8. 适用范围

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