概覽

API URL：/api/v1/zoloz/realid/checkresult
API 描述：該介面用於擷取身分識別驗證進程的運行狀態和相關的驗證結果，包括證件驗證結果及詳細資料、人臉驗證結果、風險控制結果等。

說明：該介面支援重複調用，即符合等冪性。

請求參數

欄位名稱	資料類型	最大長度	是否必填	預設值	描述	樣本值
bizId	String	32	是	-	業務ID，業務的唯一標識，用於追蹤業務。例如，商戶業務相關資料庫中的序號。說明：ZOLOZ伺服器不檢查該欄位的值是否唯一。為了更便捷地追蹤業務，建議開啟商戶伺服器，並確保業務ID的唯一性。	"2017839040588699"
transactionId	String	64	是	-	事務ID，由ZOLOZ RealID initialize API的響應訊息返回。	"G000000005FID20200304000000000001570702"
isReturnImage	String	1	否	N	是否在響應中返回圖片資料。取值如下： `Y`：在響應中返回圖片資料。 `N`：不在響應中返回圖片資料。	"Y"
extraImageControlList	List<String>	-	否	[]	指定需要返回的額外的圖片。支援的圖片類型如下： `FACE_EYE_CLOSE`：返回閉眼的人臉圖片。 `DOC_FRONT_ANGLE`：返回從傾斜角度拍攝的證件首頁圖片。 `DOC_FRONT_FLASH`：返回在閃光燈照射下拍攝的證件首頁圖片。 `DOC_BACK_ANGLE`：返回從傾斜角度拍攝的證件背面圖片。 `DOC_BACK_FLASH`：返回在閃光燈照射下拍攝的證件背面圖片。 `CROPPED_FACE`：返回裁剪後的人臉圖片。 `CROPPED_FACE_FROM_DOC`：返回從採集的證件圖片中裁剪出臉部地區的人臉圖片。注意：當isReturnImage為Y時，該參數才生效。是否返回額外的圖片還取決於這些圖片是否已被成功採集，這由整合模式和初始化API中設定的serviceLevel的值決定。例如，整合模式為原生App SDK，serviceLevel的值為`REALID0002`，此時會返回在閃光燈照射下拍攝的證件首頁圖片。	[ "FACE_EYE_CLOSE", "DOC_FRONT_ANGLE" ]
returnFiveCategorySpoofResult	String	1	否	N	是否返回五類證件防偽檢測結果。取值如下： `Y`：證件防偽檢測結果將分五類返回，包括： `TAMPER_CHECK` `MATERIAL_CHECK` `SCREEN_RECAPTURE_CHECK` `INFORMATION_CHECK` `SECURITY_FEATURE_CHECK` `N`：證件防偽檢測結果將分四類返回，包括： `TAMPER_CHECK` `MATERIAL_CHECK` `SCREEN_RECAPTURE_CHECK` `OTHER_CHECK`	"Y"

返回參數

欄位名稱	資料類型	必須返回	描述	樣本值
result	Result	是	API請求結果，包含結果狀態、結果碼和結果訊息。	{ "resultCode": "SUCCESS", "resultMessage": "Success", "resultStatus": "S" }
ekycResult	String	否	標識整個身分識別驗證進程的運行狀態。取值如下： `Success`：身分識別驗證運行成功。 `Pending`：身分識別驗證結果待人工確認。 `Failure`：身分識別驗證失敗，可能是證件驗證、人臉驗證或風控處理失敗導致。 `InProcess`：正在身分識別驗證中。 `VoidCancelled`：使用者取消了身分識別驗證。 `VoidTimeout`：身分識別驗證逾時。說明：當result.resultStatus的值為S時，才返回該欄位。	"Pending"
extBasicInfo	ExtBasicInfo	否	基本實名資訊。詳細資料，請參見ExtBasicInfo。說明：當result.resultStatus的值為S時，才返回該欄位。	{ "certType": "08530000001", "certNo": "A12345678", "certName": "xxxxxx" }
extFaceInfo	ExtFaceInfo	否	eKYC申請中人臉驗證的詳細資料。詳細資料，請參見ExtFaceInfo。說明：當result.resultStatus的值為S時，才返回該欄位。	{ "ekycResultFace": "Success", "faceScore": 88, "faceImg": "/9j/4AA..[omitted]..PxA=", "extraImages": { "FACE_EYE_CLOSE": "/9j/4AA..[omitted]..PxA=" }, "faceQuality": 97.61517973846627, "faceLivenessResult": "Success" }
extIdInfo	ExtIdInfo	否	eKYC申請中證件驗證的詳細資料。詳細資料，請參見ExtIdInfo。說明：當result.resultStatus的值為S時，才返回該欄位。	參考返回樣本
extRiskInfo	ExtRiskInfo	否	eKYC申請中風險控制的詳細資料。詳細資料，請參見ExtRiskInfo。說明：當result.resultStatus的值為S時，才返回該欄位。	{ "ekycResultRisk": "Pending", "strategyPassResult": "ID_NETWORK_HIGH_RISK", "idNetworkDetails": "..." }
extCustomInfo	ExtCustomInfo	否	eKYC申請中關於定製資訊的詳情。詳細資料，請參見ExtCustomInfo。說明：當result.resultStatus的值為S時，才返回該欄位。	{"h5Degraded":"Y"}

