概覽
API URL：/api/v1/zoloz/connect/checkresult
API 描述：該介面用於擷取人臉驗證的結果。
說明：該介面支援重複調用，即符合等冪性。
請求參數
欄位名稱 | 資料類型 | 最大長度 | 是否必填 | 描述 | 樣本值 |
bizId | String | 32 | 是 | 業務ID，業務的唯一標識，用於追蹤業務。例如，商戶業務相關資料庫中的序號。 說明：ZOLOZ伺服器不檢查該欄位的值是否唯一。為了更便捷地追蹤業務，建議開啟商戶伺服器，並確保業務ID的唯一性。 | "2017839040588699" |
transactionId | String | 64 | 是 | 事務ID，由ZOLOZ Connect initialize API在初始化人臉驗證進程時的響應訊息中返回。 | "G006600016CN20190114000000009572520355" |
返回參數
欄位名稱 | 資料類型 | 必須返回 | 描述 | 樣本值 |
result | 是 | API請求結果，包含結果狀態、結果碼和結果訊息。 | { "resultCode": "SUCCESS", "resultMessage": "Success", "resultStatus": "S" } | |
extFaceInfo | ExtFaceInfo | 否 | 人臉驗證的詳細資料。 說明：當result.resultCode的值為 | { "aliveImage": "#ALIVE_FACE_BASE64_CONTENT#", "refImage": "#REFERENCE_FACE_BASE64_CONTENT#", "faceScore": 89.1, "faceAttack": false } |
ExtFaceInfo欄位說明
說明：當人臉採集完成時，才返回aliveImage、refImage和faceScore欄位。
欄位名稱 | 資料類型 | 必須返回 | 描述 | 樣本值 |
aliveImage | String | 否 | 採用Base64編碼的人臉圖片。 | "#ALIVE_FACE_BASE64_CONTENT#" |
refImage | String | 否 | 採用Base64編碼的人臉註冊圖片。 | "#REFERENCE_FACE_BASE64_CONTENT#" |
faceScore | Double | 否 | 人臉比對分數，取值範圍0-100。該分數是將活體人臉與註冊人臉進行比對得出的結果。 | 89.1 |
faceAttack | Boolean | 否 | 通過人臉活體檢測演算法檢測當前的人臉圖片是否為假臉攻擊。
| false |
處理結果
根據請求結果執行下一步的響應動作，具體如下：
當result.resultCode的值為
SUCCESS或NOT_SAME_PERSON時，表示調用ZOLOZ Connect checkresult API成功，並返回人臉驗證結果SUCCESS或NOT_SAME_PERSON。當result.resultCode的值非
SUCCESS或NOT_SAME_PERSON時，表示調用ZOLOZ Connect checkresult API失敗。請檢查錯誤碼擷取有關該錯誤的更多資訊，並分析導致該錯誤的原因。
API通用結果碼
有關通用結果碼的完整列表，請參見API通用結果碼。
API特有結果碼
Connect checkresult API的結果碼見下表。
結果碼 | 結果狀態 | 描述 |
SUCCESS | S | API調用成功。 |
INVALID_ARGUMENT | F | 輸入參數無效。關於無效參數的詳細資料，請查看返回的resultMessage。 |
SYSTEM_ERROR | F | 其他內部錯誤。有關錯誤詳情，請查看返回的resultMessage。 |
NOT_SAME_PERSON | F | 人臉驗證失敗。可能原因如下：
|
UNABLE_GET_IMAGE | F | 註冊的圖片不可用或無效。 |
PROCESSING | F | 進行中人臉驗證。 |
程式碼範例
請求樣本
商戶服務端發送的請求程式碼範例。
{
"bizId": "2017839040588699",
"transactionId": "G006600016CN20190114000000009572520355"
}返回樣本
ZOLOZ伺服器返回的響應程式碼範例。
copy
{
"result": {
"resultCode": "SUCCESS",
"resultMessage": "Success",
"resultStatus": "S"
},
"extFaceInfo": {
"aliveImage": "#ALIVE_FACE_BASE64_CONTENT#",
"refImage": "#REFERENCE_FACE_BASE64_CONTENT#",
"faceScore": 89.1,
"faceAttack": false
}
}