全局文档
产品文档
失联修复
身份验证
图片OCR
身份证OCR(idcardocr)
驾驶证OCR(driving_license_ocr)
行驶证OCR(vehicle_license_ocr)
行驶证正页OCR(vehicle_license_front_ocr)
车牌号OCR(platenoocr)
手机号码检测
车辆信息查验
企业背景

验真平台API文档


身份证OCR(idcardocr)

<p>[TOC]</p> <h5>产品描述</h5> <ul> <li>检测和识别中华人民共和国身份证图片为结构化的文字信息,如:身份证图片类型、姓名、身份证号、签发机关等</li> </ul> <h5>接口地址</h5> <ul> <li>请求地址:<code>https://api.caih.com/verify/api/idcardocr</code></li> <li>请求方式:POST</li> <li>接口数据类型:JSON</li> <li>编码方式:UTF-8</li> <li>接口参数传递位置:请求体body</li> <li>接口参数传递内容:认证信息参数(authinfo)和校验请求参数(param)</li> </ul> <h5>接口须知</h5> <ul> <li><strong>认证信息参数</strong> 和 <strong>统一响应参数</strong>请查看页面 <a href="https://www.showdoc.cc/p/52021eddfd9994a7b84d891a16e27f66" title="认证信息参数和统一响应参数">认证信息参数和统一响应参数</a></li> <li>如需加密对接请查看页面 <a href="https://www.showdoc.cc/p/dfff667dec3c68748dddde67674eb993" title="加密对接说明">加密对接说明</a>,并联系运营人员进行配置</li> </ul> <h5>校验请求参数(param)</h5> <table> <thead> <tr> <th>参数名</th> <th>是否必填</th> <th>类型</th> <th><div style="width: 400px"/>说明</th> </tr> </thead> <tbody> <tr> <td>imagetype</td> <td>是</td> <td>string</td> <td>图片类型的枚举值:</br>URL:图片网络地址</br>BASE64:图片的base64编码</br>默认值:URL</td> </tr> <tr> <td>url</td> <td>否</td> <td>string</td> <td>图片网络地址,支持http/https,imagetype为URL时为必填</td> </tr> <tr> <td>base64</td> <td>否</td> <td>string</td> <td>图片的base64编码,无图片头,imagetype为BASE64时为必填</td> </tr> <tr> <td>idcardside</td> <td>否</td> <td>string</td> <td>身份证正反面的枚举值:</br>0:身份证正面</br>1:身份证反面</br>默认值:0</td> </tr> </tbody> </table> <p>图片文件类型建议jpg格式,图片大小建议1M左右,不能大于2M</p> <h5>请求示例</h5> <pre><code>{ (认证信息参数) "param": { "imagetype": "BASE64", "base64": "/9j/4AAQSkZJRgABAQIAdgB2AAD/2wBDAAgGBgcGBQgHB", "idcardside": "0" } }</code></pre> <h5>产品响应参数(data)</h5> <p>验真状态码及描述请查看本页章节 <code>验真状态码及描述</code> 。 只有在入参的身份证正反面(idcardside)为对应值时,才会有对应的参数。如:当idcardside为1,且state为1,才会返回issuingauthority、issuingdate、expirydate</p> <table> <thead> <tr> <th>参数名</th> <th>是否必填</th> <th>类型</th> <th>身份证正反面</th> <th><div style="width: 300px"/>说明</th> </tr> </thead> <tbody> <tr> <td>state</td> <td>是</td> <td>string</td> <td>正、反</td> <td>验真状态码</td> </tr> <tr> <td>desc</td> <td>是</td> <td>string</td> <td>正、反</td> <td>验真状态码描述</td> </tr> <tr> <td>risktype</td> <td>否</td> <td>string</td> <td>正</td> <td>身份证图片类型的枚举值:</br>normal:正常身份证</br>copy:复印件</br>temporary:临时身份证</br>screen:翻拍</br>unknown:其他未知情况</br>idcardside为0时返回该参数</td> </tr> <tr> <td>address</td> <td>否</td> <td>string</td> <td>正</td> <td>地址</td> </tr> <tr> <td>birthday</td> <td>否</td> <td>string</td> <td>正</td> <td>生日</td> </tr> <tr> <td>name</td> <td>否</td> <td>string</td> <td>正</td> <td>姓名</td> </tr> <tr> <td>idcardnum</td> <td>否</td> <td>string</td> <td>正</td> <td>身份证号</td> </tr> <tr> <td>sex</td> <td>否</td> <td>string</td> <td>正</td> <td>性别</td> </tr> <tr> <td>nation</td> <td>否</td> <td>string</td> <td>正</td> <td>民族</td> </tr> <tr> <td>issuingauthority</td> <td>否</td> <td>string</td> <td>反</td> <td>签发机关</td> </tr> <tr> <td>issuingdate</td> <td>否</td> <td>string</td> <td>反</td> <td>签发日期</td> </tr> <tr> <td>expirydate</td> <td>否</td> <td>string</td> <td>反</td> <td>有效日期</td> </tr> </tbody> </table> <h5>返回示例</h5> <h6>查询成功</h6> <pre><code>{ (统一响应参数) "data": { "state": "1", "desc": "识别成功", "address": "河南省****", "birthday": "19940305", "name": "小明", "idcardnum": "412825****", "risktype": "copy", "sex": "男", "nation": "汉" } }</code></pre> <h6>查询失败</h6> <pre><code>{ (统一响应参数) "data": { "state": "0", "desc": "失败" } }</code></pre> <h5>验真状态码及描述</h5> <table> <thead> <tr> <th>验真状态码(state)</th> <th>验真状态码描述(desc)</th> <th>是否收费</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>0</td> <td>失败</td> <td>否</td> </tr> <tr> <td>1</td> <td>识别成功</td> <td>是</td> <td>该情况有其他响应参数</td> </tr> </tbody> </table>

页面列表

ITEM_HTML