バージョン6.xの変更点#
エラーレスポンスパラメータをerror_descriptionのみに統一しました。
一部のリクエスト/レスポンスにおいて、パラメータ名を下記の使い分けに従い変更しました。
CallbackとRedirectは、どちらも特定の処理後に別の場所へ遷移するという点で似ていますが、次の定義を設け、使い分けております。Redirect:あるURLから別のURLへブラウザを直接移動させる際に使用。
Callback:特定の処理(認証など)が完了した後に、元の場所(クライアント)に結果を通知する際に使用。
バージョン6.x以降:expires_inを追加しました。これによって、request_id が有効な期間(秒)を取得することができます。
バージョン5.x以前:/jpki/callback/request
バージョン6.x以降:/jpki/redirect/request
バージョン6.x以降:redirect_url
※機能・動作に変更はありません。
本APIを使用することで、クライアントを署名検証者とした公的個人認証を利用者に要求することができます。xIDが発行する電子証明書による本人確認では現行法令上対応できない取引・申請業務において、xIDアプリを利用してマイナンバーカードによる電子署名を付し、その電子証明書の有効性をJ-LISへ問い合わせることによって本人確認を実施します。法令上マイナンバーカードによる電子署名を求められているケースとして、例えば次のようなものが該当します。犯罪による収益の移転防止に関する法律に規定 される特定事業者における特定業務に関する本人確認(犯収法施行規則第六条ワ)
行政手続きにおいて、有効な電子証明書が限定列挙されているケース(住民票請求等)
JPKIまたはJPKIRedirectエンドポイントを呼び出して公的個人認証の要求を利用者のxIDアプリに送信すると、利用者はその都度、マイナンバーカードの読み取りによる本人確認を実施します。本APIを利用するクライアントは事前にJ-LISへの届け出をする必要があります。申請は弊社で代行いたしますので、詳細は弊社営業担当者へお尋ねください。
本APIは以下のエンドポイントで構成されています。JPKIエンドポイントを利用することで、クライアントを署名検証者として公的個人認証を実施できます。本エンドポイントへリクエスト送信後、利用者に公的個人認証要求が送信されます。JPKIStatusエンドポイントからは、利用者の対応状況(status)のほか、uid, digest, in_transaction_id, out_transaction_idなどが返却されます。利用者がクライアントアプリをモバイル端末で操作し、公的個人認証を開始する場合には、JPKIRedirectを活用することで、クライアントアプリとxIDアプリ間の遷移の利便性を向上できます。返却されたデータは、各種法令に基づきクライアントにおいて適切に管理・保管を行ってください。当社側に情報が保管されることはありません。
JPKIについて#
シーケンス#
利用者フロー#
JPKIRedirectにつ いて#
モバイル端末で署名を開始する場合は、JPKIRedirectエンドポイントを活用することで、クライアントアプリとxIDアプリ間の遷移の利便性を向上できます。JPKIとの違い#
本エンドポイントを用いて公적個人認証を実施した場合、自動的にxIDアプリへ遷移して公的個人認証が開始されます。
当該認証が完了した後、本リクエストを実行したサービスに自動的に戻ります。
xIDアプリからの自動遷移先はデフォルトブラウザとなります(特定のアプリへ遷移させたい場合の対策は下記のNoteを参照)。
特定のアプリへ遷移が必要な場合は、JPKIRedirectリクエストのパラメータであるredirect_urlにクライアントアプリのユニバーサルリンクまたはアプリリンクを指定することをご検討ください。
リクエスト元からxIDアプリへの自動遷移#
レスポンスに含まれるredirect_urlを呼び出していただくことで、xIDアプリに自動遷移し、公的個人認証が開始されます。xIDアプリからリクエスト元への自動遷移#
公的個人認証の手続き終了後は、リクエスト時に指定されたURLへ自動遷移します。その際、当該手続きのステータス(certificate_verified, certificate_invalid, canceled)が付与されますので、ステータスに応じてリクエスト元でクライアントに 表示する画面を制御することができます。利用者が公的個人認証を完了した場合#
自動遷移するURLにステータスcertificate_verifiedが付与されます。公的個人認証の詳細情報をJPKIStatusエンドポイントを用いて取得してください。セキュリティの観点から、ステータスと公的個人認証情報はそれぞれ切り分けています。シーケンス#
利用者フロー#