ExtBasicInfo欄位說明

說明：當證件採集成功時，才返回certType、certNo和certName欄位。

欄位名稱	資料類型	必須返回	描述	樣本值
certType	String	否	證件類型。	"00860000001"
certNo	String	否	證件號碼，即從身份證件中識別到的證件號碼。	"420502198012345000"
certName	String	否	姓名，即從身份證件中識別到的姓名。	"李四"

ExtFaceInfo欄位說明

說明：當人臉採集成功時，才返回ekycResultFace、faceScore和faceQuality欄位。

欄位名稱	資料類型	必須返回	描述	樣本值
ekycResultFace	String	否	人臉模組的驗證結果。 `Success`：人臉驗證成功。 `Pending`：人臉驗證結果待人工確認。 `Failure`：人臉驗證失敗。	"Success"
faceScore	Integer	否	人臉比對分數，取值範圍0-100。該分數是將活體人臉與證件臉進行比對得出的結果。	88
faceImg	String	否	返回的人臉圖片，採用Base64編碼格式。說明：當isReturnImage的值為Y，且人臉採集成功時才返回該欄位。	"/9j/4AA..[omitted]..PxA="
extraImages	Map<String,String>	否	在extraImageControlList中指定的額外需要返回的人臉圖片。 Key是在extraImageControlList中指定的值。 Value是以Base64編碼的圖片內容。如果未找到請求的圖片，則該值為“”。	{ "FACE_EYE_CLOSE": "/9j/4AA..[omitted]..PxA=" }
faceQuality	Double	否	人臉圖片的品質分數，取值範圍0-100。	97.61517973846627
faceLivenessResult	String	-	人臉活體檢測結果。使用人臉活體檢測演算法檢測人臉圖片是否為假臉攻擊。 `Success`：非假臉攻擊。 `Failure`：假臉攻擊。	"Success"
estimatedAge	Integer	否	根據人臉圖片推測出來的年齡，推測年齡和實際年齡的差值小於等於10歲的準確率為95%。說明：該欄位輸出的值僅供參考，ZOLOZ不會根據推測的年齡進行業務判斷，如需攔截特定年齡的交易請自行增加校正邏輯。	34
faceAttribute	FaceAttribute	否	人臉屬性檢測結果，詳情請參見FaceAttribute。說明：當在RealID initialize API中傳入faceAttributeCheck參數且detectOpen為Y時，才返回該欄位。	{ "occlusionMouthResult": "false", "occlusionForeheadResult": "false", "occlusionResult": "false", "occlusionChinResult": "false", "occlusionEyesResult": "false", "occlusionNoseResult": "false", "occlusionCheekResult": "false", "maskResult": "false", "glassesResult": "true", "hatResult": "false" }
deeperFaceResult	String	否	返回的Deeper臉部偵測結果。當`deeperMode`不設定為`CLOSED`時才返回該參數，具體返回的參數值如下： `Success`：Deeper臉部偵測通過，未檢測到AIGC攻擊風險。 `Failure`：Deeper臉部偵測失敗，檢測到有AIGC攻擊風險。	"Success"
deeperFaceResultDescription	String	否	Deeper臉部偵測結果的詳細描述，當`deeperMode`不設定為`CLOSED`，且`deeperFaceResult`為`Failure`時才返回該參數。	""
deviceRisk	DeviceRisk	否	返回的裝置風險資訊。當您購買了Deeper產品，且initialize API中的`deeperMode`不為`CLOSED`時，才返回該欄位，詳見DeviceRisk。	{ "riskLevel": 0 }

