/v2/ocr/birth_certificate
1.接口描述
该API的功能主要支持对出生医学证明的23个关键字段进行结构化识别,包括新生儿姓名、性别、出生时间、父亲姓名、母亲姓名、出生证编号等。
- 图片要求:
- 格式为 JPG(JPEG),BMP,PNG
- 宽和高大于 8px,小于等于 4800px
- 小于等于 5 MB
请求方式
POST
请求 URL
https://cloudapi.linkface.cn/v2/ocr/birth_certificate
2.请求参数
字段 | 类型 | 必需 | 描述 |
---|---|---|---|
api_id | string | 是 | API 账户。 |
sequence_id | string | 是 | 客户请求流水号,建议唯一性 |
file | file | 见下方注释 | 需上传的图片文件。上传本地图片可选取此参数 |
url | string | 见下方注释 | 图片网络地址。采用抓取网络图片方式可选取此参数 |
image_id | string | 见下方注释 | 图片的id。在云端上传过的图片可选取此参数 |
image_base64 | string | 见下方注释 | 采用base64编码的二进制图片数据可选此参数 |
timestamp | string | 是 | 时间戳 |
sign | string | 是 | 签名(api_id+api_secret+timestamp使用SHA256算法获取) |
请求参数
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.返回参数
字段 | 类型 | 描述 |
---|---|---|
request_id | string | 本次请求的 id |
code | string | 业务响应码。正常为 0000 ,其他值表示失败。详见业务响应码 |
msg | string | 消息说明 |
data | object | 消息体,详见data数组中字段的结构(只有code: 0000调用成功时返回) |
charge | int | 是否收费,1收费,2不收费 |
data
的结构如下:
字段 | 类型 | 描述 |
---|---|---|
image_id | string | 唯一的图片id,用于查找图片 |
birthProvince | string | 出生地点_省 |
birthWeight | string | 出生体重 |
motherNationality | string | 母亲国籍 |
fatherAddress | string | 父亲住址 |
motherEthnic | string | 母亲民族 |
motherAddress | string | 母亲地址 |
code | string | 出生证编号 |
babySex | string | 性别 |
birthCounty | string | 出生地点_县(区) |
babyBirthday | string | 出生时间 |
babyName | string | 姓名 |
fatherAge | string | 父亲年龄 |
fatherEthnic | string | 父亲民族 |
motherName | string | 母亲姓名 |
motherID | string | 母亲身份证号 |
birthLength | string | 出生身长 |
gestationalAge | string | 出生孕周 |
birthCity | string | 出生地点_市 |
motherAge | string | 母亲年龄 |
hospita | string | 出生医院/医疗机构名称 |
fatherNationality | string | 父亲国籍 |
fatherID | string | 父亲身份证号 |
fatherName | string | 父亲姓名 |
说明:支持对出生医学证明的23个关键字段进行结构化识别,包括新生儿姓名、性别、出生时间、父亲姓名、母亲姓名、出生证编号等。
收费标准:code为0000,charge为1时收费;其他情况(code非0000),charge为2,不收费;
成功返回示例
{
"code": "0000",
"msg": "调用成功",
"charge": 1,
"data": {
"image_id": "d973ae315e3240a99a2e3ee902ec7a13",
"birthProvince": "山东",
"birthWeight": "3450克",
"motherNationality": "中国",
"fatherAddress": "山东省青岛市",
"motherEthnic": "汉族",
"motherAddress": "山东省青岛市",
"code": "U370073333",
"babySex": "女",
"birthCounty": "黄岛区",
"babyBirthday": "2020年06月19日17时00分",
"babyName": "安琪",
"fatherAge": "30岁",
"fatherEthnic": "汉族",
"motherName": "田田",
"motherID": "370284199509086021",
"birthLength": "50厘米",
"gestationalAge": "41+1周",
"birthCity": "青岛",
"motherAge": "25岁",
"hospital": "青岛市黄岛区医院",
"fatherNationality": "中国",
"fatherID": "370284199207126034",
"fatherName": "王军"
},
"request_id": "TID84e25c1aa8a14a018b30703aeb2b14be"
}
失败返回示例
{
"request_id": "TID2af751b4bff24be781d60af10bf84101",
"code": "1000",
"msg": "验签失败",
"charge": 2
}
4.业务响应码
code | msg 字段 |
---|---|
0000 |
调用成功 |
1000 |
验签失败 |
1001 |
参数非UTF-8编码 |
1002 |
请求参数错误,具体原因见 reason 字段内容 |
1003 |
liveness_data 出错 |
1004 |
图片未检测出人脸 。对应图片见字段 image 所反馈的值 |
1005 |
从网络获取图片超时 |
1006 |
网络地址图片获取失败 |
1007 |
账号或密钥错误 |
1008 |
账号过期,具体情况见 reason 字段内容 |
1009 |
调用频率超出限额 |
1010 |
调用次数超出限额 |
1011 |
无调用权限 |
1012 |
请求路径错误 |
1013 |
图片体积过大。对应图片见字段 image 所反馈的值 |
1014 |
图片不存在。对应图片见字段 image 所反馈的值。 |
1015 |
文件不是图片文件或已经损坏。对应图片见字段 image 所反馈的值 |
1016 |
图片大小或格式不符合要求。对应图片见字段 image 所反馈的值 |
1027 |
交易受限 |
9999 |
服务器内部错误 |
9990 |
数据服务异常 |
9980 |
余额不足 |