身份证OCR_标准版
<p>[TOC]</p>
<h3>接口描述</h3>
<ul>
<li>根据身份证照片，识别身份证信息</li>
<li>自动识别人像面和国徽面，如果传人像面照片则只返回人像面信息，如果传国徽面照片则只返回国徽面信息</li>
<li>照片格式为 jpg或png，宽和⾼大于 8px，⼩于等于4000px，文件大小不能超过2MB</li>
</ul>
<h3>请求说明</h3>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/ocr/idcard-v1</code></p>
<h4>请求方式</h4>
<ul>
<li>POST</li>
</ul>
<h4>请求格式</h4>
<ul>
<li>form-data</li>
</ul>
<h4>请求参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>appId</td>
<td>String</td>
<td>是</td>
<td>服务商分配的唯一标识</td>
</tr>
<tr>
<td>timestamp</td>
<td>Long</td>
<td>是</td>
<td>当前时间的毫秒数</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>签名，见签名算法说明</td>
</tr>
<tr>
<td>file</td>
<td>File</td>
<td>否</td>
<td>身份证正面或反面照片，文件类型，file、image、url 必须提供一个</td>
</tr>
<tr>
<td>base64</td>
<td>String</td>
<td>否</td>
<td>照片base64字符串，file、image、url 必须提供一个</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>照片 url，file、image、url 必须提供一个</td>
</tr>
</tbody>
</table>
<h4>签名算法说明</h4>
<pre><code class="language-java">sign = sha256(appId + appSecret + timestamp)</code></pre>
<p>用服务商分配的 appId、服务商分配的 appSecret，当前时间毫秒数 timestamp，按上述顺序拼接成字符串，再进行 sha256 哈希得到。如下：</p>
<pre><code class="language-java">String appId = &quot;xyzxy2121zxyz&quot;；
String timestamp = &quot;1555378976238&quot;；
String appSecret = &quot;efcefcef1121cefcefc1212121&quot;；
String str = appId + appSecret + timestamp；
String sign = sha256(str)；</code></pre>
<h3>返回说明</h3>
<h4>人像面返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200, // 返回码，详见返回码说明
&quot;msg&quot;: &quot;成功&quot;, // 返回码对应描述
&quot;taskNo&quot;: &quot;65605503936940344488&quot;, // 本次请求号
&quot;charge&quot;: true, // 计费标志
&quot;data&quot;: {
&quot;result&quot;: 0,
&quot;side&quot;: &quot;front&quot;,
&quot;info&quot;: {
&quot;number&quot;: &quot;330106198912014010&quot;,
&quot;name&quot;: &quot;赵宁宁&quot;,
&quot;address&quot;: &quot;浙江省杭州市西湖区文二路108号&quot;,
&quot;year&quot;: &quot;1989&quot;,
&quot;month&quot;: &quot;12&quot;,
&quot;day&quot;: &quot;1&quot;,
&quot;nation&quot;: &quot;汉&quot;,
&quot;sex&quot;: &quot;男&quot;
},
&quot;validity&quot;: {
&quot;birthday&quot;: true,
&quot;number&quot;: true,
&quot;address&quot;: true,
&quot;sex&quot;: true,
&quot;name&quot;: true
}
}
}</code></pre>
<h4>国徽面返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200, // 返回码，详见返回码说明
&quot;msg&quot;: &quot;成功&quot;, // 返回码对应描述
&quot;taskNo&quot;: &quot;65605503936940344488&quot;, // 本次请求号
&quot;charge&quot;: true, // 计费标志
&quot;data&quot;: {
&quot;result&quot;: 0,
&quot;side&quot;: &quot;back&quot;,
&quot;rotate&quot;: &quot;cw90&quot;,
&quot;info&quot;: {
&quot;authority&quot;: &quot;杭州市公安局余杭分局&quot;,
&quot;timelimit&quot;: &quot;20190806-20390806&quot;
},
&quot;validity&quot;: {
&quot;authority&quot;: true,
&quot;timelimit&quot;: true
}
}
}</code></pre>
<h4>错误返回样例</h4>
<pre><code class="language-json">{
&quot;msg&quot;: &quot;照片格式不正确&quot;,
&quot;code&quot;: 400
}</code></pre>
<h4>返回字段说明</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>返回码，详见code返回码说明</td>
</tr>
<tr>
<td>msg</td>
<td>code对应的描述</td>
</tr>
<tr>
<td>charge</td>
<td>是否计费</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果，object类型，详见data返回字段描述</td>
</tr>
</tbody>
</table>
<h4>data返回字段说明</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>result</td>
<td>扫描结果，0 - 扫描成功；1 - 扫描失败</td>
</tr>
<tr>
<td>side</td>
<td>front - ⼈像面， back - 国徽⾯</td>
</tr>
<tr>
<td>rotate</td>
<td>旋转角度。返回旋转的角度值，可能的值为 cw90，cw180，cw270，表明顺时针旋转的角度。如果没有发生旋转，则不返回此字段</td>
</tr>
<tr>
<td>info</td>
<td>扫描结果信息，分正面和反面，详见info字段说明</td>
</tr>
<tr>
<td>validity</td>
<td>各字段扫描是否成功，分正面和反面，详见validity字段说明</td>
</tr>
</tbody>
</table>
<h4>info返回字段说明</h4>
<h5>⼈像面</h5>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>姓名</td>
</tr>
<tr>
<td>number</td>
<td>身份证号</td>
</tr>
<tr>
<td>sex</td>
<td>性别</td>
</tr>
<tr>
<td>nation</td>
<td>民族</td>
</tr>
<tr>
<td>year</td>
<td>出⽣年</td>
</tr>
<tr>
<td>month</td>
<td>出⽣月</td>
</tr>
<tr>
<td>day</td>
<td>出⽣日</td>
</tr>
<tr>
<td>address</td>
<td>地址</td>
</tr>
</tbody>
</table>
<h5>国徽⾯</h5>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>authority</td>
<td>签发机关</td>
</tr>
<tr>
<td>timelimit</td>
<td>身份证有效期</td>
</tr>
</tbody>
</table>
<h4>validity返回字段说明</h4>
<p>指单个字段是否扫描成功，true：成功，false：失败，分正面和反面</p>
<ul>
<li>注意：当上传的照片是⾮身份证照片时，系统不会报错，但validity中所有字段都会为 false ，请参考 validity 字段进行判断</li>
</ul>
<h5>⼈像面</h5>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>birthday</td>
<td>生日</td>
</tr>
<tr>
<td>number</td>
<td>身份证号</td>
</tr>
<tr>
<td>address</td>
<td>地址</td>
</tr>
<tr>
<td>sex</td>
<td>性别</td>
</tr>
<tr>
<td>name</td>
<td>姓名</td>
</tr>
</tbody>
</table>
<h5>国徽⾯</h5>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>authority</td>
<td>签发机关</td>
</tr>
<tr>
<td>timelimit</td>
<td>身份证有效期</td>
</tr>
</tbody>
</table>
<h4>code返回码说明</h4>
<table>
<thead>
<tr>
<th>code</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功 （计费）</td>
</tr>
<tr>
<td>301</td>
<td>识别失败</td>
</tr>
<tr>
<td>400</td>
<td>参数错误</td>
</tr>
<tr>
<td>404</td>
<td>接口地址不正确</td>
</tr>
<tr>
<td>500</td>
<td>系统维护，请稍候再试</td>
</tr>
<tr>
<td>601</td>
<td>接口未开通</td>
</tr>
<tr>
<td>602</td>
<td>账号停用</td>
</tr>
<tr>
<td>603</td>
<td>余额不足请充值</td>
</tr>
<tr>
<td>604</td>
<td>接口停用</td>
</tr>
<tr>
<td>606</td>
<td>调用超限，请稍候再试</td>
</tr>
<tr>
<td>607</td>
<td>ip不在白名单</td>
</tr>
<tr>
<td>609</td>
<td>请求过于频繁，请稍候再试</td>
</tr>
<tr>
<td>610</td>
<td>请求超时</td>
</tr>
<tr>
<td>999</td>
<td>其他，以实际返回为准</td>
</tr>
</tbody>
</table>