マイナポータルAPI
電子申請等API
公開日
更新日
「電子申請等API」とは
マイナポータルのサービスの一つであるぴったりサービスでは、子育てや引越しに関する手続をはじめとして、各自治体への様々な申請・届出をオンライン上で行うことができます。
電子申請等APIは、当該機能をシステム間連携によりAPIの利用を希望する者が利用できるようマイナポータルのAPIの一つとして作成・公開するものです。
概要
本サービスでは、ぴったりサービスにおいて電子申請可能な手続をAPIによって申請可能とするため、「認証機能」、「申請情報取得機能」、「申請機能」、「申請データ処理状況照会機能」、「申請処理状況照会機能」を提供します。
また、申請受付完了後の照会時には受付番号及び控えZIPを返却します。
提供API一覧
| 業務 | API | 概要 |
|---|---|---|
| 認証機能 | 民間サービス事業者認証API | 民間サービス事業者の認証を行うAPI。 |
| 申請情報取得機能 | 手続検索API | 申請に必要な手続コード及び手続情報を提供するAPI。 なお、既にこれらの情報を民間サービス事業者が所持している場合は実行不要である。 |
| 申請情報取得機能 | 申請XML取得API | 申請データを作成するために必要な入力情報及び手続情報を提供するAPI。 なお、既にこれらの情報を民間サービス事業者が所持している場合は実行不要である。 |
| 申請機能 | 申請データ送信API | 民間サービス事業者が、申請原本データを本サービスへ送信するAPI。 なお、電子署名が必要な手続の場合、引き続き電子署名データ送信APIによるデータ連携が必要である。 |
| 申請機能 | 電子署名データ送信API | 民間サービス事業者が、電子署名データ（申請原本データのHash値に署名を付与したデータ）と署名用電子証明書を本サービスへ送信するAPI。 |
| 申請データ処理状況照会機能 | 申請データ処理状況照会API | 申請原本データの送信の処理状況を応答するAPI。 申請データの処理状況に応じて、電子署名に必要なHash値、申請の控えZIPを返却する。 |
| 申請処理状況照会機能 | 申請処理状況照会API | 申請データが正常に受付けられた後に、当該申請の処理状況を応答するAPI。 |
| 子育て支援制度レジストリ | 外部連携制度・手続一覧検索API | 自治体及び国がデータベースに登録した子育て支援制度情報の制度・手続一覧を提供するAPI。 |
| 子育て支援制度レジストリ | 外部連携制度・手続詳細検索API | 自治体及び国がデータベースに登録した子育て支援制度情報の制度・手続詳細情報を提供するAPI。 |
※引越し手続は、申請データ等が一部異なるため、仕様書にて詳細をご確認ください。
活用事例
電子申請等APIを活用している事例を公開しています。
【行政手続】国民（行政手続きのオンライン申請者）が、「電子審査システム・中間DB連携サービス」において、マイナンバーカード認証による住民情報の取得および申請フォームへのプリセットを行うことで、申請フォームへの入力の手間を省くことができるサービスです。（利用API：電子申請等API）
【行政手続】DX-Pandは行政情報や各種デジタルサービスの入口を集約し住民との接点を一元化するアプリです。住民はマイナンバーカードによる本人認証を行い、電子申請とその結果通知・資格証等をアプリで受け取れます。更に、個人と紐づけされた自治体サービスも利用できます。（利用API：電子申請等API）
【行政手続】しらせあいアプリをダウンロードしたスマホユーザーを対象に、自治体がしらせあいから提供している電子申請サービスを365日24時間いつでもどこでも行えるサービスです。しらせあいから行える電子申請サービスは、マイナポータル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の利用を申請してください。
なお、利用申請において利用目的等に照らした判断を行うため、申請を却下することもございますので、ご留意ください。
よくある質問・お問合せ
※お問合せをご利用いただく際、初めての方はアカウントの新規登録が必要です。すでにアカウントをお持ちの方は、メールアドレスとパスワードでログインしてください。