本文へ移動

マイナポータルAPI

民間送達接続API

公開日

更新日

「民間送達接続API」とは

「民間送達サービス」について

民間送達サービスとは、インターネット上に自分専用のポストを作り、自分宛のメッセージやレターを受け取ることができるサービスのことです。
国民等利用者は、マイナポータルと自身が利用する民間送達サービスを連携させることで、様々な情報をマイナポータルで電子的に受け取ることができます。
民間送達サービスの活用方法の詳細は「民間送達接続API」想定されるユースケースをご確認下さい。

民間送達サービスとは、マイナポータルと連携し、行政機関と民間企業の間で情報を安全にやり取りする仕組みである。行政機関には国税庁などが含まれ、民間企業には銀行、証券会社、保険会社、雇用先企業などが含まれる。
国民等利用者はマイナポータルや民間送達サービスにアクセスし、様々な情報を電子的に受け取れる。

概要

民間送達サービスを提供する事業者は「民間送達接続API」を利用することにより、民間送達サービスとマイナポータルを連携してサービスを提供することが可能となります。民間送達接続APIを利用して提供できるサービス内容は以下の通りです。

①お知らせ情報の提供

民間送達サービスに届いたお知らせ情報をマイナポータルに連携することにより、国民等利用者がマイナポータルでお知らせ情報を確認することができます。※

※民間送達サービスからマイナポータルに提供する情報は、件名・差出人・受信日時・保存期限・開封状態・本文のURL情報です。
国民等利用者はマイナポータルに表示されるリンクをクリックすることで民間送達サービスにてお知らせの本文や添付ファイルを確認できます。

②シングルサインオン機能

シングルサインオン機能を利用することにより、マイナポータルを利用する国民等利用者は都度ID・パスワードを入力することなくシームレスに民間送達サービスを利用することができます。

マイナポータルと民間送達サービスの連携の仕組みを示す図。国民等利用者はマイナンバーカードを使用してマイナポータルにログインし、マイナポータルを経由して民間送達サービスから、お知らせ情報(例:件名情報)を取得したり、リンク先にシングルサインオンで遷移が可能となる。

想定されるユースケース

例えば、生命保険会社から民間送達サービスに提供された控除証明書等の電子データを、マイナポータルを通じて外部Webサービスが取得することで、国民等利用者は確定申告書の作成・提出をスムーズに行うことができます。
「お知らせ情報取得・民間送達サービス保有情報取得API」想定されるユースケースを合わせてご参照ください。

確定申告するために生命保険会社から控除証明書を取得するユースケース時のシステム間の連携を示す図。まず、国民等利用者は外部Webサービスを使用して、本人同意を行ったのちにマイナポータルへ控除証明書の取得リクエストを申請する。次にマイナポータルが民間送達サービスに控除証明書取得リクエストを送信。民間送達サービスが生命保険会社から提供された控除証明書情報をマイナポータルを通してWebサービスへ提供し、国民等利用者は控除証明書を受領する。このユースケースで、Webサービスはお知らせ情報取得・民間送達サービス保有情報取得API、利用者登録等API、属性連携設定APIを使用し、民間送達サービスは民間送達接続APIを使用する。

活用事例

民間送達接続APIを活用している事例を公開しています。

活用事例の一覧を見る

「民間送達接続API」の利用にあたって

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

APIの利用までの流れ

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

また、詳細のフローにつきましては、民間送達接続API利用ガイドライン(PDF/2.8MB)をご確認ください。

マイナポータル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週間)

  • 本番動作確認は、マイナンバーカードを使用して実施します。本番動作確認の開始までに、利用目的に沿ったマイナンバーカードの事前準備をお願いします。

7.サービス提供前確認

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

APIの利用申請

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

利用申請手続き

1.必要書類の確認

はじめに、民間送達接続API利用ガイドライン、利用規約を確認し、仕様書取得を行ってAPIの利用について検討してください。
民間送達接続API利用ガイドライン(PDF/2.8MB)
利用規約(PDF/359KB)

仕様書の事前取得

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

2.利用申請

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

APIの利用を申請する

よくある質問・お問合せ

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

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

関連コンテンツ