Sandbox
本人確認用の sandbox API キー。
sandbox キーでは、本番環境と同一の API、ホスト型ページ、webhook フローが、請求の発生しないキーで動作します。料金のご相談の前に、ShieldID が合うかどうかを確かめる最も手早い方法です。
仕組み
同じパイプライン。異なるキー。請求なし。
sandbox は簡易的なデモモードではありません。送信するキーによってのみ区別される、本物の認証パイプラインです。
| キーのプレフィックス | vk_sand_… は、認証時にそのキーが sandbox キーであることを示します。設定が必要な別個の sandbox アカウントやダッシュボードはありません。 |
|---|---|
| 環境スタンプ | sandbox キーで作成されたすべてのセッション、結果、webhook には environment: "sandbox" が付与されるため、sandbox で作成されたものが下流で実際の認証と取り違えられることはありません。 |
| 請求 | sandbox のセッションは、どのプランでも請求されません。連携の構築とテストに必要なだけ、何件でも実行できます。 |
| 認証そのもの | 実際の認証です。ご自身の書類、ご自身の顔、同じチェックが行われます。テスト用の偽の書類は別途用意されておらず、ご自身で認証を行って製品の動作を確認します。 |
キーの取得
今すぐお申し込みください。セルフサービスは近日対応予定です。
対象プランでのセルフサービス版 sandbox キー作成は計画されていますが、時期は未定です。提供開始までは、お問い合わせフォームからお申し込みいただければ、キーを直接発行します。
近日公開
近日公開対象プランでのセルフサービス版 sandbox キー作成は計画されていますが、時期は未定です、そのため、サインアップ後すぐにキーを生成できます。
ご自身で試す
ご自身のスマートフォンで実行できるテストシナリオ。
偽の書類は不要です。ご自身の身分証明書でこれらを実行して、それぞれの経路が実際にどのように動作するかをご確認ください。
問題なく合格するケース
セッションを作成し、ホスト型ページを開いて、ご自身の身分証明書を撮影し、ライブネスチャレンジを完了します。checks.document、checks.liveness、checks.antispoof、checks.face_match がそれぞれ PASS で返ってくることを確認してください。
カメラを拒否するケース
ホスト型ページから求められたときに、カメラの権限を拒否します。セッションは FAILED になり、failure_reason が返されるので、それをもとに実際のエラーメッセージを作成できます。
失敗後の再試行(近日公開)
FAILED セッションの verification_url を開き直して PENDING にリセットし、2回目の試行を行う機能は、まだ利用できません。現在は FAILED を最終状態として扱い、申請者が再度試したい場合は新しいセッションを作成してください。
期限切れのセッション
セッションを作成し、そのまま何も操作しないでおきます。既定の期間を過ぎると EXPIRED に移行し、person や checks のデータは含まれません。UI のタイムアウト表示をテストするのに適した状態です。
キャンセルされたセッション
PENDING のセッションに対して DELETE /v1/sessions/{id} を呼び出し、その後 verification_url を開いてみてください。アプリがキャンセルされたセッションをエラーではなく完了として扱うことを確認します。
フランス語ロケール
locale: "fr" を指定してセッションを作成し、フランス語を話す申請者向けに、ホスト型ページとご自身の return_url の処理が正しく表示されることを確認してください。
制限事項
sandbox でできないこと。
細かい注意書きではなく、率直な回答です。
- sandbox には、本番環境とは別のレート制限はありません。現在、プランごとの制限によってリクエストが制限されることは一切なく、その制限の適用はまだ開始されていません。
- sandbox と本番環境は、キーのプレフィックスのみで区別されます。別個のアカウント、ダッシュボード、書類セットはありません。
- sandbox のセッションは、実際の書類に対する本物の認証です。テストに他人の身分証明書を使わず、ご自身の書類で認証してください。
ご質問
SandboxのFAQ。
キーを取得する
sandbox キーをリクエストする。
開発中の内容をお知らせください。テストを始めるためのキーを発行します。
Sandboxのセッションに課金されることはありません。