ID Verification 產品支援全鏈路日誌監控,未完成認證的Face Service過程,也可通過 TransactionId 自助查詢,查詢結果可用於分析使用者流失原因。此介面不涉及計費。
介面說明
查詢認證的完整鏈路日誌。
此介面僅可查詢有用戶端接入的方案日誌,不支援純服務端接入方案。
採用認證的端側 SDK 版本需在 1.2.6 及以上(建議使用最新版),Web SDK 需使用最新版。
由於認證過程中日誌上報按照操作時間非同步上傳,請在認證TransectionID的30分鐘有效期間失效後查詢。
ID Verification服務記錄預設儲存30天,超期系統自動刪除,請您在認證結束後的30天內查詢認證記錄。
介面名:CheckVerifyLog
要求方法:POST
傳輸協議:HTTPS
服務地址:
說明內網指的是阿里雲同地區產品之間的內部通訊網路,如果您的商務服務器部署在阿里雲的對應地區,可以通過內網網域名稱訪問 ID Verification 服務,以獲得更安全、穩定的網路通訊品質。
ID Verification不同產品方案支援的Region不同,資料之間相互隔離,您需要選擇資料所在Reigon下的介面網域名稱,才能成功訪問資料。
新加坡
公網:
cloudauth-intl.ap-southeast-1.aliyuncs.com內網:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
印尼
公網:
cloudauth-intl.ap-southeast-5.aliyuncs.com內網:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
中國香港
公網:
cloudauth-intl.cn-hongkong.aliyuncs.com內網:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
線上調試和整合
在調試和整合前,請確保您已完整閱讀使用OpenAPI調試和整合服務端API文檔,充分瞭解API介面在OpenAPI平台的調用方式和SDK及其代碼的擷取方式。
您可以在OpenAPI Explorer中直接運行本介面進行調試,並產生本介面的SDK程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 描述 | 樣本值 |
MerchantBizId | String | 是 | 您自訂的業務唯一標識,用於後續排查問題定位。支援長度為32位的字母和數位組合,請確保唯一。 說明 阿里雲伺服器不會對該欄位的值進行唯一性檢查。為了更好地跟蹤,強烈建議保證欄位唯一性。 | e0c34a77f5ac40a5aa5e6ed20c****** |
TransactionId | String | 是 | 整個認證流程的唯一標識。該值需要調用 Initialize介面 擷取。 | 80414a5e6ed20c37ac40a7f55a****** |
返回參數
名稱 | 類型 | 描述 | 樣本 |
RequestId | String | 請求ID。 | |
Code | String | 返回碼。 | |
Message | String | 返回Code的詳細描述。 | |
Result | Object | 日誌內容,參數詳細說明見下文Result表。 |
Result
名稱 | 類型 | 是否必含 | 描述 |
VerifyStatus | String | 是 | 認證狀態,取值:
|
LogInfo | List<String> | 否 | SDK運行鏈路日誌詳情,格式: [
] |
LogInfoEn | List<String> | 否 | SDK運行鏈路日誌詳情,英文取值。 此欄位格式同LogInfo。 |
Passed | String | 否 說明 僅當 VerifyStatus = 0 時返回。 | 認證最終結果,取值:
|
SubCode | String | 否 說明 僅當 VerifyStatus = 0 時返回。 | 認證結果描述,傳回值請參考使用的認證方案介面文檔中的SubCode描述。 說明 例如,使用了 eKYC - Web SDK 方案進行了認證,則需參考 eKYC - Web SDK - CheckResult 介面文檔中的 SubCode 描述。 |
InterruptPage | String | 否 | 認證中斷最後停留頁面,取值:
|
InterruptPageEn | String | 否 | 認證中斷最後停留頁面,英文取值: 當然,以下是將這些取值轉換為無序列表的形式:
|
VerifyErrorCode | String | 否 | 認證中斷錯誤碼:
|
LogStatisticsInfo | String | 否 | SDK作業記錄統計詳情 ,JSON字串格式,內容詳見下文LogStatisticsInfo 表 。 |
ExtInfo | String | 否 | 擴充欄位(預留) |
LogStatisticsInfo
名稱 | 類型 | 含義 | 樣本 |
pageStayTimeInfo | Map<String,Long> | 頁面停留時間長度(單位毫秒),頁面:
說明 停留時間長度指每一個頁面從渲染展示到跳轉至下一個頁面或者關閉所經歷的時間長度。 | |
hasFaceOverTimes | Boolean | 活體檢測過程中,是否有彈出重試彈窗。 | true |
faceOverTimes | Long | 活體檢測過程中,使用者點擊重試次數。 | 2 |
hasOcrOverTimes | Boolean | OCR是否有重試: 是否存在拍攝證件提交服務端驗證不通過,使用者點擊重拍提交。 | false |
ocrOverTimes | Long | OCR拍攝證件過程中,使用者點擊重試次數。 | 0 |
hasOcrEdit | Boolean | 在OCR頁面中停留時,是否有點擊編輯欄位資訊。 | true |
ocrEditTimes | Long | OCR編輯次數: 使用者編輯點擊提交服務端校正計一次。 | 1 |
hasOcrEditOverTimes | Boolean | OCR編輯是否有重試 | false |
ocrEditOverTimes | Long | OCR編輯重試次數 | 0 |
hasOcrPermissionRefuse | Boolean | OCR是否被相機拒絕許可權 | false |
hasFacePermissionRefuse | Boolean | 活體檢測是否被相機拒絕許可權 | false |
返回碼
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 | 系統內部錯誤,請反饋工程師排查。 |