API

電子申請API

電子申請APIは、目的・用途に応じた4つのカテゴリ（電子申請、電子送達、アカウント間情報共有及び利用者認証）により構成されます。

電子申請では、選択した行政手続について、電子申請を行い、形式チェック後に到達した申請等の事務処理状況を照会します。申請等の結果として公文書が発出された場合、これら公文書を取得できます。また、申請等に関連して行政手数料などの納付が求められる場合、電子納付（情報リンク方式）に必要な情報を取得できます。このほか、電子申請API対象手続の所管行政機関から通知、案内等が発行されている場合、これらの情報を取得できます。

電子送達では、特段の申請・届出等を前提とせずに、行政手続を所管する行政機関から特定の利用者に対して発出される通知文書を取得できます。電子送達の利用にあたり、利用申込みを必要とする行政分野の場合、利用申込みを行うことにより、対象通知文書を取得できるようになります。

アカウント間情報共有では、gBizIDプライム、メンバー間の電子申請の申請案件、公文書、電子送達、電子送達の通知文書等の情報が共有可能です。

利用者認証では、OAuth2及びOpenID Connectに準拠したユーザー認可、アクセストークンの取得/再取得、アクセストークンの検証及び発行済みトークンの無効化が可能です。

電子申請API仕様へ

電子申請APIドキュメント

電子申請APIリファレンス

アカウント間情報共有（2023年3月13日より利用可能）

gBizIDプライム、メンバー間の電子申請の申請案件、公文書、電子送達、電子送達の通知文書等の情報を共有可能とする、アカウント間情報共有機能の提供を開始しました。電子申請APIにも当該機能を対象としたAPIを追加しました。
電子申請APIのアカウント間情報共有機能への対応に伴い、電子申請APIのバージョンを引き上げ、最新の電子申請APIをバージョン２としています。
なお、バージョン１も今までと同様にご利用いただけます（バージョン１の提供終了は予定していません）。
最終確認試験を実施する場合は、「最終確認試験テスト仕様書兼成績書（バージョン２）」をご利用下さい。

電子送達（2023年3月3日より利用可能）

電子送達機能を対象としたAPIの提供を開始しました。
最終確認試験を実施する場合は、「最終確認試験テスト仕様書兼成績書（バージョン２）」または、「最終確認試験テスト仕様書兼成績書（電子送達用）」をご利用下さい。

ソフトウェア開発事業者による一括紐付け（2022年8月12日より受付開始）

ソフトウェア開発事業者による一括紐付けの詳細は、以下の資料をご参照ください。

ソフトウェア開発事業者による一括紐付けについてZIP

申請・届出案件の紐付け設定については、外部連携APIサポート終了後も実施いただけますので、外部連携API対応ソフトウェアで申請・届出等実施した案件を電子申請API対応ソフトウェア（e-Gov電子申請アプリケーション）で参照する場合は、紐付け設定作業の実施をお願いいたします。
なお、e-Govのガバメントクラウド移行に伴うサービス停止に伴い、紐付け設定を一時的に停止し、ガバメントクラウドへの移行完了後、順次、紐付け設定を再開する予定です。停止時期については追ってご案内いたします。

APIに関するお問合せについて

電子申請API（外部連携APIを含む）の仕様やテスト環境の利用方法等については、e-Gov利用者サポートデスクとは異なる専用のお問合せ窓口を設置しています。

APIに関するお問合せ

（参考）外部連携API

外部連携APIについては、2024年1月31日をもってサポート終了いたしました。

API