FaceAttribute類型說明

欄位名稱	資料類型	必須返回	描述	樣本值
occlusionMouthResult	String	否	嘴巴遮擋檢測結果。 `true`：有遮擋 `false`：無遮擋	"false"
occlusionForeheadResult	String	否	額頭遮擋檢測結果。 `true`：有遮擋 `false`：無遮擋	"false"
occlusionResult	String	否	遮擋檢測總結果。 `true`：有遮擋 `false`：無遮擋	"false"
occlusionChinResult	String	否	下巴遮擋檢測結果。 `true`：有遮擋 `false`：無遮擋	"false"
occlusionEyesResult	String	否	眼睛遮擋檢測結果。 `true`：有遮擋 `false`：無遮擋	"false"
occlusionNoseResult	String	否	鼻子遮擋檢測結果。 `true`：有遮擋 `false`：無遮擋	"false"
occlusionCheekResult	String	否	臉頰遮擋檢測結果。 `true`：有遮擋 `false`：無遮擋	"false"
maskResult	String	否	口罩檢測結果。 `true`：有口罩 `false`：無口罩	"false"
glassesResult	String	否	眼鏡檢測結果。 `true`：有眼鏡 `false`：無眼鏡	"true"
hatResult	String	否	帽子檢測結果。 `true`：有帽子 `false`：無帽子	"false"

DeviceRisk類型說明

欄位名稱

資料類型

必須返回

描述

樣本值

riskLevel

Integer

否

風險等級及對應的處理建議如下：

-1：無法識別人臉注入風險。建議您基於其他情況進行進一步判斷。
說明：新加坡網站暫不支援該能力，riskLevel將返回-1。

0：無風險，未檢測到人臉注入風險。建議繼續進行。
1：低風險。建議標記和觀察。
2：中風險。建議添加安全檢查方法，例如簡訊驗證等。
3：高風險，建議直接攔截。

ExtIdInfo欄位說明

