Primagest Trust Services (PTS)
プロダクトドキュメント
運営会社
プロダクトドキュメント
運営会社
APIリファレンス
  1. マイナアプリ
  • ようこそ
  • 本人確認
    • 公的個人認証
      • 署名API
      • 利用者証明API
    • カード代替電磁的記録
      • スマートフォンのマイナンバーカードAPI
    • ICチップ読み取り
      • マイナンバーカード券面API
      • マイナンバーカード券面事項入力補助API
      • 運転免許証API
      • 在留カードAPI
      • 特別永住者証明書API
    • ICチップ読み取り+容貌撮影
    • 証跡
      • 証跡照会API
  • 利用者情報取得
    • 基本4情報提供
      • 同意
        • 同意取得API
        • 同意取消しAPI
        • 同意状況照会API
      • 失効情報
        • 失効情報確認API
        • 失効情報通知API
      • 基本4情報提供
        • 基本4情報提供API
        • 基本4情報自動最新化API
  • 連携プロダクト
    • マイナアプリ
      • マイナアプリ 署名API
      • マイナアプリ 認証API
      • マイナアプリ 同意取得API
      • マイナアプリ 同意取消しAPI
  • SDK
    • iOS
    • Android
    • React Native
    • Windows
  1. マイナアプリ

マイナアプリ 同意取得API


概要#

マイナアプリ同意取得APIは、利用者の基本4情報(氏名・住所・生年月日・性別)の提供を受けるために、予め利用者から同意を取得するAPIです。
利用者からの同意は、本人の意思に基づくものであることを確実に示すため、署名用電子証明書を用います。署名用電子証明書を用いた同意は、サービスプロバイダ事業者とプラットフォーム事業者を経由したうえで、J-LISに送信されます。
各事業者及びJ-LISは、それぞれ同意情報に関するデータベース等を構築し、保存・管理を行います。

アクセスコントロール#

マイナンバーカード
スマートフォンのマイナンバーカード

処理の流れ#

1
同意取得の要求(サービスプロバイダ事業者)
利用者の基本4情報(氏名・住所・生年月日・性別)提供に対する同意情報を取得し、リダイレクト先URLと併せてAPIに送信します。
2
署名トランザクションの開始(プラットフォーム事業者)
受信した同意情報に基づき同意申請書を生成し、その内容から署名対象データを作成します。署名対象データを同意申請書に追加し、署名トランザクションを開始します。正常に開始された場合、サービスプロバイダ事業者にマイナアプリ用の同意URLを返却します。
3
マイナアプリの起動(サービスプロバイダ事業者)
受信した同意URLにアクセスすると、利用者のスマートフォンでマイナアプリが起動します。PCまたはタブレットを利用する場合は、認証用のQRコードがブラウザまたはアプリ画面に表示されますので、利用者はスマートフォンでQRコードを読み取り、表示された6桁のパスコードを入力して認証を行い、マイナアプリを起動します。
4
署名値の生成(サービスプロバイダ事業者)
マイナアプリ起動後、利用者は画面の案内に従って操作を行い、同意申請書に基づいて署名値を生成します。署名完了後、リダイレクトにより署名結果パラメータをAPIへ送信します。
5
CSRF対策検証(プラットフォーム事業者)
リダイレクトで受信したデータをもとに、CSRF攻撃の有無を検証します。攻撃が検知された場合は、認証処理を中断しエラーを返却します。
6
署名トランザクション結果の取得(プラットフォーム事業者)
検証が正常に完了した場合、マイナアプリで生成された署名結果を取得します。取得した内容に異常がある場合はエラーを返却し、処理を中断します。
7
署名値・署名用電子証明書の追加(プラットフォーム事業者)
取得した署名結果から、署名値、署名用電子証明書を同意申請書に追加します。
8
同意申請の要求(プラットフォーム事業者)
署名値および署名用電子証明書を追加した同意申請書を使用し、J-LISに同意申請を送信します。
9
署名トランザクションIDの返却(プラットフォーム事業者)
同意申請が正常に完了した場合、署名トランザクションIDをリダイレクトで返却し、署名完了画面へ遷移します。
10
同意申請結果の取得(サービスプロバイダ事業者)
取得した署名トランザクションIDを各APIに送信することで、利用者識別用のID、同意申請結果が返却されます。

シーケンス図#


前へ
マイナアプリ 認証API
次へ
マイナアプリ 同意取消しAPI
Built with