Primagest Trust Services
プロダクトドキュメント
よくあるご質問運営会社
プロダクトドキュメント
よくあるご質問運営会社
APIリファレンス
  1. ICチップ読み取り
  • ようこそ
  • 本人確認
    • ICチップ読み取り
      • マイナンバーカード一括取得API
      • マイナンバーカード券面API
      • マイナンバーカード券面事項入力補助API
      • 運転免許証API
      • 在留カードAPI
      • 特別永住者証明書API
      • ICチップ画像OCR(オプション)
    • 公的個人認証
      • 署名API
      • 利用者証明API
    • カード代替電磁的記録
      • スマートフォンのマイナンバーカードAPI
    • ICチップ読み取り+容貌撮影
  • 本人情報取得
    • 基本4情報提供
      • 同意
        • 同意取得API
        • 同意取消しAPI
        • 同意状況照会API
      • 証跡
        • 証跡照会API
      • 失効情報
        • 失効情報確認API
        • 失効情報通知API
      • 基本4情報提供
        • 基本4情報提供API
        • 基本4情報自動最新化API
  • 連携プロダクト
    • マイナアプリ
      • マイナアプリ 署名API
      • マイナアプリ 認証API
      • マイナアプリ 同意取得API
      • マイナアプリ 同意取消しAPI
  • 本人確認サービス
    • 管理コンソール
    • 確認記録取得API
    • 対面本人確認アプリ
    • 非対面本人確認アプリ
  1. ICチップ読み取り

マイナンバーカード一括取得API


概要#

マイナンバーカード一括取得APIは、マイナンバーカードのICチップにある複数のAP(アプリケーション)からデータを1回でまとめて読み取り、署名検証や有効性確認を行うAPIです
公的個人認証AP、券面AP、券面事項入力補助AP、マイナ免許APのうち、必要なAPを組み合わせて読み取れます。APごとに異なる暗証番号や照合番号が必要な場合も、カードをかざすのは1回です。読み取ったデータはAPごとに署名検証と有効性確認を行い、結果と取得項目をまとめて返却します。
ご利用料金について
選択したAPごとに、対応する以下の各APIを利用した場合と同じ料金がかかります。
署名API
利用者証明API
券面API
券面事項入力補助API
運転免許証(マイナ免許)API
画像のテキスト変換について
券面APの氏名と住所は、オプションのICチップ画像OCRを使うとテキストデータでも取得できます。

取得できる項目#

公的個人認証APの取得項目
券面APの取得項目
券面事項入力補助APの取得項目
マイナ免許APの取得項目

アクセスコントロール#

公的個人認証APの署名用電子証明書を読み取る
公的個人認証APの利用者証明用電子証明書を読み取る
券面APと券面事項入力補助APの全項目を読み取る
券面APの表面と券面事項入力補助APの基本4情報を読み取る
券面APの表面と裏面、券面事項入力補助APの個人番号を読み取る
マイナ免許APを読み取る

処理の流れ#

1
セッションの作成(サービスプロバイダ事業者)
内部認証を行う場合は、APIでセッションを作成し、内部認証に使用するセッションIDと乱数を取得します。セッションは作成から10分間有効で、1回だけ使用できます。
2
暗証番号または照合番号の入力要求(サービスプロバイダ事業者)
読み取るAPに対応する暗証番号または照合番号の入力を、利用者に要求します。
3
暗証番号または照合番号の入力(利用者)
利用者が暗証番号または照合番号を入力します。
情報
SDKの券面OCR機能により、スマートフォンのカメラで照合番号の自動読み取りが可能です。
4
マイナンバーカードのデータ取得(サービスプロバイダ事業者)
SDKを利用してマイナンバーカードのICチップを読み取り、入力された暗証番号または照合番号で、指定したAPのデータをまとめて取得します。内部認証を行う場合は、SDKにセッションを指定します。券面APと券面事項入力補助APでは、ICチップがセッションの乱数に署名します。取得したデータは、署名検証や有効性確認、利用可能な形式への変換を行うために、APIで送信します。
5
署名検証・有効性確認(プラットフォーム事業者)
APIで送信されたデータから、APごとに電子署名を取得し、署名を検証して真贋判定を行います。署名検証後は、公的個人認証APの電子証明書の有効性確認を行います。また、券面APの有効期限とマイナ免許APの有効期間の末日を当日の日付と比較し、期限内であることを確認します。内部認証を行う場合は、ICチップが乱数に対して作成した署名を検証し、複製されたカードでないことを確認します。
6
カードの情報返却(プラットフォーム事業者)
署名検証および有効性確認後、取得したカード情報をAPごとに利用可能な形式へ変換し、サービスプロバイダ事業者へ返却します。取得項目を選択している場合は、対象の項目のみ返却されます。

シーケンス図#

実装例#

iOS
Android

前へ
ICチップ読み取り
次へ
マイナンバーカード券面API
Built with