跳至主要內容
ShieldID

開發人員

身分驗證 API 文件，為實際使用而設計。

一個 REST API、一個替您省去自行開發的託管頁面，以及簽章 webhook,讓您在結果產生的當下立即得知。Sandbox 金鑰一律不計費，所以了解 ShieldID 最快的方式就是直接呼叫它。

在 sandbox 免費開始閱讀快速入門

五分鐘速覽

四次呼叫。一個核心概念。

這些文件中的其他內容，都是建立在這個循環之上的細節。

  1. 建立 session

    呼叫 POST /v1/sessions 並帶入 return URL 與 webhook URL。您會取得 session_id 與 verification_url。

  2. 交給申請人

    將 verification_url 以連結傳送給申請人，或讓他們掃描託管頁面在桌面版顯示的 QR code。他們會在自己的手機上完成流程。

  3. 接收已簽章的 webhook

    當工作階段達到 VERIFIED 或 FAILED 時，ShieldID 會將結果 POST 到您的 webhook URL,並附上簽章，讓您確信它來自我們。

  4. 讀取結果

    您可以信任 webhook,或自行呼叫 GET /v1/sessions/{id}/result。無論哪種方式，您取得的都是逐項檢查的判定結果，而不是單一個不透明的分數。

立即試用

建立您的第一個 session。

以三種語言呈現相同的請求。這就是概念模型第一步所描述的呼叫。

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_ 金鑰後，除了帳單之外，其他一切都不會改變。

找到入門方式

其餘的開發人員文件。

共六頁，挑您需要的來讀。

SDKs

網頁小工具、託管流程，以及未來規劃。
開啟 SDKs

Sandbox

測試模式如何運作，以及如何取得金鑰。
開啟 Sandbox

Sandbox

在簽約之前，先完整測試整個流程。

sandbox 金鑰（前綴為 vk_sand_）執行的 API、託管頁面與 webhook 流程，都與正式環境完全相同。工作階段在所有出現的地方都會標記 environment: "sandbox"，而且無論哪一種方案，sandbox 工作階段一律不計費。

閱讀 sandbox 指南
  • 建立真實的工作階段，用您自己的手機驗證真實證件，並收到真實的已簽章 webhook 回傳
  • 您在 sandbox 中的任何操作都不會影響帳單
  • 只要更換金鑰前綴即可切換到正式環境；請求格式完全不變

公開透明地打造

哪些已經完成，哪些還沒有。

與其讓您在整合到一半時才發現，我們寧可主動告訴您。

網頁 widget 完成回呼

即將推出

onComplete、onCancel 與 onStep 目前已存在於 widget 的介面中，但尚未有任何機制會觸發它們。請改用返回 URL 與 webhook，這兩者現在都能正常運作。

強制執行的速率限制

即將推出

每把 API 金鑰都有依您的方案記錄的速率限制，但目前尚未對請求強制執行，請自行妥善規劃，不要依賴 ShieldID 為您限流。

自助註冊 sandbox

即將推出

在自助註冊功能開發完成前，sandbox 金鑰需依申請核發。只要告訴我們，我們會盡快為您處理。

常見問題

為開發者提供直截了當的解答。

開始使用

一個下午就能上線。

從 sandbox 金鑰開始，用您自己的手機執行一次驗證，並查看它傳送給您的 webhook。無需預約業務通話。

在 sandbox 免費開始閱讀快速入門

sandbox 工作階段一律不計費。