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

欄位名稱

資料類型

最大長度

是否必填

預設值

描述

樣本值

bizId

String

32

是

-

業務ID，業務的唯一標識，用於追蹤業務。例如，商戶業務相關資料庫中的序號。

說明：ZOLOZ伺服器不檢查該欄位的值是否唯一。為了更便捷地追蹤業務，建議開啟商戶伺服器，並確保業務ID的唯一性。

"2017839040588699"

metaInfo

String

512

是

-

SDK和使用者裝置的元資訊。該欄位的值由ZOLOZ SDK以JSON字串格式返回。

說明：不要修改傳回值，直接傳遞即可。如果是H5接入模式，則設定為MOB_H5。

"{

\"deviceType\": \"android\", \"appVersion\": \"1.0.9\", \"osVersion\": \"9\", \"appName\": \"com.zoloz.atomic.client\", \"bioMetaInfo\": \"3.46.0:2916352,0\", \"apdidToken\": \"69b74bfe-bf7f-4d3b-ac59-907ee09e7955\", \"deviceModel\": \"MI 6\", \"zimVer\": \"1.0.0\" }"

flowType

String

32

是

-

指定身分識別驗證流的類型。取值如下：

• REALIDLITE_KYC：使用App SDK接入模式。

• H5_REALIDLITE_KYC：使用H5接入模式。

"H5_REALIDLITE_KYC"

docType

String

16

是

-

指定證件類型。例如要上傳的證件是護照，該欄位的值需要設定為00000001003。

RealID支援的證件類型，請參見RealID和ID Recognition支援的證件類型和返回的OCR結果。

"08520000001"

autoDocTypes

List<String>

200

否

null

證件類型列表。docType和autoDocTypes不能同時傳入，需選擇其中一個傳入。

• 如果傳入autoDocTypes，ZOLOZ將自動對上傳的證件進行分類。

  說明：

• 目前護照不支援自動分類。

• 新加坡證件00650000001和00650000002將統一歸類為00650000001。

• 如果ZOLOZ無法對上傳的證件進行分類或分類的證件類型不在autoDocTypes中，則checkresultAPI將返回NO_REQUIRED_ID。

支援的證件類型，請參見RealID和ID Recognition支援的證件類型和返回的OCR結果。

autoDocCategory

List<String>

-

否

null

指定證件類別列表。docType、autoDocTypes和autoDocCategory三個參數互斥，僅支援傳入其中一個。

• 如果傳入autoDocCategory，ZOLOZ將自動對上傳的證件進行分類。支援的證件類別如下：

  • PASSPORT：護照

  • DRIVING_LICENSE：駕照

  • ID_CARD：身份證

  • RESIDENCE_PERMIT：居住證

  • VISA：簽證

  • ALL：所有證件

• 如果ZOLOZ無法對上傳的證件進行分類或分類的證件類型不在autoDocCategory中，則checkresult API將返回NO_REQUIRED_ID。

注意：當傳入autoDocCategory時，ZOLOZ可能會識別出新的證件類型，同時在checkresult API中，certType和docCategory會被歸類為新的證件類別，這是因為ZOLOZ正在不斷擴充其全球範圍內的證件支援範圍，以覆蓋更多類型的證件。

以下樣本僅供參考：

當autoDocCategory設定為ALL時，ZOLOZ會根據使用者上傳的證件進行自動分類，分類完成後，certType可能返回一種新的證件類型，例如00000001001，並歸類為NEW_CATEGORY。

為確保系統平穩適配新的證件類型，建議您採取必要的相容性整合措施，例如避免對返回的certType和docCategory進行強校正。

"ID_CARD"

autoDocPages

Map<String, String>

-

否

null

證件自動分類後，指定要用於證件識別的證件頁面。僅當傳入autoDocTypes時需設定該參數。

• Key：在autoDocTypes中傳入的證件類型。

• Value：指定需要掃描的頁面，具體如下：

  • 1：掃描第一頁。

  • 1,2：掃描第一頁和第二頁。

