附錄
適用於各項 API 的參考表。
術語表
| 術語 | 描述 |
|---|---|
| apiKey | 標識租戶的公開憑證。包含在每個 API 請求 URL 中。 |
| apiSecret | 用於 HMAC-SHA256 簽名的私有密鑰。切勿公開暴露。 |
| executionId |
唯一的工作流執行實例標識符。由
workflow.apply.submit 生成。
|
| callbackKey | 標識等待輸入的特定節點。每個節點有唯一的 callbackKey。 |
| requestId | 每次 API 調用的追蹤 ID，用於支持和調試。 |
| referenceId | 您自定義的追蹤 ID，透傳用於審計追蹤和關聯。 |
| domainId |
租戶內的業務單元標識符（通過
x-domain 請求頭傳遞）。
|
| nodeType | 等待輸入的工作流節點類型。決定應調用哪個提交 API。 |
| crpPid | KYB 工作流中的關聯方標識符。將活體檢測、證件、表單關聯到指定 CRP。 |
| JSON 字符串字段 |
personData、scores、images、formData
等字段接受 JSON 編碼的字符串，而非嵌套對象。
|
執行狀態
待工程確認：KYC 與附錄表使用
CANCELLED，工作流生命週期參考使用 CANCELED。下表保留附錄拼法，不代表已確認 API 的準確枚舉值。實現取消狀態判斷前，請向 WIDTH 工程團隊確認實際返回值。
下表是執行層狀態。服務端對接時，Case
層的審核結論維度（caseStatus）見
工作流生命週期 API → 查詢狀態與審核結論。
| 狀態 | 終態？ | 描述 |
|---|---|---|
CREATED |
否 | 已創建，尚未開始 |
RUNNING |
否 | 正在執行 |
WAITING |
否 | 等待外部輸入 |
COMPLETED |
是 | 成功完成 |
FAILED |
是 | 執行失敗 |
TIMEOUT |
是 | 執行超時 |
CANCELLED |
是 | 執行已取消 |
事件類型
待工程確認：指南在本表與持續監控章節列出
PERIODIC_FLOW_EVENT，但工作流提交事件列表未列出該值。本行保留監控事件的原始記錄；workflow.apply.submit 是否接受該值仍待確認。| eventType | 模式 | 描述 |
|---|---|---|
KYC_EVENT |
異步 | 個人客戶入駐。平台界面上顯示為 KYC。 |
KYB_EVENT |
異步 | 企業客戶入駐。平台界面上顯示為 KYB。 |
TRANSACTION_EVENT |
同步 / 異步 | 交易篩查 |
WEB3_TRANSACTION_EVENT |
同步 / 異步 | Web3 鏈上交易篩查（KYT） |
PERIODIC_FLOW_EVENT |
異步 | 持續監控 |
MANUAL_CASE_EVENT |
異步 | 名單篩查——把待篩查主體提交到工作流，產生告警並生成案件供人工復核。平台界面上顯示為 人工。 |
證件類型
| 代碼 | 描述 |
|---|---|
NATIONAL_ID |
國民身份證 |
INTERNATIONAL_PASSPORT |
國際護照 |
DRIVING_LICENCE |
駕駛執照 |
RESIDENCE_PERMIT |
居留許可 |
UTILITY_TELEPHONE_BILL |
水電/電話賬單 |
BANK_STATEMENT |
銀行對賬單 |
CUSTOMER_ACCEPTANCE_FORM |
客戶受理表 |
SELF_IMAGE |
自拍照 |
更新日誌
| 版本 | 日期 | 變更內容 |
|---|---|---|
| 1.2 | 2026-09-11 |
移動 SDK 版本對齊正式發佈版：iOS 1.0.11 / Android 1.0.11 /
Flutter 1.0.2。憑據精簡為 domain +
sdkToken 兩項（appId /
apiKey 已編碼在 token 內）。iOS 新增必填的
NSSpeechRecognitionUsageDescription。Android 要求
minSdk 26、compileSdk 36、開啓 core
library desugaring，AGP 9 上還需
android.uniquePackageNames=false。三端均新增可選的
language 參數，Android 與 Flutter 另新增可選的
eventType 參數。
|
| 1.1.1 | 2026-06-14 |
修正 Android「權限」節：內置的 OCR
引擎（Veriff、Regula）會傳遞合併
RECORD_AUDIO、NFC、WAKE_LOCK、VIBRATE、FLASHLIGHT。運行時（危險級）權限現為
CAMERA 與
RECORD_AUDIO；每一項權限都須反映到 Google Play Data
Safety（數據安全）申報。
|
| 1.1 | 2026-06-14 |
新增 Flutter SDK 章。iOS 公共類型名 Width* →
WIDTH*（1.0.5），麥克風（NSMicrophoneUsageDescription）改為必填。SDK
版本對齊：iOS 1.0.5 / Android 1.0.2 / Flutter 1.0.1。
|
| 1.0 | 2026-04-17 | 首次發佈 — OpenAPI 參考、Android SDK、iOS SDK |