法人情報検索API
本APIは、プレミアムプランご購読のお客様のみが利用できます。
GET /v1/houjinbangou?q=...&offset=...&limit=...&mode=...&facet_area=...&facet_kind=...&facet_process=...&facet_close_cause=...
与えられた検索クエリを元に、該当する法人情報リソースを取得します。
リソースURL
https://api.kenall.jp/v1/houjinbangou
パラメーター
名前 | 型 | 必須かどうか | 説明 | 例 |
---|---|---|---|---|
q | string | 必須 | 検索クエリ。クエリの仕様については検索クエリの仕様を参照のこと。 | "株式会社オープンコレクター" |
offset | number | 省略可 | 結果を取得するオフセット値。省略した場合は0と見なされる。 | 0 |
limit | number | 省略可 | 最大取得件数を指定する。1以上100以下の値を指定できる。 | 50 |
mode | string | 省略可 | 法人名の検索モードの変更。部分一致検索(partial )、完全一致検索(法人種別込み)(exact_with_kind )、完全一致検索(法人種別抜き)(exact )かを指定する。デフォルトはpartial 。法人名以外は常に部分一致。詳細は検索モードを参照 | "exact" |
normalize_name | string | 省略可 | true にすると、法人名を正規化する。詳細は法人名の正規化を参照のこと。 | "false" |
facet_area | string | 省略可 | 地域ファセットの階層を指定する。詳細はファセットを参照 | "/東京都" |
facet_kind | string | 省略可 | 法人種別ファセットの階層を指定する。詳細はファセットを参照 | "/株式会社" |
facet_process | string | 省略可 | 処理区分ファセットの階層を指定する。詳細はファセットを参照 | "/新規" |
facet_close_cause | string | 省略可 | 閉鎖事由ファセットの階層を指定する。詳細はファセットを参照 | "/清算の結了等" |
検索クエリの仕様
デフォルトは部分一致検索です。法人名の検索については、検索モードの変更によって、完全一致(法人種別込み)と完全一致(法人種別抜き)の変更が可能です。詳細は検索モードを参照してください。
- 法人名以外のフィールドは常に部分一致検索のみ行います。
検索ワードは一つ以上の半角スペース、タブまたは改行文字で区切ります。
検索ワードの間に
AND
もしくはOR
といったキーワード文字列を挟むと、「かつ」「もしくは」といった条件で検索が可能です。キーワード文字列がない場合は「もしくは」となります。- (例1)
オープン AND コレクター
→ 「オープン」「コレクター」の両方を含むレコードを検索する。 - (例2)
オープン OR コレクター
→ 「オープン」もしくは「コレクター」 (またはその両方) を含むレコードを検索する。 - (例3)
オープン コレクター
→ 「オープン」もしくは「コレクター」 (またはその両方) を含むレコードを検索する。
- (例1)
特定の項目のみを対象に検索を行いたいときは、項目名に続けて
:
(半角コロン) を記述し、その後にキーワード文字列を記載します。- (例) 法人名に「オープンコレクター」を含む法人情報を取得する →
name:オープンコレクター
- (例) 法人名に「オープンコレクター」を含む法人情報を取得する →
キーワード文字列は正規化されます。詳細は検索の正規化を参照してください。
- 全角・半角どちらでも入力可能
- (例)
オープンコレクター
(半角カナ) →オープンコレクター
を検索する。
- (例)
- かな小文字・大文字どちらでも入力可能
- (例)
キヨウトフ
→キョウトフ
、キヨウトフ
のどちらかを含むレコードを検索する。
- (例)
- 歴史的仮名遣い・現代仮名遣いどちらでも入力可能
- (例)
ゐろはにほへと
→ゐろはにほへと
、いろはにほへと
のどちらかを含むレコードを検索する。
- (例)
- 旧字体・異体字・新字体いずれでも入力可能。詳細は旧字体・非標準文字の正規化を参照してください。
- (例)
株式會社オープンコレクター
→株式会社オープンコレクター
を検索する。
- (例)
- 全角・半角どちらでも入力可能
特定のファセットの階層以下の情報を取得したい場合は下記のクエリを使用します。詳細はファセットを参照してください。
- (例1)
_facet_area:/宮城県
- (例2)
_facet_kind:/株式会社
- (例1)
検索対象フィールド
検索クエリで指定できるフィールドは以下の通りです。
検索項目 | 型 | 説明 | 例 |
---|---|---|---|
name | string | 商号又は名称。150文字を超過した場合は切り捨てられている | "株式会社オープンコレクター" |
en_name | string | 商号又は名称(英語表記) 半角英数300文字。 | "Open Collector, Inc," |
furigana | string | nameに対するフリガナ。全角カナ及び長音のみ使用。フリガナの登録がない場合ブランク | "オープンコレクター" |
post_code | string | 国内所在地の文字情報を基に設定した郵便番号。全国町・字ファイルを基に設定しているため、所在地に外字が含まれる場合や、誤字脱字がある場合には、正確な郵便番号が設定されていない場合がある。なお、同一の字・大字内の特定の地番に付与される郵便番号や、ビルや大口事業所に係る個別郵便番号には対応していない。 | "1020083" |
prefecture_name | string | 国内所在地(都道府県) | "東京都" |
city_name | string | 国内所在地(市区町村) | "千代田区" |
address_outside | string | 国外所在地。全角300文字。300文字を超過した場合は切り捨てられる。 | "アメリカ合衆国ハワイ州22411メリーランド州トライオン・ストリート20" |
street_number | string | 国内所在地(丁目番地等)。都道府県、市区町村との合計文字数300文字を超過した場合は切り捨てられる。 | "麹町3丁目12-14麹町駅前ヒルトップ8階" |
_facet_area | string | 地域ファセットの階層を指定する。詳細はファセットを参照 | "/東京都" |
_facet_kind | string | 法人種別ファセットの階層を指定する。詳細はファセットを参照 | "/株式会社" |
_facet_process | string | 処理区分ファセットの階層を指定する。詳細はファセットを参照 | "/新規" |
_facet_close_cause | string | 閉鎖事由ファセットの階層を指定する。詳細はファセットを参照 | "/清算の結了等" |
検索モード
法人名の検索モードは、デフォルトの部分一致の他、完全一致(法人種別込み)と完全一致(法人種別抜き)の3つのモードを提供しています。
(例1) デフォルト(部分一致)を用いて
オープンコレクター
で検索すると、以下のレコードがヒット株式会社○○オープンコレクター
株式会社オープンコレクター○○
オープンコレクター株式会社
株式会社オープンコレクター
(例2) 完全一致(法人種別抜き)(
mode=exact
)を用いてオープンコレクター
で検索すると、以下のレコードがヒットオープンコレクター株式会社
株式会社オープンコレクター
(例3) デフォルト(部分一致)を用いて
株式会社オープンコレクター
で検索すると、以下のレコードがヒット株式会社オープンコレクター○○
株式会社オープンコレクター
(例4) 完全一致(法人種別込み)(
mode=exact_with_kind
)を用いて株式会社オープンコレクター
で検索すると、以下のレコードがヒット株式会社オープンコレクター
部分一致モードで検索する場合、検索文字列は2文字以上必要です。1文字で検索すると完全一致の法人名のみが検索されます。
- (例5) 部分一致モードで
name:(漢字1文字)
を検索 → 何も検索にヒットしない - (例6) 完全一致モード(法人種別抜き)で
name:(漢字1文字)
を検索 →株式会社(漢字1文字)
などがヒット - (例7) 部分一致モードで
(漢字1文字)
を検索 →株式会社(漢字1文字)
などがヒット(完全一致モードの検索結果と同じ)
- (例5) 部分一致モードで
完全一致(法人種別抜き)で省略可能な法人種別については、完全一致(法人種別抜き)の省略可能な法人種別を参照してください。
完全一致(法人種別抜き)の省略可能な法人種別
完全一致(法人種別抜き)で省略可能な法人種別は以下の通りです。
- 株式会社
- 有限会社
- 合資会社
- 合同会社
- 合名会社
- 相互会社
- 医療法人
- 医療法人財団
- 医療法人社団
- 社会医療法人
- 社会福祉法人
- 財団法人
- 社団法人
- 一般財団法人
- 一般社団法人
- 公益財団法人
- 公益社団法人
- 学校法人
- 国立大学法人
- 公立大学法人
- 更生保護法人
- 独立行政法人
- 地方独立行政法人
- 農業生産法人
- 農事組合法人
- 弁護士法人
- 税理士法人
- 行政書士法人
- 司法書士法人
- 社会保険労務士法人
- 管理組合法人
- 無限責任中間法人
- 有限責任中間法人
- 宗教法人
- 特定非営利活動法人
- 協同組合
- 生活協同組合
- 漁業協同組合
- 労働組合
- 従業員組合
- 連合会
- 厚生年金基金
検索の正規化
法人番号APIは、検索時のキーワードを正規化します。これにより、ユーザーは入力文字列のフォーマットを整理する必要なく、必要なレコードを簡単に取得することができるようになります。
正規化対象フィールド
正規化されるフィールドは以下の通りです。
name
en_name
furigana
address_outside
street_number
正規化ルール
en_name
以外の正規化対象フィールドは以下のルールで正規化されます。
- 全角・半角の正規化: 検索時には全角・半角を区別しません。
- 旧字体・非標準文字の正規化: 旧字体や非標準文字の検索時には、新字体と漢字を区別しません。詳しくは旧字体・非標準文字の正規化も参照してください。
- かな小文字の正規化: 拗音(
ゃ
、ゅ
、ょ
)、促音(っ
)、ヵ
、ヶ
、ぁぃぅぇぉ
の検索時には大文字・小文字を区別しません。ただし、完全一致検索の場合は正規化を行いません。 - 歴史的仮名遣いの正規化:
ゐ
、ゑ
の検索時にはそれぞれい
、え
と区別しません。ただし、完全一致検索の場合は正規化を行いません。
en_name
は以下のルールで正規化されます。
- 全角・半角の正規化: 検索時には全角・半角を区別しません。
旧字体・非標準文字の正規化
法人番号APIは、旧字体や非標準文字による検索に対応しています。例えば、非JIS漢字である髙
(はしご高)で検索した場合、常用漢字の高
を検索します。そのため、法人番号データに含まれていない登記簿上の法人名でそのまま検索することができます。
- (例1)
髙橋
→高橋
を含むレコードを検索する。(はしご高は非JIS漢字のため法人番号データには未収録) - (例2)
計畫
→計画
あるいは計畫
を含むレコードを検索する。
一部未対応の漢字もあります。制限事項も参照してください。
法人名の正規化
normalize_name
オプションを有効にすると、法人名を以下のように正規化します。
- 全角英数字を半角英数字に変換
- ハイフンや長音などの記号(以下、長音状記号)を以下のルールに基づき変換
- 長音状記号の直前の文字が英数字の場合は半角ハイフン
-
に変換 - それ以外の場合は全角長音
ー
に変換
- 長音状記号の直前の文字が英数字の場合は半角ハイフン
- (例1)
abc-def
→abc-def
- (例2)
あいう-えお
→あいうーえお
ファセット
ファセットのパス名は必ず /
で始まり、各階層は /
で区切られます。ルート階層は /
で表されます。
ファセットには以下の4種類があります。
- 地域ファセット (
facet_area
): 都道府県や市区町村を表すファセット。 (例) /東京都/千代田区 - 法人種別ファセット (
facet_kind
): 法人種別を表すファセット。 (例) /株式会社 - 処理区分ファセット (
facet_process
): 処理区分を表すファセット。 (例) /新規 - 閉鎖事由ファセット (
facet_close_cause
): 閉鎖事由を表すファセット。 (例) /清算の結了等
入力できる項目は以下の通りです。
- 地域ファセット (
facet_area
)/{都道府県}
/{都道府県}/{市区町村}
/海外など
- 国外の法人を対象とする場合はこのファセットを指定してください。
- 法人種別ファセット (
facet_kind
)行政機関など
地方公共団体
株式会社
有限会社
合名会社
合資会社
合同会社
その他の設立登記法人
外国会社等
その他
- 処理区分ファセット (
facet_process
)新規
商号又は名称の変更
国内所在地の変更
国外所在地の変更
登記記録の閉鎖等
登記記録の復活等
吸収合併
吸収合併無効
商号の登記の抹消
削除
- 閉鎖事由ファセット (
facet_close_cause
)清算の結了等
合併による解散等
登記官による閉鎖
その他の清算の結了等
クエリの実行例
- 法人名:
株式会社オープンコレクター
を検索https://api.kenall.jp/v1/houjinbangou?q=株式会社オープンコレクター
- 法人名にオープンコレクターを含み、かつ都道府県が東京都の法人を1件だけ検索
https://api.kenall.jp/v1/houjinbangou?q=name:オープンコレクター AND prefecture_name:東京都&limit=1
- 法人種別が株式会社で、かつ法人名にオープンコレクターを含む法人を検索
https://api.kenall.jp/v1/houjinbangou?q=name:オープンコレクター&facet_kind=/株式会社
レスポンス
{
"version": "2021-08-20",
"data": [
{ ... },
{ ... },
{ ... }
],
"query": "name:...",
"count": 3,
"offset": 0,
"limit": 100,
"facets": {
"area": [
["/大阪府", 2],
["/東京都", 1]
],
"kind": [
["/合同会社", 1],
["/有限会社", 1],
["/株式会社", 1]
],
"process": [
["/吸収合併", 1],
["/国内所在地の変更", 1],
["/新規", 1]
],
"close_cause": [
["/その他", 2],
["/合併による解散等", 1]
]
}
}
レスポンスのデータは以下のような構成になっています。
名前 | 型 | 説明 | 例 |
---|---|---|---|
version | string | データのバージョン番号。YYYY-MM-DD形式のデータ作成日付となっている。 | "2022-01-31" |
data | array | 前述の法人番号レコードの配列 | |
query | string | q パラメーターに与えられたクエリ文字列 | "name:オープンコレクター" |
count | number | クエリに合致したレコードの総数 (dataプロパティに返却されるレコードの数ではなく、合致したすべてのレコードの件数) | 1 |
offset | number | offset パラメーターに与えられたオフセット | 0 |
limit | number | limit パラメーターに与えられた最大取得件数 | 100 |
facets | object またはnull | ファセットパラメーターが与えられた場合のみ出力される。パラメーターで示されたファセット階層配下のファセットとそのファセットに含まれるレコードの数のペアの配列。 | 後述 |
data内のそれぞれの法人番号レコードは法人番号検索APIのレスポンスと同一です。
法人番号検索APIと異なり、レスポンスが配列になっていることにご注意ください。
facets内のデータは以下のような構成になっています。
名前 | 型 | 説明 | 例 |
---|---|---|---|
area | array | 地域ファセットの結果 | ["/東京都": 1] |
kind | array | 法人種別ファセットの結果 | ["/株式会社": 1] |
process | array | 処理ファセットの結果 | ["/国内所在地の変更": 1] |
close_cause | array | 閉鎖事由ファセットの結果 | ["/その他": 1] |