API Docs
v6.1.0
  • v6.1.0
  • v5.9.0
ガイドAPI仕様
よくある質問リリースノートお知らせ
ガイドAPI仕様
よくある質問リリースノートお知らせ
v6.1.0
  • v6.1.0
  • v5.9.0
SmartPOST APIドキュメント
v6.1.0
  • v6.1.0
  • v5.9.0
  1. 本人確認情報更新API
  • APIの概要
  • システム概要
  • 認証＆認可API
    • 概要
    • Authorization
      GET
    • Token
      POST
    • Userinfo
      GET
  • 本人確認API
    • 概要
    • 利用者情報の検証方法
    • Userdata
      GET
  • 電子署名API
    • 概要
    • Signing
      POST
    • SigningRedirect
      POST
    • SigningStatus
      GET
    • Certificate
      GET
  • 本人確認情報更新API
    • 概要
    • Re:Verification
      POST
    • Re:VerificationRedirect
      POST
    • Re:VerificationStatus
      GET
  • 公的個人認証API
    • 概要
    • JPKI
      POST
    • JPKIRedirect
      POST
    • JPKIStatus
      GET
  • マイナポータル向け公的個人認証API
    • 概要
    • JPKIPittari
      POST
    • JPKIPittariRedirect
      POST
  • 利用者証明用証明書シリアルAPI
    • 概要
    • Serial
    • SerialRedirect
  • 券面事項入力補助
    • 概要
    • CardInput
    • CardInputRedirect
    • CardInputStatus
  • マイナンバーAPI
    • 概要
    • MyNumber
    • MyNumberStatus
  1. 本人確認情報更新API

概要

バージョン6.xの変更点#

共通#

Base URLが変更されています。
変更後のURL：https://api-uat.x-id.io/v6/
エラーレスポンスパラメータをerror_descriptionのみに統一しました。
一部のリクエスト/レスポンスにおいて、パラメータ名を下記の使い分けに従い変更しました。
CallbackとRedirectの使い分け
CallbackとRedirectは、どちらも特定の処理後に別の場所へ遷移するという点で似ていますが、次の定義を設け、使い分けております。
Redirect：あるURLから別のURLへブラウザを直接移動させる際に使用。
Callback：特定の処理（認証など）が完了した後に、元の場所（クライアント）に結果を通知する際に使用。

Re:Verification#

Responseに、expires_inを追加しました。これによって、request_id が有効な期間（秒）を取得することができます。

Re:VerificationRedirect（旧Re:VerificationCallback）#

URLパスを変更しました。
バージョン5.x以前：/reverification/callback/request
バージョン6.x以降：/reverification/redirect/request
リクエストパラメータ名を変更しました。
バージョン5.x以前：callback_url
バージョン6.x以降：redirect_url
※機能・動作に変更はありません。

本API群は、xIDアカウントに登録されている本人確認情報を更新するためのものです。
本人確認情報更新APIは以下のエンドポイントで構成されています。
Re:Verification（利用者への本人確認情報更新リクエストを発行する）
Re:VerificationRedirect（利用者のモバイル端末への本人確認情報更新リクエストを発行する）
Re:VerificationStatus（本人確認情報更新リクエストのステータスを取得する）
Re:Verificationエンドポイントによって、利用者のxIDアプリに本人確認情報更新要求を送信できます。
利用者がモバイル端末でクライアントアプリを開き、本人確認情報更新の操作を実施する場合は、Re:VerificationRedirectの活用をご検討ください。
利用者の操作状況（status）は、Re:VerificationStatusを用いて確認できます。

Re:Verificationについて#

シーケンス#

利用者フロー#

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

Re:VerificationRedirectについて#

利用者がモバイル端末でクライアントアプリを操作し、xIDの本人確認情報更新を実施することを想定する場合は、Re:VerificationRedirectをご活用ください。
本人確認情報更新要求がxIDアプリに送信された後、クライアントアプリとxIDアプリ間の遷移が自動で行われるため、利用者はよりスムーズに操作を完結させることができます。

Re:Verificationとの違い#

主に下記3点です。
本エンドポイントを用いて本人確認情報更新を実施した場合、自動的にxIDアプリへ遷移して本人確認情報更新プロセスが開始されます。更新不要な場合は、更新不要のステータスを返却します。
当該プロセスが完了した後、本要求を実行したクライアントアプリに自動的に戻ります。
xIDアプリからの自動遷移先はデフォルトブラウザとなります（特定のアプリへ遷移させたい場合の対策は下記のNoteを参照）。
注意
特定のアプリへ遷移が必要な場合は、Re:VerificationRedirectリクエストのパラメータであるredirect_urlにクライアントアプリのユニバーサルリンクまたはアプリリンクを指定することをご検討ください。
注意
Re:VerificationRedirectを利用する場合は、モバイル端末へのプッシュ通知の送信は行われません。

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

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

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

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

シーケンス#

利用者フロー#

利用者の本人確認情報が最新（status = is_latest）の場合は、xIDアプリへの操作リクエストの送信は発生しません。
reverification-mobile-flow.png
更新日時 2026-06-26 08:32:07
前へ
本人確認情報更新API
次へ
Re:Verification
Built with