{

   "00630000032": "1",  

   "00630000004": "1,2"

}

userId

String

64

是

-

商戶的使用者ID或其他可用於識別某一使用者的標識，例如手機號碼、電子郵件地址等。

建議對userId欄位的值進行預脫敏，例如進行雜湊處理。

"123456abcd"

sceneCode

String

64

否

null

情境碼，用來為資料分析指定不同的業務情境。

當需要區分不同業務情境中的資料表現時，建議根據業務用途為sceneCode欄位設定不同的值，例如login、riskVerify、payment、changePassword。

"changePassword"

serviceLevel

String

32

否

REALID0001

防偽檢測和人臉活體檢測的服務等級。該參數基於不同的整合模式，預設了檢測等級、人臉動作、採集幀等配置，如需自訂這些配置，請使用productConfig相關欄位。

serviceLevel支援的取值，詳見serviceLevel配置說明。

"REALID0001"

operationMode

String

32

否

STANDARD

為身分識別驗證配置操作模式。取值如下：

• CLOSED：所有的演算法和風控規則都未開啟。該操作模式可用於測試情境，測試進程不受演算法和風控規則的影響。

• STANDARD：推薦的標準模式。

• LOOSE：相對寬鬆的模式，可用於低風險情境。

• STRICT：相對嚴格的模式，可用於高風險情境。

• STANDARD_VC_CLOSED：使用此模式關閉Velocity功能。

• STANDARD_IDN_CLOSED：使用此模式關閉IDN功能。

• STANDARD_VC_IDN_CLOSED：使用此模式關閉Velocity功能和IDN功能。

說明：當operationMode設定為STANDARD_VC_CLOSED、 STANDARD_IDN_CLOSED或 STANDARD_VC_IDN_CLOSED時，其他演算法能力與 STANDARD相同。

以下是IDN和Velocity的含義：

• IDN：表示通過IDN檢測到虛假驗證風險。例如，檢測到識別出的人臉與多個身份證件相關或檢測到一個身份證件與多張人臉相關。更多詳情，請參見checkresult。

• Velocity：表示通過Velocity檢測到虛假驗證風險。例如，同一使用者（通過userId、證件號或deviceId識別）在一段時間內嘗試攻擊（例如篡改證件資訊或活體攻擊）的次數達到一定閾值時，Velocity功能將不允許該使用者繼續提交，直到冷卻期結束為止。

"STANDARD"

pages

String

32

否

證件類型支援的所有頁

待掃描和上傳的證件頁面，多個頁面以英文逗號分隔。例如：

• 1：表示掃描第一頁。

• 1,2：表示掃描第一頁和第二頁。

有關證件頁面的範圍，請參見RealID和ID Recognition支援的證件類型和返回的OCR結果。

說明：如果不傳該欄位，預設值為對應證件類型支援的所有頁。

"1,2"

pageConfig

PageConfig

-

否

null

指定H5頁面的配置資訊。詳細資料，請參見PageConfig。

{ "urlFaceGuide":"http://xxxxxx.html" }

h5ModeConfig

H5ModeConfig

-

否

null

H5 RealID的配置資訊。詳細資料，請參見H5ModeConfig。

說明：當flowType的值為H5_REALIDLITE_KYC時必須傳入該欄位。

{ "completeCallbackUrl":"http://xxx.html", "interruptCallbackUrl":"http://xxx.html"

}

productConfig

ProductConfig

-

否

null

為RealID產品提供更精細化的控制。詳細資料，請參見ProductConfig。

{

"cropDocImage": "Y", "landmarkCheck": [ {"name":"kadPengenalan"}, {"name":"mykadLogo"}, {"name":"flagLogo"}, {"name":"mscLogo"}, {"name":"ghostFace"}, {"name":"hibiscusLogo"}, {"name":"coatOfArm"}, {"name":"twinTower"} ], "hologramCheck": [ {"name":"hologram"} ], "pageInfoCheck": [ {"name":"id"}, {"name":"symbol"}, {"name":"name"} ], "preciseTamperCheck": "Y" }

