互億無(wú)線 · 文檔中心

身份證OCR識(shí)別 - API文檔


身份證OCR識(shí)別接口文檔 點(diǎn)擊下載

身份證OCR識(shí)別接口接入指南 點(diǎn)擊訪問(wèn)

1、概要

1.1 文檔說(shuō)明

本文檔主要提供給互億平臺(tái)的用戶對(duì)接接口的使用說(shuō)明,開(kāi)發(fā)者可以利用互億無(wú)線提供的 HTTP 接口,調(diào)用互億無(wú)線的身份證OCR識(shí)別服務(wù)。

1.2 接口內(nèi)容

本文檔包含身份證OCR提交識(shí)別、余額查詢。

1.3 提交方式

GET / POST

1.4 加密方式

1、采用HTTPS協(xié)議提交請(qǐng)求
2、通過(guò)MD5動(dòng)態(tài)簽名方式加密

1.5 API ID / API KEY

登錄用戶中心,進(jìn)入【API數(shù)據(jù)服務(wù)-OCR】模塊,在【產(chǎn)品總覽】頁(yè)面右上角,如下圖所示:

ocr識(shí)別接口

1.6 限制條件

  • · 文件格式支持:OCR服務(wù)支持多種常見(jiàn)的文件格式,包括JPG、JPEG、PNG、BMP和PDF等。為了獲得最佳的識(shí)別效果,我們建議使用JPG格式。
  • · 圖片像素尺寸要求:圖片的像素尺寸應(yīng)介于最小256 x 256像素和最大2048 x 2048像素之間。為確保文字識(shí)別的準(zhǔn)確性,建議身份證圖片的最短邊長(zhǎng)不低于256像素,并且整個(gè)圖片的長(zhǎng)寬比應(yīng)保持在合理范圍內(nèi)。
  • · 文件大小限制:文件大?。ń?jīng)Base64編碼和urlencode處理后)不應(yīng)超過(guò)8MB。請(qǐng)盡量使身份證主體占據(jù)圖片的主要區(qū)域,注意我們不支持黑白圖片。如果傳送圖片或PDF的完整URL,建議對(duì)應(yīng)文件大小不要超過(guò)8MB。
  • · 注意圖片質(zhì)量:確保身份證圖片足夜清晰,避免由于壓縮產(chǎn)生的噪聲。不當(dāng)?shù)墓庹眨ㄈ鐝?qiáng)光、暗光、逆光)和身份證正反面的遮擋也應(yīng)避免,這些因素可能會(huì)降低識(shí)別的準(zhǔn)確度。
  • · 圖片版權(quán)和法律風(fēng)險(xiǎn):提交的圖片需擁有版權(quán)和肖像權(quán),且不涉及任何法律或政策風(fēng)險(xiǎn)。請(qǐng)?jiān)谑褂们皩?duì)相關(guān)風(fēng)險(xiǎn)進(jìn)行評(píng)估。
  • · 多頁(yè)P(yáng)DF處理:輸入多頁(yè)P(yáng)DF文件時(shí),默認(rèn)只識(shí)別第一頁(yè)。

2、身份證OCR提交識(shí)別

2.1 接口描述

通過(guò)POST、 GET 方式進(jìn)行提交,數(shù)據(jù)編碼采用utf-8格式,支持24小時(shí)全天提交。

2.2 請(qǐng)求地址

https://api.ihuyi.com/orc/idcard/Submit.json

2.3 請(qǐng)求參數(shù)

參數(shù)名稱 參數(shù)值描述 必填
account APIID(用戶中心【API數(shù)據(jù)服務(wù)-OCR】-【產(chǎn)品總覽】查看)
password 1、APIKEY(用戶中心【API數(shù)據(jù)服務(wù)-OCR】-【產(chǎn)品總覽】查看)
2、動(dòng)態(tài)密碼(生成動(dòng)態(tài)密碼方式請(qǐng)看該文檔末尾的說(shuō)明)
img_base64 圖片base64編碼(與“img_url”二選一,推薦使用“img_url”方式)
img_url 圖片URL(與“img_base64”二選一,推薦使用“img_url”方式)
time Unix時(shí)間戳(10位整型數(shù)字,當(dāng)使用動(dòng)態(tài)密碼方式時(shí)為必填)

