API docs by Redocly

e-Gov電子申請API (2.0.0)

Download OpenAPI specification:Download

電子申請API v2のAPI仕様を表示しています。
従来のAPI仕様は、電子申請API v1を参照して下さい。

電子申請

手続選択:指定したAPI対象手続に係る申請データ構造（スケルトン）一式を取得する。

事前登録された基本情報と選択された手続識別子をもとに電子申請を行うための申請データ構造として基本情報をセットしたデータ一式を取得する。

path Parameters
proc_id
required
string = 16 characters

手続識別子
・16桁
・半角英数字

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

プレ印字データ取得:プレ印字データを取得する。

プレ印字対象手続に対して、府省に問い合わせて、府省に登録されているプレ印字データを取得して返却する。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
required
Array of objects

申請届出識別情報
繰り返し回数1～10

proc_id
required
string = 16 characters

手続識別子
・半角英数字

form_id
required
string = 18 characters

様式ID
・半角英数字

form_version
required
integer <int32> [ 1 .. 9999 ]

様式バージョン
・数字

file_data
required
string <byte> non-empty

申請書XMLデータ
・半角
・バイナリデータはBASE64エンコードしたものを使用する。

Responses

Request samples

Content type
application/json
{
  • "application_info": [
    ],
  • "proc_id": "stringstringstri",
  • "form_id": "stringstringstring",
  • "form_version": 1,
  • "file_data": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

申請データ送信：申請データの形式チェックと到達確認を行い、到達番号等を取得する。

送信された申請データの形式チェックと申請処理を行い、到達番号等を応答する。
※再提出を行う場合も当APIを使用する。申請するデータの「初回受付番号」には申請受付番号の初回受付時の到達番号、「申請種別」には"再提出"を指定する。設定方法の詳細は、申請データ仕様共通データ仕様書を参照。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Request Body schema: application/json
proc_id
required
string = 16 characters

手続識別子
・半角英数字

required
object

申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "proc_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    },
  • "_links": {
    }
}

申請データbulk送信:複数の申請データを送信し、形式チェック（バッチ）に引き渡す情報を登録する。

送信された複数の申請データを受信し、後続の一括申請開始バッチに引き継ぐ情報を登録する。
※再提出を行う場合は、申請データ送信を使用すること。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Request Body schema: application/json
required
object

１つ以上の申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    },
  • "_links": {
    }
}

補正データ送信:補正データの形式チェックを行い、補正を行う。

補正申請可能な到達番号に対して、
送信された補正データの形式チェックを行い、指定された到達番号の申請案件に関する補正処理を行う。
※補正申請可能な到達番号について
　・申請案件に関する通知取得の補正種別が"部分補正"であること。
　・補正種別が"再提出"、"手続終了(再提出可)"の場合は、申請データ送信を使用すること。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字

required
object

補正対象データをZIPファイル形式で圧縮したものを設定
構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "arrive_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

取り下げ依頼送信:取下げ依頼を行う。

指定された到達番号の取下げ処理を行う。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字

required
object

取下げ依頼データをZIPファイル形式で圧縮したものを設定
構成管理XMLファイル、取下げ依頼の申請書XMLファイル

Responses

Request samples

Content type
application/json
{
  • "arrive_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

形式チェック実行:申請データに対する形式チェックの実行結果を取得する。

送信された申請データに対して、形式チェックを実行し、結果を応答する。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
proc_id
required
string = 16 characters

手続識別子
・半角英数字

required
object

申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "proc_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

申請案件一覧取得:申請案件の一覧情報を取得する。

期間等を指定して、申請案件の一覧情報を取得する。対象期間内の到達日時の申請案件を取得対象とする。
※送信番号のみを指定または対象期間及び取得件数/ページを指定
　送信番号指定時 例:https://api.e-gov.go.jp/shinsei/v2/apply/lists?send_number=123456789012345678
　対象期間及び取得件数/ページを指定時　例:https://api.e-gov.go.jp/shinsei/v2/apply/lists?date_from=2019-01-01&date_to=2019-02-28&limit=50&offset=0

query Parameters
send_number
string = 18 characters

送信番号
・半角数字
・18桁
・送信番号で取得する場合のみ指定

date_from
string <date> = 10 characters

取得対象期間開始日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

date_to
string <date> = 10 characters

取得対象期間終了日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

limit
integer <int32> [ 1 .. 50 ]

取得件数
・数字
・1-2桁
・上限値50
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

offset
integer <int32> [ 1 .. 9999 ]

取得ページ番号
・数字
・1-4桁
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "resultset": {
    },
  • "results": {
    },
  • "_links": {
    }
}

