HTTP/HTTPS
请求协议
OAPI接口服务市场 / OpenAPI / 身份证识别接口
身份证识别接口
接口地址：https://www.oapi.cc/store/App.Idcard.Ocr
接口描述： 通过传递身份证照片识别身份证信息
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 | ||
| ImageBase64 | 字符串 | 可选 | - | 图片的 Base64 值。要求图片经Base64编码后不超过 7M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 | |
| ImageUrl | 字符串 | 可选 | - | 图片的 Url 地址。要求图片经Base64编码后不超过 7M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。 | |
| CardSide | 字符串 | 可选 | - | FRONT：身份证有照片的一面（人像面）， BACK：身份证有国徽的一面（国徽面）， 该参数如果不填，将为您自动判断身份证正反面。 | |
| Config | 字符串JSON格式 | 可选 | - | 以下可选字段默认false： CropIdCard，身份证照片裁剪（去掉证件外多余的边缘、自动矫正拍摄角度） CropPortrait，人像照片裁剪（自动抠取身份证头像区域） CopyWarn，复印件告警 BorderCheckWarn，边框和框内遮挡告警 ReshootWarn，翻拍告警 DetectPsWarn，PS检测告警 TempIdWarn，临时身份证告警 InvalidDateWarn，身份证有效日期不合法告警 Quality，图片质量分数（评价图片的模糊程度） MultiCardDetect，是否开启多卡证检测 ReflectWarn，是否开启反光检测。 {"CropIdCard":"true","CropPortrait":"true"} |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.Name | 字符串 | 姓名（人像面） |
| data.Sex | 字符串 | 性别（人像面） |
| data.Nation | 字符串 | 民族（人像面） |
| data.Birth | 字符串 | 出生日期（人像面） |
| data.Address | 字符串 | 地址（人像面） |
| data.IdNum | 字符串 | 身份证号（人像面） |
| data.Authority | 字符串 | 发证机关（国徽面） |
| data.ValidDate | 字符串 | 证件有效期（国徽面） |
| data.AdvancedInfo | 字符串 | 扩展信息，不请求则不返回 IdCard，裁剪后身份证照片的base64编码，请求 Config.CropIdCard 时返回； Portrait，身份证头像照片的base64编码，请求 Config.CropPortrait 时返回； Quality，图片质量分数，请求 Config.Quality 时返回（取值范围：0~100，分数越低越模糊，建议阈值≥50）; BorderCodeValue，身份证边框不完整告警阈值分数，请求 Config.BorderCheckWarn时返回（取值范围：0~100，分数越低边框遮挡可能性越低，建议阈值≥50）; WarnInfos，告警信息，Code 告警码列表和释义： -9100 身份证有效日期不合法告警， -9101 身份证边框不完整告警， -9102 身份证复印件告警， -9103 身份证翻拍告警， -9105 身份证框内遮挡告警， -9104 临时身份证告警， -9106 身份证 PS 告警， -9107 身份证反光告警。 |
| data.RequestId | 字符串 | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| ImageBase64 | 可选 | |
| ImageUrl | 可选 | |
| CardSide | 可选 | |
| Config | 可选 |
客户端请求示例
# 暂无示例，可添加示例文件：./src/view/docs/demos/App.Idcard.Ocr.json错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | 表示客户端参数错误 |
| 404 | 表示接口服务不存在 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2025-05-04 19:46:04