欄位名稱	資料類型	必須返回	描述	樣本值
ekycResultDoc	String	否	證件模組的驗證結果。當證件採集成功時，才返回該欄位。 `Success`：證件驗證成功。 `Pending`：證件驗證結果待人工確認。 `Failure`：證件驗證失敗。	"Pending"
docEdition	Integer	否	身份證件的版本。 `1`~`3`：身份證件的版本，詳見RealID和ID Recognition支援的證件類型和返回的OCR結果。 `0`：無法對身份證件進行分類或證件類型錯誤。 `-1`：未知錯誤。	1
frontPageImg	String	否	身份證件的正面照，採用Base64編碼格式。說明：當isReturnImage的值為Y，且證件採集成功時才返回該欄位。	"/9j/4AA..[omitted]..PxA="
backPageImg	String	否	身份證件的背面照（如果有），採用Base64編碼格式。說明：當isReturnImage的值為Y，證件採集成功且需要上傳身份證件的背面照時，才返回該欄位。	"/9j/4AA..[omitted]..PxA="
extraImages	Map<String,String>	否	在extraImageControlList中指定的額外需要返回的圖片。 Key是在extraImageControlList中指定的值。 Value是以Base64編碼的圖片內容。如果未找到請求的圖片，則該值為“”。如果cropDocImage為Y，則結果中還會包含以下兩個欄位： `CROPPED_FRONT`：經過背景裁剪的證件正面圖片。 `CROPPED_BACK`：經過背景裁剪的證件背面圖片。	{ "DOC_FRONT_ANGLE": "/9j/4AA..[omitted]..PxA=", "CROPPED_FRONT": "/9j/4AA..[omitted]..PxA=", "CROPPED_BACK": "/9j/4AA..[omitted]..PxA=" }
ocrResult	Map	否	OCR識別結果，結果中包含身份相關的資訊。不同的身份證件類型識別出來的身份資訊集不同，詳細請參見RealID和ID Recognition支援的證件類型和返回的OCR結果。說明：當證件採集成功時，才返回該欄位。	{ ... }
ocrResultDetail	Map<String, OcrResultDetail>	否	OCR識別結果詳情，當在initialize API中傳入`mrzVisualConsistencyCheck`時才返回該欄位。
spoofResult	Map	否	證件防偽分項檢測結果，包含篡改、材質和螢幕翻拍等檢測結果。詳細資料，請參見spoofResult。	{ "TAMPER_CHECK": "Y", "MATERIAL_CHECK": "Y", "SCREEN_RECAPTURE_CHECK": "Y", "INFORMATION_CHECK": "Y", "SECURITY_FEATURE_CHECK":,"Y" }
extraSpoofResultDetails	List<ExtraSpoofResultDetail>	否	擴充證件防偽檢測細項結果。詳細資料，請參見ExtraSpoofResultDetail。	[{ "name": "hologramCheck", "result": "Y", "spoofType": "SECURITY_FEATURE_CHECK", "components": [ { "name": "hologram", "subResult": "Y" } ] }]
securityFeaturesResult	Map	否	該參數已廢棄，詳見香港證件安全功能更新通知—2024年7月31日。	{ "LASER_IMAGE_1_SCORE":95, "LASER_IMAGE_1_THRESHOLD":90, "LASER_IMAGE_1_PASSED":"True", "HOLOGRAM_SCORE":95, "HOLOGRAM_THRESHOLD":90, "HOLOGRAM_PASSED":"True", "STEREO_LASER_PORTRAIT_SCORE":95, "STEREO_LASER_PORTRAIT_THRESHOLD":90, "STEREO_LASER_PORTRAIT_PASSED":"True", "LASER_IMAGE_2_SCORE":95, "LASER_IMAGE_2_THRESHOLD":90, "LASER_IMAGE_2_PASSED":"True", "OVERALL_SCORE":95, "OVERALL_THRESHOLD":90, "OVERALL_PASSED":"True" }
docErrorDetails	String	否	證件識別不通過明細。 `NO_REQUIRED_ID`：證件圖片不符合指定的證件類型。 `BLUR`：證件圖片模糊。 `NO_FACE_DETECTED`：未檢測到證件上的人臉。 `NOT_REAL_DOC`：證件防偽檢測不通過。 `EXPOSURE`：證件圖片過度曝光。 `UNKNOWN`：其他錯誤。	"BLUR"
docErrorDescription	String	否	證件識別失敗的原因。	""
uploadEnabledResult	String	否	返回證件圖片的擷取方式。 `Y`：通過從案頭上傳檔案的方式擷取。 `N`：非案頭上傳檔案的方式擷取。	"N"
deeperDocResult	String	否	返回的Deeper證件檢測結果，僅當`deeperMode`不為`CLOSED`時返回。傳回值如下： `Success`：未檢測到AIGC攻擊風險。 `Pending`：檢測到AIGC攻擊風險。	"Pending"
deeperDocResultDescription	String	否	Deeper證件檢測結果的詳細描述，僅當`deeperMode`不為`CLOSED`且`deeperDocResult`為`Pending`時返回。	"deepfake risk"

spoofResult欄位說明

欄位名稱	資料類型	必須返回	描述	樣本值
TAMPER_CHECK	String	是	身份證件是否通過了篡改檢測。 `Y`：通過，即檢測結果為未被篡改。 `N`：不通過，即檢測結果為被篡改。	"Y"
MATERIAL_CHECK	String	是	身份證件是否通過了材質檢測。 `Y`：通過。 `N`：不通過，例如檢測結果為黑白材質。	"Y"
SCREEN_RECAPTURE_CHECK	String	是	身份證件是否通過了螢幕翻拍檢測。 `Y`：通過。 `N`：不通過，即上傳的圖片被檢測為從螢幕上翻拍的圖片。	"Y"
INFORMATION_CHECK	String	否	身份證件是否通過了資訊校正檢測。目前僅支援中國香港身份證（包括2003版和2018版）。 `Y`：通過。 `N`：不通過。說明：當returnFiveCategorySpoofResult的值為Y時，才返回該欄位。	"Y"
SECURITY_FEATURE_CHECK	String	否	身份證件是否通過了防偽安全特徵檢測。目前僅支援中國香港身份證（包括2003版和2018版）和大馬卡。 `Y`：通過。 `N`：不通過。說明：當returnFiveCategorySpoofResult的值為Y時，才返回該欄位。	"Y"

ExtraSpoofResultDetail類型說明

