本文へ移動

マイナポータルAPI

自己情報取得API

公開日

更新日

「自己情報取得API」とは

マイナポータルのサービスの一つに、「行政機関等が保有する自己情報(所得、世帯など)を確認できるサービス」があります。「自己情報取得API」は、国民がWebサービスやキオスク端末等から、自己情報の確認のみならず、提供まで行えるよう機能を拡充し、当該機能をシステム間連携によりAPIの利用を希望する者が利用できるようマイナポータルのAPIの一つとして作成・公開するものです。

自己情報取得APIとサービスを連携する前後の比較図。連携前ではサービス利用者がマイナポータルにある自己情報を目的サイトにアップロードしたい場合に、マイナポータルにログインして自己情報を取得し、その後目的のサイトにログインして自己情報を自らアップロードする必要があった。しかし、目的サイトと自己情報取得APIが連携した後では、サービス利用者は目的サイトにログインし自己情報の提供について同意すると、目的サイト上でマイナポータルから取得した自己情報を照会・登録することが可能となる。自己情報取得APIとの連携は目的サイトのサービス向上や利用促進に繋がる。

概要

Webサービスや、キオスク端末等のマイナポータルアプリの利用が困難なシステムを利用している民間事業者や国・地方公共団体など、様々なAPIの利用を希望する者は、自己情報取得APIを活用しマイナポータルと連携することにより、自らのサービス利用者の自己情報を、安全かつスピーディに取得し、そのサービスにおいて活用することが可能となります。

自己情報取得APIの連携フロー図。まず、国民がサービスを利用する際マイナンバーカードで本人確認・同意を行う。次にマイナポータルAPIを利用しているサービスから、マイナポータルに予め設定された自らのサービスIDを指定して情報取得要求をマイナポータルに送信(キオスク端末等からも同様の流れ)。マイナポータルは、行政機関等(情報提供者)に情報取得要求し、取得した自己情報を、API利用者であるサービスへ提供する。

想定されるユースケース

例えば、銀行等の民間事業者がローン等の審査の際に必要な所得情報をオンラインで即時に取得することで、ローンの審査をスムーズに進めることが可能となります。

銀行等の民間事業者のローン等の審査における現状とサービスに自己情報取得APIを組み込んだ後のサービス利用者の体験を比較した図。現状では住民は役所で所得証明書を取得し、金融機関に提出する必要がある。しかし、APIを利用したサービスを使用すれば、住民はマイナンバーカードで本人確認と同意を行うだけで、所得証明などの情報を取得することができ、役所や銀行に出向く必要なく銀行等に提出することが可能となる。

活用事例

自己情報取得APIを活用している事例を公開しています。

活用事例の一覧を見る

「自己情報取得API」で取得できる情報の概要一覧(令和8年6月時点)

分野名分野詳細
健康・医療予防接種 ※1
健康・医療検診情報 ※1
健康・医療医療保険
健康・医療医療保険その他
健康・医療学校保健
健康・医療難病患者支援
健康・医療保険証の被保険者番号等
税・所得・口座情報税・所得
税・所得・口座情報公金受取口座
年金関係年金
年金関係年金その他
子ども・子育て児童手当
子ども・子育てひとり親家庭
子ども・子育て母子保健 ※1
子ども・子育て教育・就学支援
子ども・子育て障害児支援・小児慢性特定疾病医療
世帯・戸籍情報世帯情報
世帯・戸籍情報戸籍関係情報
世帯・戸籍情報戸籍手続オンライン利用者情報
福祉・介護障害保健福祉
福祉・介護生活保護
福祉・介護中国残留邦人等支援
福祉・介護介護・高齢者福祉
雇用保険・労災雇用保険
雇用保険・労災労災補償
出入国出入国関連情報

※1 予防接種歴、検診情報、乳幼児健診、特定健診、薬剤情報等を取得する場合「PHRサービス提供者による健診等情報の取扱いに関する基本的指針」を遵守する必要があります。

取得情報一覧を見る

「自己情報取得API」の利用にあたって

APIの利用を開始するためには、本サイトにて利用規約(PDF/359KB)をご確認のうえ、API利用申請フォームから仕様書の取得申請利用申請を行ってください。なお、API利用申請フォームを利用する際、初めての方はユーザーアカウントの新規登録が必要になります。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。
申請内容の確認後、事業者とデジタル庁、マイナポータル運営主体にて事前打合せを実施します。事前打合せ後、利用内容がデジタル庁の審査により承認されると、開発が可能となります。
(審査後に開示されるエンドポイントなどの情報を開発ベンダーなど第三者に共有する場合は、デジタル庁が申請内容を確認後に案内する「第三者開示承諾願」をAPI利用申請フォームにてご提出ください。)
利用手順の詳細は、自己情報取得API利用ガイドライン(PDF/2.1MB)をご参照ください。
なお、利用検討にあたり疑問等が生じた際は、随時API利用申請フォームのお問合せにてご連絡ください。

