如：appid=xyzxyzxyz，timestamp=1555378976238，app_security=efcefcefcefcefc ;
 拼接后的字符串：str=xyzxyzxyz&1555378976238&efcefcefcefcefc ;
 加密后得到sign = md5(str) = 4e7e1974b79f3656aeaf03f1158f5d5d ;

{
    "msg": "成功",
    "success": true,
    "code": 200,
    "data": {
        "order_no": "634416423342575616",
        "result": 0,
        "side": "front",
        "info": {
            "number": "320382198912014010",
            "address": "江苏省苏州市岔河镇东沙庄村黄庄150号",
            "month": "12",
            "nation": "汉",
            "year": "1989",
            "sex": "男",
            "name": "赵宁宁",
            "day": "1"
        },
        "validity": {
            "birthday": true,
            "number": true,
            "address": true,
            "sex": true,
            "name": true
        },
        "image_url": "https://img.../16974...jpg"
    }
}

{
    "msg": "成功",
    "success": true,
    "code": 200,
    "data": {
        "order_no": "634436714873622528",
        "result": 0,
        "side": "back",
        "info": {
            "authority": "杭州市公安局余杭分局",
            "timelimit": "20180806-20380806"
        },
        "validity": {
            "authority": true,
            "timelimit": true
        },
        "image_url": null
    }
}

{
    "msg": "参数错误",
    "success": false, 
    "code": 400, 
    "data": { }
}

