港澳台通行证OCR
<p>[TOC]</p>
<h3>接口描述</h3>
<ul>
<li>支持识别4类港澳台出入境证件，包含港澳通行证正/反面、台湾通行证正/反面、台胞证（台湾居民来往大陆通行证）正/反面、返乡证（港澳居民来往内地通行证）正/反面，支持识别以上4类证件的全部字段信息。</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/ocr/exitentrypermit/hk-macau-taiwan</code></p>
<h3>请求方式</h3>
<ul>
<li>POST</li>
</ul>
<h3>请求格式</h3>
<ul>
<li>x-www-form-urlencoded</li>
</ul>
<h3>请求参数</h3>
<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>type</td>
<td>String</td>
<td>是</td>
<td>类型</br>hk_mc_passport_front：港澳通行证正面 </br>hk_mc_passport_back：港澳通行证反面</br>tw_passport_front：台湾通行证正面</br>tw_passport_back：台湾通行证反面</br>tw_return_passport_front：台胞证正面</br>tw_return_passport_back：台胞证反面</br>hk_mc_return_passport_front：返乡证正面</br>hk_mc_return_passport_back：返乡证反面</br></td>
</tr>
<tr>
<td>image</td>
<td>String</td>
<td>否</td>
<td>图片base64</td>
</tr>
<tr>
<td>pdf</td>
<td>String</td>
<td>否</td>
<td>PDF文件的base64</td>
</tr>
<tr>
<td>pdfNum</td>
<td>String</td>
<td>否</td>
<td>需要识别的PDF文件的对应页码，不传默认识别第1页</td>
</tr>
<tr>
<td>file</td>
<td>File</td>
<td>否</td>
<td>图片文件或pdf文件</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>图片或pdf的url</td>
</tr>
</tbody>
</table>
<ul>
<li>image、pdf、file、url 必须提供一个，优先级：image > pdf > file > url</li>
<li>图片、pdf或odf文件不超过4M，最短边至少15px，最长边最大4096px，支持jpg/jpeg/png/bmp格式</li>
<li>图片支持jpg/jpeg/png/bmp格式</li>
</ul>
<h3>签名算法说明</h3>
<pre><code>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>
<pre><code class="language-json">{
&quot;code&quot;: 200, //详见code返回码说明
&quot;msg&quot;: &quot;成功&quot;,//code 对应的描述
&quot;taskNo&quot;: &quot;666000157174321156577895&quot;,//本次请求号
&quot;charge&quot;: true,//计费标志
&quot;data&quot;: {
&quot;birthday&quot;: &quot;1922.09.22&quot;,//出生日期
&quot;issue_place&quot;: &quot;浙江&quot;,//签发地点
&quot;issue_authority&quot;: &quot;中华人民共和国出入境管理局&quot;,//签发机关
&quot;valid_date&quot;: &quot;2022.01.13-2032.01.12&quot;,//有效期限
&quot;name_eng&quot;: &quot;xx,xx&quot;,//姓名（英文）
&quot;MRZCode&quot;: &quot;CSxxxxx&quot;,//证件下方第一行
&quot;card_number&quot;: &quot;CCxxxx&quot;,//证件号码
&quot;sex&quot;: &quot;男&quot;,//性别
&quot;name_chn&quot;: &quot;xx&quot;//姓名
}
}</code></pre>
<h3>错误返回样例</h3>
<pre><code class="language-json">{
&quot;msg&quot;: &quot;文件不能为空&quot;,
&quot;code&quot;: 400
}</code></pre>
<h3>返回字段说明</h3>
<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类型，详见成功返回体</td>
</tr>
</tbody>
</table>
<h4>港澳通行证正面</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>pdf_size</td>
<td>传入PDF文件的总页数，当 pdf 参数有效时返回该字段</td>
</tr>
<tr>
<td>card_number</td>
<td>证件号码</td>
</tr>
<tr>
<td>name_chn</td>
<td>姓名</td>
</tr>
<tr>
<td>name_eng</td>
<td>姓名（英文）</td>
</tr>
<tr>
<td>birthday</td>
<td>出生日期</td>
</tr>
<tr>
<td>sex</td>
<td>性别</td>
</tr>
<tr>
<td>valid_date</td>
<td>有效期限</td>
</tr>
<tr>
<td>issue_authority</td>
<td>签发机关</td>
</tr>
<tr>
<td>issue_place</td>
<td>签发地点</td>
</tr>
<tr>
<td>MRZCode</td>
<td>证件下方第一行</td>
</tr>
</tbody>
</table>
<h4>港澳通行证反面</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>pdf_size</td>
<td>传入PDF文件的总页数，当 pdf 参数有效时返回该字段</td>
</tr>
<tr>
<td>hk_type</td>
<td>来往香港签注-种类</td>
</tr>
<tr>
<td>hk_valid_date</td>
<td>来往香港签注-有效期</td>
</tr>
<tr>
<td>hk_remarks</td>
<td>来往香港签注-备注</td>
</tr>
<tr>
<td>hk_round_trip_number</td>
<td>来往香港签注-往返有效</td>
</tr>
<tr>
<td>mc_type</td>
<td>来往澳门签注-种类</td>
</tr>
<tr>
<td>mc_valid_date</td>
<td>来往澳门签注-有效期</td>
</tr>
<tr>
<td>mc_remarks</td>
<td>来往澳门签注-备注</td>
</tr>
<tr>
<td>mc_round_trip_number</td>
<td>来往澳门签注-往返有效</td>
</tr>
</tbody>
</table>
<h4>台湾通行证正面</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>pdf_size</td>
<td>传入PDF文件的总页数，当 pdf 参数有效时返回该字段</td>
</tr>
<tr>
<td>card_number</td>
<td>证件号码</td>
</tr>
<tr>
<td>name_chn</td>
<td>姓名</td>
</tr>
<tr>
<td>name_eng</td>
<td>姓名（英文）</td>
</tr>
<tr>
<td>birthday</td>
<td>出生日期</td>
</tr>
<tr>
<td>sex</td>
<td>性别</td>
</tr>
<tr>
<td>valid_date</td>
<td>有效期限</td>
</tr>
<tr>
<td>issue_authority</td>
<td>签发机关</td>
</tr>
<tr>
<td>issue_place</td>
<td>签发地点</td>
</tr>
<tr>
<td>MRZCode</td>
<td>证件下方第一行</td>
</tr>
</tbody>
</table>
<h4>台湾通行证反面</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>pdf_size</td>
<td>传入PDF文件的总页数，当 pdf 参数有效时返回该字段</td>
</tr>
<tr>
<td>type</td>
<td>种类</td>
</tr>
<tr>
<td>valid_date</td>
<td>有效期</td>
</tr>
<tr>
<td>remarks</td>
<td>备注</td>
</tr>
<tr>
<td>round_trip_number</td>
<td>往返有效</td>
</tr>
</tbody>
</table>
<h4>返乡证正面</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>pdf_size</td>
<td>传入PDF文件的总页数，当 pdf 参数有效时返回该字段</td>
</tr>
<tr>
<td>card_number</td>
<td>证件号码</td>
</tr>
<tr>
<td>name_chn</td>
<td>姓名</td>
</tr>
<tr>
<td>name_eng</td>
<td>姓名（英文）</td>
</tr>
<tr>
<td>birthday</td>
<td>出生日期</td>
</tr>
<tr>
<td>sex</td>
<td>性别</td>
</tr>
<tr>
<td>valid_date</td>
<td>有效期限</td>
</tr>
<tr>
<td>issue_authority</td>
<td>签发机关</td>
</tr>
<tr>
<td>issue_times</td>
<td>签发次数</td>
</tr>
</tbody>
</table>
<h4>返乡证反面</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>pdf_size</td>
<td>传入PDF文件的总页数，当 pdf 参数有效时返回该字段</td>
</tr>
<tr>
<td>idcard_name</td>
<td>身份证姓名</td>
</tr>
<tr>
<td>idcard_number</td>
<td>身份证号码</td>
</tr>
<tr>
<td>MRZCode1</td>
<td>证件下方第一行</td>
</tr>
<tr>
<td>MRZCode2</td>
<td>证件下方第二行</td>
</tr>
</tbody>
</table>
<h4>台胞证正面</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>pdf_file_size</td>
<td>传入PDF文件的总页数，当pdf_file参数有效时返回该字段</td>
</tr>
<tr>
<td>words_result_num</td>
<td>识别结果数，表示words_result的元素个数</td>
</tr>
<tr>
<td>words_result</td>
<td>识别结果</td>
</tr>
<tr>
<td>name_chn</td>
<td>姓名</td>
</tr>
<tr>
<td>name_eng</td>
<td>姓名（英文）</td>
</tr>
<tr>
<td>birthday</td>
<td>出生日期</td>
</tr>
<tr>
<td>sex</td>
<td>性别</td>
</tr>
<tr>
<td>valid_date</td>
<td>有效期限</td>
</tr>
<tr>
<td>issue_authority</td>
<td>签发机关</td>
</tr>
<tr>
<td>issue_place</td>
<td>签发地点</td>
</tr>
<tr>
<td>card_number</td>
<td>证件号码</td>
</tr>
<tr>
<td>issue_times</td>
<td>签发次数</td>
</tr>
<tr>
<td>word</td>
<td>字段识别结果，以上字段均包含</td>
</tr>
<tr>
<td>location</td>
<td>字段位置信息，当请求参数location=true时返回该字段，以上字段均包含</td>
</tr>
<tr>
<td>top</td>
<td>字段的上边距</td>
</tr>
<tr>
<td>left</td>
<td>字段的左边距</td>
</tr>
<tr>
<td>height</td>
<td>字段的高度</td>
</tr>
<tr>
<td>width</td>
<td>字段的宽度</td>
</tr>
<tr>
<td>probability</td>
<td>字段识别结果置信度，当请求参数probability=true时返回该字段，以上字段均包含</td>
</tr>
<tr>
<td>average</td>
<td>字段识别结果中各字符的置信度平均值</td>
</tr>
<tr>
<td>min</td>
<td>字段识别结果中各字符的置信度最小值</td>
</tr>
</tbody>
</table>
<h4>台胞证反面</h4>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>pdf_file_size</td>
<td>传入PDF文件的总页数，当pdf_file参数有效时返回该字段</td>
</tr>
<tr>
<td>words_result_num</td>
<td>识别结果数，表示words_result的元素个数</td>
</tr>
<tr>
<td>words_result</td>
<td>识别结果</td>
</tr>
<tr>
<td>idcard_name</td>
<td>身份证姓名</td>
</tr>
<tr>
<td>idcard_number</td>
<td>身份证号码</td>
</tr>
<tr>
<td>MRZCode1</td>
<td>证件下方第一行</td>
</tr>
<tr>
<td>MRZCode2</td>
<td>证件下方第二行</td>
</tr>
<tr>
<td>word</td>
<td>字段识别结果，以上字段均包含</td>
</tr>
<tr>
<td>location</td>
<td>字段位置信息，当请求参数location=true时返回该字段，以上字段均包含</td>
</tr>
<tr>
<td>top</td>
<td>字段的上边距</td>
</tr>
<tr>
<td>left</td>
<td>字段的左边距</td>
</tr>
<tr>
<td>height</td>
<td>字段的高度</td>
</tr>
<tr>
<td>width</td>
<td>字段的宽度</td>
</tr>
<tr>
<td>probability</td>
<td>字段识别结果置信度，当请求参数probability=true时返回该字段，以上字段均包含</td>
</tr>
<tr>
<td>average</td>
<td>字段识别结果中各字符的置信度平均值</td>
</tr>
<tr>
<td>min</td>
<td>字段识别结果中各字符的置信度最小值</td>
</tr>
</tbody>
</table>
<h3>code返回码说明</h3>
<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>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>