往来港澳通行证识别
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | RecognizeExitEntryPermitToHK |
系统规定参数。取值：RecognizeExitEntryPermitToHK。 |
| Url | String | 否 | https://img.alicdn.com/imgextra/i2/O1CN01Rs4C321G2oTD7Dg1U_!!6000000000565-0-tps-1024-692.jpg |
图片链接（长度不超 2048，不支持 base64） |
| String | 否 | 图片二进制 |
图片二进制字节流，最大10MB |
|
| OutputFigure | Boolean | 否 | true/false |
图案坐标信息输出，针对结构化，如身份证人脸头像 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | C99EABB8-9FCB-5E5E-B4D9-AFCFA6C8B3FD |
请求唯一 ID |
| Data | String | { "data":{ "permitType":"往来港澳通行证", "nameCn":"朱伟", "nameEn":"ZHU,WEI", "birthDate":"2021.01.01", "sex":"男", "validPeriod":"2018.06.11-2028.06.10", "issueAuthority":"公安部出入境管理局", "issuePlace":"江苏", "permitNumber":"C88600000", "mrzCode":"CSC886084772<2800800<8200000<6" }, "ftype":0, "height":692, "orgHeight":692, "orgWidth":1024, "prism_keyValueInfo":[ { "key":"permitType", "keyProb":100, "value":"往来港澳通行证", "valuePos":[ { "x":142, "y":39 }, { "x":476, "y":35 }, { "x":477, "y":75 }, { "x":142, "y":79 } ], "valueProb":100 }, { "key":"nameCn", "keyProb":100, "value":"朱伟", "valuePos":[ { "x":272, "y":126 }, { "x":346, "y":124 }, { "x":347, "y":160 }, { "x":272, "y":161 } ], "valueProb":100 }, { "key":"nameEn", "keyProb":100, "value":"ZHU,WEI", "valuePos":[ { "x":273, "y":168 }, { "x":403, "y":167 }, { "x":403, "y":194 }, { "x":274, "y":196 } ], "valueProb":100 }, { "key":"birthDate", "keyProb":100, "value":"2021.01.01", "valuePos":[ { "x":421, "y":240 }, { "x":421, "y":269 }, { "x":281, "y":269 }, { "x":281, "y":240 } ], "valueProb":100 }, { "key":"sex", "keyProb":100, "value":"男", "valuePos":[ { "x":502, "y":240 }, { "x":502, "y":270 }, { "x":474, "y":270 }, { "x":474, "y":240 } ], "valueProb":100 }, { "key":"validPeriod", "keyProb":100, "value":"2018.06.11-2028.06.10", "valuePos":[ { "x":579, "y":301 }, { "x":579, "y":328 }, { "x":275, "y":328 }, { "x":275, "y":301 } ], "valueProb":100 }, { "key":"issueAuthority", "keyProb":100, "value":"公安部出入境管理局", "valuePos":[ { "x":278, "y":361 }, { "x":524, "y":361 }, { "x":524, "y":391 }, { "x":278, "y":391 } ], "valueProb":100 }, { "key":"issuePlace", "keyProb":100, "value":"江苏", "valuePos":[ { "x":619, "y":361 }, { "x":619, "y":391 }, { "x":561, "y":391 }, { "x":561, "y":361 } ], "valueProb":100 }, { "key":"permitNumber", "keyProb":100, "value":"C88600000", "valuePos":[ { "x":524, "y":61 }, { "x":727, "y":60 }, { "x":728, "y":92 }, { "x":524, "y":94 } ], "valueProb":100 }, { "key":"mrzCode", "keyProb":98, "value":"CSC886084772<2800800<8200000<6", "valuePos":[ { "x":714, "y":421 }, { "x":714, "y":449 }, { "x":65, "y":449 }, { "x":65, "y":421 } ], "valueProb":98 } ], "sliceRect":{ "x0":107, "y0":135, "x1":880, "y1":134, "x2":874, "y2":616, "x3":117, "y3":624 }, "width":1024 } |
返回数据 |
| Code | String | noPermission |
错误码 |
| Message | String | You are not authorized to perform this operation. |
错误提示 |
示例
请求示例
http(s)://[Endpoint]/?Action=RecognizeExitEntryPermitToHK
&Url=https://img.alicdn.com/imgextra/i2/O1CN01Rs4C321G2oTD7Dg1U_!!6000000000565-0-tps-1024-692.jpg
&OutputFigure=false
&公共请求参数正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RecognizeExitEntryPermitToHKResponse>
<RequestId>C99EABB8-9FCB-5E5E-B4D9-AFCFA6C8B3FD</RequestId>
<Data>{"data":{"permitType":"往来港澳通行证","nameCn":"朱伟","nameEn":"ZHU,WEI","birthDate":"2021.01.01","sex":"男","validPeriod":"2018.06.11-2028.06.10","issueAuthority":"公安部出入境管理局","issuePlace":"江苏","permitNumber":"C88600000","mrzCode":"CSC886084772<2800800<8200000<6"},"ftype":0,"height":692,"orgHeight":692,"orgWidth":1024,"prism_keyValueInfo":[{"key":"permitType","keyProb":100,"value":"往来港澳通行证","valuePos":[{"x":142,"y":39},{"x":476,"y":35},{"x":477,"y":75},{"x":142,"y":79}],"valueProb":100},{"key":"nameCn","keyProb":100,"value":"朱伟","valuePos":[{"x":272,"y":126},{"x":346,"y":124},{"x":347,"y":160},{"x":272,"y":161}],"valueProb":100},{"key":"nameEn","keyProb":100,"value":"ZHU,WEI","valuePos":[{"x":273,"y":168},{"x":403,"y":167},{"x":403,"y":194},{"x":274,"y":196}],"valueProb":100},{"key":"birthDate","keyProb":100,"value":"2021.01.01","valuePos":[{"x":421,"y":240},{"x":421,"y":269},{"x":281,"y":269},{"x":281,"y":240}],"valueProb":100},{"key":"sex","keyProb":100,"value":"男","valuePos":[{"x":502,"y":240},{"x":502,"y":270},{"x":474,"y":270},{"x":474,"y":240}],"valueProb":100},{"key":"validPeriod","keyProb":100,"value":"2018.06.11-2028.06.10","valuePos":[{"x":579,"y":301},{"x":579,"y":328},{"x":275,"y":328},{"x":275,"y":301}],"valueProb":100},{"key":"issueAuthority","keyProb":100,"value":"公安部出入境管理局","valuePos":[{"x":278,"y":361},{"x":524,"y":361},{"x":524,"y":391},{"x":278,"y":391}],"valueProb":100},{"key":"issuePlace","keyProb":100,"value":"江苏","valuePos":[{"x":619,"y":361},{"x":619,"y":391},{"x":561,"y":391},{"x":561,"y":361}],"valueProb":100},{"key":"permitNumber","keyProb":100,"value":"C88600000","valuePos":[{"x":524,"y":61},{"x":727,"y":60},{"x":728,"y":92},{"x":524,"y":94}],"valueProb":100},{"key":"mrzCode","keyProb":98,"value":"CSC886084772<2800800<8200000<6","valuePos":[{"x":714,"y":421},{"x":714,"y":449},{"x":65,"y":449},{"x":65,"y":421}],"valueProb":98}],"sliceRect":{"x0":107,"y0":135,"x1":880,"y1":134,"x2":874,"y2":616,"x3":117,"y3":624},"width":1024}</Data>
</RecognizeExitEntryPermitToHKResponse>JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C99EABB8-9FCB-5E5E-B4D9-AFCFA6C8B3FD",
"Data" : "{\"data\":{\"permitType\":\"往来港澳通行证\",\"nameCn\":\"朱伟\",\"nameEn\":\"ZHU,WEI\",\"birthDate\":\"2021.01.01\",\"sex\":\"男\",\"validPeriod\":\"2018.06.11-2028.06.10\",\"issueAuthority\":\"公安部出入境管理局\",\"issuePlace\":\"江苏\",\"permitNumber\":\"C88600000\",\"mrzCode\":\"CSC886084772<2800800<8200000<6\"},\"ftype\":0,\"height\":692,\"orgHeight\":692,\"orgWidth\":1024,\"prism_keyValueInfo\":[{\"key\":\"permitType\",\"keyProb\":100,\"value\":\"往来港澳通行证\",\"valuePos\":[{\"x\":142,\"y\":39},{\"x\":476,\"y\":35},{\"x\":477,\"y\":75},{\"x\":142,\"y\":79}],\"valueProb\":100},{\"key\":\"nameCn\",\"keyProb\":100,\"value\":\"朱伟\",\"valuePos\":[{\"x\":272,\"y\":126},{\"x\":346,\"y\":124},{\"x\":347,\"y\":160},{\"x\":272,\"y\":161}],\"valueProb\":100},{\"key\":\"nameEn\",\"keyProb\":100,\"value\":\"ZHU,WEI\",\"valuePos\":[{\"x\":273,\"y\":168},{\"x\":403,\"y\":167},{\"x\":403,\"y\":194},{\"x\":274,\"y\":196}],\"valueProb\":100},{\"key\":\"birthDate\",\"keyProb\":100,\"value\":\"2021.01.01\",\"valuePos\":[{\"x\":421,\"y\":240},{\"x\":421,\"y\":269},{\"x\":281,\"y\":269},{\"x\":281,\"y\":240}],\"valueProb\":100},{\"key\":\"sex\",\"keyProb\":100,\"value\":\"男\",\"valuePos\":[{\"x\":502,\"y\":240},{\"x\":502,\"y\":270},{\"x\":474,\"y\":270},{\"x\":474,\"y\":240}],\"valueProb\":100},{\"key\":\"validPeriod\",\"keyProb\":100,\"value\":\"2018.06.11-2028.06.10\",\"valuePos\":[{\"x\":579,\"y\":301},{\"x\":579,\"y\":328},{\"x\":275,\"y\":328},{\"x\":275,\"y\":301}],\"valueProb\":100},{\"key\":\"issueAuthority\",\"keyProb\":100,\"value\":\"公安部出入境管理局\",\"valuePos\":[{\"x\":278,\"y\":361},{\"x\":524,\"y\":361},{\"x\":524,\"y\":391},{\"x\":278,\"y\":391}],\"valueProb\":100},{\"key\":\"issuePlace\",\"keyProb\":100,\"value\":\"江苏\",\"valuePos\":[{\"x\":619,\"y\":361},{\"x\":619,\"y\":391},{\"x\":561,\"y\":391},{\"x\":561,\"y\":361}],\"valueProb\":100},{\"key\":\"permitNumber\",\"keyProb\":100,\"value\":\"C88600000\",\"valuePos\":[{\"x\":524,\"y\":61},{\"x\":727,\"y\":60},{\"x\":728,\"y\":92},{\"x\":524,\"y\":94}],\"valueProb\":100},{\"key\":\"mrzCode\",\"keyProb\":98,\"value\":\"CSC886084772<2800800<8200000<6\",\"valuePos\":[{\"x\":714,\"y\":421},{\"x\":714,\"y\":449},{\"x\":65,\"y\":449},{\"x\":65,\"y\":421}],\"valueProb\":98}],\"sliceRect\":{\"x0\":107,\"y0\":135,\"x1\":880,\"y1\":134,\"x2\":874,\"y2\":616,\"x3\":117,\"y3\":624},\"width\":1024}"
}返回示例补充说明
返回数据说明</br>
permitType 证件类别</br>
nameCn 中文姓名</br>
nameEn 英文姓名</br>
birthDate 出生日期</br>
sex 性别</br>
validPeriod 有效期限</br>
issueAuthority 签发机关</br>
issuePlace 签发地</br>
permitNumber 证件号码</br>
mrzCode 机读码</br>
angle 角度：0-360，0表示向上，90表示向右，180表示向下，270度表示向左</br>
height 算法矫正图片后的高度</br>
width 算法矫正图片后的宽度</br>
orgHeight 原图的高度</br>
orgWidth 原图的宽度</br>
----------------------------------------prism_keyValueInfo文字块数组内的字段说明---------------------------------------</br>
valuePos 外矩形四个点的坐标按顺时针排列，左上、右上、右下、左下</br>
错误码
访问错误中心查看更多错误码。