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

概要

本APIを利用することで、利用者に公的個人認証を要求し、マイナンバーカードの利用者証明用電子証明書に紐付けられたシリアル番号の提供を利用者にリクエストすることができます。
また、プロセスの最初に、利用者の署名用電子証明書の失効確認を行います。その結果、無効であった場合は、その旨が応答され、プロセスは終了します。本人確認情報更新APIを用いるなどして、本人確認情報の更新を利用者に促してください。
注意
シリアル番号をはじめとする本プロセスにおいて取得されたデータはxIDには保管されず、一度クライアント側から取得されると即座に削除されます。クライアント側にて適切に管理保管してください。
本APIは以下のエンドポイントで構成されています。
Serial(利用者への利用者証明用電子証明書シリアル番号リクエストを発行する)
SerialCallback(利用者証明用電子証明書シリアル番号リクエストのステータスを取得する)
Serialエンドポイントによって、利用者に公的個人認証を要求し、マイナンバーカードの利用者証明用電子証明書に紐付けられたシリアル番号を取得できます。
モバイルでクライアントサービスを使用している利用者に対しては、SerialCallbackエンドポイントを使用することで、プロセスをスムーズに完結させることができます。

Serialについて#

シーケンス#

利用者フロー#

serial-flow.png

SerialCallbackについて#

Serialとの違い#

Serialとの違いは主に下記の2点です。
本エンドポイントを用いてSerialが開始された場合、自動的にxIDアプリへ遷移してプロセスが開始されます。
当プロセスが完了した後、本要求を実行したサービスに自動的に戻ります
xIDアプリから自動遷移して戻る先は、デフォルトブラウザがターゲットとなります。特定のアプリへ遷移が必要な場合は、クライアントアプリ側でユニバーサルリンク、アプリリンクを用いて、そちらをcallback_urlに指定することをご検討ください。

リクエスト元からxIDアプリへの自動遷移#

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

xIDアプリからリクエスト元への自動遷移#

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

シーケンス#

利用者フロー#

serial-mobile-flow.png
更新日時 2026-06-05 09:19:05
前へ
利用者証明用証明書シリアルAPI
次へ
Serial
Built with