はじめに
法人情報検索APIを使用すると、法人番号または法人名から簡単に法人情報を検索できます。 本ドキュメントでは、houjin_number
(法人番号検索)とhoujin_name
(法人名検索)の2つのAPIエンドポイントの使い方について詳しく解説します。
法人番号検索 API
法人番号を使って特定の法人情報を取得するためのAPIです。12桁または13桁の法人番号を指定して、該当する法人の詳細情報を取得します。
エンドポイント
GET https://houjin-search.tychy.jp/v1/houjin_number?number={法人番号}
パラメータ
パラメータ | 必須 | 説明 |
---|---|---|
number | はい | 検索したい法人の12桁または13桁の法人番号 |
レスポンス例(成功)
{ "corporate_number": "1234567890123", // 法人番号 "name": "サンプル株式会社", // 法人名 "kind": 301, // 法人種別(301: 株式会社、305: 合同会社など) "prefecture_name": "東京都", // 都道府県名 "city_name": "千代田区", // 市区町村名 "street_number": "架空町1丁目1番1号", // 町名・番地等 "prefecture_code": 13, // 都道府県コード "city_code": 101, // 市区町村コード "post_code": "1000001", // 郵便番号 "assignment_date": "2015-10-05", // 法人番号指定年月日 "update_date": "2023-04-01", // 最終更新年月日 "furigana": "サンプルカブシキガイシャ" // 法人名フリガナ }
法人名検索 API
法人名をキーワードにして法人情報を検索するためのAPIです。前方一致で検索し、条件に合う複数の法人情報を取得できます。また、入力された法人名から「株式会社」などの法人種別を自動的に除外した値で検索します。
検索機能の特徴
- 全角半角区別なし:検索時に全角文字と半角文字を区別せず検索します。例えば「アイウエオ」と「アイウエオ」、「ABC」と「ABC」は同じものとして扱われます。
- 前方一致検索:入力された検索キーワードで始まる法人名を検索します。
- 法人種別除外:「株式会社」「有限会社」などの法人種別は自動的に除外して検索します。
エンドポイント
GET https://houjin-search.tychy.jp/v1/houjin_name?name={法人名}&limit={取得件数}&offset={オフセット}
パラメータ
パラメータ | 必須 | デフォルト値 | 説明 |
---|---|---|---|
name | はい | - | 検索したい法人名(前方一致)。「株式会社」などの法人種別は自動的に除外されます。 |
limit | いいえ | 10 | 取得する最大件数(最大100件) |
offset | いいえ | 0 | 検索結果のオフセット(ページング用) |
レスポンス例(成功)
{ "corporations": [ // 検索結果の法人情報リスト { "corporate_number": "1234567890123", // 法人番号 "name": "サンプル株式会社", // 法人名 "kind": 301, // 法人種別(301: 株式会社) "prefecture_name": "東京都", // 都道府県名 "city_name": "千代田区", // 市区町村名 "street_number": "架空町1丁目1番1号", // 町名・番地等 "prefecture_code": 13, // 都道府県コード "city_code": 101, // 市区町村コード "post_code": "1000001", // 郵便番号 "assignment_date": "2015-10-05", // 法人番号指定年月日 "update_date": "2023-04-01", // 最終更新年月日 "furigana": "サンプルカブシキガイシャ" // 法人名フリガナ } ], "total_count": 1 // 検索結果の総件数 }
注意点
- 法人番号検索は完全一致検索のみをサポートしています。法人番号は12桁または13桁で指定できます。12桁の法人番号を指定した場合、チェックディジットを自動で計算して検索します。
- 法人名検索は前方一致検索で、入力された法人名から「株式会社」などの法人種別を自動的に除外した値で検索します。例えば「株式会社テスト」で検索した場合、「テスト」という文字で始まる法人名を持つ法人が検索されます。
- 検索結果は最大で指定された
limit
件数まで取得されます。デフォルトは10件です。 - 法人情報データは毎日更新されるため、常に最新の情報を取得できます。