serviceLevel

支援的SDK模式

證件採集方式

防偽檢測等級

人臉動作

額外採集的圖片

REALID0001

Native SDK和Web SDK

手動拍攝

基本

眨眼

無

REALID0002

Native SDK

自動拍攝

進階

眨眼

無

Web SDK

手動拍攝

基本

眨眼

HKID可額外採集多角度幀

REALID0003

Native SDK

自動拍攝

進階

從以下列表中隨機播放兩個：眨眼、張嘴、抬頭、低頭、左搖頭、右搖頭。

無

Web SDK

手動拍攝

基本

HKID可額外採集多角度幀

REALID0004

Native SDK

自動拍攝且無需證件對齊採集框

基本

眨眼

無

REALID0009

Native SDK

自動拍攝

進階

眨眼

閉眼幀

REALID0011

Web SDK

手動拍攝

基本

眨眼

• HKID可額外採集多角度幀

• 閉眼幀

REALID0012

Web SDK

自動拍攝

進階

眨眼

無

欄位名稱

資料類型

最大長度

是否必填

預設值

描述

樣本值

urlFaceGuide

String

256

否

null

人臉引導頁URL。該頁面為H5提示頁面，可自訂設定，用於引導使用者進行人臉掃描。 說明：

• PC端內建人臉引導頁，該參數僅適用於移動端。

• 如需在定製頁面中隱藏ZOLOZ提供的標題列，請參見如何隱藏Native SDK的人臉引導網頁標題欄？。

"http://xxxxxx.html"

欄位名稱

資料類型

最大長度

是否必填

預設值

描述

樣本值

state

String

128

否

transactionId欄位的值

用於恢複客戶內容相關的標識符。

您可以為該欄位設定任何值，當ZOLOZ SDK回調商戶的移動App時將該值作為參數進行傳遞。

"G000000005FID20200304000000000001570702"

completeCallbackUrl

String

128

是

-

當整個身分識別驗證完成時，為瀏覽器指定即將重新導向的回調URL。

"http://xxx.html"

interruptCallbackUrl

String

128

是

-

當進程中斷時，為瀏覽器指定重新導向到的回調URL。

"http://xxx.html"

locale

String

16

否

en

網頁語言，目前支援以下語言：

• en（英語）

• zh-CN（簡體中文）

• zh-HK（繁體中文）

• jp（日語）

• th（泰語）

• es（西班牙語）

• pt（葡萄牙語）

• fr（法語）

• id（印尼語）

• de（德語）

• kr（韓語）

• vi（越南語）

"zh-CN"

isIframe

String

1

否

N

是否需要在iframe中開啟網頁，如果需要設定為Y，否則設定為N。

"Y"

uiCfg

String

256

否

null

自訂UI配置，採用JSON字串格式。支援以下欄位：

• titlebarbgcolor

• titlebartextcolor

• buttoncolor

• isDesktop：是否從PC端初始化證件採集模式。

  • Y：從PC端初始化。當isDesktop為Y時，serviceLevel僅支援REALID0001，docUiType僅支援1，否則系統將返回INVALID_ARGUMENT。

  • N：從移動端初始化，使用移動Web SDK掃描流程。預設值為N。

"{\"titlebarbgcolor\":\"#ffffff\",\"titlebartextcolor\":\"#000000\",\"buttoncolor\":\"#3696fd\"}"

enableUpload

String

1

否

N

是否允許從案頭上傳檔案擷取證件圖片。取值：

• Y：允許從案頭上傳檔案擷取證件圖片。

• N：不允許從案頭上傳檔案擷取證件圖片。

注意：

• enableUpload必須與isDesktop一起使用。

• 如果enableUpload為Y，則isdesktop也必須為Y，否則系統將返回INVALID_ARGUMENT。

"Y"

allowDegradation

String

1

否

N

是否允許進入降級模式。取值如下：

• Y：允許進入降級模式。

• N：不允許進入降級模式。

說明：

