外国人永居证识别V2

---

接口描述

外国人永居证识别，通过光学字符识别技术，识别外国人永居证正面的 6 个字段（姓名，性别，年龄，地址，身份证号），以及外国人永居证反面的两个字段（签发机关，有效期).

进行接口调用前，需要获取必要的token信息，可查看登录鉴权。 该接口为加密接口，可查看签名与加密方式配置加密秘钥，并对接口内容进行加密。

请求说明

HTTP 方法:

POST

请求 URL V2(建议使用)：

/ai-cloud-face/ocr/v2/foreignerResident

Header如下：

参数名称	值
Content-Type	application/json;charset=UTF-8

Body中放置请求参数，参数详情如下：

请求参数：

参数名称	必填	数据类型	长度	参数描述
img	是	String	1-3000k	待处理图片(base64 编码)，原始图片大小需要小于 3M;
getFace	否	String	0-1	1:返回截取的人脸图片,0:不返回人脸图片(默认);正面身份证才返回结果
busFlowId	否	String	0-64	业务流水号，业务系统唯一序列号（对账用，建议传入）
getDetail	否	String	0-64	是否返回key-value格式详情 0：是 ，1：否 默认为1-否
getPosition	否	String	0-64	是否返回识别坐标信息 0：是 ，1：否 默认为1-否 getDetail为0-是时， 该配置才生效

请求示例：

{
    "img":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQ......",
    "busFlowId":"uRVJfd594lRwz7m3",
    "getDetail":"0",
    "getPosition":"0"
}

返回说明

返回参数：

返回值名称	数据类型	长度	描述
code	String	1-8	返回结果，00000000表示成功
message	String	1-255	返回码描述
data	Object	-	返回的数据
-flowId	String	1-64	交易流水ID（建议保存）
-type	String	1-32	证件类型
-name	String	1-32	姓名
-namech	String	1-32	中文姓名
-cardno	String	1-32	证件号码
-birthday	String	1-16	出生日期
-sex	String	1-4	性别
-nationality	String	1-32	国籍
-validdate	String	1-16	有效期，如2023.09.15-2033.09.14
-face	Object	-	返回的人脸信息（getFace为1的情况下才返回）
--left	int	4	人脸在身份证中 x 坐标
--top	int	4	人脸在身份证中y 坐标
--width	int	4	人脸宽度
--height	int	4	人脸高度
--image	String	1-200k	人脸图片(base64 编码)
-busFlowId	String	1-64	传入的业务流水号
-details	Object[]	1-16	字段详情信息，getDetail为0时返回该字段
--key	String	1-16	字段信息名称
--name	String	1-16	字段信息中文名称
--value	String	1-16	字段识别结果
--position	OcrPos	1-16	字段识别坐标信息

OcrPos对象：

返回值名称	数据类型	长度	描述
left	int	1-4	表示定位位置的长方形左上顶点的水平坐标
top	int	1-4	表示定位位置的长方形左上顶点的垂直坐标
width	int	-	表示定位位置的长方形的宽度
height	int	-	表示定位位置的长方形的高度

返回示例：

{
	"code": "00000000",
	"data": {
		"birthday": "1980年01月01日",
		"validdate": "2023.09.15-2033.09.14",
		"face": {
			"image": "base64",
			"top": 197,
			"left": 655,
			"width": 164,
			"height": 164
		},
		"nationality": "加拿大/CAN",
		"sex": "女/F",
		"name": "ZHENGJIAN, YANGBEN",
		"details": [
			{
				"name": "生日",
				"position": {
					"top": 264,
					"left": 281,
					"width": 144,
					"height": 24
				},
				"value": "1980年01月01日",
				"key": "birthday"
			},
			{
				"name": "身份证号码",
				"position": {
					"top": 482,
					"left": 277,
					"width": 485,
					"height": 31
				},
				"value": "911124198108030024",
				"key": "cardno"
			},
			{
				"name": "姓名",
				"position": {
					"top": 126,
					"left": 78,
					"width": 360,
					"height": 30
				},
				"value": "ZHENGJIAN, YANGBEN",
				"key": "name"
			},
			{
				"name": "中文姓名",
				"position": {
					"top": 166,
					"left": 78,
					"width": 160,
					"height": 32
				},
				"value": "证件样本",
				"key": "namech"
			},
			{
				"name": "国籍",
				"position": {
					"top": 346,
					"left": 78,
					"width": 178,
					"height": 30
				},
				"value": "加拿大/CAN",
				"key": "nationality"
			},
			{
				"name": "性别",
				"position": {
					"top": 261,
					"left": 79,
					"width": 72,
					"height": 31
				},
				"value": "女/F",
				"key": "sex"
			},
			{
				"name": "有效期",
				"position": {
					"top": 432,
					"left": 78,
					"width": 336,
					"height": 22
				},
				"value": "2023.09.15-2033.09.14",
				"key": "validdate"
			},
			{
				"name": "证件类型",
				"position": {
					"top": 346,
					"left": 78,
					"width": 178,
					"height": 30
				},
				"value": "外国人永久居留身份证",
				"key": "type"
			},
			{
				"name": "人像图片",
				"position": {
					"top": 197,
					"left": 655,
					"width": 164,
					"height": 164
				},
				"value": "base64",
				"key": "face"
			}
		],
		"busFlowId": "scBI9Pb3IVzq3a09",
		"type": "外国人永久居留身份证",
		"cardno": "911124198108030024",
		"flowId": 1061683005577252864,
		"namech": "证件样本"
	},
	"success": true,
	"message": "success",
	"flowId": "1061683005577252864"
}

错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共CODE码表

码值	是否成功	是否计费	描述
00000000	是	是	成功
50028100	否	否	图片不能为空
50028103	否	否	图片大小不能超过3M
50028272	否	否	身份证识别异常
50028204	否	否	引擎检测异常
80003002	否	否	识别异常