欄位名稱	資料類型	必須返回	描述	樣本值
name	String	是	擴充證件防偽檢測名稱。	"landmarkCheck"
result	String	是	擴充證件防偽檢測結果。 `Y`：檢測通過。 `N`：檢測失敗。	"Y"
spoofType	String	是	擴充證件防偽檢測所屬的分項類別。 TAMPER_CHECK MATERIAL_CHECK SCREEN_RECAPTURE_CHECK INFORMATION_CHECK SECURITY_FEATURE_CHECK	"SECURITY_FEATURE_CHECK"
components	Array	是	擴充證件防偽檢測細項的檢查結果。該欄位一定會被返回。如果只指定了一個細項檢查，則數組將只返回一個元素。	[ { "name": "hologram", "subResult": "Y" } ]
components.name	String	是	擴充證件防偽檢測細項的檢查名稱。詳細資料，請參見證件防偽檢測組件。	"kadPengenalan"
components.subResult	String	是	擴充證件防偽檢測單個檢測細項的檢查結果。 `Y`：檢查通過。 `N`：檢查失敗。	"Y"

securityFeaturesResult欄位說明（已廢棄）

securityFeaturesResult參數已廢棄，詳見香港證件安全功能更新通知—2024年7月31日。

ExtRiskInfo欄位說明

欄位名稱	資料類型	必須返回	描述	樣本值
ekycResultRisk	String	-	風控模組的驗證結果。 `Success`：風險控制驗證通過。 `Pending`：風險控制結果待人工確認。 `Failure`：風險控制驗證失敗。	"Pending"
strategyPassResult	String	否	風險檢測結果。當風控執行完成時，才返回該欄位。 `PASS`：身分識別驗證通過了風險檢測。 `VELOCITY_HIGH_RISK`：風控引擎檢測到高風險。 `ID_NETWORK_HIGH_RISK`：通過IdNetwork檢測到虛假驗證風險。例如，檢測到識別出的人臉與多個身份證件相關或檢測到一個身份證件與多張人臉相關。說明：同一使用者或同一證件號檢測出相同的人臉不會觸發該風險。 `BLACKLIST_HIGH_RISK`：黑名單掃描檢測到高風險。 `AGE_MISMATCH_HIGH_RISK`：在年齡驗證過程中檢測到高風險。	"ID_NETWORK_HIGH_RISK"
idNetworkDetails	String	否	IdNetwork輸出的詳細資料，該欄位是一段JSON字串，來自於IdNetworkDetails結構的JSON序列化結果，詳見IdNetworkDetails結構。說明：當strategyPassResult的值為`ID_NETWORK_HIGH_RISK`時，才返回該欄位。	"[ { \"ekyc_id\":\"\", \"mobile\":\"\", \"reason_code\":[ \"SIMILAR_FACE\" ], \"transaction_id\":\"G000000000FRL20231110000000035925247043\", \"type\":\"Fake ID\", \"user_id\":\"idn-z8Cuj\" }, { \"reason_code\":\"[SIMILAR_FACE]\", \"score\":\"0.996945100506912\", \"user_id\":\"0ha6_1692349732313\", \"mobile\":\"\", \"ekyc_id\":\"\", \"type\":\"Duplicated ID\" } ]"
otherRiskReasonDetails	String	否	除了IdNetwork之外的風險引擎的詳細資料。例如在黑名單命中的情況下，該欄位的結構如右側所示。	{ "BLACKLIST_HIGH_RISK": { "CERT": [ {"listId":"xx","transactionId":"xx","itemId":xx,"similarScore":xx} ], "FACE":[ {"listId":"xx","transactionId":"xx","itemId":"xx","similarScore":xx}]} }
deeperRiskResult	String	否	返回的Deeper風險檢測結果。當`deeperMode`不設定為`CLOSED`時才返回該參數，具體返回的參數值如下： `Success`：Deeper風險檢測通過，未檢測到AIGC攻擊風險。 `Failure`：Deeper風險檢測失敗，檢測到有AIGC攻擊風險。	"Success"
deeperRiskResultDescription	String	否	Deeper風險檢測結果的詳細描述，當`deeperMode`不設定為`CLOSED`，且`deeperRiskResult`為`Failure`時才返回該參數。	""
advancedIdnDetail	AdvancedIdnDetail	否	IDN輸出的詳細資料，詳見AdvancedIdnDetail。說明：僅當購買了IDN，且initialize API的入參`checkAdvancedIdn`為`Y`時，才返回該參數。	{ "itemId": "AIN20220727890204890950", "riskDetails": [ { "type": "IDFAKE", "subType": "SameFaceDifferentIdNumber", "riskData": [ "AIN20220727890199220364" ] } ] }
blackListDetails	List<BlackListDetail>	否	黑名單輸出的詳細資料，詳見BlackListDetail。說明：僅當購買了黑名單功能，且initialize API的入參`checkBlacklist`為`Y`時，才返回該參數。	[ { "listId": "10064", "itemId": "95c0e4e55d5cd5485edaa573d15e82", "itemType": "FACE", "similarScore": 99.99999999999999, "transactionId": "G000000001FRL202410100000000109481109" }, { "listId": "10066", "itemId": "20015", "itemType": "CERT", "similarScore": 100 } ]

