本文介紹如何通過CheckResult介面查詢eKYC方案的認證結果。
介面說明
介面名:CheckResult
要求方法:HTTPS POST
介面說明:當您收到回調通知之後,可以在服務端通過該介面擷取相應的認證狀態和認證資料。
重要ID Verification服務結果預設儲存30天,超期系統自動刪除,請您在認證結束後的30天內查詢認證結果。
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程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 描述 | 樣本值 |
MerchantBizId | String | Yes | 您自訂的業務唯一標識,用於後續定位排查問題。支援長度為32位的字母和數位組合,請確保唯一。 說明 阿里雲伺服器不會對該欄位的值進行唯一性檢查。為了更好地跟蹤,強烈建議保證欄位唯一性。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
TransactionId | String | Yes | 整個認證流程的唯一標識。該值需要調用 Initialize 介面擷取。 重要 為避免篡改風險,該值必須使用您Initialize介面時服務端儲存的TransactionId,不建議使用用戶端回調的TransactionId。 | hksb7ba1b28130d24e015d6******** |
IsReturnImage | String | No | 是否需要返回認證圖片資料:
| Y |
返回資料
名稱 | 類型 | 描述 | 樣本值 | |
HTTP Status Code | Integer | HTTP狀態代碼。 | 200 | |
HTTP Body | RequestId | String | 請求ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039795 |
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 | 非法參數。 | |
TransactionIdInvalid | 無效Transaction id。 | |
403 | Forbidden.RAMUserAccessDenied | 需要給RAM使用者授予AliyunAntCloudAuthFullAccess的操作許可權。更多資訊,請參見授權RAM使用者訪問服務。 |
Forbidden.AccountAccessDenied | 確保您開通了ID verifycation,並且保證賬戶未欠費。 | |
Throttling.Api | API限流攔截。 | |
404 | ProcessNotCompleted | 整個認證流程未完成。 |
500 | InternalError | 系統內部錯誤,請反饋工程師排查。 |
ResultObject.SubCode錯誤碼說明
錯誤碼 | 認證記錄是否計費 | 描述和原因建議 |
200 | 是 | 認證通過。 |
201 | 是 | 官方資料庫中姓名和身份證不一致。可能是使用者的資訊有誤或使用者的資訊為假資訊,建議使用者確認後重新操作。 |
202 | 是 | 官方資料庫查詢不到身份資訊。建議預留人工審核入口,進行人工審核。 |
204 | 是 | 活體人臉和證件照片比對不一致。可能是人證不符或活體照片品質較低。 |
205 | 是 | 活體檢測存在風險。 |
206 | 是 | 業務策略限制。開啟安全模式後,會對認證的裝置等環境進行安全檢測,若檢測到可能存在風險,則判定認證結果不通過。 您可以按照如下方法排查處理:
|
207 | 是 | 官方資料庫中人臉核驗失敗。可能不是同一人或活體照片品質較低。 |
209 | 是 | 權威比對源異常。 |
212 | 是 | 證件防偽檢測存在風險。可能存在翻拍、篡改、複印等高風險操作。 |
ExtFaceInfo
名稱 | 類型 | 描述 | 樣本值 |
facePassed | String | 掃臉階段的活體人臉驗證最終結果:
| Y |
faceComparisonScore | Double | 採集人臉和證件人像比對分。比對分取值範圍0~100。 說明 分數越高代表相同人臉機率越高,預設閾值90 ,您也可以基於業務樣本資料自訂處理。 | 99.99 |
faceImg | String | 採集人臉圖片,Base64格式。如在發起介面請求時,參數 | base64格式 |
faceAttack | String | 採集人臉是否涉及活體攻擊,攻擊為Y,否則為N。 | N |
faceQuality | Double | 活體人臉品質分數。取值範圍0~100。 | 99.99 |
faceOcclusion | String | 是否有臉部遮擋,有臉部遮擋為Y,否則為N。 | N |
docVideoUrl | String | 存證OSS下載地址。 說明
| https://aliyun-cloudauth.oss-aliyuncs.com/******.webm |
faceAge | String | 人臉預測的參考年齡,可能存在預測失敗無法返回的情況。 | 30 |
faceGender | String | 人臉圖片預測的性別,可能存在預測失敗無法返回的情況。
| M |
authorityComparisonScore | Double | 採集人臉和官方權威資料來源比對分。比對分取值範圍0~100。 說明
| 99.99 |
faceAttackScore | Double | Face Service演算法預測的假臉攻擊可能性,分數越高代表假臉的可能性越高。 分值取值:0~100。 | 80 |
guardRiskScore | Double | 人臉保鏢演算法預測的裝置風險可能性,分數越高代表裝置風險越高。 分值取值:0~100。 | 90 |
ExtIdInfo
名稱 | 類型 | 描述 | 樣本值 |
ocrIdPassed | String | 證件OCR識別階段的最終結果:
| N |
idImage | String | 證件OCR照片,base64格式。如在發起介面請求時,參數isReturnImage=Y且證件OCR流程順利完成,則返回此欄位。 | base64格式 |
ocrIdInfo | String | 證件OCR欄位資訊。 說明 如果證件OCR流程失敗,則該欄位值為空白。 | |
spoofInfo | String | 證件防偽檢測結果,包括風險判定結果和風險類型: 說明 僅當Initialize介面中 IdSpoof = Y 時,才會開啟卡證檢測。 否則 spoofResult 預設返回N,spoofType 為空白。
| |
ocrIdEditInfo | String | 使用者在OCR結果頁二次編輯後,提交的證件OCR欄位資訊。該功能適用用戶端配置選擇啟用OCR結果編輯頁面時(ShowOcrResult)返回。 | |
idBackImage | String | 證件反面OCR照片,base64格式。 說明 如在發起介面請求時,參數isReturnImage = Y且證件OCR流程順利完成,則返回此欄位。 | base64 |
ocrIdBackInfo | String | 證件反面OCR欄位資訊。 重要 如果證件OCR流程失敗,則該欄位值為空白。 | |
spoofBackInfo | String | 證件防偽檢測結果,包括風險判定結果和風險類型:
說明 演算法預測結果,該欄位可能無法返回,建議業務上避免設定必要依賴。 | |
OCR識別返回欄位
中國香港居民身份證
智能身份證2003和2018版本均支援。
欄位 | 類型 | 描述 |
name | String | 姓名 |
englishName | String | 姓名(英文) |
nameCode | String | 中文姓名電碼 |
sex | String | 性別,取值:
|
birthDate | String | 出生日期 |
idNumber | String | 社會安全號碼碼 |
currentIssueDate | String | 登記日期 |
firstIssueDate | String | 首次登記的月份和年份 |
isPermanent | String | 是否屬於永久性居民身份證,取值:
|
symbols | String | 符號標記。例如:"***AZ"。 |
往來港澳通行證
欄位 | 類型 | 描述 |
name | String | 姓名 |
englishName | String | 姓名(拼音) |
sex | String | 性別 |
birthDate | String | 出生日期 |
idNumber | String | 證件號碼 |
issueDate | String | 簽發日期 |
expiryDate | String | 失效日期 |
placeOfIssue | String | 簽發地點 |
originOfIssue | String | 簽發機關 |
港澳居民來往內地通行證
欄位 | 類型 | 描述 |
name | String | 姓名 |
englishName | String | 姓名(英文) |
sex | String | 性別 |
birthDate | String | 出生日期 |
idNumber | String | 證件號碼 |
issueDate | String | 簽發日期 |
expiryDate | String | 失效日期 |
originOfIssue | String | 簽發機關 |
台灣居民來往大陸通行證
欄位 | 類型 | 描述 |
name | String | 姓名 |
englishName | String | 姓名(拼音) |
sex | String | 性別 |
birthDate | String | 出生日期 |
idNumber | String | 證件號碼 |
issueDate | String | 簽發日期 |
expiryDate | String | 失效日期 |
originOfIssue | String | 簽發機關 |
placeOfIssue | String | 簽發地點 |
全球護照
欄位 | 類型 | 描述 |
surname | String | 姓 |
givenname | String | 名 |
sex | String | 性別 |
birthDate | String | 出生日期 |
passportNo | String | 護照號 |
nationality | String | 國籍 |
expiryDate | String | 失效日期 |
countryCode | String | 國家代碼 |
中國澳門居民身份證
欄位 | 類型 | 描述 |
surnameCN | String | 姓(中文) |
givennameCN | String | 名(中文) |
surname | String | 姓(英文) |
givenname | String | 名(英文) |
sex | String | 性別 |
birthDate | String | 出生日期 |
idNumber | String | 證件號碼 |
expiryDate | String | 失效日期 |
placeOfBirth | String | 出生地代碼。例如:"AS"。 |
中華人民共和國居民身份證
欄位 | 類型 | 描述 |
name | String | 姓名 |
sex | String | 性別 |
ethnicity | String | 民族 |
birthDate | String | 出生日期 |
idNumber | String | 社會安全號碼 |
address | String | 地址 |
province | String | 省 說明 預留欄位,預設返回為空白。 |
city | String | 市 說明 預留欄位,預設返回為空白。 |
originOfIssue | String | 簽發機關 |
issueDate | String | 簽發日期 |
expiryDate | String | 失效日期 |