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

開発者

実際に使いやすいことを目指して作られた、本人確認APIのドキュメント。

1つのREST API、構築したくない部分のためのホスト型ページ、そして結果が出た瞬間にお知らせする署名付きwebhook。Sandboxキーは課金されることがないため、ShieldIDを理解する最も早い方法は実際に呼び出してみることです。

sandboxで無料で始めるクイックスタートを読む

5分でわかる概要

4つの呼び出し。1つの考え方。

このドキュメントのそれ以外の内容は、すべてこの一連の流れに対する詳細です。

  1. セッションを作成

    リターンURLとwebhook URLを指定して POST /v1/sessions を呼び出します。session_id と verification_url が返されます。

  2. 申請者に渡す

    verification_url をリンクとして送るか、デスクトップのホスト型ページに表示されるQRコードをスキャンしてもらいます。申請者はご自身のスマートフォンで手続きを完了します。

  3. 署名付きwebhookを受信する

    セッションが VERIFIED または FAILED になると、ShieldIDが結果をお客様のwebhook URLにPOSTします。当社から送信されたものであると信頼できるよう、署名が付けられています。

  4. 結果を確認

    webhookを信頼するか、ご自身で GET /v1/sessions/{id}/result を呼び出してください。どちらの場合も、不透明な単一のスコアではなく、チェックごとの判定結果が得られます。

試してみる

最初のセッションを作成しましょう。

同じリクエストを3つの言語で紹介します。これは、メンタルモデルのステップ1で説明している呼び出しです。

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_ キーに差し替えても、変わるのは請求書だけです。

目的のページを探す

その他の開発者向けドキュメント。

全6ページ。必要なものだけお読みください。

APIリファレンス

すべてのエンドポイント、すべてのフィールド、想定できるすべてのエラー。
開く APIリファレンス

SDKs

Webウィジェット、ホスト型フロー、そして今後の予定。
開く SDKs

Sandbox

テストモードの仕組みと、キーの取得方法。
開く Sandbox

Sandbox

ご契約の前に、フロー全体をテストしてください。

sandbox キー(プレフィックス vk_sand_)は、本番環境とまったく同じ API、ホスト型ページ、webhook フローを実行します。セッションには、表示されるすべての場所で environment: "sandbox" と記録され、sandbox セッションはどのプランでも課金されません。

sandbox ガイドを読む
  • 実際のセッションを作成し、ご自身のスマートフォンで実際の書類を検証して、署名付きの実際の webhook を受け取れます
  • sandbox での操作が請求書に影響することはありません
  • キーのプレフィックスを入れ替えるだけで本番環境に切り替えられます。リクエストの形式は変わりません

オープンな開発

完成しているものと、まだのもの。

統合作業の途中で気づかれるより、先にお伝えしたいと考えています。

Web ウィジェットの完了コールバック

近日公開

onComplete、onCancel、onStep はウィジェットのインターフェースに現時点で存在しますが、まだどこからも呼び出されません。リターン URL と webhook をご利用ください。どちらも現在ご利用いただけます。

レート制限の適用

近日公開

すべての API キーにはご契約プランに応じたレート制限が記録されていますが、リクエストにはまだ適用されていません。そのためご自身で調整のうえご利用ください。ShieldID によるスロットリングには頼らないでください。

セルフサービスでの sandbox 登録

近日公開

セルフサービスでの登録機能を構築中のため、sandbox キーはご依頼に応じて発行しています。お申し付けいただければ、すぐに対応いたします。

ご質問

開発者向けの率直な回答。

はじめる

午後のうちに本番稼働できます。

まずは sandbox キーで、ご自身のスマートフォンから検証を実行し、送信される webhook をご確認ください。営業担当との通話は不要です。

sandboxで無料で始めるクイックスタートを読む

Sandboxのセッションに課金されることはありません。