港澳台居民居住证OCR识别

提交查询

1、接口描述

提交查询

2、请求地址

https://api.ihuyi.com/ocr/rphmt/Submit.json

3、请求头说明

参数名称	参数值描述	示例	类型	必填
Content-Type	内容类型，固定值	application/x-www-form-urlencoded	string	是

4、请求参数说明

参数名称	参数值描述	示例	类型	必填
account	APIID(用户中心【认证核验】-【OCR识别】-【产品总览】查看)	xxxxxxxx	string	是
password	1、APIKEY(用户中心【认证核验】-【OCR识别】-【产品总览】查看) 2、动态密码(生成动态密码方式请看该文档末尾的说明)	xxxxxxxxx	string	是
img_file	图片文件(img_file、img_url二选一传递，小于1MB，支持jpg、png、bmp)		file	否
img_url	图片url(img_file、img_url二选一传递，小于1MB，支持jpg、png、bmp)		string	否
time	Unix时间戳（10位整型数字，当使用动态密码方式时为必填）	1623643787	string	否

5、响应参数

参数名称	参数值描述	示例	类型	必返
code	返回值为2时，表示提交成功	2\|1	int	是
msg	提交结果描述	提交成功\|提交失败	string	是
idcardid	当提交成功后，此字段为流水号，否则为0或空	16236437872836\|0	string
result	识别结果		object
info	数据		object
Name	证件姓名	张三	string
Sex	性别	男	string
Birth	出生日期	1990-01-01	string
Address	地址	上海市XXXXXXX13号	string
IdCardNo	身份证号	31010119900101****	string
CardType	0-正面，1-反面	0	string
ValidDate	证件有效期限	2025-01-01	string
Authority	签发机关	上海市公安局	string
VisaNum	签发次数	1	string
PassNo	通行证号码	C12345678	string

6、响应状态码说明

code	msg
0	未知错误
1	提交失败
2	提交成功
400	非法ip访问
401	帐号不能为空
402	密码不能为空
403	应用不存在
405	API ID 或 API KEY 不正确
4050	账号被冻结
40501	动态密码已过期
40502	动态密码校验失败
40505	没有签定合同
4051	剩余条数不足
4052	访问 ip 与备案 ip 不符
4086	通道无效
4010	通道错误
4202	参数错误
4205	系统异常
4208	查询失败
4210	图片识别失败
4301	img_file、img_url不能同时为空
4302	上传图片大小必须控制在5KB-1MB之间
4303	上传图片格式不正确，只支持bmp,jpg,jpeg,png
4304	上传图片失败

7、GET传参示例

https://api.ihuyi.com/ocr/rphmt/Submit.json?account=xxxxxxxx&password=xxxxxxxxx&img_file=&img_url=&time=1623643787

8、响应示例

示例（成功）

<?xml version="1.0" encoding="utf-8"?><SubmitResult><code>2</code><msg>提交成功</msg><idcardid>16236437872836</idcardid><result><info><Name>张三</Name><Sex>男</Sex><Birth>1990-01-01</Birth><Address>上海市XXXXXXX13号</Address><IdCardNo>31010119900101****</IdCardNo><CardType>0</CardType><ValidDate>2025-01-01</ValidDate><Authority>上海市公安局</Authority><VisaNum>1</VisaNum><PassNo>C12345678</PassNo></info></result></SubmitResult>

{    "code":
            2
        ,        "msg":
            "提交成功"
        ,        "idcardid":
            "16236437872836"
        ,        "result":
                {    "info":
                {    "Name":
            "张三"
        ,        "Sex":
            "男"
        ,        "Birth":
            "1990-01-01"
        ,        "Address":
            "上海市XXXXXXX13号"
        ,        "IdCardNo":
            "31010119900101****"
        ,        "CardType":
            "0"
        ,        "ValidDate":
            "2025-01-01"
        ,        "Authority":
            "上海市公安局"
        ,        "VisaNum":
            "1"
        ,        "PassNo":
            "C12345678"
            }
                }
                }

示例（失败）

<?xml version="1.0" encoding="utf-8"?><SubmitResult><code>1</code><msg>提交失败</msg></SubmitResult>

{"code":1,"msg":"提交失败"}

9、PHP生成动态密码方式代码示例

$account = 'xxxxxxxx';
$password = 'xxxxxxxxx';
$app = 'rphmt'; //固定值
$time = '1623643787';
$password=md5($account.$password.$app.$time);
$password=md5('xxxxxxxxxxxxxxxxxrphmt1623643787');

//注意：所有字符编码统一为UTF-8

港澳台居民居住证OCR识别

提交查询

1、接口描述

2、请求地址

3、请求头说明

4、请求参数说明

5、响应参数

6、响应状态码说明

7、GET传参示例

8、响应示例

9、PHP生成动态密码方式代码示例

10、代码示例

免费体验

填写验证码后，点击“开通体验账户”自动开通体验账户。