跳到主要内容
ShieldID

开发者

身份验证 API 文档，为实际使用而打造。

一个 REST API,一个替您省去开发工作的托管页面，以及带签名的 webhook,让您在结果产生的第一时间获知。Sandbox 密钥永不计费，因此了解 ShieldID 最快的方式就是直接调用它。

在 sandbox 中免费开始阅读快速入门

五分钟速览

四次调用，一个思维模型。

这些文档中的其他内容，都是在这个循环之上的细节。

  1. 创建会话

    使用返回 URL 和 webhook URL 调用 POST /v1/sessions。您会得到一个 session_id 和一个 verification_url。

  2. 交给申请人

    将 verification_url 以链接形式发送，或让对方扫描托管页面在桌面端显示的二维码。他们会在自己的手机上完成验证。

  3. 接收带签名的 webhook

    当会话达到 VERIFIED 或 FAILED 时，ShieldID 会将结果 POST 到您的 webhook URL,并附带签名，方便您确认其来自我们。

  4. 查看结果

    您可以直接信任 webhook,也可以自行调用 GET /v1/sessions/{id}/result。无论哪种方式，您得到的都是逐项检查的结论，而不是一个不透明的分数。

试一试

创建您的第一个会话。

同一个请求的三种语言版本。这就是思维模型第一步所描述的调用。

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Sandbox 密钥(vk_sand_…)可免费运行这套完全相同的流程。换成 vk_live_ 密钥后，除了账单之外，其他一切都不会改变。

找到入口

其余开发者文档。

共六页，按需阅读。

快速入门

从 sandbox 密钥到第一个带签名的 webhook,按步骤进行。
打开 快速入门

SDKs

网页小组件、托管流程，以及即将推出的内容。
打开 SDKs

Sandbox

测试模式如何运作，以及如何获取密钥。
打开 Sandbox

状态

状态信息上线后，我们将报告的内容。
打开 状态

Sandbox

在签约之前，先完整测试整个流程。

沙盒密钥（前缀 vk_sand_）所运行的 API、托管页面和 webhook 流程与生产环境完全一致。会话在所有出现的地方都会标记为 environment: "sandbox"，并且无论哪种套餐，沙盒会话均不计费。

阅读沙盒指南
  • 创建真实会话，用您自己的手机验证真实证件，收到真实的已签名 webhook
  • 您在沙盒中的任何操作都不会产生账单
  • 只需替换密钥前缀即可切换到生产环境；请求结构保持不变

公开透明地构建

哪些已经完成，哪些还没有。

我们宁愿现在就告诉您，也不愿让您在集成过程中才发现。

Web 小组件完成回调

即将推出

onComplete、onCancel 和 onStep 目前已存在于小组件的接口中，但还没有任何逻辑会触发它们。请使用返回 URL 和 webhook——这两者现在都可以正常使用。

强制执行的速率限制

即将推出

每个 API 密钥都按您的套餐记录了速率限制，但目前尚未对请求强制执行——请自行做好规划，不要依赖 ShieldID 为您限流。

自助注册沙盒

即将推出

自助注册功能开发期间，沙盒密钥按申请发放。提出申请后，我们会尽快为您办理。

常见问题

为开发者提供的直接解答。

开始使用

一个下午即可上线。

从沙盒密钥开始，用您自己的手机完成一次验证，并查看它发给您的 webhook。无需销售电话。

在 sandbox 中免费开始阅读快速入门

Sandbox 会话从不计费。