附录
适用于各项 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 |