/v2/ocr/passport

• 1.接口描述
• 2.请求参数
• 3.返回参数
• 4.错误码
• 5.输入示例

1.接口描述

该API的功能主要是识别护照信息，此接口需要用户第一方授权，如有委托情况，需提供委托证明。

• 图片要求：
  1. 格式为 JPG（JPEG），BMP，PNG
  2. 宽和高大于 8px，小于等于 4800px
  3. 小于等于 5 MB

请求方式

POST

请求 URL

https://cloudapi.linkface.cn/v2/ocr/passport

2.请求参数

请求参数 file,url,image_id与 image_base64 必四选一，如同时传入多个参数，本API使用顺序为image_id优先，其次file、image_base64、url。 url 中含有不少特殊字符，若将 URL 放入 Query String 中则需要对这些字符进行转义，所有中文和特殊字符必需以UTF-8编码转义。 目前支持 http/https 等协议的网络地址。下载限时 5s，超时后仍未下载完成则属于失败。 参数 file 需把图片文件的内容以 multipart/form-data 的形式放到 POST 消息体中。

签名sign说明：

我们会为每位公有云用户分配一个账户API ID和对应秘钥API SECRET。为了保证安全性，用户的每次接口调用都需要上传一个签名（基于API ID和API SECRET获取）。

Java示例代码：

SHA256Util.getSHA256Str(LF_APP_ID + LF_APP_SECRET + timeStamp)
/**
     * 利用java原生的摘要实现SHA256加密
     *
     * @param str 加密后的报文
     */
    public static String getSHA256Str(String str) {
        MessageDigest messageDigest;
        String encodeStr = "";
        try {
            messageDigest = MessageDigest.getInstance("SHA-256");
            messageDigest.update(str.getBytes("UTF-8"));
            encodeStr = byte2Hex(messageDigest.digest());
        } catch (NoSuchAlgorithmException e) {
            e.printStackTrace();
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }
        return encodeStr;
    }
    /**
     * 将byte转为16进制
     */
    private static String byte2Hex(byte[] bytes) {
        StringBuffer stringBuffer = new StringBuffer();
        String temp = null;
        for (int i = 0; i < bytes.length; i++) {
            temp = Integer.toHexString(bytes[i] & 0xFF);
            if (temp.length() == 1) {
                //1得到一位的进行补0操作
                stringBuffer.append("0");
            }
            stringBuffer.append(temp);
        }
        return stringBuffer.toString();
    }

3.返回参数

data 的结构如下：

words_result 的结构如下：

说明：支持对中国大陆护照个人资料页所有15个字段进行结构化识别，包括国家码、护照号、姓名、姓名拼音、性别、出生地点、出生日期、签发地点（不支持境外签发地）、签发日期、有效期、签发机关、护照类型、国籍、MRZCode1、MRZCode2。

收费标准：code为0000，charge为1时收费；其他情况（code非0000），charge为2，不收费；

成功返回示例

{
    "code":"0000",
    "msg":"调用成功",
    "charge":1,
    "data":{
        "words_result_num":15,
        "image_id":"d973ae315e3240a99a2e3ee902ec7a13",
        "words_result":{
            "MRZCode2":{
                "words":"521252N<2HHU50600<<<<<<",
                "location":{
                    "top":276,
                    "left":48,
                    "width":336,
                    "height":14
                }
            },
            "护照类型":{
                "words":"",
                "location":{
                    "top":40,
                    "left":151,
                    "width":10,
                    "height":11
                }
            },
            "护照签发地点":{
                "words":"北京/BEIJING",
                "location":{
                    "top":163,
                    "left":269,
                    "width":82,
                    "height":13
                }
            },
            "签发机关":{
                "words":"公安部出入境管理局",
                "location":{
                    "top":217,
                    "left":152,
                    "width":110,
                    "height":15
                }
            },
            "护照号码":{
                "words":"",
                "location":{
                    "top":-1,
                    "left":-1,
                    "width":-1,
                    "height":-1
                }
            },
            "签发日期":{
                "words":"2008年12月31日",
                "location":{
                    "top":190,
                    "left":152,
                    "width":87,
                    "height":14
                }
            },
            "出生地点":{
                "words":"北京/BEIJING",
                "location":{
                    "top":136,
                    "left":268,
                    "width":83,
                    "height":14
                }
            },
            "生日":{
                "words":"",
                "location":{
                    "top":-1,
                    "left":-1,
                    "width":-1,
                    "height":-1
                }
            },
            "有效期至":{
                "words":"2013年12月30日",
                "location":{
                    "top":189,
                    "left":269,
                    "width":85,
                    "height":13
                }
            },
            "姓名拼音":{
                "words":"XXX",
                "location":{
                    "top":107,
                    "left":149,
                    "width":94,
                    "height":14
                }
            },
            "性别":{
                "words":"男/M",
                "location":{
                    "top":136,
                    "left":152,
                    "width":30,
                    "height":13
                }
            },
            "姓名":{
                "words":"XXX",
                "location":{
                    "top":80,
                    "left":152,
                    "width":58,
                    "height":13
                }
            },
            "国家码":{
                "words":"CHN",
                "location":{
                    "top":41,
                    "left":208,
                    "width":23,
                    "height":9
                }
            },
            "国籍":{
                "words":"",
                "location":{
                    "top":-1,
                    "left":-1,
                    "width":-1,
                    "height":-1
                }
            },
            "MRZCode1":{
                "words":"POCHNTIAN<<BAIHAO<<<<<<<<<<<<<<<<<<<<<<<<<<<",
                "location":{
                    "top":256,
                    "left":62,
                    "width":348,
                    "height":18
                }
            }
        }
    },
    "request_id":"TID84e25c1aa8a14a018b30703aeb2b14be"
}

失败返回示例

{
  "request_id": "TID2af751b4bff24be781d60af10bf84101",
  "code": "1000",
  "msg": "验签失败",
  "charge": 2
}

4.业务响应码