概要 - API Docs

xIDアカウントに登録されている本人確認情報を更新するためのAPIです。

本人確認情報更新APIは以下のエンドポイントで構成されています。

Re:Verificationエンドポイントによって、利用者のxIDアプリに本人確認情報更新のリクエストを送信することができます。

利用者の操作状況（status）や、クライアントアプリの画面に表示する確認コード（verification_code）はRe:VerificationStatusを呼び出すことで確認することができます。

利用者がクライアントアプリをモバイル端末で開き、本人確認情報更新の操作を実施する場合はRe:VerificationCallbackの活用をご検討ください。

Re:Verificationについて

利用者の本人確認情報が最新(status = is_latest)の場合は、xIDアプリへの操作リクエストの送信は発生しません。

利用者がモバイル端末でクライアントアプリケーションを操作しxIDの本人確認情報更新を実施することを想定されている場合は、 Re:VerificationCallbackの活用をご検討ください。

本人確認情報更新要求がxIDアプリに送信された後、クライアントアプリケーション - xIDアプリ間の遷移が自動で行われるため、利用者がよりスムーズに操作を完結させることができます。

主に下記3点です。

本エンドポイントを用いて本人確認情報更新を実施した場合、自動的にxIDアプリへ遷移して本人確認情報更新プロセスが開始されます。更新不要な場合、更新不要のステータスを返送します

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

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

注意

Re:VerificationCallbackを利用する場合は、モバイル端末へのプッシュ通知の送信は行われません。

レスポンスに含まれるredirect_urlを呼び出していただくことで、xIDアプリに自動遷移し本人確認情報更新が開始されます。

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

利用者の本人確認情報が最新(status = is_latest)の場合は、xIDアプリへの操作リクエストの送信は発生しません。