<h1><a id="OCR_0"></a>接口名称：身份证OCR(含头像)</h1> <h4><a id="_2"></a>描述：传入身份证照片，扫描识别身份证信息并返回，如果传的是正面照片只返回正面信息，如果传的是反面只返回反面信息</h4> <blockquote> <p>图片要求：格式为 jpg或png，宽和⾼大于 8px，⼩于等于4000px，大小不能超过1MB</p> </blockquote> <p>请求地址 url：https://api.shuliancloud.com/v2/idcard/ocr<br /> 请求方式 method：post<br /> 参数：</p> <table> <thead> <tr> <th>名称</th> <th>类型</th> <th>是否必填</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>appid</td> <td>varchar</td> <td>是</td> <td>服务商分配的唯一标识</td> </tr> <tr> <td>timestamp</td> <td>number</td> <td>是</td> <td>当前时间的毫秒数</td> </tr> <tr> <td>sign</td> <td>varchar</td> <td>是</td> <td>签名，<a href="#sign">签名算法说明</a></td> </tr> <tr> <td>image</td> <td>varchar</td> <td>否</td> <td>图片base64字符串，image、url二选一</td> </tr> <tr> <td>url</td> <td>varchar</td> <td>否</td> <td>图片url，image、url二选一</td> </tr> </tbody> </table> <a> <h4><a id="_22"></a>签名算法说明：</h4> <h6><a id="appidtimestampapp_security_md5_23"></a>服务商分配的appid、当前时间毫秒数timestamp、商户分配的app_security、 三者通过&amp;符号拼接成字符串进行md5加密得到。</h6> <pre><code> 如：appid=xyzxyzxyz，timestamp=1555378976238，app_security=efcefcefcefcefc ; 拼接后的字符串：str=xyzxyzxyz&amp;1555378976238&amp;efcefcefcefcefc ; 加密后得到sign = md5(str) = 4e7e1974b79f3656aeaf03f1158f5d5d ; </code></pre> </a> <h4><a id="_29"></a>正面返回：</h4> <pre><code class="lang-">{ &quot;msg&quot;: &quot;成功&quot;, &quot;success&quot;: true, &quot;code&quot;: 200, &quot;data&quot;: { &quot;order_no&quot;: &quot;634416423342575616&quot;, &quot;result&quot;: 0, &quot;side&quot;: &quot;front&quot;, &quot;info&quot;: { &quot;number&quot;: &quot;320382198912014010&quot;, &quot;address&quot;: &quot;江苏省苏州市岔河镇东沙庄村黄庄150号&quot;, &quot;month&quot;: &quot;12&quot;, &quot;nation&quot;: &quot;汉&quot;, &quot;year&quot;: &quot;1989&quot;, &quot;sex&quot;: &quot;男&quot;, &quot;name&quot;: &quot;赵宁宁&quot;, &quot;day&quot;: &quot;1&quot; }, &quot;validity&quot;: { &quot;birthday&quot;: true, &quot;number&quot;: true, &quot;address&quot;: true, &quot;sex&quot;: true, &quot;name&quot;: true }, &quot;image_url&quot;: &quot;https://img.../16974...jpg&quot; } } </code></pre> <h4><a id="_60"></a>反面返回</h4> <pre><code class="lang-">{ &quot;msg&quot;: &quot;成功&quot;, &quot;success&quot;: true, &quot;code&quot;: 200, &quot;data&quot;: { &quot;order_no&quot;: &quot;634436714873622528&quot;, &quot;result&quot;: 0, &quot;side&quot;: &quot;back&quot;, &quot;info&quot;: { &quot;authority&quot;: &quot;杭州市公安局余杭分局&quot;, &quot;timelimit&quot;: &quot;20180806-20380806&quot; }, &quot;validity&quot;: { &quot;authority&quot;: true, &quot;timelimit&quot;: true }, &quot;image_url&quot;: null } } </code></pre> <h4><a id="_84"></a>错误返回：</h4> <pre><code class="lang-">{ &quot;msg&quot;: &quot;参数错误&quot;, &quot;success&quot;: false, &quot;code&quot;: 400, &quot;data&quot;: { } } </code></pre> <h4><a id="_94"></a>返回字段说明：</h4> <table> <thead> <tr> <th>字段名</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>success</td> <td>接口请求成功标识，true为成功，false为失败，失败情况下，会有对应描述和状态码</td> </tr> <tr> <td>code</td> <td>成功为200，其它为失败状态码</td> </tr> <tr> <td>msg</td> <td>code对应的说明描述</td> </tr> <tr> <td>data</td> <td>验证结果详细信息</td> </tr> <tr> <td>order_no</td> <td>订单号</td> </tr> <tr> <td>result</td> <td>扫描成功 0 收费；扫描失败 1 不收费</td> </tr> <tr> <td>side</td> <td>身份证⽅方向信息。front 代表身份证正面(⼈像面)， back 代表身份证反面(国徽⾯)</td> </tr> <tr> <td>info</td> <td>身份证信息，分正面和反面，见详情</td> </tr> <tr> <td>validity</td> <td>扫描成功结果，分正面和反面，见详情</td> </tr> <tr> <td>image_url</td> <td>身份证头像照片URL</td> </tr> </tbody> </table> <h4><a id="info_109"></a>info返回字段</h4> <table> <thead> <tr> <th>字段名</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>name</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> <tr> <td>number</td> <td>身份证号</td> </tr> <tr> <td>authority</td> <td>签发机关</td> </tr> <tr> <td>timelimit</td> <td>身份证有效期</td> </tr> </tbody> </table> <p>上传身份证正面照片时返回字段 name , sex , nation , year , mouth , day , address ，number ，上传身份证背面照⽚时返回字段 authority 和 timelimit</p> <h4><a id="validity_125"></a>validity返回字段</h4> <table> <thead> <tr> <th>字段名</th> <th>说明</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> <tr> <td>authority</td> <td>签发机关</td> </tr> <tr> <td>timelimit</td> <td>身份证有效期</td> </tr> </tbody> </table> <p>上传身份证正面照片时返回字段 name , sex , birthday , address，number ， 上传身份证背⾯照片时返回字段 authority 和 timelimit</p> <p>当上传的图⽚是⾮身份证图⽚片时，系统不会报错，但这种情况下就需要关注 validity 中的信息，如有false，说明对应识别结果不可信</p> <h4><a id="code_140"></a>code错误码说明</h4> <table> <thead> <tr> <th>code</th> <th>说明</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>501</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>1001</td> <td>其他，以实际返回为准</td> </tr> </tbody> </table>