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

自己情報取得API


概要#

自己情報取得APIは、デジタル庁が提供するマイナポータルAPI(自己情報取得API)を利用して、利用者本人の同意のもとで行政機関や地方公共団体などが保有する自己情報を取得するためのAPIです。自己情報は、税・所得や年金、健康・医療、子ども・子育て、世帯・戸籍、福祉・介護などの分野の情報があります。
利用者は、マイナアプリ/マイナポータルの画面で利用目的と提供する情報を確認し、マイナンバーカードで本人確認を行ったうえで、情報の提供を許可します。これにより、ローンの審査やサービスへの入会などで、証明書類の提出や情報の手入力を利用者に求めずに、必要な情報を確認できます。
サービスプロバイダ事業者は、事前にデジタル庁にマイナポータルAPIの利用を申請します。プラットフォーム事業者は、その委託を受けてマイナポータルAPIとの接続を行います。

活用シーン#

ローン審査(収入の確認)
企業年金の請求(基礎年金番号や口座の確認)
マッチングアプリ(独身や年収の証明)
健康管理アプリ(予防接種や健診の記録)
障害者割引の申請(障害者手帳の確認)
子育て支援アプリ(予防接種や健診の記録)
導入の効果について
いずれの場合も、利用者が用意した書類ではなく、行政機関や地方公共団体が保有する情報を直接受け取るため、書類の真正性や記入内容を確認する手間を減らせます。
ほかの事業者の活用事例について
ほかの事業者の活用事例は、デジタル庁のマイナポータルAPI 活用事例一覧で確認できます。

取得できる項目#

健康・医療の取得項目
税・所得・口座情報の取得項目
年金関係の取得項目
子ども・子育ての取得項目
世帯・戸籍情報の取得項目
福祉・介護の取得項目
雇用保険・労災の取得項目
出入国の取得項目
取得できる項目の詳細について
取得する項目は、事前にデジタル庁へ提出した申請の内容によって決まります。リクエストで項目は指定できません。
詳細情報は、デジタル庁の取得情報一覧で確認できます。

アクセスコントロール#

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

処理の流れ#

1
自己情報取得の要求(サービスプロバイダ事業者)
リダイレクト先URLなどをAPIに送信します。本人同意・本人確認用のURLと、結果の取得に使用するIDが返却されます。
2
本人同意・本人確認(利用者)
返却されたURLにアクセスすると、利用者の端末にマイナポータルの画面が表示されます。利用者は、利用目的と提供する情報を確認し、マイナアプリでマイナンバーカードを読み取って本人確認を行います。続けて、情報の提供を許可します。PCまたはタブレットの場合は、画面に表示されたQRコードをスマートフォンのマイナアプリで読み取ります。PCの場合は、カードリーダーで読み取ることもできます。
3
リダイレクト先URLへの遷移(プラットフォーム事業者)
利用者が情報の提供を許可すると、マイナポータルに自己情報の取得を要求し、利用者の画面をリダイレクト先URLへ遷移させます。遷移の際は、手順1で返却したIDを付けます。利用者が情報の提供を拒否した場合や、エラーが発生した場合も、リダイレクト先URLへ遷移します。サービスプロバイダ事業者は、遷移先の画面で、手続きを受け付けたことを利用者に案内します。
4
自己情報の受信(プラットフォーム事業者)
マイナポータルは、情報提供者(情報を保有する行政機関や地方公共団体など)から自己情報を取得します。プラットフォーム事業者は、マイナポータルから自己情報を受け取って保存します。自己情報の取得には一定の時間がかかるため、リダイレクト先URLへ遷移した時点では、取得が完了していない場合があります。
5
自己情報の取得(サービスプロバイダ事業者)
手順1で返却されたIDをAPIに送信すると、処理の状況が返却されます。処理中の場合は、一定の間隔で再度確認します。処理が完了している場合は、自己情報が返却されます。取得に失敗した場合は、エラーが返却されます。取得結果を案内する方法は、サービスプロバイダ事業者が決定します。

シーケンス図#


前へ
マイナポータルAPI
次へ
医療保険情報取得API
Built with