マイナポータルAPI
電子申請等情報受取等API
公開日
更新日
「電子申請等情報受取等API」とは
マイナポータルのサービスの一つであるぴったりサービスや、電子申請等APIを利用しているWebサービスから行われた各自治体への様々な行政手続のオンライン申請に対して、地方公共団体は申請データを取得し、ダウンロードできます。
電子申請等情報受取等APIでは、当該機能をシステム間連携により地方公共団体が利用できるようマイナポータルのAPIの一つとして作成・公開するものです。
概要
本サービスでは、申請データを取得するために、ログインし認証トークンを取得後、申請データ一覧を取得して受付番号を抽出し、受付番号に対応する申請データを取得します。
提供API一覧
| API | 概要 |
|---|---|
| ログインAPI | 本サービスにログインし、他のAPIコールで使用する認証トークンを取得するAPI。 |
| 申請データ一覧取得API | 検索条件を指定して申請データに対するクエリを実行し、一致した申請データの簡易情報を一覧取得するAPI。 |
| 申請データ取得API | 指定した受付番号の申請データの詳細情報を取得するAPI。 |
| 申請処理状況一覧取得API | 検索条件を指定して申請データに対するクエリを実行し、申請処理状況登録対象の申請データの中から、検索条件に一致した申請データの申請処理状況情報を一覧取得するAPIを提供する。 |
| 申請処理状況登録API | 指定した受付番号の申請処理状況の登録および自治体コメントを登録、削除するAPIを提供する。 |
想定されるユースケース
本APIを活用することで、マイナポータル申請管理に送達された電子申請データを特定通信を通して、申請管理システムに取込を行うことができます。これに加えて、申請管理システムと基幹システムとの接続を行うことで、自治体の基幹システムとぴったりサービスとのエンドトゥエンドのオンライン接続を実現させることが可能となります。
活用事例
現在、掲載可能な事例がありません。
「電子申請等情報受取等API」の利用にあたって
APIの利用を開始するためには、本サイトにて利用規約（PDF／359KB）、機密保持誓約書（PDF／163KB）をご確認のうえ、API利用申請フォームから仕様書の取得申請や利用申請を行ってください。なお、API利用申請フォームを利用する際、初めての方はユーザーアカウントの新規登録が必要になります。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。
申請内容がデジタル庁の審査により承認されると、開発が可能となります。
（審査後に開示されるエンドポイントなどの情報を開発ベンダーなど第三者に共有する場合は、デジタル庁が申請内容を確認後に案内する「第三者開示承諾願」をAPI利用申請フォームにてご提出ください。）
利用手順の詳細は、API利用申請者向け手引書（PDF／3.6MB）をご参照ください。
なお、利用検討にあたり疑問等が生じた際は、随時API利用申請フォームのお問合せにてご連絡ください。
APIの利用までの流れ
APIの利用申請をしてからサービス利用開始までの参考期間として約半年から約1年ほどかかります。
参考期間は、過去のAPI利用申請事業者が実際にかかった値を基に算出しています。実際にリリースまでにかかる期間は事業者の体制や使用するAPIの種類、サービスの規模等によって変動いたしますので、あらかじめご了承ください。
また、詳細のフローにつきましては、API利用申請者向け手引書（PDF／3.6MB）をご確認ください。
※開発、接続試験、本番動作確認は事業者の体制や利用するAPIの種類、サービスの規模によって期間が大きく変動します。
1．利用検討
利用したいAPIの概要・手引書・利用規約・機密保持誓約書等を確認して、APIの利用について検討ください。
2．利用申請
必要書類の確認をし、利用の意思が概ね固まったら、利用申請手続きを行ってください。
デジタル庁が申請内容を確認後、審査に必要な書類を案内するため、審査に必要な書類を作成のうえAPI利用申請フォームにてご提出ください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
（参考期間：約1週間）
3．審査
デジタル庁にて申請書類を確認し、審査を行います。承認されると、開発が可能となります。
（参考期間：約2週間）
4．開発
事業者において、必要な開発を行ってください。
（参考期間：約5か月）
5．接続試験
接続試験の準備ができましたら、接続確認環境の利用申請を提出してください。
デジタル庁が申請内容を確認し、アカウント等の払い出しが完了すると、接続試験を実施することができます。
（参考期間：約4か月）
- 接続試験は、テスト用マイナンバーカードを使用して実施します。そのため、J-LIS（地方公共団体情報システム機構）への貸与申請を実施し、接続試験の開始までに、テスト用マイナンバーカードの事前準備をお願いします。
- iOSの接続試験は、TestFlightを使用して実施します。TestFlightの利用にはApple IDの登録が必要です。承諾書の発行後に、デジタル庁がTestFlight登録申請に関する案内を送付するため、あらかじめApple IDの事前準備をお願いします。
6．本番動作確認
本番動作確認の開始予定日の15営業日前までに、動作確認を実施するための申請を提出してください。
デジタル庁が申請内容を確認し、アカウント等の払い出しが完了すると、本番動作確認を実施することができます。
（参考期間：約1か月）
- 本番動作確認は、マイナンバーカードを使用して実施します。本番動作確認の開始までに、利用目的に沿ったマイナンバーカードの事前準備をお願いします。
7．サービス提供前確認
サービス開始予定日の2週間前までに本番動作確認完了報告書を提出してください。
デジタル庁が本番動作確認完了報告書を受領したら、サービス提供前の確認を行います。
サービス提供前確認完了後、確認結果の通知を行い、事業者はサービスを開始することができます。
（参考期間：約1～2週間）
APIの利用申請
以下の流れに沿って、APIの利用を申請してください。
利用申請手続き
1．必要書類の確認
はじめに、API利用申請者向け手引書、利用規約、機密保持誓約書を確認し、仕様書取得を行ってAPIの利用について検討してください。
API利用申請者向け手引書（PDF／3.6MB）
利用規約（PDF／359KB）
機密保持誓約書（PDF／163KB）
仕様書の事前取得
仕様書の取得には申請が必要です。以下より申請を行ってください。
仕様書の取得申請
2．利用申請
利用の意思が概ね固まったら、以下よりAPIの利用を申請してください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
よくある質問・お問合せ
※お問合せをご利用いただく際、初めての方はアカウントの新規登録が必要です。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。