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
    • JPKIPittariRedirect
  • 利用者証明用証明書シリアルAPI
    • 概要
    • Serial
      POST
    • SerialRedirect
      POST
  • 券面事項入力補助
    • 概要
    • 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:特定の処理(認証など)が完了した後に、元の場所(クライアント)に結果を通知する際に使用。

SerialRedirect(旧SerialCallback)#

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

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

Serialについて#

シーケンス#

利用者フロー#

serial-flow.png

SerialRedirectについて#

Serialとの違い#

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

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

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

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

Serialのプロセス終了後は、リクエスト時に指定されたURLへ自動遷移いたします。その際、当該手続きのステータス(succeeded, canceled)が付与されますので、ステータスに応じてリクエスト元でクライアントに表示する画面を制御することができます。
なお、本エンドポイントでは、署名データなどの送信先(callback_url)と、利用者の画面遷移先(redirect_url)が独立しています。データは callback_url へ送信され、利用者の画面は redirect_url へ遷移します。

シーケンス#

利用者フロー#

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