マイナポータルAPI
お知らせ情報取得・民間送達サービス保有情報取得API
公開日
更新日
「お知らせ情報取得・民間送達サービス保有情報取得API」とは
概要
マイナポータルには、「行政機関等から自分宛にお知らせが届くサービス」と「民間送達サービス等から自分宛に配信されたお知らせ（控除証明書等）を確認できるサービス」があります。
｢お知らせ情報取得・民間送達サービス保有情報取得API」（以下、お知らせ／民送情報取得API）を利用することで、行政機関等から自分宛てに届くお知らせや民間送達サービスから配信されたお知らせを利用者の同意を得た上で、外部のAPI利用者へ提供することができるようになります。
なお、お知らせ／民送情報取得APIを利用するためには、国民がマイナポータルにおける利用者登録を完了している必要があります。また、民送情報取得APIを利用するためには、マイナポータルと民間送達サービスとの属性連携設定を完了している必要があります。
マイナポータルAPIにて提供している利用者登録等API・属性連携設定APIを利用することで、利用者登録が済んでいない国民はAPI利用者の画面よりマイナポータルの利用者登録およびマイナポータルと民間送達サービスとの属性連携設定を完了し、お知らせ／民送情報取得API利用の条件を満たせるため、お知らせ／民送情報取得APIと利用者登録等API・属性連携設定APIの併用を推奨します。
利用者がマイナポータルで事前に代理人登録をしている場合、「お知らせ情報（行政機関から届くお知らせ）」と「民送情報（民間送達サービスから配信されたお知らせ）」を代理人に提供できます。
マイナポータルが提供する「複数API利用時の本人確認省略」機能を併せて利用することで、「お知らせ情報」と「民送情報」を併せて提供することができます。「複数API利用時の本人確認省略」の詳細については、「複数API利用時の本人認証に関するガイドライン（PDF／977KB）」を参照ください。
想定されるユースケース
例えば、確定申告書を作成する際に、利用者本人や代理人が必要な各種証明書をオンラインで即時に取得することで、確定申告書の作成・提出をスムーズに進めることが可能となります。既にマイナポータル等連携プラットフォーム（国税庁）にて本ユースケースによるサービス提供が行われています。※
※マイナポータルを活用した年末調整及び所得税確定申告のよくある質問をご覧下さい。
活用事例
お知らせ情報取得・民間送達サービス保有情報取得APIを活用している事例を公開しています。
「お知らせ情報取得・民間送達サービス保有情報取得API」で取得できる情報
「お知らせ情報取得・民間送達サービス保有情報取得API」で取得できる情報は、以下の表で掲載しているものがすべてとなります。
| 情報 | 情報の内容 |
|---|---|
| 行政機関等からのお知らせ情報 | ・お知らせ件名等情報（行政機関等から届く通知の件名） ・お知らせ本文情報（行政機関等から届く通知の本文及び添付ファイル） |
| 民間送達サービスから提供される証明書（民送情報） | ・件名等情報（民間送達サービスから提供される件名） |
「お知らせ情報取得・民間送達サービス保有情報取得API」の利用にあたって
APIの利用を開始するためには、本サイトにて利用規約（PDF／359KB）をご確認のうえ、API利用申請フォームから仕様書の取得申請や利用申請を行ってください。なお、API利用申請フォームを利用する際、初めての方はユーザーアカウントの新規登録が必要になります。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。
申請内容の確認後、事業者とデジタル庁、マイナポータル運営主体にて事前打合せを実施します。事前打合せ後、利用内容がデジタル庁の審査により承認されると、開発が可能となります。
（審査後に開示されるエンドポイントなどの情報を開発ベンダーなど第三者に共有する場合は、デジタル庁が申請内容を確認後に案内する「第三者開示承諾願」をAPI利用申請フォームにてご提出ください。）
利用手順の詳細は、お知らせ／民送情報取得API利用ガイドライン（PDF／1,662KB）をご参照ください。
なお、利用検討にあたり疑問等が生じた際は、随時API利用申請フォームのお問合せにてご連絡ください。
APIの利用までの流れ
APIの利用申請をしてからサービス利用開始までの参考期間として約半年から約1年ほどかかります。
参考期間は、過去のAPI利用申請事業者が実際にかかった値を基に算出しています。実際にリリースまでにかかる期間は事業者の体制や使用するAPIの種類、サービスの規模等によって変動いたしますので、あらかじめご了承ください。
また、詳細のフローにつきましては、お知らせ／民送情報取得API利用ガイドライン（PDF／1,662KB）をご確認ください。
※開発、接続試験、本番動作確認は事業者の体制や利用する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週間）
- 本番動作確認は、マイナンバーカードを使用して実施します。本番動作確認の開始までに、利用目的に沿ったマイナンバーカードの事前準備をお願いします。
7．サービス提供前確認
本番動作確認完了の通知をデジタル庁が受領したら、サービス提供前の確認を行います。
サービス提供前確認完了後、確認結果の通知を行い、事業者はサービスを開始することができます。
（参考期間：約2週間～約1か月半）
APIの利用申請
以下の流れに沿って、APIの利用を申請してください。
利用申請手続き
1．必要書類の確認
はじめに、お知らせ／民送情報取得API利用ガイドライン、利用規約を確認し、仕様書取得を行ってAPIの利用について検討してください。
お知らせ／民送情報取得API利用ガイドライン（PDF／1,662KB）
利用規約（PDF／359KB）
※お知らせ情報取得・民間送達サービス保有情報取得APIを利用するためには、利用者登録等APIの併用が必要です。利用者登録等APIのページを参照し、必要書類の確認を行ってください。
仕様書の事前取得
仕様書の取得には申請が必要です。以下より申請を行ってください。
仕様書の取得申請
2．利用申請
利用の意思が概ね固まったら、以下よりAPIの利用を申請してください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
よくある質問・お問合せ
※お問合せをご利用いただく際、初めての方はアカウントの新規登録が必要です。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。