• 如果將allowDegradation設定為Y，當ZOLOZ檢測到使用者的瀏覽器不支援Web SDK時，使用者可以選擇是否進入降級模式，確認進入降級模式後，ZOLOZ將調用系統原生相機進行拍攝。

• 降級模式可能存在較高風險，對於來自降級模式下的交易，ZOLOZ判定出的最高eKYC結果為Pending，需要您進行二次檢查。

"Y"

docFrontPageGuideUrl

String

128

否

null

指定降級模式下證件引導頁首頁的URL。這是一個可定製的H5提示頁面，用於引導使用者採集證件的第一頁圖片。

說明：如果不傳該參數，則使用預設頁面。

"http://xxx.html"

docBackPageGuideUrl

String

128

否

null

指定降級模式下證件引導頁第二頁的URL。這是一個可定製的H5提示頁面，用於引導使用者採集證件的第二頁圖片。 說明：如果不傳該參數，則使用預設頁面。

"http://xxx.html"

facePageGuideUrl

String

128

否

null

指定降級模式下人臉引導頁面的URL。這是一個可定製的H5提示頁面，用於引導使用者採集自拍人臉圖片。

說明：如果不傳該參數，則使用預設頁面。

"http://xxx.html"

欄位名稱

資料類型

最大長度

是否必填

預設值

描述

特別說明

樣本值

cropDocImage

String

1

否

N

是否額外返回一張裁剪掉證件背景的證件圖片。取值如下：

• Y：是，如果同時採集了證件的正面和背面圖片，則會額外返回兩張裁剪後的圖片。

• N：否

-

"Y"

cropFaceImage

String

1

否

N

是否額外返回一張裁剪出臉部地區的人臉圖片。取值如下：

• Y：是

• N：否

-

"Y"

landmarkCheck

Array

-

否

null

在證件防偽檢測中進行landmark檢查，詳細檢查項，請參見證件防偽檢測組件。

說明：landmark檢查僅適用於大馬卡（MyKad）。

-

[{"name":"kadPengenalan"}, {"name":"mykadLogo"}, {"name":"flagLogo"}, {"name":"mscLogo"}, {"name":"ghostFace"}, {"name":"hibiscusLogo"}, {"name":"coatOfArm"}, {"name":"twinTower"}]

hologramCheck

Array

-

否

null

在證件防偽檢測中進行全息圖檢查，詳細檢查項，請參見證件防偽檢測組件。

說明：全息圖檢查僅適用於大馬卡（MyKad）。

-

[{"name":"hologram"}]

pageInfoCheck

Array

-

否

null

在證件防偽檢測中進行頁面資訊檢查，詳細檢查項，請參見證件防偽檢測組件。

說明：頁面資訊檢查僅適用於中國香港身份證。

-

[

{"name":"id"}, {"name":"symbol"}, {"name":"name"} ]

preciseTamperCheck

String

1

否

N

該參數已廢棄，後續不再維護，為了保證API相容性，該參數會繼續保留。

是否進行精細篡改檢測。精細篡改檢測僅適用於中國香港身份證。

• Y：進行精細篡改檢測

• N：不進行精細篡改檢測

-

"Y"

docUiType

String

20

否

• Native SDK：2

• Web SDK：1

證件照片的採集方式。取值如下：

• 1：手拍版（Self-capture），使用者需要手動拍攝證件照片，僅具備基礎防偽能力。

• 2：Native防偽版（Deep-scan），僅適用於Native SDK。ZOLOZ SDK將自動對齊並拍攝證件照片，具備攔截彩打等進階防偽能力。

• 3：H5掃描版（Auto-scan），僅適用於Web SDK。ZOLOZ SDK將自動對齊並拍攝證件照片，僅具備基礎防偽能力。

• 4：甩證版（Trace-scan），僅適用於Native SDK。當ZOLOZ SDK在網路攝影機範圍內檢測到證件時將自動拍攝。該版式可用於提升使用者體驗，但防偽能力較弱，僅具備基礎防偽能力。

