Look up a Japanese postal code / 郵便番号から住所

Look up the address (prefecture, city, town) for a 7-digit Japanese postal code, from Japan Post data. Accepts forms like 1000001, 100-0001 or 〒100-0001. One code can cover several towns; all are returned. town_detail holds the parenthesized part as written by Japan Post (e.g. chome ranges or building floors). If the code is a business-specific code (大口事業所個別番号) or a PO box code, the business is returned in offices. / 郵便番号から住所（都道府県・市区町村・町域）。日本郵便のデータ。1つの郵便番号に町域が複数あれば、すべて返す。事業所の個別郵便番号なら、事業所名と所在地を offices に返す。

get/v1/postal-codes/lookup

Request

  • Base URL: https://biz.ossalt.jp
  • URL: https://biz.ossalt.jp/v1/postal-codes/lookup
  • Auth: none declared

Query parameters

postal_codestring required

7-digit postal code, hyphen optional / 郵便番号（7桁、ハイフンは任意）

Response

OK

resultobject required

The answer / 結果

sourceobject required

Source and verification / 出典と照合の状況

as_ofstring required

Reference date in Japan time (YYYY-MM-DD) / 基準日（日本時間）

notesstring[] required

Assumptions such as estimated values / 前提（見込みの値など）

flagsstring[] required

flags holds machine-readable codes: estimated (a value is an estimate, e.g. a future equinox day — tell the user), unverified (year not yet checked against Cabinet Office data — tell the user), assumes_current_era (a future date written in the current era — tell the user), outside_era (the era date given is outside that era), weekday_mismatch, closed (the company's registry record is closed — tell the user), excluded_from_search, truncated, not_found, exact_match_only, partial, ambiguous, city_not_found, ambiguous_city.

Changes

No recorded changes to this operation across all 1 revision of this API.