その他令和8年3月24日
住登外者宛名番号付番API仕様書
出典：官報発行サイトの掲載情報を加工しています。AI 抽出や OCR に誤りが含まれる可能性があるため、 重要な確認は公式原文を基準にしてください。
本文と原文の対照
まず左側の本文を読み、必要な箇所だけ原文ページで確認できる構成です。
← 同日の官報に戻る
原文対照の表示オプション
住登外者宛名番号付番API仕様書
本文はAI抽出です。左の段落を選ぶと、右側の官報原文画像で該当箇所を照合できます。
概要
本資料は、住登外者宛名番号付番APIをAPIコールして実施するためのAPI仕様について記述したものである。
「地方公共団体情報システムの標準化に関する法律第7条第1項に規定する各地方公共団体情報システムに共通する基準のうち電磁的記録において用いられる用語及び符号の相互運用性の確保その他の地方公共団体情報システムに係る互換性の確保に関する基準を定める命令(令和8年デジタル庁・総務省令第8号)」の文字要件で定めた標準仕様に従う必要がある。
本APIでリクエストするHTTPメソッドはPOSTとする。
提供可能なAPI一覧について
提供するAPIコールは、以下のとおりである。
| No. | APIコール名 | 操作種類 | 概要 |
| 1 | app_submit/v10/jutogaishaatenbangofuuban goidban | Create | 基幹業務システムの住登外者宛名番号付番依頼機能 - 住登外者宛名番号管理機能の住登外者宛名番号付番依頼受信機能、住登外者宛名基本情報送信機能 リクエストパラメータ元に住登外者宛名番号の付番依頼を行う。(付表第1を参照) |
APIコールにおける補足事項
■通信プロトコル
本APIを利用する際の通信プロトコルは、HTTP1.1以上を採用する。
■要求元認証
本APIの要求元認証は、OAuth2.0 アクセス・トークン: Bearerタイプ、認証方式: client_secret_jwtで行う。
※将来的にID連携に係る対応方針の整理が進められる可能性を踏まえ、当面の間、暫定措置として、以下の認証方式の実装も可能とする。
-OAuth2.0 (アクセストークン: Bearer client secret basic)
シーケンス図
| 別表第四付表第一(第二条関係) |
| 使用方法 |
| 本APIを使用して住登外者宛名番号を付翻、登録する。 |
| 正常に登録が完了した場合は、処理結果情報が返却される。正常に登録されなかった場合は、失敗した理由がエラーメッセージとして返却される。 |
| リクエスト/レスポンスは共にJSON形式とする。 |
| HTTPメソッド: POST |
| 留意事項 |
| 本APIが正常に終了した場合は、HTTPステータスコード200とJSON形式のレスポンスオブジェクトが返却される。(付表第1を参照) |
| 送信したパラメータのチェックにエラーとなった場合は、HTTPステータスコード400とJSON形式のレスポンスオブジェクトが返却される。(付表第1を参照) |
| 認証情報の取得できないまたはアクセストークンが未指定の場合は、HTTPステータスコード401とJSON形式のレスポンスオブジェクトが返却される。(付表第1を参照) |
| 処理が30秒以上※経過した場合は、タイムアウトとなる。タイムアウトが発生した場合、原則HTTPステータスコード500番台のエラーが返却される。(JSON形式では返却されない) ※目安として30秒と記載しているが、性能テストを踏まえ、適切なタイムアウト時間を設定されたい |
| サービスメンテナンス時も同様に原則HTTPステータスコード500番台のエラーが返却される。(JSON形式では返却されない) |
| 上記以外の想定外エラーが発生した場合は、HTTPステータスコード503とJSON形式のレスポンスオブジェクトが返却される。(付表第1を参照) |
| ※1【必須】:「○」･･･パラメータまたはオフセットが必ず出現する。 |
| ※※で始まる記載については、パラメータ一式条件付き必須(の場合の条件を記載 |
| リクエストID |
| app_submit/v10/jutogashatenabango/touban_R01 |
| Content-Type |
| application/json |
| パラメータ |
| 項番 パラメータ名 項目名 項目説明 必須 データ 桁数 検索 備考 |
| 型 方法 |
| 1 shikuchosonkodo 市区町村コード 市区町村を一意に識別するコード X 6 「全国地方公共団体コード」(総務省)に従って6桁のコード値を設定すること |
| (指定都市においては区までを特 |
| 定) |
| 2 kojinhbango 個人番号 特定の個人を識別するための番号の X 12 |
| 利用等に関する法律(平成25年法 |
| 律第27号)に基づき、行政手続に |
| おける特定の個人を識別するために |
| 各市区町村から住民に指定される番 |
| 号 |
| 3 shimei 氏名 住登外者の氏名 N 100 ・日本人住登外者の場合は、氏と名の間に全角の空白を一文字入れる |
| ・漢字氏名がある外国人住登外者の場合は、ローマ字氏名+漢字氏名の形で記載 |
| し、間に全角の空白を一文字入れる |
| ・外国人住登外者の場合は、氏名を構成する要素(氏と名、名(ファーストネーム)と |
| 中間名(ミドルネーム)と氏(ラストネーム)など)の間に全角の空白を一文字入れる |
| ・氏名未定でない場合は出力すること |
| 4 uji_nihonjin 氏_日本人 日本人住登外者の氏 N 50 日本人住登外者の場合は出力すること |
| 5 na_nihonjin 名_日本人 日本人住登外者の名 N 50 日本人住登外者の場合かつ名未定ではない場合は出力すること |
| 6 shimei_gaikkokujinromaji 氏名_外国人ローマ字 外国人住登外者の氏名(ローマ N 100 ・氏名を構成する要素(氏と名、名(ファーストネーム)と中間名(ミドルネーム)と氏 |
| 字) (ラストネーム)など)の間に全角の空白を一文字入れる |
| ・ローマ字表記での氏名を有する外国人住登外者は出力すること |
| 7 shimei_gaikkokujinkanji 氏名_外国人漢字 外国人住登外者の氏名(漢字) N 100 ・氏名を構成する要素(氏と名、名(ファーストネーム)と中間名(ミドルネーム)と氏 |
| (ラストネーム)など)の間に全角の空白を一文字入れる |
| ・漢字表記での氏名を有する外国人住登外者は出力すること |
p.71 / 2
読み込み中...
テキスト領域
選択中
非公開 (PII)