API Docs
v5.9.0
  • v5.9.0
  • v6.1.0
ガードAPI仕様
よくある質問
ガードAPI仕様
よくある質問
v5.9.0
  • v5.9.0
  • v6.1.0
v5.9.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
    • SigningCallback
      POST
  • マイナンバーAPI
    • 概要
    • MyNumber
      POST
    • MyNumberStatus
      GET
  • 本人確認情報更新API
    • 概要
    • Re:Verification
      POST
    • Re:VerificationStatus
      GET
    • Re:VerificationCallback
      POST
  • 公的個人認証API
    • 概要
    • JPKI
      POST
    • JPKIStatus
      GET
    • JPKICallback
      POST
  • マイナポータル向け公的個人認証API
    • 概要
    • JPKIPittari
    • JPKIPittariCallback
  • 利用者証明用証明書シリアルAPI
    • 概要
    • Serial
    • SerialCallback
  • 券面事項入力補助API
    • 概要
    • CardInput
    • CardInputStatus
    • CardInputCallback
  1. 公的個人認証API

概要

本APIを使用することで、クライアント事業者(自治体)を署名検証者とした公的個人認証を利用者にリクエストすることができます。xIDが発行する電子証明書による本人確認では現行法令上対応できない取引・申請業務において、xIDアプリを利用してマイナンバーカードによる電子署名を付し、その電子証明書の有効性をJ-LISへ問い合わせることによって本人確認を実施します。
法令上マイナンバーカードによる電子署名を求められているケースとして、例えば以下のようなものが該当します。 
犯罪による収益の移転防止に関する法律に規定される特定事業者における特定業務に関する本人確認(犯収法施行規則第六条ワ)
行政手続きにおいて、有効な電子証明書が限定列挙されているケース(住民票請求等)
JPKIまたはJPKICallbackエンドポイントを呼び出して公的個人認証のリクエスト利用者のxIDアプリに送信すると、利用者はリクエスト毎にマイナンバーカードの読取りによる本人確認を実施します。
注意
本APIを利用するクライアント事業者(自治体)は事前にJ-LISへの届け出と総務大臣による認定を取得する必要があります。申請は弊社で代行いたしますので、詳細は弊社営業担当者へお尋ねください。
本APIは以下のエンドポイントで構成されています。
JPKI(利用者への公的個人認証リクエストを発行する)
JPKIStatus(公的個人認証リクエストのステータスを取得する)
JPKICallback(利用者のモバイル端末への公的個人認証リクエストを発行する)
JPKIエンドポイントを利用することで、クライアント事業者(自治体)を署名検証者として公的個人認証を実施することが可能です。本エンドポイントへリクエスト送信後、xIDアプリユーザーに公的個人認証リクエストが送信されます。
JPKIStatusエンドポイントからは、xIDアプリユーザーの対応状況(status)のほか、uid, digest, in_trnsaction_id, out_transaction_idなどが返却されます。
利用者がクライアントアプリをモバイルで操作し、公的個人認証を開始する場合には、JPKICallbackを活用することで、クライアントアプリ、xIDアプリ間の遷移の利便性を向上させることができます。
注意
返却されたデータは、各種法令に基づきクライアント側で適切に管理保管を行なってください。当社側に情報が保管されることはありません。

JPKIについて#

シーケンス#

利用者フロー#

jpki-flow.png

JPKICallbackについて#

JPKIとの違い#

JPKIとの違いは主に下記の2点です。
本エンドポイントを用いて公的個人認証を実施した場合、自動的にxIDアプリへ遷移して公的個人認証が開始されます。
当該認証が完了した後、本リクエストを実行したサービスに自動的に戻ります
xIDアプリから自動遷移して戻る先は、デフォルトブラウザがターゲットとなります。特定のアプリへ遷移が必要な場合は、クライアントアプリ側でユニバーサルリンク、アプリリンクを用いて、そちらをcallback_urlに指定することをご検討ください。
モバイルで端末で署名を開始する場合は、JPKICallbackエンドポイントを活用することでクライアントアプリ、xIDアプリ間の遷移の利便性を向上させることができます。

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

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

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

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

利用者が公的個人認証を完了した場合#

自動遷移するURLにステータスcertificate_verifiedが付与されます。公的個人認証の詳細情報をJPKIStatusエンドポイントを用いて取得してください。セキュリティの観点から、ステータスと公的個人認証情報はそれぞれ切り分けております。

シーケンス#

利用者フロー#

jpki-mobile-flow.png
更新日時 2026-06-05 02:15:48
前へ
公的個人認証API
次へ
JPKI
Built with