# 身份证有效期验证核验详细版 · 身份证四要素核验

> 本文档为机器可读 Markdown，便于 AI / SDK 自动对接。页面原文：https://www.wapi.cn/api_detail/207/387.html
> 纯文本地址：`https://www.wapi.cn/api_detail/207/387.html?format=md`

## 概览

- **接口名称**：身份证四要素核验
- **子接口**：身份证有效期验证核验详细版（ID `387`）
- **接口简介**：输入身份证号码、姓名、身份证有效期开始日期、身份证有效期截止日期核验返回一致时，包含户籍状态 (0 有效、1 有效 (户籍迁出，但未迁入)、2 无效 (死亡、失踪、迁出、服兵 役、出国境定居、消除重复登记人口、冻结户口、重载注销等))；证件最新状态 (1 最新、0 非最新)；挂失状态 (1 挂失、0 非挂失)；过期状态 (1 过期、0 非过期)等信息，核验不一致时无以上信息
- **计费说明**：按次
- **请求地址**：`https://uaqy.api.storeapi.net/pyi/207/387`（支持 http/https）
- **请求方式**：`GET,POST`
- **返回格式**：`json,xml`
- **Content-Type（POST）**：`application/x-www-form-urlencoded;charset=utf-8`

## 请求参数

| 名称 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `appid` | 是 | String | 应用ID，在后台我的应用查看或者添加 | 1 |
| `bank_end_date` | 是 | String | 有效期截止日期：格式:20170606(长期有效身份证填8个0) | 20290701 |
| `bank_id` | 是 | String | 身份证号码 | 362536199105034456 |
| `bank_name` | 是 | String | 开户名,即身份证上名字 | 张三 |
| `bank_start_date` | 是 | String | 有效期开始日期：格式:20170606 | 20190701 |
| `format` | 否 | String | 返回数据格式类型，每个接口已经说明支持返回格式:json,xml, jsonp调用方法说明 | json |
| `sign` | 是 | String | 1.使用Md5方式验证，参数按一定规则md5后返回的字符串，详情点击这里阅读 2.使用Hash验证方式，直接跟上密钥即可。如何设置hash验证 通过我的应用里面修改验证方式 | 52a32be274a5c537bbf7a53e2d66c09f |

## 签名（MD5）

按参数名排序后拼接「键名+值」，空值不参与；末尾直接追加 32 位密钥（密钥不写键名）：

```
sign = MD5(appid1bank_end_date20290701bank_id362536199105034456bank_name张三bank_start_date20190701formatjson{secret})
```

说明：示例中 `appid` 默认为 `1`，请替换为「我的应用」中的 appid；密钥为应用 Secret。

## 返回参数

| 名称 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `bank_area` | 否 | String | 归属地 | 江西省广昌县 |
| `bank_attachment` | 否 | Array | 验证一致时返回参数。不一致不返回 |  |
| `bank_birthday` | 否 | String | 出生日期 | ***** |
| `bank_domicile_status` | 否 | String | 户籍状态 (0 有效、1 有效 (户籍迁出，但未迁入)、2 无效 (死亡、失踪、迁出、服兵 役、出国境定居、消除重复登记人口、冻结户口、重载注销等)) | 0 |
| `bank_expire_status` | 否 | String | 过期状态 (1 过期、0 非过期) | 0 |
| `bank_idCard` | 否 | String | 身份证号码 | ***** |
| `bank_lost_status` | 否 | String | 挂失状态 (1 挂失、0 非挂失) | 0 |
| `bank_msg` | 否 | String | 消息说明 | 验证通过 |
| `bank_name` | 是 | String | 开户名,即身份证上名字 | ***** |
| `bank_new_status` | 否 | String | 证件最新状态 (1 最新、0 非最新) | 1 |
| `bank_sex` | 否 | String | 性别 | 男 |
| `bank_status` | 否 | String | 返回的状态码，详情点击这里查看 | 01 |
| `codeid` | 否 | Integer | 状态码，返回10000状态都会进行计费。具体说明可查看状态码说明 | 10000 |
| `message` | 否 | String | 请求状态说明 | 通过 |
| `retdata` | 否 | Array | 回数据集合,可能是数据、对象或者字符串 |  |
| `time` | 否 | String | 请求时传递的当前服务器时间戳 | 1577695766 |

## JSON 返回示例

```json
{
    "codeid": "10000",
    "message": "通过",
    "retdata": {
        "bank_status": "01",
        "bank_msg": "验证通过",
        "bank_idCard": "*****",
        "bank_name": "*****",
        "bank_sex": "男",
        "bank_area": "江西省广昌县",
        "bank_birthday": "*****",
        "bank_attachment": {
            "bank_domicile_status": "0",
            "bank_new_status": "1",
            "bank_lost_status": "0",
            "bank_expire_status": "0"
        }
    },
    "time": 1577695766
}
```

## 状态码说明

| 状态码 | 说明 |
| --- | --- |
| `10000` | 返回成功 |
| `10001` | appid必须指定，可以我的应用里面查看 |
| `10002` | sign值必须指定，加密规则请前往帮助中心查看 |
| `10003` | sign值验证不通过，加密规则请前往帮助中心查看 |
| `10004` | 时差不能超过10分钟，可以不传递这个参数，注意时间戳单位是秒 |
| `10005` | appid错误，请检查appid值,前往会员中心->我的应用查看或添加 |
| `10006` | 当前IP地址未授权，请前往用户中心->我的应用添加ip{@info} |
| `10007` | 应用被禁用，请联系客服处理 |
| `10008` | 应用内没有该接口，请到我的应用里面添加这个接口 |
| `10009` | api接口不存在 |
| `10010` | 您没有添加该api接口 |
| `10011` | api已经到期 |
| `10012` | 没有订购任何api,请前往购买后再操作 |
| `10013` | 该接口已经暂停使用 |
| `10014` | 未知的错误，可以联系客服处理 |
| `10015` | 参数个数错误 |
| `10019` | {@info} |
| `10017` | time必须是整型 |
| `10018` | 次数不足 |
| `10020` | 子接口不存在,可能已经被关闭 |
| `10021` | 服务器发生错误 |
| `10022` | 帐户余额不足，请充值！ |
| `10023` | 订单提交成功，等待回调结果 |
| `10024` | 调试模式数据 |
| `10025` | 查无数据 |

## 对接提示

1. 先在挖数据（wapi.cn）创建应用，获取 `appid` 与密钥。
2. 按上方参数组装请求，计算 `sign` 后调用接口地址。
3. 可用在线测试工具：`https://www.wapi.cn/api_debug/207/387.html`