Face++ 证件识别API文档
身份证识别服务
版本
1.0
描述
检测和识别中华人民共和国第二代身份证的关键字段内容，并支持返回身份证正反面信息、身份证照片分类判断结果。
图片要求
图片格式：JPG(JPEG)，PNG
图片像素尺寸：最小48*48像素，最大4096*4096像素
图片文件大小：2MB
调用URL
http://xx.xx.xx.xx:8000/idcard/v1/detect
调用方法
POST
请求体格式
application/json
请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | image | String | base64 编码的二进制图片数据 |
返回值
| 字段 | 类型 | 说明 |
|---|---|---|
| cards | Array | 检测出证件的数组 注：如果没有检测出证件则为空数组 |
| error | String | 请求失败时返回的错误信息，成功不返回 |
cards数组中单个元素的结构
| 字段 | 类型 | 说明 |
|---|---|---|
| type | Int | 检测出证件类型：0.正面 1.背面 |
| address | String | 住址 |
| birthday | Object | 生日，{'day': dd, 'month': mm, 'year': yyyy, 'day_confidence': dd, 'month_confidence': mm, 'year_confidence': yyyy} |
| gender | String | 性别（男/女） |
| card_bound | Object | 卡片边框，{'lb': {'x': x, 'y': y}, 'lt': {..}, 'rb': {..}, 'rb': {..}, 'rt': {..}} |
| head_rect | Object | 头像边框，{'lb': {'x': x, 'y': y}, 'lt': {..}, 'rb': {..}, 'rb': {..}, 'rt': {..}} |
| id_card_number | String | 身份证号 |
| name | String | 姓名 |
| race | String | 民族（汉字） |
| issued_by | String | 签发机关 |
| valid_date | String | 有效日期，返回值有两种格式：一个16位长度的字符串：YYYY.MM.DD-YYYY.MM.DD 或是：YYYY.MM.DD-长期 |
| legality | Object | 身份证照片的合法性检查结果。返回结果为身份证五种分类的概率值（取［0，1］区间实数，小数点后3位有效数字，概率值总和等于1.0）。五种分类为：ID Photo （正式身份证照片），Temporary ID Photo （临时身份证照片），Photocopy （正式身份证的复印件），Screen （手机或电脑屏幕翻拍的照片），Edited （用工具合成或者编辑过的身份证图片） |
- 注：除边框返回值和legality字段，其他字段均还有置信度字段（例：address为address_confidence，String返回值置信度类型为Array，值为每个字符的置信度，另id_card_number置信度字段为idnumber_confidence）
返回值示例
正面返回值示例
{
"cards": [
{
"detail": {
"address": "河北省张家口市XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"address_confidence": [
0.9999945163726807,
0.9999948740005493,
0.9999985694885254,
1,
0.9999842643737793,
0.9479639530181885,
0.9088846445083618,
0.9999933242797852,
0.9999827146530151,
0.9999756813049316,
0.999997615814209,
0.9999972581863403,
0.9999556541442871,
1,
0.9995597004890442,
1,
0.9999986886978149,
1,
0.9999970197677612,
1,
0.9999996423721313,
0.9999978542327881,
0.8793725371360779,
0.9999992847442627,
0.9999977350234985,
0.9994266033172607,
0.9999538660049438,
0.9999958276748657,
0.999796450138092,
0.9806990027427673,
0.9999934434890747,
0.9999815225601196
],
"birthday": {
"day": "17",
"day_confidence": [
0.9999804496765137,
0.9999990463256836
],
"month": "7",
"month_confidence": [
1
],
"year": "1977",
"year_confidence": [
0.9999889135360718,
1,
0.9999998807907104,
0.9999998807907104
]
},
"card_bound": {
"lb": {
"x": 60,
"y": 631
},
"lt": {
"x": 52,
"y": 72
},
"rb": {
"x": 937,
"y": 638
},
"rt": {
"x": 945,
"y": 66
}
},
"gender": "男",
"gender_confidence": [
1
],
"head_rect": {
"lb": {
"x": 0.602,
"y": 0.6533333
},
"lt": {
"x": 0.603,
"y": 0.21866667
},
"rb": {
"x": 0.883,
"y": 0.65466666
},
"rt": {
"x": 0.887,
"y": 0.21733333
}
},
"id_card_number": "132528XXXXXXXXXXXX",
"idnumber_confidence": [
0.9999972581863403,
0.9999998807907104,
0.9999997615814209,
0.9999750852584839,
0.9999977350234985,
0.999981164932251,
0.9999889135360718,
1,
0.9999998807907104,
0.9999998807907104,
0.9995229244232178,
1,
0.9999804496765137,
0.9999990463256836,
0.9999679327011108,
0.9999998807907104,
0.999998927116394,
0.9999997615814209
],
"legality": {
"Edited": 1.7680933e-34,
"ID Photo": 0.999864,
"Photocopy": 1.0168541e-26,
"Screen": 0.00013602337,
"Temporary ID Photo": 4.1308097e-34
},
"name": "张XX",
"name_confidence": [
1,
0.9999970197677612,
1
],
"race": "汉",
"race_confidence": [
1
]
},
"type": 0
}
]
}背面返回值示例
{
"cards": [
{
"detail": {
"card_bound": {
"lb": {
"x": 753,
"y": 1974
},
"lt": {
"x": 739,
"y": 513
},
"rb": {
"x": 3088,
"y": 1942
},
"rt": {
"x": 3047,
"y": 492
}
},
"issue_by": "XXX公安局",
"issue_by_confidence": [
0.9999991655349731,
0.9999986886978149,
0.9466056227684021,
0.9999897480010986,
1,
0.9999974966049194
],
"legality": {
"Edited": 3.380226e-22,
"ID Photo": 0.9999982,
"Photocopy": 2.8349175e-14,
"Screen": 0.0000017482556,
"Temporary ID Photo": 7.365266e-20
},
"valid_date": "2006.07.16-2016.07.16",
"valid_date_confidence": [
0.9999914169311523,
0.9999949932098389,
0.9999762773513794,
0.9999867677688599,
0.999997615814209,
0.9999943971633911,
0.9998838901519775,
0.9999985694885254,
0.9999699592590332,
0.999984860420227,
0.9999908208847046,
0.9999874830245972,
0.9999790191650391,
0.9999850988388062,
0.9997584223747253,
0.9999986886978149,
0.9999924898147583,
0.9995725750923157,
0.99998939037323,
0.9999746084213257,
0.9999910593032837
]
},
"type": 1
}
]
}驾照(driver Lincense)识别服务
版本
1.0
描述
检测和识别中华人民共和国机动车驾驶证（以下称“驾照”）图像为结构化的文字信息。目前只支持驾照主页正面，不支持副页正面反面。
- 驾照图像须为正拍（垂直角度拍摄），但是允许有一定程度的旋转角度；
- 仅支持图像里有一个驾照的主页正面，如果同时出现多页、或正副页同时出现，可能会返回空结果。
图片要求
图片格式：JPG(JPEG)，PNG
图片像素尺寸：最小48*48像素，最大4096*4096像素
图片文件大小：2MB
调用URL
http://xx.xx.xx.xx:8000/cardpp/dl/v1/detect
调用方法
POST
请求体格式
application/json
请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | image | String | base64 编码的二进制图片数据 |
返回值
| 字段 | 类型 | 说明 |
|---|---|---|
| cards | Array | 检测出证件的数组 注：如果没有检测出证件则为空数组 |
| error | String | 请求失败时返回的错误信息，成功不返回 |
cards数组中单个元素的结构
| 字段 | 类型 | 说明 |
|---|---|---|
| type | Int | 检测出证件类型：2. driver Lincense |
| address | String | 住址 |
| birthday | String | 生日，格式"YYYYMMDD" |
| gender | String | 性别（男/女） |
| card_no | String | 证件号 |
| category | Int | 驾照类型： 1. 新版驾驶证 2. 旧版驾驶证 |
| driver_class | String | 驾照类别 |
| nationality | String | 国籍 |
| name | String | 姓名 |
| signet | String | 发证机关 |
| first_issue | String | 初次领证日期 |
| valid_date | String | 有效日期 |
| valid_from | String | 有效开始日期 |
返回值示例
{
"cards": [
{
"detail": {
"address": "广东省深圳市XXXXXXXXXXXXXXX",
"birthday": "19560908",
"card_no": "710XXXXXX",
"category": 2,
"driver_class": "C1",
"first_issue": "2004XXXX",
"gender": "男",
"name": "张XX",
"nationality": "XX",
"signet": "广东省深圳市XXXXXXXXX",
"valid_date": "10年",
"valid_from": "20101208"
},
"type": 2
}
]
}行驶证(vehicle Lincense)识别服务
版本
1.0
描述
检测和识别中华人民共和国机动车行驶证（以下称“行驶证”）图像为结构化的文字信息。目前只支持行驶证主页正面，不支持副页正面反面。
- 行驶证图像须为正拍（垂直角度拍摄），但是允许有一定程度的旋转角度；
- 仅支持图像里有一个行驶证的主页正面，如果同时出现多页、或正副页同时出现，可能会返回空结果。
图片要求
图片格式：JPG(JPEG)，PNG
图片像素尺寸：最小48*48像素，最大4096*4096像素
图片文件大小：2MB
调用URL
http://xx.xx.xx.xx:8000/cardpp/vl/v1/detect
调用方法
POST
请求体格式
application/json
请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | image | String | base64 编码的二进制图片数据 |
返回值
| 字段 | 类型 | 说明 |
|---|---|---|
| cards | Array | 检测出证件的数组 注：如果没有检测出证件则为空数组 |
| error | String | 请求失败时返回的错误信息，成功不返回 |
cards数组中单个元素的结构
| 字段 | 类型 | 说明 |
|---|---|---|
| type | Int | 检测出证件类型：3. vehicle Lincense |
| address | String | 住址 |
| car_no | String | 车牌号 |
| engine_no | String | 发动机号码 |
| type | String | 车辆类型 |
| use_character | String | 使用性质 |
| vin | String | 车辆识别代号 |
| model | String | 品牌型号 |
| owner | String | 所有人 |
| signet | String | 发证机关 |
| register_no | String | 注册日期 |
| issue_date | String | 发证日期 |
返回值示例
{
"cards": [
{
"detail": {
"address": "南京市白下区XXXXXXXXX",
"car_no": "苏A61XXXX",
"engine_no": "10197XX",
"issue_date": "2011090",
"model": "奥德赛牌XXXXXXX",
"owner": "张X",
"register_no": "2011090",
"signet": "江苏省南京市公安局XXXXXX",
"type": "小型普通客车",
"use_character": "非营运",
"vin": "LHGRB386XXXXXXXXX"
},
"type": 3
}
]
}通用返回值
| HTTP状态码 | 错误信息 | 说明 |
|---|---|---|
| 400 | ARGUMENTS_ERROR | 参数错误 |
| 400 | BAD_REQUEST | 请求参数不合法 |
| 500 | INTERNAL_ERROR | 请求处理异常 |
注意
- 需要在VPC/路由器上绑定公网ip，能访问公网才能部署docker镜像
- 创建应用集群的时候ip带宽最好设置20Mb以上，创建完成后再调至所需带宽