户口本OCR
<h3>接口描述</h3>
<ul>
<li>传入户口本照片，扫描识别户口本信息信息并返回</li>
<li>图片大小必须在20K到500K之间，支持jpg/png/bmp格式。</li>
<li>支持对户口本内常住人口登记卡的全部 22 个字段，包括户号、姓名、与户主关系、性别、出生地、民族、出生日期、身份证号、本市县其他住址、曾用名、籍贯、宗教信仰、身高、血型、文化程度、婚姻状况、兵役状况、服务处所、职业、何时由何地迁往本市、何时由何地迁往本址、登记日期。</li>
<li>支持对户口本内户主页的5个字段进行结构化识别，包括户别、户主姓名、户号、住址、户主页时间。</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/ocr/householdRegister</code></p>
<h3>请求方式</h3>
<ul>
<li>POST</li>
</ul>
<h3>请求格式</h3>
<ul>
<li>form-data</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>file</td>
<td>File</td>
<td>否</td>
<td>户口本照片，file、base64、url 必须提供一个</td>
</tr>
<tr>
<td>base64</td>
<td>String</td>
<td>否</td>
<td>户口本照片base64字符串，file、base64、url 必须提供一个</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>户口本照片 url，file、base64、url 必须提供一个</td>
</tr>
<tr>
<td>householdSide</td>
<td>String</td>
<td>否</td>
<td>户主或成员页 默认值subpage subpage：常住人口登记卡 (成员）homepage:户主页</td>
</tr>
</tbody>
</table>
<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>{
&quot;code&quot;: 200, // 详见code返回码说明
&quot;msg&quot;: &quot;成功&quot;, // code 对应的描述
&quot;charge&quot;: true, // 计费标志
&quot;taskNo&quot;: &quot;30853523396532582768&quot;, // 本次请求号
&quot;data&quot;: {
&quot;birthAddress&quot;: &quot;广东省英德市&quot;,//出生地址
&quot;name&quot;: &quot;梁小满&quot;,//名称
&quot;relationship&quot;: &quot;户主&quot;,//与户主关系
&quot;cardNo&quot;: &quot;4418221980080063171&quot;,//身份证号
&quot;sex&quot;: &quot;男&quot;,//性别
&quot;nation&quot;: &quot;汉族&quot;,//民族
&quot;belief&quot;: &quot;无宗教信仰&quot;,//宗教
&quot;career&quot;: &quot;农业&quot;,//职业
&quot;maritalStatus&quot;: &quot;未婚&quot;,//婚姻状态
&quot;registerDate&quot;: &quot;2009年6月30日&quot;,//登记日期
&quot;birthday&quot;: &quot;1980年08月03日&quot;,//出生日期
&quot;education&quot;: &quot;初中&quot;,//学历
&quot;hometown&quot;: &quot;广东省英德市&quot;//籍贯
&quot;whenWhereToCity&quot;: &quot;1980年09月01日出生&quot;,//何时由何地迁来本市(县)
&quot;whenWhereToHere&quot;: &quot;1980年09月01日出生&quot;,//何时由何地迁往本址
&quot;householdNum&quot;: &quot;&quot;,//户号
&quot;formerName&quot;: &quot;&quot;,//曾用名
&quot;otherAddress&quot;: &quot;&quot;,//本市（县）其他住址
&quot;height&quot;: &quot;&quot;,//身高
&quot;bloodType&quot;: &quot;&quot;,//血型
&quot;veteranStatus&quot;: &quot;&quot;,//兵役状况
&quot;workAddress&quot;: &quot;&quot;//服务处所
}
}</code></pre>
<h3>错误返回样例</h3>
<pre><code>{
&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>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>charge</td>
<td>计费标志</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果，object类型，详见成功返回体</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>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>702</td>
<td>未识别到图片</td>
</tr>
<tr>
<td>999</td>
<td>其他，以实际返回为准</td>
</tr>
</tbody>
</table>