本文介紹憑證識別服務的API介面。傳入憑證圖片,通過AI提取關鍵資訊,並支援憑證偽造檢測。此介面為同步調用,調用結束後直接返回結果。
介面資訊
介面名:CredentialRecognition
介面說明:傳入憑證圖片,通過AI提取關鍵資訊,並支援憑證偽造檢測。
要求方法:POST
傳輸協議:HTTPS
QPS限量:API獨享QPS限量,詳情請參見ID Verification服務端API QPS限量說明。
服務地址:
說明內網指的是阿里雲同地區產品之間的內部通訊網路,如果您的商務服務器部署在阿里雲的對應地區,可以通過內網網域名稱訪問 ID Verification 服務,以獲得更安全、穩定的網路通訊品質。
新加坡
公網:
cloudauth-intl.ap-southeast-1.aliyuncs.com內網:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
憑證識別偽造檢測功能屬於AI預測類產品,自我裝載集樣本準確率是90%,實際準確率由於樣本情境的差異可能有波動。
電子合成圖片類圖片PS檢測難度較大,原生相機拍攝圖片檢測效果優於電子合成圖片。
偽造檢測不建議作為憑證真實性判斷的唯一方法,可作為輔助審核依據,或作為人工審核提效工具。
偽造檢測金融支付收單、電商商家入駐等電子資料審核情境已經得到廣泛的運用,有效提升人審效率,如果您有更廣泛情境需求,請聯絡您的商務經理。
線上調試和整合
在調試和整合前,請確保您已完整閱讀使用OpenAPI調試和整合服務端API文檔,充分瞭解API介面在OpenAPI平台的調用方式和SDK及其代碼的擷取方式。
您可以在OpenAPI Explorer中直接運行本介面進行調試,並產生本介面的SDK程式碼範例。
請求參數
參數CredentialOcrPictureBase64或CredentialOcrPictureUrl對應的圖片必須符合以下規則:
圖片格式:支援PNG、JPG、JPEG、BMP和WebP格式。
圖片尺寸:圖片長寬需要大於15像素,小於8192像素,且長寬比需要小於50。
說明為了確保較好的識別效果,建議映像的長寬均大於500像素。
圖片大小:
CredentialOcrPictureUrl格式傳入,不能超過10MB;CredentialOcrPictureBase64傳入,不能超過3MB。說明圖片過大會影響介面響應速度,建議使用小於 3MB圖片。
名稱 | 類型 | 是否必選 | 描述 | 樣本值 |
ProductCode | string | 是 | 固定取值:CREDENTIAL_RECOGNITION。 | CREDENTIAL_RECOGNITION |
CredentialOcrPictureBase64 | string | 否 | 圖片Base64編碼。如果您選擇此方式傳入照片,請注意檢查照片大小,不要傳入過大的照片。 | - |
CredentialOcrPictureUrl | string | 否 | 圖片地址,公網可訪問的HTTP、HTTPS連結。 | https://*** |
DocType | string | 是 | 憑證類型:
| 01 |
OcrArea | string | 是 | 提取類型:
| 0101 |
FraudCheck | string | 是 | 是否開啟篡改檢測
| true |
響應參數
名稱 | 類型 | 描述 | 樣本值 | |
HTTP Status Code | Integer | HTTP狀態代碼。 | 200 | |
HTTP Body | RequestId | String | 請求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039**** |
Result.TransactionId | String | 整個流程的唯一標識。 | hksb7ba1b28130d24e015d694361b**** | |
Code | String | 重要
| Success | |
Message | String | 返回資訊的響應訊息。 | success | |
Result.Success | String | 提取結果:
| S | |
Result.SubCode | String | 認證結果描述。更多資訊,請參見ResultObject.SubCode錯誤碼說明。 | 200 | |
Result.ExtIdInfo | String | 關於JSON格式,請參見右側樣本。更多資訊,請參見Result.ExtIdInfo。 |
| |
返回Code
HTTP狀態代碼 | Code | Message描述 |
200 | Success | 請求成功。 |
400 | MissingParameter | 參數不可為空。 |
400 | InvalidParameter | 非法參數。 |
403 | Forbidden.RAMUserAccessDenied | 需要給RAM使用者授予AliyunAntCloudAuthFullAccess的操作許可權。更多資訊,請參見授權RAM使用者訪問服務。 |
403 | Forbidden.AccountAccessDenied | 賬戶存在欠費,請儲值後再進行操作。 |
403 | Throttling.Api | API限流攔截。 |
500 | InternalError | 系統內部錯誤,請反饋工程師排查。 |
ResultObject.SubCode錯誤碼說明
錯誤碼 | 是否計費 | 描述和原因建議 |
200 | 是 | 提取成功。 |
213 | 是 | 未提取到文字。 |
Result.ExtIdInfo
名稱 | 類型 | 描述 | 樣本值 |
recInfo | String | 提取的關鍵資訊。 說明 如果提取失敗,則該欄位值為空白。 |
|
spoofInfo | String | 證件防偽檢測結果,包括風險判定結果和風險類型:
| 開啟篡改檢測(請求參數 |