メインコンテンツへスキップ
ShieldID

SDKs

本人確認用 SDK と、SDK 不要の方法。

ほとんどの連携では SDK はまったく必要ありません。ホスト型ページがすべて処理します。フローをご自身のページ内に収めたい場合には、Web ウィジェットをご利用いただけます。ネイティブモバイル SDK は次の対応予定です。

クイックスタートを読むAPIリファレンス

SDK 不要の方法

ホスト型ページは、どのプラットフォームでも SDK 不要です。

POST /v1/sessions は verification_url を返します。メール、SMS、アプリ内リダイレクト、画面上の QR コードなど、お使いの製品が普段リンクを送る方法で申請者に送ってください。撮影、ライブネスチャレンジ、セルフィーは、ShieldID が申請者のスマートフォン上で処理します。

  • Web アプリ、ネイティブアプリのシステムブラウザーや WebView、メールのリンク、キオスクの QR コードのいずれからでも動作します。インストールは不要です
  • 対象プランではホワイトラベルのブランディングに対応しており、外部の第三者に引き渡されているようには見えません
  • 結果は return_url へのリダイレクトと署名付き webhook で届くため、クライアント側のコールバックの実装は不要です
ホスト型ページのエンドポイントを見る

Web ウィジェット

フローをご自身のページに埋め込みます。

申請者をページから移動させる代わりに、ホスト型の認証フローをご自身のページ内の iframe に表示する小さなスクリプトです。

現在利用できる機能

  • TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) はセッションを作成し、指定した要素にそれを表示します
  • ホスト型ページと同一の撮影フローを、ご自身のレイアウト内で、accentColor とロゴを適用して実行します
  • セッションの作成と、フローのインライン表示については、現在ご利用いただけます

完了コールバック

近日公開

onComplete、onCancel、onStep、およびiframeの自動リサイズはウィジェットのインターフェースに含まれていますが、現時点ではフロー内のどの処理からも呼び出されません。これらが発火することを前提としたロジックは構築しないでください。代わりに、現在どちらも動作するリターンURLとwebhookをご利用ください。

ブラウザでのAPIキーに関する注意

ウィジェット自体のinit()呼び出しは、クライアント側のJavaScriptで生のapiKeyを受け取るものとして文書化されています。ただし、本番環境ではおすすめしません。ソースを表示すれば誰でもキーを見られてしまうためです。代わりに、バックエンドで POST /v1/sessions を使ってセッションを作成し、その結果得られる verification_url をウィジェットに渡して表示してください。これはホスト型フローと同じ推奨方法で、リンクではなく埋め込みで表示するだけの違いです。

html
<div id="shieldid-verify"></div>
<!-- Exact script URL is published with your API keys; the path below is illustrative. -->
<script src="https://cdn.shieldid.ca/sdk/v1/widget.js"></script>
<script>
  // Recommended: create the session on your backend first (see API reference),
  // then pass its verification_url straight through — never a raw API key.
  TLVerify.init({
    containerId: "shieldid-verify",
    verificationUrl: "{{ session.verification_url }}", // from your backend
    theme: { accentColor: "#0B5CD8" },
  });
</script>

モバイル

ネイティブSDKは近日対応予定です。

現在、iOS用やAndroid用のSDKはありません。提供されるまでは、アプリのシステムブラウザまたはWebView内でホスト型の認証ページを開いてください。Webの申請者が利用するものと同じフローで、アプリが動作するあらゆるプラットフォームで今すぐご利用いただけます。

近日公開ネイティブのiOS SDKとAndroid SDK

導入方法の選び方

3つの方法を率直に比較します。

埋め込む特別な理由がない限り、まずはホスト型ページから始めてください。

各導入方法で現時点でできること。
機能ホスト型ページWebウィジェットモバイルSDK
SDKもクライアント側のコードも不要はいいいえ近日公開
お客様自身のページ内にとどまるリンクとして開く埋め込み型iframe近日公開
お客様のコード内での完了コールバックリターンURL + webhook近日公開近日公開
お客様のブランディング対象プランで利用可能対象プランで利用可能近日公開
今すぐ利用可能はいはいいいえ

ご質問

SDKとウィジェットのFAQ。

構築を始める

ホスト型ページが最も手早い始め方です。

API呼び出し1回とリンク1つだけで、SDKは不要です。今すぐsandboxキーでお試しください。

sandboxで無料で始めるAPIリファレンス