電子申請等API

本ページはAPIの利用を希望する者・開発事業者・サービス導入を検討される自治体向けのぺージです。
自治体向けの手続の電子申請に対応しているサービスの利用をご検討されている方はサービス一覧をご確認ください。

「電子申請等API」とは

マイナポータルのサービスの一つであるぴったりサービスでは、子育てや引越しに関する手続をはじめとして、各自治体への様々な申請・届出をオンライン上で行うことができます。
電子申請等APIは、当該機能をシステム間連携によりAPIの利用を希望する者が利用できるようマイナポータルのAPIの一つとして作成・公開するものです。

「電子申請等API」の概要と提供API一覧

1. 概要

本サービスでは、ぴったりサービスにおいて電子申請可能な手続をAPIによって申請可能とするため、「認証機能」、「申請情報取得機能」、「申請機能」、「申請データ処理状況照会機能」、「申請処理状況照会機能」を提供します。
また、申請受付完了後の照会時には受付番号及び控えZIPを返却します。

2. 提供API一覧

提供API一覧
No. 業務 API 概要
1 認証機能 民間サービス事業者認証API 民間サービス事業者の認証を行うAPI。
2 申請情報取得機能 手続検索API 申請に必要な手続コード及び手続情報を提供するAPI。
なお、既にこれらの情報を民間サービス事業者が所持している場合は実行不要である。
申請XML取得API 申請データを作成するために必要な入力情報及び手続情報を提供するAPI。
なお、既にこれらの情報を民間サービス事業者が所持している場合は実行不要である。
3 申請機能 申請データ送信API 民間サービス事業者が、申請原本データを本サービスへ送信するAPI。
なお、電子署名が必要な手続の場合、引き続き電子署名データ送信APIによるデータ連携が必要である。
電子署名データ送信API 民間サービス事業者が、電子署名データ(申請原本データのHash値に署名を付与したデータ)と署名用電子証明書を本サービスへ送信するAPI。
4 申請データ処理状況照会機能 申請データ処理状況照会API 申請原本データの送信の処理状況を応答するAPI。
申請データの処理状況に応じて、電子署名に必要なHash値、申請の控えZIPを返却する。
5 申請処理状況照会機能 申請処理状況照会API 申請データが正常に受付けられた後に、当該申請の処理状況を応答するAPI。

引越し手続は、申請データ等が一部異なるため、仕様書にて詳細をご確認ください。

「電子申請等API」の利用にあたって

APIの利用を開始するためには、本サイトにて利用規約(別ウィンドウ)機密保持誓約書(別ウィンドウ)を確認・同意し、仕様書取得フォーム(別ウィンドウ)より仕様書を取得・確認し、利用申請フォーム(別ウィンドウ)よりAPIの利用を申請してください。申請内容の確認が完了するとユーザアカウントが作成され、開発者専用サイト(デジタルPMO)への初回ログインのためのURLが記載されたメールが送信されますので、そのURLにアクセスし初期設定を行った後、サービス情報を登録してください。
その後、デジタルPMOにて利用申請を提出し、デジタル庁の審査により承認されると、開発が可能となります。
(審査後に開示されるエンドポイント等情報を開発ベンダー等に共有する場合は、第三者開示承諾願を利用申請の際にデジタルPMOにてご提出ください。)
利用手順の詳細はAPI利用申請者向け手引書(別ウィンドウ)をご参照ください。
なお、利用検討にあたり疑問等が生じた際は、随時本サイトの問合せフォーム(別ウィンドウ)にて、疑問点をお問い合わせ下さい。

API利用の申請

APIの利用を開始するためには、利用規約、機密保持誓約書を確認・同意し、仕様書取得を申請してください。

仕様書事前取得

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

質問・お問い合わせ