• 5：多角度版（Multi-angle），僅適用於Web SDK中的中國香港證件。使用者需要分別拍攝正對證件的照片和證件傾斜30°的照片，具備攔截彩打等進階防偽能力。

說明：Deeper功能依賴Deep-scan和Auto-scan這兩種採集方式。當開啟Deeper功能時，為確保最佳檢測效果，請根據您的實際應用情境選擇對應的採集方式，Native端使用Deep-scan，H5端使用Auto-scan，否則會影響檢測效果。

以下10個參數的優先順序高於serviceLevel和operationMode，如果傳入了10個參數中的任何一個，其他幾個參數的預設值都會生效。此時即使傳入了servicelevel和operationmode的值，servicelevel和operationmode也不生效。

• docUiType

• spoofMode

• livenessMode

• antiInjectionMode

• deeperMode

• actionCheckItems

• actionRandom

• actionFrame

• riskMode

• idnThreshold

"2"

spoofMode

String

10

否

STANDARD

證件防偽等級。取值如下：

• CLOSED：所有的防偽演算法都未開啟。該等級可用於測試情境，測試進程不受演算法和風控規則的影響。

• STANDARD：推薦的標準等級。

• LOOSE：預留等級，暫不支援使用。

• STRICT：預留等級，暫不支援使用。

"STANDARD"

livenessMode

String

10

否

STANDARD

人臉活體檢測等級。取值如下：

• CLOSED：所有的演算法和風控規則都未開啟。該等級可用於測試情境，測試進程不受演算法和風控規則的影響。

• STANDARD：推薦的標準等級。

• LOOSE：相對寬鬆的等級，可用於低風險情境。

• STRICT：相對嚴格的等級，可用於高風險情境。

"STANDARD"

antiInjectionMode

String

10

否

CLOSED

該參數已廢棄，後續不再維護，為了保證API相容性，該參數會繼續保留。

防注入檢測等級。防注入檢測能夠有效抵禦使用換臉圖片或視頻進行的注入攻擊。取值如下：

• CLOSED：所有的防注入演算法都不開啟。如果業務情境不需要注入攻擊檢測，則不需要開啟。

• STANDARD：推薦的標準等級。

• LOOSE：預留等級，暫不支援使用。

• STRICT：預留等級，暫不支援使用。

注意：開啟防注入檢測會略微增加誤判率和已耗用時間，開啟前請先聯絡ZOLOZ支援人員。

"CLOSED"

deeperMode

String

10

否

CLOSED

AIGC攻擊檢測的Deeper等級，Deeper檢測功能的詳細介紹，請參見什麼是Deeper。該參數支援以下取值：

• CLOSED：Deeper的所有能力均不開啟，例如AIGC檢測演算法、終端風險檢測等。如果業務情境不需要AIGC攻擊檢測，則無需開啟。

• STANDARD：推薦的標準等級。

• LOOSE：相對寬鬆的等級，可用於低風險情境。

• STRICT：相對嚴格的等級，可用於高風險情境。

注意：需要先購買Deeper產品，才能使用該功能。

"CLOSED"

actionCheckItems

List<String>

-

否

FACEBLINK

用戶端和Web端的動作檢測列表。取值如下：

• FACEBLINK：眨眼

• MOUTHOPEN：張嘴

• HEADSHAKE：搖頭

• HEADLOWER：低頭

• HEADRAISE：抬頭

說明：為了更好的使用者體驗，不建議使用兩種及以上的動作。

["FACEBLINK","HEADLOWER"]

actionRandom

String

1

否

N

用戶端和Web端的動作檢測順序是否隨機。取值如下：

• Y：隨機。

• N：不隨機，則按照actionCheckItems中的順序進行檢測。

"Y"

actionFrame

List<String>

-

否

null

採集其他幀圖片。取值如下：

• EYECLOSE：設定此值可返回在眨眼檢測過程中採集的閉眼幀。

["EYECLOSE"]

riskMode

String

10

否

STANDARD

RealID中的多維度風控規則校正，用於攔截可疑交易。取值如下：

