本文介紹通過純服務端(API)接入ID Verification的流程。
介面說明
介面名:EkycVerify
要求方法:HTTPS POST
介面說明:通過傳入圖片資料等資訊進行eKYC認證。
QPS限量:API獨享QPS限量,詳情請參見ID Verification服務端API QPS限量說明。
服務地址:
說明內網指的是阿里雲同地區產品之間的內部通訊網路,如果您的商務服務器部署在阿里雲的對應地區,可以通過內網網域名稱訪問 ID Verification 服務,以獲得更安全、穩定的網路通訊品質。
中國香港
公網:
cloudauth-intl.cn-hongkong.aliyuncs.com內網:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
線上調試和整合
在調試和整合前,請確保您已完整閱讀使用OpenAPI調試和整合服務端API文檔,充分瞭解API介面在OpenAPI平台的調用方式和SDK及其代碼的擷取方式。
您可以在OpenAPI Explorer中直接運行本介面進行調試,並產生本介面的SDK程式碼範例。
傳入圖片格式要求
圖片格式:JPG、JPEG、PNG。
圖片大小:推薦50~100 KB,最大不超過1 MB。
圖片解析度:不超過1920*1080(高*寬),至少為640*480(高*寬),推薦短邊縮放到720像素,壓縮率大於0.9。照片高大於寬,如果傳入的照片寬大於高,可能會影響檢測效果。
說明圖片轉base64格式後,通常會導致資料體積增加。如您需要使用base64格式傳參,請保證原始圖片的體積不超過0.6MB,以滿足1MB的最巨量資料傳輸限制。
圖片品質建議:
人臉面部需要完整清晰無遮擋,正對網路攝影機,推薦通過自拍採集的人臉圖片。
人臉大小佔比圖片中面積需要>60%,若人臉較小會影響檢測的準確性。
若圖片中存在多個人臉,演算法預設截取較大的人臉,建議避免傳入多人臉圖片。
請求參數
名稱 | 類型 | 是否必選 | 描述 | 樣本值 |
ProductCode | String | 是 | 要接入的產品方案。取值eKYC_MIN。 | eKYC_MIN |
SceneCode | String | 否 | 您自訂的認證情境ID,用於後續控制台輸入此情境ID查詢相關記錄。支援長度為10位的字母、數字或底線的組合。 | 1234567890 |
MerchantBizId | String | 是 | 自訂的業務唯一標識,用於後續定位排查問題使用。支援長度為32位的字母和數位組合,請確保唯一。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | 是 | 您自訂的使用者ID,或者其他可以識別特定使用者的標識,例如手機號碼、郵箱地址等。強烈建議對該欄位的值進行預先脫敏,例如對值進行雜湊處理。 | Y |
DocType | String | 是 | 證件類型,以8位元字組合作為唯一標識。更多說明,請參見證件類型列表。 | 01000000 |
DocName | String | 否 | 使用者的真實姓名。 說明 當Authorize=T且證件類型為中國內地居民身份證時,以下證件關鍵資訊與證件圖片必須輸入至少一組:
| 張三 |
DocNo | String | 否 | 使用者的證件號碼。 說明 當Authorize=T且證件類型為中國內地居民身份證時,以下證件關鍵資訊與證件圖片必須輸入至少一組:
| 411xxxxxxxxxxx0001 |
IdOcrPictureBase64 | String | 否 說明 IdOcrPictureBase64和IdOcrPictureUrl二選一。 | 證件圖片Base64編碼。 說明 如果您選擇該方式傳入證件圖片,請檢查照片大小,不要傳入過大的照片。 | base64編碼 |
IdOcrPictureUrl | String | 否 | 證件圖片地址,公網可訪問的HTTP、HTTPS連結。 | https://*** |
FacePictureBase64 | String | 否 說明 FacePictureBase64和FacePictureUrl二選一。 | 人像圖片Base64編碼。 說明 如果您選擇該方式傳入證件圖片,請檢查照片大小,不要傳入過大的照片。 | base64編碼 |
FacePictureUrl | String | 否 | 人像地址,公網可訪問的HTTP、HTTPS連結。 | https://*** |
Crop | String | 否 | 是否允許裁剪人臉圖片:
| F |
Authorize | String | 否 | 是否開啟官方資料庫身份核驗:
說明 目前僅適用於中國內地第二代居民身份證。 | F |
IdThreshold | String | 否 | 自訂OCR品質檢測閾值模式:
| 0 |
證件類型列表
DocType | 對應證件 |
01000000 | 全球護照 |
00000006 | 香港居民身份證(2003版) |
00000008 | 香港居民身份證(2018版) |
00000007 | 往來港澳通行證 |
00000009 | 港澳居民來往內地通行證 |
000000011 | 澳門身份證 |
000000012 | 台灣居民來往大陸通行證 |
00000001 | 中國內地第二代居民身份證 |
返回資料
名稱 | 類型 | 描述 | 樣本值 | |
HTTP Status Code | Integer | HTTP狀態代碼。 | 200 | |
HTTP Body | RequestId | String | 請求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF0**** |
Code | String | Success | ||
Message | String | 返回Code的詳細描述。 | success | |
Result.Passed | String | 認證最終結果,取值:
| Y | |
Result.SubCode | String | 認證結果描述。更多資訊,請參見ResultObject.SubCode錯誤碼說明。 | 200 | |
Result.ExtFaceInfo | String | 活體人臉驗證相關結果資訊。關於JSON格式,請參見右側樣本。更多資訊,請參見ExtFaceInfo。 | | |
Result.ExtIdInfo | String | 證件識別相關結果資訊。 關於JSON格式,請參見右側樣本。更多資訊,請參見ExtIdInfo。 | | |
返回Code
HTTP狀態代碼 | Code | Message說明 |
200 | Success | 請求成功。 |
400 | MissingParameter | 參數不可為空。 |
InvalidParameter | 非法參數。 | |
401 | UnqualifiedPhoto | 傳入的圖片不可讀,或圖片解析度不符合要求,建議更換圖片。 需確保照片清晰、曝光正常,完整無遮擋,角度無太大偏差。 |
DataDuplication | 同時傳入Base64編碼的圖片和Url圖片地址,此二參數任選其一即可。 | |
ToolargeImage | 圖片尺寸過大,建議壓縮圖片或更換圖片上傳方式。 | |
DownloadTimeout | URL圖片下載逾時。 | |
NoFaceDetected | 傳入圖片無人臉。 | |
403 | Forbidden.RAMUserAccessDenied | 需要給RAM使用者授予 AliyunAntCloudAuthFullAccess 操作許可權。更多資訊,請參見授權RAM使用者訪問服務。 |
Forbidden.AccountAccessDenied | 確保您開通了ID verifycation,並且保證賬戶未欠費。 | |
Throttling.Api | API限流攔截。 | |
500 | InternalError | 系統內部錯誤,請反饋給工程師排查。 |
ResultObject.SubCode錯誤碼說明
錯誤碼 | 是否計費 | 描述和原因建議 |
200 | Yes | 認證通過。 |
201 | Yes | 官方資料庫中姓名和身份證不一致。可能是使用者的資訊有誤或使用者的資訊為假資訊,建議使用者確認後重新操作。 |
202 | Yes | 官方資料庫查詢不到身份資訊。建議預留人工審核入口,進行人工審核。 |
203 | Yes | 查詢不到照片或照片不可用。可能原因:權威比對源未留存底庫照片。建議預留人工審核入口,進行人工審核。 |
204 | Yes | 人臉比對不一致。可能不是同一人或活體照片品質較低。 |
205 | Yes | 活體檢測存在風險。 |
207 | Yes | 上傳人臉與官方資料庫中的人臉比對不一致。可能不是同一人或人臉照片品質較低。 |
209 | Yes | 權威比對源異常。 |
212 | Yes | 證件防偽檢測存在風險。可能存在翻拍、篡改、複印等高風險操作。 |
ExtFaceInfo
名稱 | 類型 | 描述 | 樣本值 |
facePassed | String | 掃臉階段的活體人臉驗證最終結果:
| Y |
faceComparisonScore | Double | 採集人臉和證件人像比對分。比對分取值範圍0~100。 | 99.99 |
faceAttack | String | 採集人臉是否涉及活體攻擊:
| N |
authorityComparisonScore | Double | 採集人臉和官方權威資料來源比對分。比對分取值範圍0~100。 | 99.99 |
ExtIdInfo
名稱 | 類型 | 描述 | 樣本值 |
idPassed | String | 證件OCR識別階段的最終結果:
| N |
ocrIdInfo | String | 證件OCR欄位資訊。 說明 如果證件OCR流程失敗,則該欄位值為空白。 | |
spoofInfo | String | 證件防偽檢測結果,包括風險判定結果和風險類型:
| |