申請案件取得:申請案件の詳細情報を取得する。

指定した申請案件の詳細情報を取得する。

path Parameters
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字
・16-18桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

エラーレポート取得:申請データbulk送信の申請データに対する形式チェックの実行結果に関するエラーレポートを取得する。

申請データbulk送信の申請データに対して、後続の処理にて実行された形式チェックの実行結果を、取得して応答する。
リクエストの対象期間内に受信した申請データに対するエラーレポートを取得対象とする。
形式チェック実行にてチェックエラーが発生せずに到達した申請については、発行された到達番号等を応答する。
※送信番号のみを指定または対象期間及び取得件数/ページを指定
　送信番号指定時 例:https://api.e-gov.go.jp/shinsei/v2/apply/report?send_number=123456789012345678
　対象期間及び取得件数/ページを指定時　例:https://api.e-gov.go.jp/shinsei/v2/apply/report?date_from=2019-01-01&date_to=2019-02-28&limit=50&offset=0

query Parameters
send_number
string = 18 characters

送信番号
・半角数字
・18桁
・送信番号で取得する場合のみ指定

date_from
string <date> = 10 characters

取得対象期間開始日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

date_to
string <date> = 10 characters

取得対象期間終了日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

limit
integer <int32> [ 1 .. 30 ]

取得件数
・数字
・1-2桁
・上限値30
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

offset
integer <int32> [ 1 .. 9999 ]

取得ページ番号
・数字
・1-4桁
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "resultset": {
    },
  • "results": {
    },
  • "_links": {
    }
}

手続に関するご案内一覧取得:手続に関するご案内情報のリストを取得する。

期間等を指定して、手続に関するご案内情報を一覧で取得する。

query Parameters
date_from
required
string <date> = 10 characters

取得対象期間開始日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01

date_to
required
string <date> = 10 characters

取得対象期間終了日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01

limit
required
integer <int32> [ 1 .. 50 ]

取得件数
・数字
・1-2桁
・上限値50

offset
required
integer <int32> [ 1 .. 9999 ]

取得ページ番号
・数字
・1-4桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "resultset": {
    },
  • "results": {
    },
  • "_links": {
    }
}

手続に関するご案内取得:お知らせ情報（手続に関するご案内）を取得する。

指定したお知らせ（手続に関するご案内）の情報を取得する。

path Parameters
information_id
required
string [ 1 .. 16 ] characters

お知らせID
・半角英数字
・1-16桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

申請案件に関する通知一覧取得:申請案件に関する通知情報のリストを取得する。

期間等を指定して、申請案件に関する通知情報を一覧で取得する。

query Parameters
date_from
required
string <date> = 10 characters

取得対象期間開始日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01

date_to
required
string <date> = 10 characters

取得対象期間終了日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01

limit
required
integer <int32> [ 1 .. 50 ]

取得件数
・数字
・1-2桁
・上限値50

offset
required
integer <int32> [ 1 .. 9999 ]

取得ページ番号
・数字
・1-4桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "resultset": {
    },
  • "results": {
    },
  • "_links": {
    }
}

申請案件に関する通知取得:申請案件に関する通知情報を取得する。

指定した申請案件に関する通知の情報を取得する。

path Parameters
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字
・16-18桁

notice_sub_id
required
integer <int32> [ 1 .. 999 ]

通知通番
・数字
・1-3桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

公文書取得:公文書を取得する。

指定された申請案件の公文書を取得する。

path Parameters
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字
・16-18桁

notice_sub_id
required
integer <int32> [ 1 .. 999 ]

通知通番
・数字
・1-3桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    },
  • "_links": {
    }
}

公文書取得完了:公文書の取得日時を登録する。

指定された申請案件の公文書の取得日時を登録する。
また、申請案件に紐づくすべての公文書が取得された状態となった場合は、申請案件のステータスを手続完了に更新する。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Request Body schema: application/json
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字

notice_sub_id
required
integer <int32> [ 1 .. 999 ]

通知通番
・数字

Responses

Request samples