• CLOSED：關閉風控冷卻規則。該等級適用於測試情境，測試進程不受風控規則的影響。

• STANDARD：推薦的標準等級。

• LOOSE：相對寬鬆的等級，可用於低風險情境。

• STRICT：相對嚴格的等級，可用於高風險情境。

"STANDARD"

idnThreshold

Integer

-

否

3

該參數已廢棄，後續不再維護，為了保證API相容性，該參數會繼續保留。

指定閾值，用於攔截同一商戶同臉不同證或同證不同臉的交易，當不同userId之間的關聯交易筆數超過指定的閾值時將被攔截。 支援傳入大於等於1的任何整數，預設閾值為3。

"3"

allowExpiredDocument

String

-

否

不同的證件類型有不同的預設值：

• Y：除護照（docType=00000001003）外的所有證件

• N：護照（docType=00000001003）

已到期的證件是否可以通過驗證。取值如下：

• Y：已到期的證件可以通過驗證。

• N：已到期的證件不能通過驗證。當檢測到證件到期時，RealID流程會失敗。

說明：

• 如果傳入除Y和N之外的值，系統將返回INVALID_ARGUMENT。

• 對於中國香港一代身份證（docType=08520000001），其到期攔截邏輯將嚴格依據香港政府身份證換領計劃執行。

-

"N"

faceAttributeCheck

FaceAttributeCheck

-

否

null

人臉屬性檢測，詳情請參見FaceAttributeCheck。

說明：faceAttributeCheck的優先順序高於livenessMode。例如，當occlusionCheck.detectOpen為N時，即使livenessMode為STRICT，也不會進行人臉遮擋檢測。

-

{

     "occlusionCheck": {

       "details": [

         "eyesOcclusion",

         "noseOcclusion",

         "mouthOcclusion",

         "foreheadOcclusion",

         "chinOcclusion",

         "cheekOcclusion"

       ],

       "detectOpen": "Y",

       "needRetry": "Y"

     },

     "maskCheck": {

       "detectOpen": "Y",

       "needRetry": "N"

     },

     "glassesCheck": {

       "detectOpen": "Y",

       "needRetry": "N"

     },

     "hatCheck": {

       "detectOpen": "Y",

       "needRetry": "N"

     }

   }

consistencyCheck

List<ConsistencyCheckItem>

-

否

null

是否在證件防偽檢測中進行一致性檢查。一致性檢查僅適用於部分證件的特定欄位，詳見ConsistencyCheckItem。

-

參考請求樣本

checkAdvancedIdn

String

-

否

N

是否開啟IDN風險檢查。取值：

• Y：開啟。

• N：不開啟。

說明：需要先購買IDN，才能開啟該功能。

-

"Y"

advancedIdnRiskDetection

RiskDetection

-

否

RiskDetection

風險檢測，詳情請參見RiskDetection。

說明：僅當checkAdvancedIdn為Y時，該參數才生效。

-

{

   "riskTypes":[

     "IDFAKE",

     "DUPLICATE",

     "BATCH_REGISTER"

   ],

   "timeWindow":{

      "startTime":1651882535687,

      "endTime":1658902665000

   }

 }

advancedIdnThreshold

String

-

否

3

指定IDN風險檢查的閾值，取值範圍為1-100，當歷史有關聯的風險交易筆數超過指定閾值時將被攔截。相同的itemId只會計數一次。

說明：僅當checkAdvancedIdn為Y時，該參數才生效。

-

"3"

checkBlacklist

String

1

否

N

是否開啟黑名單風險檢查。取值：

• Y：開啟。

• N：不開啟。

說明：需要先購買黑名單能力，才能開啟該功能。

欄位名稱

資料類型

最大長度

是否必填

預設值

描述

樣本值

occlusionCheck

FaceAttributeDetails

-

否

null

是否進行人臉遮擋檢測，詳情請參見FaceAttributeDetails。

