Download OpenAPI specification:Download
事前登録された基本情報と選択された手続識別子をもとに電子申請を行うための申請データ構造として基本情報をセットしたデータ一式を取得する。
proc_id required | string = 16 characters 手続識別子 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "file_data": "string",
- "configuration_file_name": [
- "string"
], - "file_info": [
- {
- "form_id": "stringstringstring",
- "form_version": 1,
- "form_name": "string",
- "apply_file_name": "string",
- "xsl_file_name": "string",
- "server_check_file_name": "string",
- "schema_file_name": "string",
- "style_indication_file": "string"
}
]
}
}
プレ印字対象手続に対して、府省に問い合わせて、府省に登録されているプレ印字データを取得して返却する。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
required | Array of objects 申請届出識別情報 |
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データ |
{- "application_info": [
- {
- "label": "string",
- "value": "string"
}
], - "proc_id": "stringstringstri",
- "form_id": "stringstringstring",
- "form_version": 1,
- "file_data": "string"
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "apply_file": {
- "file_name": "string",
- "file_data": "string"
}
}
}
送信された申請データの形式チェックと申請処理を行い、到達番号等を応答する。
※再提出を行う場合も当APIを使用する。申請するデータの「初回受付番号」には申請受付番号の初回受付時の到達番号、「申請種別」には"再提出"を指定する。設定方法の詳細は、申請データ仕様共通データ仕様書を参照。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
proc_id required | string = 16 characters 手続識別子 |
required | object 申請データをZIPファイル形式で圧縮したものを設定 |
{- "proc_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "arrive_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "apply_type": "stri",
- "proc_name": "string",
- "ministry_name": "string",
- "submission_destination": "string",
- "apply_form": {
- "form": [
- {
- "form_name": "string"
}
], - "attached_file": [
- {
- "attached_file_name": "string"
}
]
}, - "apply_pay_list": [
- {
- "pay_number": "stringstringstri",
- "confirm_number": "string",
- "facility_number": "strin",
- "pay_name_kana": "string",
- "total_fee": 9223372036854776000,
- "pay_expired": "2019-08-24"
}
]
}, - "_links": {
- "self": "string",
- "status": "string"
}
}
送信された複数の申請データを受信し、後続の一括申請開始バッチに引き継ぐ情報を登録する。
※再提出を行う場合は、申請データ送信を使用すること。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
required | object 1つ以上の申請データをZIPファイル形式で圧縮したものを設定 |
{- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "send_number": "stringstringstring",
- "send_date": "stringstringstrings",
- "file_name": "string",
- "apply_count": 1
}, - "_links": {
- "self": "string",
- "list": "string",
- "report": "string"
}
}
補正申請可能な到達番号に対して、
送信された補正データの形式チェックを行い、指定された到達番号の申請案件に関する補正処理を行う。
※補正申請可能な到達番号について
・申請案件に関する通知取得の補正種別が"部分補正"であること。
・補正種別が"再提出"、"手続終了(再提出可)"の場合は、申請データ送信を使用すること。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
required | object 補正対象データをZIPファイル形式で圧縮したものを設定 |
{- "arrive_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "amend_date": "stringstringstrings"
}
}
指定された到達番号の取下げ処理を行う。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
required | object 取下げ依頼データをZIPファイル形式で圧縮したものを設定 |
{- "arrive_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "withdraw_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "proc_name": "string",
- "ministry_name": "string",
- "submission_destination": "string"
}
}
送信された申請データに対して、形式チェックを実行し、結果を応答する。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
proc_id required | string = 16 characters 手続識別子 |
required | object 申請データをZIPファイル形式で圧縮したものを設定 |
{- "proc_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "message": "string",
- "error_count": 9999,
- "report_list": [
- {
- "form_name": "string",
- "attached_file_name": "string",
- "file_name": "string",
- "item": "string",
- "content": "string"
}
]
}
}
期間等を指定して、申請案件の一覧情報を取得する。対象期間内の到達日時の申請案件を取得対象とする。
※送信番号のみを指定または対象期間及び取得件数/ページを指定
送信番号指定時 例:https://api.e-gov.go.jp/shinsei/v1/apply/lists?send_number=123456789012345678
対象期間及び取得件数/ページを指定時 例:https://api.e-gov.go.jp/shinsei/v1/apply/lists?date_from=2019-01-01&date_to=2019-02-28&limit=50&offset=0
send_number | string = 18 characters 送信番号 |
date_from | string <date> = 10 characters 取得対象期間開始日 |
date_to | string <date> = 10 characters 取得対象期間終了日 |
limit | integer <int32> [ 1 .. 50 ] 取得件数 |
offset | integer <int32> [ 1 .. 9999 ] 取得ページ番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "resultset": {
- "all_count": 9999,
- "limit": 1,
- "offset": 9999,
- "count": 9999
}, - "results": {
- "apply_list": [
- {
- "no": 1,
- "send_number": "string",
- "send_date": "string",
- "status": "string",
- "arrive_id": "stringstringstri",
- "arrive_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "proc_name": "string",
- "submission_destination": "string",
- "withdraw_flag": true,
- "pay_status": "string",
- "notice_count": 9999,
- "doc_count": 9999,
- "apply_pay_count": 9999,
- "notice_list": [
- {
- "notice_sub_id": 1,
- "issue_date": "stringstringstrings",
- "notice_data_type": "stri",
- "notice_title": "string",
- "notice_sentence": "string",
- "issuer_organization": "string",
- "correct_expired_date": "2019-08-24",
- "correct_completed_date": "2019-08-24"
}
], - "official_list": [
- {
- "notice_sub_id": 1,
- "allowed_date": "stringstringstrings",
- "doc_title": "string",
- "doc_download_expired_date": "2019-08-24",
- "doc_download_date": "2019-08-24",
- "sign": "st"
}
], - "apply_pay_list": [
- {
- "pay_number": "stringstringstri",
- "confirm_number": "string",
- "facility_number": "strin",
- "pay_name_kana": "string",
- "total_fee": 9223372036854776000,
- "pay_expired": "2019-08-24"
}
]
}
]
}, - "_links": {
- "self": "string",
- "previous": "string",
- "next": "string"
}
}
指定した申請案件の詳細情報を取得する。
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "status": "string",
- "arrive_id": "stringstringstri",
- "arrive_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "proc_name": "string",
- "submission_destination": "string",
- "withdraw_flag": true,
- "pay_status": "string",
- "notice_count": 9999,
- "doc_count": 9999,
- "apply_pay_count": 9999,
- "notice_list": [
- {
- "notice_sub_id": 1,
- "issue_date": "stringstringstrings",
- "notice_data_type": "stri",
- "notice_title": "string",
- "notice_sentence": "string",
- "issuer_organization": "string",
- "correct_expired_date": "2019-08-24",
- "correct_completed_date": "2019-08-24"
}
], - "official_list": [
- {
- "notice_sub_id": 1,
- "allowed_date": "stringstringstrings",
- "doc_title": "string",
- "doc_download_expired_date": "2019-08-24",
- "doc_download_date": "2019-08-24",
- "sign": "st"
}
], - "apply_pay_list": [
- {
- "pay_number": "stringstringstri",
- "confirm_number": "string",
- "facility_number": "strin",
- "pay_name_kana": "string",
- "total_fee": 9223372036854776000,
- "pay_expired": "2019-08-24"
}
]
}
}
申請データbulk送信の申請データに対して、後続の処理にて実行された形式チェックの実行結果を、取得して応答する。
リクエストの対象期間内に受信した申請データに対するエラーレポートを取得対象とする。
形式チェック実行にてチェックエラーが発生せずに到達した申請については、発行された到達番号等を応答する。
※送信番号のみを指定または対象期間及び取得件数/ページを指定
送信番号指定時 例:https://api.e-gov.go.jp/shinsei/v1/apply/report?send_number=123456789012345678
対象期間及び取得件数/ページを指定時 例:https://api.e-gov.go.jp/shinsei/v1/apply/report?date_from=2019-01-01&date_to=2019-02-28&limit=50&offset=0
send_number | string = 18 characters 送信番号 |
date_from | string <date> = 10 characters 取得対象期間開始日 |
date_to | string <date> = 10 characters 取得対象期間終了日 |
limit | integer <int32> [ 1 .. 30 ] 取得件数 |
offset | integer <int32> [ 1 .. 9999 ] 取得ページ番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "resultset": {
- "all_count": 9999,
- "limit": 1,
- "offset": 9999,
- "count": 9999
}, - "results": {
- "error_report_info": [
- {
- "send_number": "stringstringstring",
- "send_date": "stringstringstrings",
- "file_name": "string",
- "apply_count": 1,
- "arrive_count": 1,
- "error_count": 9999,
- "result": [
- {
- "arrive_id": "stringstringstri",
- "arrive_date": "stringstringstrings",
- "proc_name": "string",
- "folder_name": "string",
- "report_list": [
- {
- "detail": "string"
}
]
}
]
}
]
}, - "_links": {
- "self": "string",
- "previous": "string",
- "next": "string"
}
}
期間等を指定して、手続に関するご案内情報を一覧で取得する。
date_from required | string <date> = 10 characters 取得対象期間開始日 |
date_to required | string <date> = 10 characters 取得対象期間終了日 |
limit required | integer <int32> [ 1 .. 50 ] 取得件数 |
offset required | integer <int32> [ 1 .. 9999 ] 取得ページ番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "resultset": {
- "all_count": 9999,
- "limit": 1,
- "offset": 9999,
- "count": 9999
}, - "results": {
- "information_list": [
- {
- "information_id": "string",
- "issuer_organization": "string",
- "issue_date": "stringstringstrings",
- "proc_first_category": "string",
- "proc_second_category": "string",
- "proc_third_category": "string",
- "information_title": "string"
}
]
}, - "_links": {
- "self": "string",
- "previous": "string",
- "next": "string"
}
}
指定したお知らせ(手続に関するご案内)の情報を取得する。
information_id required | string [ 1 .. 16 ] characters お知らせID |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "information": {
- "issuer_organization": "string",
- "issue_date": "stringstringstrings",
- "proc_first_category": "string",
- "proc_second_category": "string",
- "proc_third_category": "string",
- "information_title": "string",
- "information_data": "string",
- "attached_file_list": [
- {
- "file_name": "string",
- "file_data": "string"
}
]
}
}
}
期間等を指定して、申請案件に関する通知情報を一覧で取得する。
date_from required | string <date> = 10 characters 取得対象期間開始日 |
date_to required | string <date> = 10 characters 取得対象期間終了日 |
limit required | integer <int32> [ 1 .. 50 ] 取得件数 |
offset required | integer <int32> [ 1 .. 9999 ] 取得ページ番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "resultset": {
- "all_count": 9999,
- "limit": 1,
- "offset": 9999,
- "count": 9999
}, - "results": {
- "notice_list": [
- {
- "issuer_organization": "string",
- "arrive_id": "stringstringstri",
- "notice_sub_id": 1,
- "notice_issue_date": "stringstringstrings",
- "type": "stri",
- "title": "string",
- "corporation_name_list": [
- {
- "corporation_name": "string"
}
], - "applicant_name_list": [
- {
- "applicant_name": "string"
}
], - "proc_name": "string"
}
]
}, - "_links": {
- "self": "string",
- "previous": "string",
- "next": "string"
}
}
指定した申請案件に関する通知の情報を取得する。
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
notice_sub_id required | integer <int32> [ 1 .. 999 ] 通知通番 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "notice": {
- "issuer_organization": "string",
- "notice_issue_date": "stringstringstrings",
- "notice_type": "stri",
- "correct_type": "string",
- "correct_expired_date": "2019-08-24",
- "correct_completed_date": "2019-08-24",
- "notice_title": "string",
- "notice_sentence": "string",
- "attached_file_list": [
- {
- "file_name": "string",
- "file_data": "string"
}
], - "corporation_name_list": [
- {
- "corporation_name": "string"
}
], - "applicant_name_list": [
- {
- "applicant_name": "string"
}
], - "proc_name": "string"
}
}
}
指定された申請案件の公文書を取得する。
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
notice_sub_id required | integer <int32> [ 1 .. 999 ] 通知通番 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "file_data": "string",
- "file_name_list": [
- {
- "file_name": "string"
}
]
}, - "_links": {
- "self": "string",
- "complete": "string"
}
}
指定された申請案件の公文書の取得日時を登録する。
また、申請案件に紐づくすべての公文書が取得された状態となった場合は、申請案件のステータスを手続完了に更新する。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
notice_sub_id required | integer <int32> [ 1 .. 999 ] 通知通番 |
{- "arrive_id": "stringstringstri",
- "notice_sub_id": 1
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "notice_sub_id": 1,
- "proc_name": "string",
- "doc_title": "string",
- "download_date": "stringstringstrings",
- "file_name_list": [
- {
- "file_name": "string"
}
]
}
}
送信された公文書に対して署名検証を行う。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
file_name required | string [ 1 .. 256 ] characters ファイル名 |
file_data required | string <byte> non-empty ファイル圧縮データ |
sig_verification_xml_file_name required | string [ 1 .. 256 ] characters 署名検証XMLファイル名 |
{- "file_name": "string",
- "file_data": "string",
- "sig_verification_xml_file_name": "string"
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "sig_verification_xml_file_name": "string",
- "attached_file_name": "string",
- "verify_result": [
- {
- "official": {
- "validation_result": "string",
- "certificate_result": "string",
- "certificate_count": 1,
- "publisher": "string",
- "owner": "string",
- "publisher_dn": "string",
- "owner_dn": "string",
- "serial_number": "string",
- "start_date": "stringstringstrings",
- "end_date": "stringstringstrings"
}, - "government": [
- {
- "publisher_dn": "string",
- "owner_dn": "string",
- "serial_number": "string",
- "start_date": "stringstringstrings",
- "end_date": "stringstringstrings"
}
]
}
]
}
}
電子納付金融機関一覧取得要求を受け付け、国庫金の電子納付が可能な金融機関一覧(金融機関名、ネットバンキングのサービス名、URL 等)を応答する。
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "bank_list": {
- "trust_bank": [
- {
- "initial_name": "s",
- "bank": [
- {
- "financial_name": "string",
- "service_name": "string",
- "url": "string"
}
]
}
], - "shinkin_bank": {
- "bank": [
- {
- "financial_name": "string",
- "url": "string"
}
]
}, - "credit_union": {
- "bank": [
- {
- "financial_name": "string",
- "url": "string"
}
]
}, - "norinchukin_bank": {
- "bank": [
- {
- "financial_name": "string",
- "url": "string"
}
]
}, - "labour_bank": {
- "bank": [
- {
- "financial_name": "string",
- "url": "string"
}
]
}
}, - "financial_type_list_date": "stringstri"
}
}
指定された到達番号に発行された手数料等の納付情報(到達番号、納付番号、確認番号、収納期間番号等)を応答する。
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "proc_name": "string",
- "apply_pay_list": [
- {
- "pay_number": "stringstringstri",
- "confirm_number": "string",
- "facility_number": "strin",
- "pay_name_kana": "string",
- "pay_expired": "2019-08-24",
- "total_fee": 9223372036854776000,
- "pay_status": "string",
- "pay_date": "2019-08-24",
- "pay_memo": "string",
- "pay_flag": "s"
}
]
}
}
電子納付金融機関サイトのURL(リダイレクト先)およびリダイレクト先へ受け渡すパラメータ情報(収納機関番号、国庫金コード、パラメータタグ名、情報リンクデータ)を応答する。
応答結果を受け、API対応ソフトウェア開発事業者側で電子納付金融機関サイトのURLへリダイレクトさせる必要がある。
・電子納付金融機関サイトのURL「応答結果.URLの値」
※リダイレクト先へは以下のパラメータを受け渡す。(POST送信)
・パラメータ名「skno」、パラメータ値「応答結果.facility_number(収納機関番号)の値」
・パラメータ名「bptn」、パラメータ値「応答結果.treasury_money_code(国庫金コード)の値」
・パラメータ名「応答結果.parameter_tag_name(パラメータタグ名)の値」、パラメータ値「応答結果.information_link_data(情報リンクデータ)をBASE64デコードした値」
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
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 手続識別子 |
{- "arrive_id": "stringstringstri",
- "pay_number": "stringstringstri",
- "bank_name": "string",
- "proc_id": "stringstringstri"
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "URL": "string",
- "facility_number": "strin",
- "treasury_money_code": "s",
- "parameter_tag_name": "string",
- "information_link_data": "string"
}
}
送信された申請データの形式チェックと電子送達の申込み処理を行い、到達番号等を応答する。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
proc_id required | string = 16 characters 手続識別子 |
required | object 申請データをZIPファイル形式で圧縮したものを設定 |
{- "proc_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "arrive_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "apply_type": "stri",
- "proc_name": "string",
- "ministry_name": "string",
- "submission_destination": "string",
- "apply_form": {
- "form": [
- {
- "form_name": "string"
}
], - "attached_file": [
- {
- "attached_file_name": "string"
}
]
}, - "apply_pay_list": [
- {
- "pay_number": "stringstringstri",
- "confirm_number": "string",
- "facility_number": "strin",
- "pay_name_kana": "string",
- "total_fee": 9223372036854776000,
- "pay_expired": "2019-08-24"
}
]
}, - "_links": {
- "self": "string",
- "status": "string"
}
}
指定した電子送達の申込みの詳細情報を取得する。
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "status": "string",
- "arrive_id": "stringstringstri",
- "arrive_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "proc_name": "string",
- "submission_destination": "string",
- "withdraw_flag": true,
- "pay_status": "string",
- "notice_count": 9999,
- "doc_count": 9999,
- "apply_pay_count": 9999,
- "notice_list": [
- {
- "notice_sub_id": 1,
- "issue_date": "stringstringstrings",
- "notice_data_type": "stri",
- "notice_title": "string",
- "notice_sentence": "string",
- "issuer_organization": "string",
- "correct_expired_date": "2019-08-24",
- "correct_completed_date": "2019-08-24"
}
], - "official_list": [
- {
- "notice_sub_id": 1,
- "allowed_date": "stringstringstrings",
- "doc_title": "string",
- "doc_download_expired_date": "2019-08-24",
- "doc_download_date": "2019-08-24",
- "sign": "st"
}
], - "apply_pay_list": [
- {
- "pay_number": "stringstringstri",
- "confirm_number": "string",
- "facility_number": "strin",
- "pay_name_kana": "string",
- "total_fee": 9223372036854776000,
- "pay_expired": "2019-08-24"
}
]
}
}
期間等を指定して、電子送達に関する一覧情報を取得する。
date_from required | string <date> = 10 characters 取得対象期間開始日 |
date_to required | string <date> = 10 characters 取得対象期間終了日 |
limit required | integer <int32> [ 1 .. 50 ] 取得件数 |
offset required | integer <int32> [ 1 .. 9999 ] 取得ページ番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "resultset": {
- "all_count": 9999,
- "limit": 1,
- "offset": 9999,
- "count": 9999
}, - "results": {
- "post_list": [
- {
- "ministry_message_id": "string",
- "type": "stri",
- "title": "string",
- "message_sentence": "string",
- "issuer_organization": "string",
- "issue_date": "stringstringstrings",
- "destination_mail_address": "string",
- "notice_data_list": [
- {
- "post_id": "string",
- "notice_data_name": "string",
- "notice_issue_date": "stringstringstrings",
- "download_expired_date": "stringstri",
- "download_date": "stringstringstrings",
- "sign": "st"
}
]
}
]
}, - "_links": {
- "self": "string",
- "previous": "string",
- "next": "string"
}
}
指定された電子送達の通知文書を取得する。
post_id required | string [ 1 .. 50 ] characters 電子送達識別子 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "notice_data_name": "string",
- "file_data": "string",
- "file_name_list": [
- {
- "file_name": "string"
}
]
}, - "_links": {
- "self": "string",
- "complete": "string"
}
}
指定された通知文書の取得日時を登録する。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
post_id required | string [ 1 .. 50 ] characters 電子送達識別子 |
{- "post_id": "string"
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "post_id": "string",
- "notice_data_name": "string",
- "download_date": "stringstringstrings"
}
}
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
client_id required | string API対応ソフトウェア開発事業者に発行されるソフトウェアID |
response_type required | string >= 4 characters レスポンス・タイプ「code」を指定する |
scope required | string スコープ「openid offline_access」を指定する |
redirect_uri required | string ログイン成功時にリダイレクトするURL |
state | string リクエストとコールバックの間で維持されるランダムな値 |
code_challenge | string API対応ソフトウェア開発事業者側でハッシュ値を生成して指定 |
code_challenge_method | string code_challengeで指定した文字列のハッシュアルゴリズムを指定 |
※使用者は呼び出しは行わないが、本呼び出しでリダイレクト先に認可コードが渡されることを意識する必要がある。
code required | string 認可コード |
state | string ユーザー認可リクエスト時に指定した「state」値 |
session_state required | string セッション状態を表す識別子 |
{- "error": "string",
- "error_description": "string"
}
ユーザー認可リクエストで返却された認可コードを認可サーバへ送信し、アクセストークンとアクセストークン更新用のリフレッシュトークンを取得する。
アクセストークン取得リクエストで取得したリフレッシュトークンを認可サーバへ送信し、アクセストークンとリフレッシュトークンを再取得する。
Content-Type required | string >= 33 characters application/x-www-form-urlencodedを設定 |
Authorization required | string Basic [client_id:client_secretをbase64でエンコードした値] |
grant_type required | string [ 13 .. 18 ] characters 取得時「authorization_code」固定 |
code required | string ユーザー認可リクエストで取得済の認可コード |
redirect_uri required | string ユーザー認可リクエストで指定した「redirect_uri」 |
code_verifier | string [ 43 .. 128 ] characters ユーザー認可リクエストで指定した「code_challenge」のハッシュ値の元となった文字列を指定 |
refresh_token required | string アクセストークン取得リクエストで取得したリフレッシュトークン |
{- "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"
}
取得したアクセストークンまたはリフレッシュトークンの有効性を検証し、トークンに関連付けられている情報を取得する。
Content-Type required | string >= 33 characters application/x-www-form-urlencodedを設定 |
Authorization required | string Basic [client_id:client_secretをbase64でエンコードした値] |
token required | string アクセストークン取得リクエストで取得したアクセストークンまたはリフレッシュトークン |
token_type_hint | string [ 12 .. 13 ] characters 「access_token」または「refresh_token」 |
{- "jti": "string",
- "exp": 0,
- "nbf": 0,
- "iat": 0,
- "iss": "string",
- "aud": "string",
- "sub": "string",
- "typ": "string",
- "azp": "string",
- "nonce": "string",
- "auth_time": 0,
- "session_state": "string",
- "email": "string",
- "email_verified": true,
- "acr": "string",
- "scope": "string",
- "egov_idp": "string",
- "egov_extidp_auth_time": 0,
- "egov_gbizid_account_type": "string",
- "client_id": "string",
- "username": "string",
- "active": true
}
e-Gov認可サーバとの認証状態を破棄し、ログアウトを行う。取得済みのアクセストークン、リフレッシュトークンが無効化される。
Content-Type required | string >= 33 characters application/x-www-form-urlencodedを設定 |
Authorization required | string Basic [client_id:client_secretをbase64でエンコードした値] |
refresh_token required | string アクセストークン取得リクエストで取得したリフレッシュトークン |
{- "error": "string",
- "error_description": "string"
}