Content type
application/json
{
  • "arrive_id": "stringstringstri",
  • "notice_sub_id": 1
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

公文書署名検証要求:公文書に付与された官職署名の検証を行う。

送信された公文書に対して署名検証を行う。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
file_name
required
string [ 1 .. 256 ] characters

ファイル名
・全半角

file_data
required
string <byte> non-empty

ファイル圧縮データ
・半角
・鑑ファイル、添付ファイル
・バイナリデータはBase64エンコードしたものを使用する。

sig_verification_xml_file_name
required
string [ 1 .. 256 ] characters

署名検証XMLファイル名
・半角英数字

Responses

Request samples

Content type
application/json
{
  • "file_name": "string",
  • "file_data": "string",
  • "sig_verification_xml_file_name": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

国庫金電子納付取扱金融機関一覧取得:国庫金電子納付が可能な金融機関一覧を取得する。

電子納付金融機関一覧取得要求を受け付け、国庫金の電子納付が可能な金融機関一覧（金融機関名、ネットバンキングのサービス名、URL 等）を応答する。

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

電子納付情報一覧取得:納付情報を取得する。

指定された到達番号に発行された手数料等の納付情報（到達番号、納付番号、確認番号、収納期間番号等）を応答する。

path Parameters
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字
・16-18桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

電子納付金融機関サイト表示:電子納付金融機関サイトのURLを取得する。

電子納付金融機関サイトのURL（リダイレクト先）およびリダイレクト先へ受け渡すパラメータ情報（収納機関番号、国庫金コード、パラメータタグ名、情報リンクデータ）を応答する。

応答結果を受け、API対応ソフトウェア開発事業者側で電子納付金融機関サイトのURLへリダイレクトさせる必要がある。
　・電子納付金融機関サイトのURL「応答結果．URLの値」
※リダイレクト先へは以下のパラメータを受け渡す。（POST送信）
　・パラメータ名「skno」、パラメータ値「応答結果．facility_number（収納機関番号）の値」
　・パラメータ名「bptn」、パラメータ値「応答結果．treasury_money_code（国庫金コード）の値」
　・パラメータ名「応答結果．parameter_tag_name（パラメータタグ名）の値」、パラメータ値「応答結果．information_link_data（情報リンクデータ）をBASE64デコードした値」

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字

pay_number
required
string = 16 characters

納付番号
・半角英数字

bank_name
required
string [ 1 .. 256 ] characters

金融機関名称
・全半角

proc_id
required
string = 16 characters

手続識別子
・半角英数字

Responses

Request samples

Content type
application/json
{
  • "arrive_id": "stringstringstri",
  • "pay_number": "stringstringstri",
  • "bank_name": "string",
  • "proc_id": "stringstringstri"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

電子送達

電子送達利用申込み：申請データの形式チェックと到達確認を行い、到達番号等を取得する。

送信された申請データの形式チェックと電子送達の申込み処理を行い、到達番号等を応答する。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※電子送達はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Request Body schema: application/json
proc_id
required
string = 16 characters

手続識別子
・半角英数字

required
object

申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "proc_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    },
  • "_links": {
    }
}

電子送達状況確認:電子送達の申込状況を取得する。

指定した電子送達の申込みの詳細情報を取得する。

path Parameters
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字
・16-18桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※電子送達はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

電子送達一覧取得:電子送達のリストを取得する。

期間等を指定して、電子送達に関する一覧情報を取得する。

query Parameters
date_from
required
string <date> = 10 characters

取得対象期間開始日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01

date_to
required
string <date> = 10 characters

取得対象期間終了日
・半角
・10桁
・YYYY-MM-DD
　例：2017-09-01

limit
required
integer <int32> [ 1 .. 50 ]

取得件数
・数字
・1-2桁
・上限値50

offset
required
integer <int32> [ 1 .. 9999 ]

取得ページ番号
・数字
・1-4桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "resultset": {
    },
  • "results": {
    },
  • "_links": {
    }
}

電子送達取得:電子送達を取得する。

指定された電子送達の通知文書を取得する。

path Parameters
post_id
required
string [ 1 .. 50 ] characters

電子送達識別子
・半角英数字
・1-50桁

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※電子送達はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    },
  • "_links": {
    }
}

電子送達取得完了:電子送達の取得日時を登録する。

指定された通知文書の取得日時を登録する。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※電子送達はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Request Body schema: application/json
post_id
required
string [ 1 .. 50 ] characters

電子送達識別子
・半角英数字
・1-50桁

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

アカウント間情報共有

情報共有一覧取得:アカウント間情報共有の設定中の情報を応答する。

アカウント間情報共有の設定中の情報を応答する。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※アカウント間情報共有はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

情報共有設定:指定されたアカウント間情報共有の設定を行う。

指定されたアカウント間情報共有の設定を行う。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※アカウント間情報共有はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Request Body schema: application/json
gbiz_id
required
string [ 1 .. 128 ] characters