{

"details": [

"eyesOcclusion",

"noseOcclusion",

"mouthOcclusion",

"foreheadOcclusion",

"chinOcclusion",

"cheekOcclusion"

],

"detectOpen": "Y",

"needRetry": "Y"

}

maskCheck

FaceAttributeDetails

-

否

null

是否進行口罩檢測，詳情請參見FaceAttributeDetails。

{

"detectOpen": "Y",

"needRetry": "N"

}

glassesCheck

FaceAttributeDetails

-

否

null

是否進行眼鏡檢測，詳情請參見FaceAttributeDetails。

{

"detectOpen": "Y",

"needRetry": "N"

}

hatCheck

FaceAttributeDetails

-

否

null

是否進行帽子檢測，詳情請參見FaceAttributeDetails。

{

"detectOpen": "Y",

"needRetry": "N"

}

欄位名稱

資料類型

最大長度

是否必填

預設值

描述

樣本值

detectOpen

String

1

是

null

是否檢測人臉屬性並在checkresult API中返回檢測結果。取值如下：

• Y：是

• N：否

"Y"

needRetry

String

1

是

null

檢測到指定屬性時是否重試。取值如下：

• Y：是。當needRetry為Y時，detectOpen必須為Y。

• N：否。當needRetry為N時，eKYC仍可能會因為人臉品質較低而提示重試。

"Y"

details

List<String>

-

否

null

是否返回人臉屬性的結果詳情。目前僅支援返回occlusionCheck的結果詳情，支援的選項如下：

• eyesOcclusion：返回眼睛遮擋結果。

• noseOcclusion：返回鼻子遮擋結果。

• mouthOcclusion：返回嘴巴遮擋結果。

• foreheadOcclusion：返回額頭遮擋結果。

• chinOcclusion：返回下巴遮擋結果。

• cheekOcclusion：返回臉頰遮擋結果。

說明：

• 當傳入details參數時，detectOpen必須為Y。

• details對應的總結果和特定屬性結果將在checkresultAPI中返回。

[

"eyesOcclusion",

"noseOcclusion",

"mouthOcclusion",

"foreheadOcclusion",

"chinOcclusion",

"cheekOcclusion"

]

欄位名稱

資料類型

取值範圍

描述

支援的證件 / 國家或地區 / 證件類型

OCR一致性檢查支援欄位

type

String

commonConsistencyCheck

對證件防偽檢測中的OCR欄位進行一致性檢查。

大馬卡 / 馬來西亞 / 00600000001

• 證件正面：ID_NUMBER

• 證件背面：ID_NUMBER_BACK前12位元字

欄位名稱

資料類型

取值範圍

描述

支援的證件 / 國家或地區 / 證件類型

OCR一致性檢查支援欄位

type

String

mrzVisualConsistencyCheck

對證件防偽檢測中機讀區和視讀區的OCR欄位進行一致性檢查。

-

-

details

List<String>

請參見RealID和ID Recognition支援的證件類型和返回的OCR結果。

在 details 中指定OCR欄位進行一致性檢查。

• 當 type 設定為 mrzVisualConsistencyCheck 時，必須傳入 details 欄位。

• 僅允許傳入證件類型所支援的OCR欄位。

MyVisa / 馬來西亞 / 00600000011

• NAME

• SEX

護照（含機讀區和視讀區）/ 中國大陸、中國香港、中國台灣、中國澳門、菲律賓、新加坡、馬來西亞 / 00000001006

• ID_NUMBER

• COUNTRY_CODE

• EXPIRY_DATE

• DATE_OF_BIRTH

欄位名稱

資料類型

取值範圍

描述

支援的證件 / 國家或地區 / 證件類型 / OCR一致性檢查支援欄位 / 預設國家代碼

type

String

passportCountryCheck

檢查OCR結果中的COUNTRY_CODE與系統檢測到的國家是否一致。

-

valueRange

List<String>

應與預設國家代碼一致

OCR結果中的COUNTRY_CODE應在valueRange範圍內。

當type設定為passportCountryCheck時，必須傳入valueRange欄位，各證件支援的valueRange，詳見RealID和ID Recognition支援的證件類型和返回的OCR結果。