APIの利用までの流れ

APIの利用申請をしてからサービス利用開始までの参考期間として約半年から約1年ほどかかります。
参考期間は、過去のAPI利用申請事業者が実際にかかった値を基に算出しています。実際にリリースまでにかかる期間は事業者の体制や使用するAPIの種類、サービスの規模等によって変動いたしますので、あらかじめご了承ください。

また、詳細のフローにつきましては、自己情報取得API利用ガイドライン(PDF/2.1MB)をご確認ください。

マイナポータルAPIの利用の流れのフロー図。利用検討、利用申請・事前打合せ、審査、開発、接続試験、本番動作確認、サービス提供前確認の順でマイナポータルAPIを利用したサービスを開始する。

※開発、接続試験、本番動作確認は事業者の体制や利用するAPIの種類、サービスの規模によって期間が大きく変動します。

1.利用検討

利用したいAPIの概要・ガイドライン・利用規約等を確認して、APIの利用について検討ください。

2.利用申請・事前打合せ

必要書類の確認をし、利用の意思が概ね固まったら、利用申請手続きを行ってください。
デジタル庁が申請内容を確認後、事前打合せに必要な書類を案内するため、事前打合せに必要な書類を作成のうえAPI利用申請フォームにてご提出ください。
デジタル庁が提出書類を確認後、事業者とデジタル庁、マイナポータル運営主体にて打合せを実施します。
なお、利用申請・事前打合せにおいて利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
(参考期間:約2か月)

3.審査

事前打合せ実施後、デジタル庁にて審査を行います。承認されると、開発が可能となります。
(参考期間:約1か月半)

4.開発

事業者において、必要な開発を行ってください。
(参考期間:約3か月)

5.接続試験

接続試験の開始予定日の3週間前までに、接続確認環境の利用申請を提出してください。
デジタル庁が申請内容を確認し、アクセス権等の設定が完了すると、接続試験を実施することができます。
(参考期間:約1か月半)

  • 接続試験は、テスト用マイナンバーカードを使用して実施します。そのため、J-LIS(地方公共団体情報システム機構)への貸与申請を実施し、接続試験の開始までに、テスト用マイナンバーカードの事前準備をお願いします。
  • iOSの接続試験は、TestFlightを使用して実施します。TestFlightの利用にはApple IDの登録が必要です。承諾書の発行後に、デジタル庁がTestFlight登録申請に関する案内を送付するため、あらかじめApple IDの事前準備をお願いします。

6.本番動作確認

本番動作確認の開始予定日の3週間前までに本番環境の利用申請を提出してください。
デジタル庁が申請内容を確認し、アクセス権等の設定が完了すると、本番動作確認を実施することができます。
(参考期間:約2週間)

  • 本番動作確認は、マイナンバーカードを使用して実施します。本番動作確認の開始までに、利用目的に沿ったマイナンバーカードの事前準備をお願いします。
  • 自己情報取得APIをご利用の場合、本番動作確認環境へのアクセスにあたっては企業の実在性を厳格に証明するためにEV証明書の提出が必要です。本番動作確認の開始までに、EV証明書の事前準備をお願いします。

7.サービス提供前確認

本番動作確認完了の通知をデジタル庁が受領したら、サービス提供前の確認を行います。
サービス提供前確認完了後、確認結果の通知を行い、事業者はサービスを開始することができます。
(参考期間:約2週間~約1か月半)

APIの利用申請

以下の流れに沿って、APIの利用を申請してください。

利用申請手続き

1.必要書類の確認

はじめに、自己情報取得API利用ガイドライン、利用規約を確認し、仕様書取得を行ってAPIの利用について検討してください。
自己情報取得API利用ガイドライン(PDF/2.1MB)
利用規約(PDF/359KB)

仕様書の事前取得

仕様書の取得には申請が必要です。以下より申請を行ってください。
仕様書の取得申請

2.利用申請

利用の意思が概ね固まったら、以下よりAPIの利用を申請してください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。

APIの利用を申請する

よくある質問・お問合せ

  • よくある質問をご確認ください。
  • 上記「よくある質問」で解決しない場合は、お問合せにてご連絡ください。

※お問合せをご利用いただく際、初めての方はアカウントの新規登録が必要です。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。

関連するAPI

関連コンテンツ