共有対象のgBizIDのアカウントID(メールアドレス)
・半角

official_doc_permission
required
string [ 4 .. 8 ] characters

公文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限

post_doc_permission
required
string [ 4 .. 8 ] characters

電子送達の通知文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限

Responses

Request samples

Content type
application/json
{
  • "gbiz_id": "string",
  • "official_doc_permission": "string",
  • "post_doc_permission": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

情報共有更新:指定されたアカウント間情報共有の更新を行う。

指定されたアカウント間情報共有の更新を行う。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※アカウント間情報共有はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Request Body schema: application/json
gbiz_id
required
string [ 1 .. 128 ] characters

共有中のgBizIDのアカウントID(メールアドレス)
・半角

official_doc_permission
required
string [ 4 .. 8 ] characters

公文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限

post_doc_permission
required
string [ 4 .. 8 ] characters

電子送達の通知文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限

Responses

Request samples

Content type
application/json
{
  • "gbiz_id": "string",
  • "official_doc_permission": "string",
  • "post_doc_permission": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

情報共有解除:指定されたアカウント間情報共有の解除を行う。

指定されたアカウント間情報共有の解除を行う。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※アカウント間情報共有はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Request Body schema: application/json
gbiz_id
required
string [ 1 .. 128 ] characters

共有中で解除を実施したいgBizIDのアカウントID(メールアドレス)
・半角

Responses

Request samples

Content type
application/json
{
  • "gbiz_id": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

共有設定確認:指定されたアカウント間情報共有の有効化設定を行う。

指定されたアカウント間情報共有の有効化設定を行う。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作
※アカウント間情報共有はトライアル非対応のため、設定を行ってもトライアルにはなりません。

Request Body schema: application/json
gbiz_id
required
string [ 1 .. 128 ] characters

共有依頼元のgBizIDのアカウントID(メールアドレス)
・半角

share_acceptance
required
string [ 4 .. 6 ] characters

共有設定の許可/不許可
・半角
ACCEPT：許可する
DENY：許可しない

Responses

Request samples

Content type
application/json
{
  • "gbiz_id": "string",
  • "share_acceptance": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

利用者認証

ユーザー認可:ユーザー認可リクエストを行い、認証・同意画面を表示する。

e-Gov認可サーバの認証・同意画面を返却後、ユーザーがログイン及び同意を実施することにより認可コードが発行される。
　全項目指定時
　　例：https://account.e-gov.go.jp/auth/auth?client_id=X99XKwoHFQsFrmxR&response_type=code&scope=openid%20offline_access&redirect_uri=https%3A%2F%2Fsample.com%2F&
　　　　state=e6a7c8b9-0884-4a17-bb51-42728853e958&code_challenge=_RpfHqw8pAZIomzVUE7sjRmHSM543WVdC4o-Kc4_3C0&code_challenge_method=S256
　必須項目のみ指定時
　　例：https://account.e-gov.go.jp/auth/auth?client_id=X99XKwoHFQsFrmxR&response_type=code&scope=openid%20offline_access&redirect_uri=https%3A%2F%2Fsample.com%2F

query Parameters
client_id
required
string

API対応ソフトウェア開発事業者に発行されるソフトウェアID
・半角英数字

response_type
required
string >= 4 characters

レスポンス・タイプ「code」を指定する
・半角英数字

scope
required
string

スコープ「openid offline_access」を指定する
・半角英数字
　例：scope=openid%20offline_access

redirect_uri
required
string

ログイン成功時にリダイレクトするURL
APIキー発行時に指定したリダイレクトするURL（API対応ソフトウェア開発事業者がログイン後に遷移させたいURL）を「URLエンコード」して指定する
・半角英数字

state
string

リクエストとコールバックの間で維持されるランダムな値
API対応ソフトウェア開発事業者側で任意に生成して指定する
・半角英数字
・CSRF対策

code_challenge
string

API対応ソフトウェア開発事業者側でハッシュ値を生成して指定
ハッシュアルゴリズムは、「SHA-256」とし、ハッシュ値は16進数の値として扱い、「BASE64URLエンコード」して指定する
※BASE64エンコードではないことに注意
ハッシュ値の元となる文字列の制限については「アクセストークン取得」の「code_verifier」を参照
・半角英数字
・43-128桁
・PKCE対策

code_challenge_method
string

code_challengeで指定した文字列のハッシュアルゴリズムを指定
ハッシュアルゴリズム「S256」を指定する
・半角英数字
・PKCE対策

Responses

ユーザー認可(リダイレクトでの認可コード送信):リダイレクト先に認可コードを渡す。

※使用者は呼び出しは行わないが、本呼び出しでリダイレクト先に認可コードが渡されることを意識する必要がある。

query Parameters
code
required
string

認可コード
・半角英数字

state
string

ユーザー認可リクエスト時に指定した「state」値
・半角英数字
・リクエスト時に保存していた値をコールバック時の値が一致するかAPI対応ソフトウェア開発事業者で確認する。

session_state
required
string

セッション状態を表す識別子
・半角英数字

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

アクセストークン取得/再取得:アクセストークンとリフレッシュトークンを取得/再取得する。

ユーザー認可リクエストで返却された認可コードを認可サーバへ送信し、アクセストークンとアクセストークン更新用のリフレッシュトークンを取得する。

アクセストークン取得リクエストで取得したリフレッシュトークンを認可サーバへ送信し、アクセストークンとリフレッシュトークンを再取得する。

header Parameters
Content-Type
required
string >= 33 characters

application/x-www-form-urlencodedを設定

Authorization
required
string

Basic [client_id:client_secretをbase64でエンコードした値]
・半角英数字
client_id:API対応ソフトウェア開発事業者に発行されるソフトウェアID
client_secret:API対応ソフトウェア開発事業者に発行されるAPIキー

Request Body schema: application/x-www-form-urlencoded
grant_type
required
string [ 13 .. 18 ] characters

取得時「authorization_code」固定
再取得時「refresh_token」固定
・半角英数字

code
required
string

ユーザー認可リクエストで取得済の認可コード
※取得時のみ指定
・半角英数字

redirect_uri
required
string

ユーザー認可リクエストで指定した「redirect_uri」
※取得時のみ指定
・半角英数字

code_verifier
string [ 43 .. 128 ] characters

ユーザー認可リクエストで指定した「code_challenge」のハッシュ値の元となった文字列を指定
※取得時のみ指定
・半角英数字
・PKCE対策

refresh_token
required
string

アクセストークン取得リクエストで取得したリフレッシュトークン
※再取得時のみ指定
・半角英数字

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "refresh_expires_in": 0,
  • "refresh_token": "string",
  • "token_type": "string",
  • "id_token": "string",
  • "not-before-policy": 0,
  • "session_state": "string",
  • "scope": "string"
}

アクセストークン検証:アクセストークンまたはリフレッシュトークンの有効性を検証する。

取得したアクセストークンまたはリフレッシュトークンの有効性を検証し、トークンに関連付けられている情報を取得する。

header Parameters
Content-Type
required
string >= 33 characters

application/x-www-form-urlencodedを設定

Authorization
required
string

Basic [client_id:client_secretをbase64でエンコードした値]
・半角英数字
client_id:API対応ソフトウェア開発事業者に発行されるソフトウェアID
client_secret:API対応ソフトウェア開発事業者に発行されるAPIキー

Request Body schema: application/x-www-form-urlencoded
token
required
string

アクセストークン取得リクエストで取得したアクセストークンまたはリフレッシュトークン
・半角英数字

token_type_hint
string [ 12 .. 13 ] characters

「access_token」または「refresh_token」
・半角英数字

Responses

Response samples

Content type
application/json
{
  • "exp": 0,
  • "iat": 0,
  • "auth_time": 0,
  • "jti": "string",
  • "iss": "string",
  • "aud": "string",
  • "sub": "string",
  • "typ": "string",
  • "azp": "string",
  • "session_state": "string",
  • "email": "string",
  • "email_verified": true,
  • "acr": "string",
  • "scope": "string",
  • "sid": "string",
  • "egov_idp": "string",
  • "egov_extidp_auth_time": 0,
  • "egov_gbizid_account_type": "string",
  • "client_id": "string",
  • "username": "string",
  • "active": true
}

ログアウト:ログアウトを行う。

e-Gov認可サーバとの認証状態を破棄し、ログアウトを行う。取得済みのアクセストークン、リフレッシュトークンが無効化される。

header Parameters
Content-Type
required
string >= 33 characters

application/x-www-form-urlencodedを設定

Authorization
required
string

Basic [client_id:client_secretをbase64でエンコードした値]
・半角英数字
client_id:API対応ソフトウェア開発事業者に発行されるソフトウェアID
client_secret:API対応ソフトウェア開発事業者に発行されるAPIキー

Request Body schema: application/x-www-form-urlencoded
refresh_token
required
string

アクセストークン取得リクエストで取得したリフレッシュトークン
・半角英数字

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}