*注:“img_base64”和“img_url”,只需要二選一,推薦使用“img_url”方式

用戶通過(guò)http 或 https提交發(fā)送請(qǐng)求到服務(wù)器后,服務(wù)器會(huì)返回一串json格式的字符串,SubmitResult結(jié)構(gòu)說(shuō)明如下:

參數(shù)名稱 類型 描述
code int 返回值為2時(shí),表示提交成功
msgid string 當(dāng)提交成功后,此字段為流水號(hào),否則為0
msg string 提交結(jié)果描述
content object 識(shí)別內(nèi)容(字段詳情分正面和反面)

正面內(nèi)容

參數(shù)名稱 類型 描述
type string front
name string 姓名
id_number string 身份證號(hào)
gender string 性別
ethnicity string 民族
birth string 出生日期(YYYY.MM.DD)
domicile string 住址

反面內(nèi)容

參數(shù)名稱 類型 描述
type string back
issue_authority string 簽發(fā)機(jī)關(guān)
valid_period string 有效期限(YYYY.MM.DD-YYYY.MM.DD)

2.4 響應(yīng)示例

示例(成功)

{"code":2,"msg":"提交成功","msgid":"22101320041348318","content":{"type":"back","issue_authority":"上海市公安局徐匯分局","valid_period":"2005.10.08-2025.10.08"}}