IdNetworkDetails類型說明

欄位名稱	資料類型	必須返回	描述	樣本值
ekyc_id	String	否	eKYC ID，該欄位已廢棄。	-
mobile	String	否	手機號，該欄位已廢棄。	-
reason_code	Array	否	觸發風險的原因。更多關於Reason Code的描述，請參見RealID IDN Lite風險類型介紹。 `SIMILAR_FACE`：從不同使用者中檢測出相似的人臉。說明：同一使用者且人臉相同不會觸發該風險。 `SAME_CERT_NO`：一個證件號被多個使用者使用。	["SIMILAR_FACE","SAME_CERT_NO"]
type	String	否	觸發的風險類型： `Duplicated ID`：同一個人多次認證。 `Fake ID`：篡改證件資訊。	"Fake ID"
score	String	否	保留欄位，請勿依賴該欄位。說明：當`type`為`Duplicated ID`時才返回該欄位。	"0.996945100506912"
user_id	String	否	使用者ID	"idn-z8Cuj"

說明：RealID中嵌入的IDN是IDN的精簡版，僅包含IDN的部分功能，被稱為IDN Lite。

如需使用IDN的全部功能，請參見IDN介面文檔。
RealID IDN和IDN的區別，請參見RealID IDN Lite和IDN有什麼區別？。

RealID IDN Lite風險類型介紹

RealID IDN Lite支援Fake ID（篡改證件資訊）和Duplicated ID（同一個人多次認證）這兩大類風險。有關風險類型和Reason Code的詳細說明見下表。

風險類型	Reason Code	說明
Fake ID	SIMILAR_FACE	相同的人臉，不同證件號（證件類型相同）。
Fake ID	SAME_CERT_NO	不同的人臉，相同證件號（證件類型相同）。
Duplicated ID	SIMILAR_FACE	相同的人臉，不同證件類型。

AdvancedIdnDetail欄位說明

欄位名稱	資料類型	必須返回	描述	樣本值
itemId	String	否	添加到ID Network資料庫的記錄ID。請妥善儲存該記錄ID，用於後續風險查詢。	"AIN20220727890204890950"
riskDetails	List<RiskDetail>	否	當前商戶存在的風險詳情，詳見RiskDetail。	[ { "type": "IDFAKE", "subType": "SameFaceDifferentIdNumber", "riskData": [ "AIN20220727890199220364" ] } ]

RiskDetail欄位說明

欄位名稱	資料類型	描述	樣本值
type	String	返回的風險類型，詳情參考IdNetwork風險介紹。	"IDFAKE"
subType	String	返回的子風險類型，詳情參考IdNetwork風險介紹。	"SameFaceDifferentIdNumber"
riskData	List<String>	返回的風險資料，內容為itemId數組。	["AIN20220727890199220364"]

BlackListDetail類型說明

欄位名稱	資料類型	必須返回	描述	樣本值
listId	String	否	目標黑名單的名單ID。	"10064"
itemId	String	否	黑名單記錄ID。	"95c0e4e55d5cd5485edaa573d15e82**"
itemType	String	否	黑名單記錄的類型，包括三種類型： `FACE`：人臉黑名單。 `CERT`：證件黑名單，黑名單條目由證件類型和證件號標識。 `DEVICE`：裝置黑名單。	"FACE"
similarScore	String	否	相似分，分值越高相似性越高。	99.99999999999999
transactionId	String	否	黑名單記錄的來源，是由客戶通過eKYC的transactionId自行錄入的黑名單資訊。	"G000000001FRL202410100000000109481109**"

ExtCustomInfo欄位說明

欄位名稱

資料類型

必須返回

描述

樣本值

h5degraded

String

否

是否採用了降級模式。

