Skip to main content

法人番号レーダー

info

本APIは、プレミアムプランご購読のお客様のみが利用できます。

caution

本APIは、シークレットキーでのみ利用できます。公開キーでは利用できませんのでご注意ください。

APIキーの管理の詳細についてはAPIキーの管理を参照してください。

法人番号レーダーは法人番号情報が変更されたことを検知できる機能です。

更新を検知したい法人の法人番号をAPIから登録し、ダッシュボードの「法人番号レーダー」画面から通知先のWebhook URLを登録してください。 毎日更新をチェックし、更新が検知されるとWebhookで通知が送られます。

Webhookのbodyには以下のように更新があった法人番号一覧が返ってくるエンドポイントが含まれているので、 そのエンドポイントを叩くことで更新された法人番号の詳細情報を取得できます。

Webhookのbody​

{
  "url": "https://api.kenall.jp/v1/houjinbangou/radar/2023-02-22",
  "date": "2023-02-22"
}

Webhookのbodyの url に含まれるエンドポイントのレスポンス​

レスポンスに含まれている更新された法人の法人番号を使用し、法人番号APIから詳細情報を取得してください。

{
  "data": [
    "1234567890111",
    "1234567890222",
    "1234567890333",
  ]
}

GET /v1/houjinbangou/radar/corporate_numbers​

法人番号レーダーに登録している法人番号一覧を取得します。

curl \
  "https://api.kenall.jp/v1/houjinbangou/radar/corporate_numbers" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token xxxxxxxxxx"

レスポンス​

{
  "data": [
    "1234567890111",
    "1234567890222",
    "1234567890333",
  ]
}

レスポンスのデータは以下のような構成になっています。

名前型説明例
dataarray法人番号"0123456789123"

POST /v1/houjinbangou/radar/corporate_numbers/add​

法人番号レーダーに対象の法人番号を登録します。すでに登録済みの法人番号が含まれていても成功します。成功した場合は登録した法人番号の一覧を返します。

caution

一度のリクエストで100件まで登録することが可能です。

パラメーター​

名前型必須かどうか説明例
dataarray必須法人番号"0123456789123"

リクエスト例​

curl -X POST \
  "https://api.kenall.jp/v1/houjinbangou/radar/corporate_numbers/add" \
  -d '{"data": ["1000000000001", "1000000000002", "1000000000003"]}' \
  -H "Content-Type: application/json" \
  -H "Authorization: Token xxxxxxxxxx"

POST /v1/houjinbangou/radar/corporate_numbers/remove​

法人番号レーダーに登録された法人番号を削除します。登録されていない法人番号が含まれている場合、登録されている番号のみ削除します。 成功した場合はHTTPステータス200のみを返します。

パラメーター​

名前型必須かどうか説明例
dataarray必須法人番号"0123456789123"

リクエスト例​

curl -X POST \
  "https://api.kenall.jp/v1/houjinbangou/radar/corporate_numbers/remove" \
  -d '{"data": ["1000000000001", "1000000000002", "1000000000003"]}' \
  -H "Content-Type: application/json" \
  -H "Authorization: Token xxxxxxxxxx"