WIDTH Identity 开发者文档
WIDTH Identity 提供完整的身份核验与合规平台,覆盖 KYC、KYB、交易筛查与持续监控全流程 — 通过 REST API 与适配 Web、iOS、Android 的 SDK 接入。
核心能力
平台提供四类核心合规工作流。每类均可通过 REST API 调用,大部分同时支持 SDK 接入。
KYC
身份核验:活体检测、证件 OCR、NFC 芯片读取、制裁与 PEP 筛查。
KYB
企业核验:注册处拉取、25% 阈值 UBO 图谱、董事 KYC、实体筛查。
交易筛查
逐笔交易实时评分,100ms 内返回决策。支持同步与异步。
持续监控
事件驱动的再筛查:制裁、地址、行为变化即时触发。实时风险评级。
集成方式
提供三种集成方式。需要完整后端控制时使用 OpenAPI;希望快速获得托管核验体验时使用 SDK。
| 方式 | 最适合 | 支持工作流 |
|---|---|---|
| OpenAPI(REST,服务器到服务器) | 已自行采集客户数据,需要完整后端控制 UX。 | KYC、KYB、交易筛查、持续监控 |
| 移动 SDK(Android、iOS) | 移动应用中开箱即用的核验体验,代码最少。 | KYC、KYB |
| Web SDK | Web 应用中即插即用的模态框或新页签核验。 | KYC、KYB、单次活体检测 |
环境
提供两套环境:用于开发的 staging(测试环境)与承载真实流量的 production(生产环境)。所有 staging URL 以 -stg 结尾。
| 资源 | 测试环境 | 生产环境 |
|---|---|---|
| API Gateway | https://one-gateway-api-stg.width.com/gateway | https://one-gateway-api.width.com/gateway |
| Storage Service | https://one-gateway-api-stg.width.com/storage | https://one-gateway-api.width.com/storage |
| Platform Console | https://one-platform-stg.width.com | https://one-platform.width.com |
凭证
根据集成方式不同,提供两类凭证。
| 类型 | 使用场景 | 字段 |
|---|---|---|
OPENAPI | 服务器到服务器 API | apiKey (prefixed ak_) + apiSecret (prefixed sk_) |
SDK | Web/移动 SDK | appId + apiKey + per-session sdkToken |
如何获取
- 登录 One Platform Console → API & Integration。
- 点击 Generate 生成密钥对。
- 复制并安全保存凭证。
apiSecret仅显示一次。
apiSecret 硬编码到源代码中。请使用环境变量或密钥管理服务。如果密钥泄露,请立即在控制台旋转。快速开始 — 请求签名
每个 OpenAPI 请求都使用 HMAC-SHA256 对请求体进行签名,签名通过 sign 查询参数附加传递。
sign = HmacSHA256(apiSecret, requestBody)
密钥与请求体均使用 UTF-8 编码,签名结果为 64 位小写十六进制字符串。
import hmac, hashlib
sign = hmac.new(
api_secret.encode('utf-8'),
request_body.encode('utf-8'),
hashlib.sha256
).hexdigest()
const crypto = require('crypto');
const sign = crypto
.createHmac('sha256', apiSecret)
.update(requestBody, 'utf8')
.digest('hex');
Mac mac = Mac.getInstance("HmacSHA256");
mac.init(new SecretKeySpec(apiSecret.getBytes("UTF-8"), "HmacSHA256"));
byte[] hash = mac.doFinal(requestBody.getBytes("UTF-8"));
String sign = HexFormat.of().formatHex(hash);
请参阅 身份验证参考 获取完整请求信封,包括请求头、查询参数与示例。
下一步:选择一个工作流
OpenAPI 参考
认证、错误、幂等性、配置、文件上传 — 所有 REST 原语集中说明。
Web SDK
Web 应用中的模态框或新页签核验。npm install @width/web-sdk。
Android SDK
适配 Activity / Compose 的 Kotlin 插件。API 24+(Android 7.0)。
iOS SDK
适配 UIKit 与 SwiftUI 的 Swift Package。iOS 16.0+、Xcode 16+。
KYC 指南
完整 KYC 工作流:注册、启动、轮询、节点提交(OCR、特征、活体、OTP、表单)。
附录
术语表、执行状态、事件类型、证件类型、变更日志。