Y：已採用降級模式。
N：未採用降級模式。

說明：當RealID initialize API中的allowDegradation參數為Y時，才返回該欄位。

"Y"

處理結果

根據請求結果執行下一步的響應動作，具體如下：

當result.resultCode的值為SUCCESS時，表示調用ZOLOZRealID checkresultAPI成功，並返回證件驗證、人臉驗證和風控處理結果。
當result.resultCode的值非SUCCESS時，表示調用ZOLOZRealID checkresultAPI失敗。請檢查錯誤碼擷取有關該錯誤的更多資訊，並分析導致該錯誤的原因。

API通用結果碼

有關通用結果碼的完整列表，請參見API通用結果碼。

API特有結果碼

RealID checkresult API的結果碼見下表。

結果碼	結果狀態	描述
SUCCESS	S	API調用成功。
INVALID_ARGUMENT	F	輸入參數無效。關於無效參數的詳細資料，請查看返回的resultMessage。
SYSTEM_ERROR	F	其他內部錯誤。有關錯誤詳情，請查看返回的resultMessage。

程式碼範例

請求樣本

商戶服務端發送的請求程式碼範例。

{
    "bizId": "2017839040588699",
    "transactionId": "G000000005FID20200304000000000001570702",
    "isReturnImage": "Y",
    "extraImageControlList": [
      "FACE_EYE_CLOSE",
      "DOC_FRONT_ANGLE"
    ],
    "returnFiveCategorySpoofResult": "Y"
}

返回樣本

ZOLOZ伺服器返回的響應程式碼範例。

注意：securityFeaturesResult參數已廢棄，詳見香港證件安全功能更新通知—2024年7月31日。為了保證API相容性，該參數會繼續保留在API響應中，並在返回樣本中展示其實際返回模樣，請勿在任何情況下使用該參數。