以下證件的valueRange為證件所屬國家或地區對應的預設國家或地區代碼所組成的列表。

• 中國大陸護照 / 00860000888 / COUNTRY_CODE / CHN

• 中國台灣護照 / 08860000002 / COUNTRY_CODE / TWN

• 中國澳門護照 / 08530000002 / COUNTRY_CODE / CHN

• 菲律賓舊版護照 / 00630000031 / COUNTRY_CODE / PHL

• 菲律賓新版護照 / 00630000032 / COUNTRY_CODE / PHL

每一項都應符合ISO_3166-1_alpha-3標準

以下證件的valueRange為列表，且每一項都應符合ISO_3166-1_alpha-3標準。

• 國際護照（僅含機讀區） / 00000001003 / COUNTRY_CODE

• 國際護照（含機讀區和視讀區）/ 00000001006 / COUNTRY_CODE

欄位名稱

資料類型

最大長度

是否必填

預設值

描述

樣本值

riskTypes

List<String>

-

否

["IDFAKE","DUPLICATE"]

待查詢的風險類型。支援以下四大類風險，系統會自動查詢其包含的子風險，詳情參考IdNetwork風險介紹。

• IDFAKE：身份冒用。

• DUPLICATE：重複認證。

• BATCH_REGISTER：大量註冊。

• DEEPFAKE：人臉偽造。

[

     "IDFAKE",

     "DUPLICATE",

     "BATCH_REGISTER",

     "DEEPFAKE"

   ]

timeWindow

TimeWindow

-

否

TimeWindow

風險查詢時間視窗，最長可查詢180天的資料，預設查詢最近30天的資料，詳情請參見TimeWindow。

注意：系統單次掃描的資料量限制為50萬條記錄。如果在查詢時間視窗範圍內資料量超過50萬條記錄，系統會動態調整您所設定的時間視窗。

{ "startTime":1651882535687, "endTime":1658902665000 }

欄位名稱

資料類型

最大長度

是否必填

預設值

描述

樣本值

startTime

Long

-

否

目前時間

風險查詢起始時間，採用13位時間戳記。

1651882535687

endTime

Long

-

否

30天前的時間

風險查詢結束時間，採用13位時間戳記。

1658902665000

欄位名稱

資料類型

必須返回

描述

樣本值

result

Result

是

API請求結果，包含結果狀態、結果碼和結果訊息。

{

"resultStatus": "S", "resultCode": "SUCCESS", "resultMessage": "Success"

}

transactionId

String

否

ZOLOZ伺服器為身分識別驗證產生的唯一事務ID。此ID將作為RealID checkresult API請求的輸入參數。

說明：僅當交易進入處理階段後系統才會返回transactionId。如果在開始處理交易之前發生錯誤，系統不會返回transactionId。包括但不限於以下情況：

• 請求參數非法，例如入參格式錯誤或缺失必傳參數。

• 請求未能成功到達伺服器，例如網路問題或網關故障。

• 系統限流導致請求被拒絕。

"G000000005FID20200304000000000001570702"

clientCfg

String

否

用戶端配置資訊，包括SDK串連和行為參數。

說明：當result.resultStatus的值為S時，才返回該欄位。

"……"

結果碼

結果狀態

描述

SUCCESS

S

API調用成功。

HIGH_RISK

F

檢測到高風險。使用者帳號被風險引擎凍結。

ACCOUNT_SERVICE_SUSPEND

F

使用者帳號被風險引擎列入黑名單。

DEVICE_NOT_SUPPORT

F

不支援當前的裝置類型。

OS_NOT_SUPPORT

F

不支援當前裝置的作業系統。

SDKVERSION_NOT_SUPPORT

F

不支援ZOLOZ SDK當前的版本。

INVALID_ARGUMENT

F

輸入參數無效。關於無效參數的詳細資料，請查看返回的resultMessage。

SYSTEM_ERROR

F

其他內部錯誤。有關錯誤詳情，請查看返回的resultMessage。