概要 - API Docs

利用者のxIDアプリで電子署名を実施し、対応状況を取得するするためのAPIです。

このAPIは以下のエンドポイントで構成されています。

Signing（利用者への署名リクエストを発行する）

SigningStatus（署名リクエストのステータスを確認する）

Certificate（利用者のxID証明書を取得する）

SigningCallback（利用者のモバイル端末への署名リクエストを発行する）

Signingエンドポイントに署名対象データを渡すことで、xIDアプリユーザーに署名のリクエストを送信することが可能です。

xIDアプリユーザーの署名状況（status）や、クライアントアプリの画面に表示する確認コード（verification_code）はSigningStatusエンドポイントで非同期で確認することができます。

Certificateエンドポイントで取得できるcertificate（証明書）は、署名完了後に署名の検証を行う際に必要となります。

モバイル端末でクライアントアプリを操作し、xID電子署名を開始する利用者フローが想定される場合は、SigningCallbackの活用をご検討ください。

Signingについて

シーケンス

利用者フロー

SigningCallbackについて

モバイルで端末で署名を開始する場合は、SigningCallbackエンドポイントを活用することでクライアントアプリ、xIDアプリ間の遷移の利便性を向上させることができます。

署名の操作前後でクライアントアプリケーション - xIDアプリ間の遷移が自動で行われるため、利用者がよりスムーズに操作を完結させることができます。

Signingリクエストとの違い

Signingリクエストとの差分は以下の三点です。

本エンドポイントを用いて署名要求を実施した場合、自動的にxIDアプリへ遷移して署名プロセスが開始されます

当該署名が完了した後、署名要求を実行したサービスに自動的に戻ります

注意

xIDアプリから自動遷移して戻る先は、デフォルトブラウザがターゲットとなります。特定のアプリへ遷移が必要な場合は、クライアントアプリ側でユニバーサルリンク・アプリリンクを用いて、当該URLをcallback_urlに指定することをご検討ください。

クライアントアプリからxIDアプリへの自動遷移

レスポンスのredirect_urlのURLを呼び出していただくことで、xIDアプリに自動遷移し署名プロセスが開始されます。

xIDアプリからクライアントアプリへの自動遷移

署名プロセス終了後は、リクエスト時にcallback_urlで指定されたURLへ自動遷移いたします。
その際、当該手続きのステータス（signed, canceled）が付与されますので、ステータスに応じてリクエスト元でクライアントに表示する画面を制御することができます。

利用者が署名を完了した場合

自動遷移するURLにステータスsignedが付与されます。
署名の詳細情報をSignatureStatusエンドポイントを用いて取得してください。
セキュリティの観点から、ステータスと署名情報は分けて提供しています。

概要

Signingについて#

シーケンス#

利用者フロー#

SigningCallbackについて#

Signingリクエストとの違い#

クライアントアプリからxIDアプリへの自動遷移#

xIDアプリからクライアントアプリへの自動遷移#

利用者が署名を完了した場合#

シーケンス#

利用者フロー#

Signingについて

シーケンス

利用者フロー

SigningCallbackについて

Signingリクエストとの違い

クライアントアプリからxIDアプリへの自動遷移

xIDアプリからクライアントアプリへの自動遷移

利用者が署名を完了した場合

シーケンス

利用者フロー