身份证识别
<p><strong>简要描述:</strong> </p>
<ul>
<li>OCR-身份证识别</li>
</ul>
<p><strong>请求方式:</strong></p>
<ul>
<li>API地址: <a href="https://open-beta.56yzm.com:8443">https://open-beta.56yzm.com:8443</a> (不同的环境,不同的API地址)</li>
<li>请求地址:/open-api/ocr/ocrScanIdCard</li>
</ul>
<p><strong>请求头数据 </strong></p>
<ul>
<li>Content-Type : application/json;charset=UTF-8 </li>
<li>Authorization: Bearer {your_access_token} </li>
</ul>
<p><strong>入参参数:</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">url</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">String</td>
<td>网络文件地址</td>
</tr>
<tr>
<td style="text-align: left;">side</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>检测身份证的人像面或国徽面。front:身份证人像面<br>back:身份证国徽面<br>如果参数值为空或无该参数,系统自动识别,建议填写,准确率更高。</td>
</tr>
<tr>
<td style="text-align: left;">returnVerification</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">boolean</td>
<td>返回校验身份证号等信息的开关,默认false,可选值如下所示:true:返回校验信息<br>false:不返回校验信息</td>
</tr>
<tr>
<td style="text-align: left;">returnTextLocation</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">boolean</td>
<td>识别到的文字块的区域位置信息。可选值包括:true:返回各个文字块区域<br>false:不返回各个文字块区域<br>如果无该参数,系统默认不返回文字块区域。如果输入参数不是Boolean类型,则会报非法参数错误。</td>
</tr>
<tr>
</tr>
<tr>
<td style="text-align: left;">detectReproduce</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">boolean</td>
<td>返回判断身份证图像是否经过翻拍的开关,默认false,可选值如下所示:true :返回身份证图像是否经过翻拍<br>false:不返回身份证图像是否经过翻拍</td>
</tr>
<tr>
<td style="text-align: left;">detectCopy</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">boolean</td>
<td>返回判断身份证图像是否是黑白复印件的开关,默认false,可选值如下所示:true :返回身份证图像是否是复印件<br>false : 不返回身份证图像是否是复印件</td>
</tr>
</tbody>
</table>
<p><strong>入参示例</strong></p>
<pre><code>{
&quot;side&quot;: &quot;front&quot;,
&quot;returnVerification&quot;: true,
&quot;url&quot;: &quot;https://static-5j56-com.oss-cn-shanghai.aliyuncs.com/idcardfront/9dcf0943-21e0-4222-a167-e4f301e681fd.jpg&quot;
}</code></pre>
<p><strong>返回参数说明</strong> </p>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">url</td>
<td style="text-align: left;">string</td>
<td>ocr识别的url</td>
</tr>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">string</td>
<td>姓名</td>
</tr>
<tr>
<td style="text-align: left;">sex</td>
<td style="text-align: left;">string</td>
<td>性别</td>
</tr>
<tr>
<td style="text-align: left;">birth</td>
<td style="text-align: left;">string</td>
<td>出生日期</td>
</tr>
<tr>
<td style="text-align: left;">ethnicity</td>
<td style="text-align: left;">string</td>
<td>民族</td>
</tr>
<tr>
<td style="text-align: left;">address</td>
<td style="text-align: left;">string</td>
<td>地址</td>
</tr>
<tr>
<td style="text-align: left;">number</td>
<td style="text-align: left;">string</td>
<td>身份证号</td>
</tr>
<tr>
<td style="text-align: left;">issue</td>
<td style="text-align: left;">string</td>
<td>发证机关</td>
</tr>
<tr>
<td style="text-align: left;">validFrom</td>
<td style="text-align: left;">string</td>
<td>有效起始日期</td>
</tr>
<tr>
<td style="text-align: left;">validTo</td>
<td style="text-align: left;">string</td>
<td>有效结束日期</td>
</tr>
<tr>
<td style="text-align: left;">verificationResult</td>
<td style="text-align: left;">object</td>
<td>校验信息。仅在输入参数returnVerification为true时,返回该字段,该字段包含validNumber、validBirth、validSex和validDate的校验信息。</td>
</tr>
<tr>
<td style="text-align: left;">textLocation</td>
<td style="text-align: left;">object</td>
<td>对应所有在原图上识别到的字段位置信息,包含所有文字区域四个顶点的二维坐标(x, y)。采用图像坐标系,坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。</td>
</tr>
<tr>
<td style="text-align: left;">detectReproduceResult</td>
<td style="text-align: left;">boolean</td>
<td>判断身份证图像是黑白复印件还是原件,“true”表示是复印件,“false”表示是原件。仅在输入参数detectCopy为true时,返回该字段。</td>
</tr>
</tbody>
</table>
<p><strong>出参示例</strong></p>
<pre><code> {
&quot;code&quot;: 200,
&quot;data&quot;: {
&quot;address&quot;: &quot;山东省烟台市福山区民阜路58号14号楼4单元203号&quot;,
&quot;birth&quot;: &quot;1980-02-26&quot;,
&quot;detectCopyResult&quot;: null,
&quot;detectReproduceResult&quot;: null,
&quot;ethnicity&quot;: &quot;汉&quot;,
&quot;imgUrl&quot;: &quot;https://img-prod.56yzm.com/prod/file/2024/10/23/4870bf8d5a19a6ce3359f5defb8c82c3.jpg&quot;,
&quot;issue&quot;: null,
&quot;name&quot;: &quot;王景波&quot;,
&quot;number&quot;: &quot;430611198002263536&quot;,
&quot;sex&quot;: &quot;男&quot;,
&quot;textLocation&quot;: null,
&quot;url&quot;: &quot;https://img-prod.56yzm.com/prod/file/2024/10/23/4870bf8d5a19a6ce3359f5defb8c82c3.jpg&quot;,
&quot;validFrom&quot;: &quot;&quot;,
&quot;validTo&quot;: &quot;&quot;,
&quot;verificationResult&quot;: {
&quot;validBirth&quot;: true,
&quot;validDate&quot;: false,
&quot;validNumber&quot;: true,
&quot;validSex&quot;: true
}
},
&quot;msg&quot;: &quot;操作成功&quot;
}</code></pre>