身份实名认证API

提供身份证二要素核验功能(姓名 + 身份证号)

API 基本信息

API 端点
api/id_verification_api.php
请求方法
POST / GET / JSON
认证方式
API Key
响应格式
JSON
POST

身份实名认证

验证姓名与身份证号是否匹配
验证姓名与身份证号是否匹配。每次调用消耗1次身份实名认证API调用次数。
请求参数
参数名 类型 是否必填 描述
api_key string 必填 用户API密钥
name string 必填 姓名(2-50个字符,支持中文、英文、空格、连字符)
idcard string 必填 身份证号(18位)
响应字段说明
字段名 类型 说明
success boolean 请求是否成功
message string 响应消息
matched boolean 姓名与身份证号是否匹配
extra object 补充信息(根据上游接口返回,可能包含:sex/gender性别、birthday/birth出生日期、address/location地址、age年龄、nation民族、province省份、city城市、district区县等)
参数传递方式
参数可通过以下方式传递(优先级从高到低):
1. JSON Body (Content-Type: application/json)
2. POST Form (Content-Type: application/x-www-form-urlencoded)
3. GET Query String
请求示例
// JSON 请求示例 (application/json)
{
  "api_key": "your_api_key",
  "name": "张三",
  "idcard": "110101199001011234"
}

// POST 请求示例 (application/x-www-form-urlencoded)
api_key=your_api_key&name=张三&idcard=110101199001011234

// GET 请求示例
api/id_verification_api.php?api_key=your_api_key&name=张三&idcard=110101199001011234
响应示例
{
  "success": true,
  "message": "核验通过",
  "matched": true,
  "extra": {
    "sex": "男",
    "birthday": "19900101",
    "address": "北京市东城区"
  }
}

错误码说明

错误信息 说明
无效的API密钥 API密钥不存在或无效
姓名不能为空 未提供姓名参数
身份证号不能为空 未提供身份证号参数
身份证号格式不正确 身份证号格式校验失败(长度或校验码)
姓名格式不正确 姓名格式校验失败(长度或字符类型)
身份实名认证调用次数不足 用户调用次数不足
未配置身份认证API密钥 系统未配置阿里云AppCode
核验失败: xxx 上游API返回的错误信息

注意事项

  1. API 调用需要有效的 API 密钥,请在用户中心获取并妥善保管。
  2. 每次调用消耗1次身份实名认证API调用次数。
  3. 如果调用失败(网络错误、API错误等),会自动加回1次调用次数(后补偿机制)。
  4. 姓名和身份证号会进行脱敏处理后记录到日志中,保护用户隐私。
  5. 身份证号格式校验包括:长度验证(18位)和校验码验证。
  6. 建议在调用前先进行本地格式校验,避免浪费调用次数。
  7. 姓名长度限制:2-50个字符,支持中文、英文、空格、连字符。