示例(失?。?/p>

{"code":405,"msg":"API ID或API KEY不正確","msgid":"0","content":{}}

2.5 響應(yīng)參數(shù)

code msg
0 未知錯(cuò)誤
1 提交失敗
2 提交成功
400 非法ip訪問(wèn)
401 帳號(hào)不能為空
402 密碼不能為空
403 應(yīng)用不存在
404 img_base64或img_url必須傳一個(gè)
405 API ID 或 API KEY 不正確
4050 賬號(hào)被凍結(jié)
40501 動(dòng)態(tài)密碼已過(guò)期
40502 動(dòng)態(tài)密碼校驗(yàn)失敗
40505 沒(méi)有簽定合同
4051 剩余次數(shù)不足
4052 訪問(wèn) ip 與備案 ip 不符
4086 圖片錯(cuò)誤
4010 通道錯(cuò)誤

2.6 GET請(qǐng)求示例

https://api.ihuyi.com/ocr/idcard/Submit.json&account=APIID&password=APIKEY&img_url=http://www.xxxx.com/xxxx.png

3、身份證OCR余額查詢

3.1 接口描述

通過(guò)接口可以方便的查詢你的賬戶剩余次數(shù)。

3.2 請(qǐng)求地址

https://api.ihuyi.com/ocr/idcard/GetNum.json

3.3 請(qǐng)求參數(shù)

參數(shù)名稱 參數(shù)值描述 是否必填
account APIID(用戶中心【API數(shù)據(jù)服務(wù)-OCR】-【產(chǎn)品總覽】查看)
password 1、APIKEY(用戶中心【API數(shù)據(jù)服務(wù)-OCR】-【產(chǎn)品總覽】查看)
2、動(dòng)態(tài)密碼(生成動(dòng)態(tài)密碼方式請(qǐng)看該文檔末尾的說(shuō)明)
time Unix時(shí)間戳(10位整型數(shù)字,當(dāng)使用動(dòng)態(tài)密碼方式時(shí)為必填)

用戶通過(guò)http 或 https提交請(qǐng)求到服務(wù)器后,服務(wù)器會(huì)返回一串json格式的字符串,GetNumResult結(jié)構(gòu)說(shuō)明如下:

參數(shù)名稱 類型 描述
code int 狀態(tài)返回值
msg string 查詢結(jié)果描述
num string 剩余次數(shù)

3.4 響應(yīng)示例

示例(成功)

{"code":2,"msg":"查詢成功","num":123} 

示例(失?。?/p>

{"code":405,"msg":"API ID或API KEY不正確","num":0}

3.5 響應(yīng)參數(shù)

code msg
2 查詢成功
400 非法ip訪問(wèn)
401 帳號(hào)不能為空
402 密碼不能為空
403 應(yīng)用不存在
405 API ID或API KEY不正確
4050 賬號(hào)被凍結(jié)
40501 動(dòng)態(tài)密碼已過(guò)期
40502 動(dòng)態(tài)密碼校驗(yàn)失敗
4052 訪問(wèn)ip與備案ip不符

3.6 GET請(qǐng)求示例

https://api.ihuyi.com/ocr/idcard/GetNum.json&account=APIID&password=APIKEY

4、生成動(dòng)態(tài)密碼方式

以PHP為例,提交認(rèn)證的生成方式:

$time = time();
$password=md5($account.$apikey.$time);

例如:

APIID: test
APIKEY:1q784322ba1******
time:1651544941
結(jié)果:$password=md5("test1q784322ba1******1651544941");

注意:所有字符編碼統(tǒng)一為UTF-8

查詢剩余條數(shù)的生成方式:

$time=time();
$password=md5($account.$apikey.$time);

例如:

APIID: test
APIKEY:1q784322ba1******
time:1651544941
結(jié)果:$password=md5("test1q784322ba1******1651544941");

Unix時(shí)間戳參考地址:http://tool.chinaz.com/Tools/unixtime.aspx

5、如何實(shí)現(xiàn)UNIX時(shí)間戳

語(yǔ)言 代碼
JAVA String date = new java.text.SimpleDateFormat("dd/MM/yyyy HH:mm:ss").format(new java.util.Date(Unix timestamp *1000))
Linux date -d @Unix timestamp
C strptime(datetime, "%Y-%m-%d %H:%M:%S", &tm_time); unixtime = mktime(&tm_time);
C++ std::time_t t = std::time(0);
DELPHI uses DateUtils;
DateTimeToUnix(Now)
GO import "time"
cur := time.Now()
timestamp := cur.UnixNano() / 1000000
Perl 先 my $time = Unix timestamp 然后 my ($sec, $min, $hour, $day, $month, $year) = (localtime($time))[0,1,2,3,4,5,6]
PHP date("r", Unix timestamp)
Node.js var date = new Date( time * 1000 );
var time = date.getTime()/1000;
Python 先 import time 然后 time.gmtime(Unix timestamp)
Ruby Time.at(Unix timestamp)
SHELL date +%s //UNIX 的時(shí)間戳;
VBScript / ASP DateAdd("s", Unix timestamp, "01/01/1970 00:00:00")
VB6 DateDiff("s", "1970-1-1 0:0:0", ToUnixTime)
易語(yǔ)言 時(shí)間_到時(shí)間戳()

6、身份證OCR識(shí)別 DEMO示例

語(yǔ)言 代碼
php http://m.422ajvm.cn/demo/ocr-idcard/php.html
Java http://m.422ajvm.cn/demo/ocr-idcard/java.html
C++ http://m.422ajvm.cn/demo/ocr-idcard/cpp.html
Go http://m.422ajvm.cn/demo/ocr-idcard/go.html
python http://m.422ajvm.cn/demo/ocr-idcard/python.html

7、身份證OCR識(shí)別接口產(chǎn)品開(kāi)通

自助開(kāi)通身份證OCR識(shí)別接口
將圖片上的文字內(nèi)容,智能識(shí)別成為可編輯的文本
身份證OCR識(shí)別套餐 免費(fèi)開(kāi)通賬戶 身份證OCR識(shí)別介紹

 

現(xiàn)在注冊(cè),即享新用戶禮包!

在線咨詢
電話咨詢

服務(wù)熱線:

4008 808 898

服務(wù)熱線(工作時(shí)間):

4008 808 898

業(yè)務(wù)咨詢(非工作時(shí)間):

售后咨詢(非工作時(shí)間):

驗(yàn)證碼已發(fā)送到您的手機(jī),請(qǐng)查收!

輸入驗(yàn)證碼后,點(diǎn)擊“開(kāi)通體驗(yàn)賬戶”按鈕可立即開(kāi)通體驗(yàn)賬戶。

收不到短信驗(yàn)證碼?
互億無(wú)線不提供接碼服務(wù),接碼用戶請(qǐng)勿點(diǎn)擊開(kāi)通按鈕。
×