統計表令和8年3月24日

住登外者宛名基本情報照会API仕様書(別表第五付表第一)

掲載日
令和8年3月24日
号種
号外
原文ページ
p.80
出典:官報発行サイト(内閣府)の掲載情報をもとに整理しています。重要な確認は公式原文を基準にしてください。

本文と原文の対照

まず左側の本文を読み、必要な箇所だけ原文ページで確認できる構成です。

← 同日の官報に戻る
原文対照の表示オプション

住登外者宛名基本情報照会API仕様書(別表第五付表第一)

令和8年3月24日|p.80

左の本文を選ぶと、右側の官報原文画像で該当箇所を照合できます。

公式原文あり本文テキスト画像照合可誤りを報告
別表第五付表第一(第二条関係)
使用方法
本APIを使用して住登外者宛名基本情報を照会する。抽出条件は、パラメータに設定した値のAND条件とし、パラメータが未入力の場合は抽出条件の対象外となる。
正常に検索が完了した場合は、処理結果情報が返却される。既に宛名番号が付番されている住登外者宛名基本情報がある場合、候補となる住登外者宛名基本情報が返却される。正常に登録されなかった場合は、失敗した理由がエラーメッセージとして返却される。
リクエスト/レスポンスは共にJSON形式とする。
HTTPメソッド:POST
留意事項
本APIが正常に終了した場合は、HTTPステータスコード200とJSON形式のレスポンスボディが返却される。(付表第2を参照)
データを複数取得する際に件数を分割して取得しなければならない場合(データ量が多く30秒以上経過しタイムアウトになることが予想の場合、一部データを取得したい場合等)、パラメータにlimit、offsetを記載する。
送信したパラメータのチェックにてエラーとなった場合は、HTTPステータスコード400とJSON形式のレスポンスボディが返却される。(付表第2を参照)
認証情報が取得できない、またはリクエストが未指定の場合は、HTTPステータスコード401とJSON形式のレスポンスボディが返却される。(付表第2を参照)
処理が30秒以上※経過した場合は、タイムアウトとなる。タイムアウトが発生した場合、原則HTTPステータスコード500番台のエラーが返却される。(JSON形式では返却されない) ※目安として30秒と記載しているが、性能テストを踏まえ、適切なタイムアウト時間を設定されたい
サービスメンテナンス時も同様に原則HTTPステータスコード500番台のエラーが返却される。(JSON形式では返却されない)
上記以外の想定外エラーが発生した場合は、HTTPステータスコード503とJSON形式のレスポンスボディが返却される。(付表第2を参照)
※【必須】:[○]・・・パラメータまたはオブジェクトが必ず出現する。[] (空白)・・・パラメータまたはオブジェクトが出現しない場合がある。
※※で始まる記載については、パラメータ・対象条件付き必須」の場合の条件を記載
リクエストID
app_submit/v1.0/jutogaishaatenakihonjohosyokai_R01
Content-Type
application/json
パラメータ
項番 パラメータ名 項目名 項目説明 必須 データ 型 桁数 検索方 法 備考
1 shikuchosonkodo 市区町村コード 市区町村を一意に識別するコード (指定都府県においては区までを特 定) ○ X 6 「全国地方公共団体コード」(総務省)に従って6桁のコード値を設定すること
2 atenabango 宛名番号 ・自治体内において、個人を一意に 識別する番号 ・住登外者宛名番号管理機能にお いては「住登外者宛名番号」を管理 する。 X 15
3 atenabango_kensakujuken 宛名番号_検索条件 宛名番号の検索条件を指定する (0:完全一致、1:部分一致) X 1 ※※宛名番号を入力した場合は必須
4 kojinhbango 個人番号 特定の個人を識別するための番号の 利用等に関する法律(平成25年法 律第27号)」に基づき、行政手続に おける特定の個人を識別するために 各市町村から住民に指定される番 号 X 12 完全 一致
5 shimei 氏名 住登外者の氏名 N 100 ・日本人住登外者の場合は、氏と名の間に全角の空白を一文字入れる ・漢字氏名がある外国人住登外者の場合は、ローマ字氏名+漢字氏名の形で記載、間 に全角の空白を一文字入れる ・外国人住登外者の場合は、氏名を構成する要素(氏と名、名(ファーストネーム)と中 間名(ミドルネーム)と氏(ラストネーム)など)の間に全角の空白を一文字入れる ・氏名未定でない場合は出力すると
6 shimei_kensakujuken 氏名_検索条件 住登外者の氏名の検索条件を指定 する(0:完全一致、1:部分一 致) X 1 ※※氏名を入力した場合は必須
7 uji_nihonjin 氏_日本人 日本人住登外者の氏 N 50 日本人住登外者の場合は出力すると
読み込み中...
住登外者宛名基本情報照会API仕様書(別表第五付表第一) - 第80頁
テキスト領域
選択中
非公開 (PII)
関連する新着公告を見逃さないために

Pro プランでは会社名・機関名・キーワードを監視条件として保存し、新着掲載を継続確認できます。14日間無料で試せます。

監視機能の詳細を見る →