{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "Success",
    "resultStatus": "S"
  },
  "ekycResult": "Pending",
  "extBasicInfo": {
    "certType": "00860000001",
    "docCategory": "PASSPORT",
    "certNo": "420502198012345000",
    "certName": "李四"
  },
  "extFaceInfo": {
    "ekycResultFace": "Success",
    "faceScore": 88,
    "faceImg": "/9j/4AA..[omitted]..PxA=",
    "extraImages": {
      "FACE_EYE_CLOSE": "/9j/4AA..[omitted]..PxA="
    },
    "faceQuality": 97.61517973846627,
    "faceLivenessResult": "Success",
    "estimatedAge": 34,
    "faceAttribute": {
      "occlusionMouthResult": "false",
      "occlusionForeheadResult": "false",
      "occlusionResult": "false",
      "occlusionChinResult": "false",
      "occlusionEyesResult": "false",
      "occlusionNoseResult": "false",
      "occlusionCheekResult": "false",
      "maskResult": "false",
      "glassesResult": "true",
      "hatResult": "false"
    },
    "deeperFaceResult":"Success",
    "deeperFaceResultDescription":"",
    "deviceRisk":{
      "riskLevel": 0
    }
  },
  "extIdInfo": {
    "ekycResultDoc": "Pending",
    "docEdition": 1,
    "frontPageImg": "/9j/4AA..[omitted]..PxA=",
    "backPageImg": "/9j/4AA..[omitted]..PxA=",
    "extraImages": {
      "DOC_FRONT_ANGLE": "/9j/4AA..[omitted]..PxA=",
      "CROPPED_FRONT": "/9j/4AA..[omitted]..PxA=",
      "CROPPED_BACK": "/9j/4AA..[omitted]..PxA="
    },
    "ocrResult": {
      "ID_NUMBER": "12345",
      "SEX": "M"
    },
    "ocrResultFormat": {
      "NUMBER": "12345",
      "GENDER": "M"
    },
    "ocrResultDetail": {
      "MRZ_ID_NUMBER": {
        "name": "ID_NUMBER",
        "source": "MRZ",
        "value": "xxxx"
      },
      "VISUAL_ID_NUMBER": {
        "name": "ID_NUMBER",
        "source": "VISUAL",
        "value": "xxxx"
      }
    },
    "countryCode": "CHN",
    "spoofResult": {
        "TAMPER_CHECK": "Y",
        "MATERIAL_CHECK": "Y",
        "SCREEN_RECAPTURE_CHECK": "Y",
        "INFORMATION_CHECK": "Y",
        "SECURITY_FEATURE_CHECK": "Y"
    },
    "extraSpoofResultDetails": [
      {
        "name": "landmarkCheck",
        "result": "Y",
        "spoofType": "SECURITY_FEATURE_CHECK",
        "components": [
          {
            "name": "kadPengenalan",
            "subResult": "Y"
          },
          {
            "name": "mykadLogo",
            "subResult": "Y"
          },
          {
            "name": "flagLogo",
            "subResult": "Y"
          },
          {
            "name": "mscLogo",
            "subResult": "Y"
          },
          {
            "name": "ghostFace",
            "subResult": "Y"
          },
          {
            "name": "hibiscusLogo",
            "subResult": "Y"
          },
          {
            "name": "coatOfArm",
            "subResult": "Y"
          },
          {
            "name": "twinTower",
            "subResult": "Y"
          }
        ]
      },
      {
        "name": "hologramCheck",
        "result": "Y",
        "spoofType": "SECURITY_FEATURE_CHECK",
        "components": [
          {
            "name": "hologram",
            "subResult": "Y"
          }
        ]
      },
      {
        "name": "pageInfoCheck",
        "result": "Y",
        "spoofType": "INFORMATION_CHECK",
        "components": [
          {
            "name": "id",
            "subResult": "Y"
          },
          {
            "name": "symbol",
            "subResult": "Y"
          },
          {
            "name": "name",
            "subResult": "Y"
          }
        ]
      },
      {
        "result": "N",
        "components": [
          {
            "subResult": "N",
            "name": "ID_NUMBER"
          }
        ],
        "spoofType": "INFORMATION_CHECK",
        "name": "commonConsistencyCheck"
      },
      {
        "result": "N",
        "components": [
          {
            "subResult": "N",
            "name": "NAME"
          },
          {
            "subResult": "Y",
            "name": "SEX"
          }
        ],
        "spoofType": "INFORMATION_CHECK",
        "name": "mrzVisualConsistencyCheck"
      }
    ], 
    "securityFeaturesResult": {
      "LASER_IMAGE_1_SCORE":95,
      "LASER_IMAGE_1_THRESHOLD":90,
      "LASER_IMAGE_1_PASSED":"True",
      "HOLOGRAM_SCORE":95,
      "HOLOGRAM_THRESHOLD":90,
      "HOLOGRAM_PASSED":"True",
      "STEREO_LASER_PORTRAIT_SCORE":95,
      "STEREO_LASER_PORTRAIT_THRESHOLD":90,
      "STEREO_LASER_PORTRAIT_PASSED":"True",
      "LASER_IMAGE_2_SCORE":95,
      "LASER_IMAGE_2_THRESHOLD":90,
      "LASER_IMAGE_2_PASSED":"True",
      "OVERALL_SCORE":95,
      "OVERALL_THRESHOLD":90,
      "OVERALL_PASSED":"True"
    },
    "docErrorDetails": "BLUR",
    "docErrorDescription": "passport country code check failed.",
    "uploadEnabledResult": "N",
    "deeperDocResult": "Pending",
    "deeperDocResultDescription": "deepfake risk"
  },
  "extRiskInfo": {
    "ekycResultRisk": "Pending",
    "strategyPassResult": "ID_NETWORK_HIGH_RISK",
    "deeperRiskResult":"Success",
    "deeperRiskResultDescription":"",
    "advancedIdnDetail": {
          "itemId": "AIN20240823437824356351",
          "riskDetails": [
              {
                  "riskData": [
                      "AIN20240823437671943639"
                  ],
                  "subType": "SamePersonDifferentFace",
                  "type": "IDFAKE"
              },
              {
                  "riskData": [
                      "AIN20240823437672383752",
                      "AIN20240822429059966837"
                  ],
                  "subType": "SamePersonDifferentIdNumber",
                  "type": "IDFAKE"
              }
          ]
      },
     "blackListDetails":[
      {
          "listId": "10064",
          "itemId": "95c0e4e55d5cd5485edaa573d15e82**",
          "itemType": "FACE",
          "similarScore": 99.99999999999999,
          "transactionId": "G000000001FRL202410100000000109481109**"
      },
      {
          "listId": "10066",
          "itemId": "20015",
          "itemType": "CERT",
          "similarScore": 100
      }
    ]
  },
  "extCustomInfo": {"h5Degraded":"Y"}
}