RISK EYES V2 取引先管理API

API情報

説明: RISK EYES V2 取引先管理API 仕様書

バージョン: 1.0.0

サーバー: https://www.riskeyes.jp

公開日: 2025年09月01日

概要

取引先の一覧取得、作成、詳細操作（取得・更新・削除）、法人番号検索による作成が可能です。

主な機能

取引先の一覧の取得（検索・ページング対応）
取引先の新規作成
取引先詳細の取得・更新・削除
法人番号による企業情報検索・取引先作成

注意事項

/api/v2/token で取得したトークンを Authorization ヘッダーに設定してください。
並行でリクエストを送信せず、1件ずつリクエストを送信してください。

認証

認証方式: Bearer Token

ヘッダー: Authorization: Bearer {token}

/api/v2/token で取得したトークンを設定してください。

エンドポイント

GET /api/v2/customer

概要: 取引先一覧取得

説明: 取引先一覧を取得します。検索キーワードによるフィルタリングとページング機能を提供します。

クエリパラメータ

パラメータ名	型	必須	説明	例
search_keyword	string	任意	会社名、代表者名、または住所のどれかでの部分一致検索	"ソーシャルワイヤー"
customer_unique_id	string	任意	貴社取引先IDの完全一致検索	"CUST001"
page	integer	任意	ページ番号（デフォルト: 1）	1
page_size	integer	任意	ページサイズ（デフォルト: 30）	10

レスポンス

200 取引先一覧取得成功

説明: 取引先一覧取得成功

レスポンススキーマ

フィールド名	型	説明
count	integer	総件数
next	string (nullable)	次のページのURL
previous	string (nullable)	前のページのURL
results	array	取引先データ配列

レスポンス例

取引先一覧取得成功:

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "corporate_number": 3011101058626,
      "company_name": "ソーシャルワイヤー株式会社",
      "customer_unique_id": "CUST001",
      "representative_name": "矢田峰之",
      "address": "東京都港区新橋１丁目１－１３アーバンネット内幸町ビル３階",
      "remarks": "重要取引先",
      "research_subjects": [
        {
          "word": "藤原直美",
          "memo": "取締役ＣＯＯ"
        }
      ],
      "created_at": "2025-07-18T13:48:37",
      "updated_at": "2025-07-22T10:52:28"
    }
  ]
}

401 認証エラー

説明: 認証エラー

エラー例

認証エラー:

{
  "error": "認証に失敗しました。"
}

POST /api/v2/customer/create

概要: 取引先新規作成

説明: 新しい取引先を作成します。

リクエストボディ

パラメータ名	型	必須	説明	例
corporate_number	integer (nullable)	任意	法人番号（13桁の半角数字）	3011101058626
company_name	string	必須	会社名	"ソーシャルワイヤー株式会社"
customer_unique_id	string (nullable)	任意	貴社取引先ID	"CUST001"
representative_name	string (nullable)	任意	代表者名	"矢田峰之"
address	string (nullable)	任意	住所	"東京都港区..."
remarks	string (nullable)	任意	備考	"重要取引先"
research_subjects	array	任意	調査対象リスト	[{"word": "藤原直美", "memo": "取締役ＣＯＯ"}]

リクエスト例

{
  "corporate_number": 3011101058626,
  "company_name": "ソーシャルワイヤー株式会社",
  "customer_unique_id": "CUST001",
  "representative_name": "矢田峰之",
  "address": "東京都港区新橋１丁目１－１３アーバンネット内幸町ビル３階",
  "remarks": "重要取引先",
  "research_subjects": [
    {
      "word": "藤原直美",
      "memo": "取締役ＣＯＯ"
    }
  ]
}

レスポンス

201 取引先作成成功

説明: 取引先作成成功

レスポンス例

取引先作成成功:

{
  "id": 1,
  "corporate_number": 3011101058626,
  "company_name": "ソーシャルワイヤー株式会社",
  "customer_unique_id": "CUST001",
  "representative_name": "矢田峰之",
  "address": "東京都港区新橋１丁目１－１３アーバンネット内幸町ビル３階",
  "remarks": "重要取引先",
  "research_subjects": [
    {
      "word": "藤原直美",
      "memo": "取締役ＣＯＯ"
    }
  ],
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

400 バリデーションエラー

説明: バリデーションエラー

エラー例

必須フィールドエラー:

{
  "company_name": ["この項目は必須です。"]
}

法人番号重複エラー:

{
  "corporate_number": [
    "この法人番号は既に使用されています。"
  ]
}

401 認証エラー

説明: 認証エラー

エラー例

認証エラー:

{
  "error": "認証に失敗しました。"
}

GET /api/v2/customer/detail/{id}

概要: 取引先詳細取得

説明: 指定されたIDの取引先詳細情報を取得します。調査対象も含めて返却します。

パスパラメータ

パラメータ名	型	必須	説明	例
id	integer	必須	取引先ID	1

レスポンス

200 取引先詳細取得成功

説明: 取引先詳細取得成功

レスポンス例

取引先詳細取得成功:

{
  "id": 1,
  "corporate_number": 3011101058626,
  "company_name": "ソーシャルワイヤー株式会社",
  "customer_unique_id": "CUST001",
  "representative_name": "矢田峰之",
  "address": "東京都港区新橋１丁目１－１３アーバンネット内幸町ビル３階",
  "remarks": "重要取引先",
  "research_subjects": [
    {
      "word": "藤原直美",
      "memo": "取締役ＣＯＯ"
    }
  ],
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

401 認証エラー

説明: 認証エラー

エラー例

認証エラー:

{
  "error": "認証に失敗しました。"
}

404 取引先が見つからない

説明: 取引先が見つからない、クエリが間違っている

エラー例

取引先が見つからない:

{
  "error": "取引先が見つかりませんでした。"
}

PATCH /api/v2/customer/detail/{id}

概要: 取引先情報部分更新

説明: 指定されたIDの取引先情報を部分的に更新します。指定されたフィールドのみが更新され、未指定のフィールドは変更されません。
※調査対象を更新する場合は、取引先に紐づいた全ての調査対象を上書きするため、ご注意ください。

パスパラメータ

パラメータ名	型	必須	説明	例
id	integer	必須	取引先ID	1

リクエストボディ

パラメータ名	型	必須	説明	例
corporate_number	integer (nullable)	任意	法人番号（13桁）	3011101058626
company_name	string	任意	会社名	"ソーシャルワイヤー株式会社"
customer_unique_id	string (nullable)	任意	貴社取引先ID	"CUST001"
representative_name	string (nullable)	任意	代表者名	"矢田峰之"
address	string (nullable)	任意	住所	"東京都港区..."
remarks	string (nullable)	任意	備考	"重要取引先"
research_subjects	array	任意	調査対象リスト	[{"word": "藤原直美", "memo": "取締役ＣＯＯ"}]

リクエスト例

{
  "company_name": "ソーシャルワイヤー"
}

レスポンス

200 取引先部分更新成功

説明: 取引先部分更新成功

レスポンス例

取引先部分更新成功:

{
  "id": 1,
  "corporate_number": 3011101058626,
  "company_name": "ソーシャルワイヤー",
  "customer_unique_id": "CUST001",
  "representative_name": "矢田峰之",
  "address": "東京都港区...",
  "remarks": "重要取引先",
  "research_subjects": [
    {
      "word": "藤原直美",
      "memo": "取締役ＣＯＯ"
    }
  ],
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

401 認証エラー

説明: 認証エラー

エラー例

認証エラー:

{
  "error": "認証に失敗しました。"
}

404 取引先が見つからない

説明: 取引先が見つからない、クエリが間違っている

エラー例

取引先が見つからない:

{
  "error": "取引先が見つかりませんでした。"
}

PUT /api/v2/customer/detail/{id}

概要: 取引先情報更新

説明: 指定されたIDの取引先情報を全て更新(上書き)します。調査対象も同時に上書きされます。

パスパラメータ

パラメータ名	型	必須	説明	例
id	integer	必須	取引先ID	1

リクエストボディ

パラメータ名	型	必須	説明	例
corporate_number	integer (nullable)	必須	法人番号（13桁）	3011101058626
company_name	string	必須	会社名	"ソーシャルワイヤー株式会社"
customer_unique_id	string (nullable)	必須	貴社取引先ID	"CUST001"
representative_name	string (nullable)	必須	代表者名	"矢田峰之"
address	string (nullable)	必須	住所	"東京都港区..."
remarks	string (nullable)	必須	備考	"重要取引先"
research_subjects	array	必須	調査対象リスト	[{"word": "藤原直美", "memo": "取締役ＣＯＯ"}]

リクエスト例

{
  "corporate_number": 3011101058626,
  "company_name": "ソーシャルワイヤー株式会社",
  "customer_unique_id": "CUST001",
  "representative_name": "矢田峰之",
  "address": "東京都港区新橋１丁目１－１３アーバンネット内幸町ビル３階",
  "remarks": "重要取引先",
  "research_subjects": [
    {
      "word": "藤原直美",
      "memo": "取締役ＣＯＯ"
    }
  ]
}

レスポンス

200 取引先更新成功

説明: 取引先更新成功

レスポンス例

取引先更新成功:

{
  "id": 1,
  "corporate_number": 3011101058626,
  "company_name": "ソーシャルワイヤー株式会社",
  "customer_unique_id": "CUST001",
  "representative_name": "矢田峰之",
  "address": "東京都港区新橋１丁目１－１３アーバンネット内幸町ビル３階",
  "remarks": "重要取引先",
  "research_subjects": [
    {
      "word": "藤原直美",
      "memo": "取締役ＣＯＯ"
    }
  ],
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

400 バリデーションエラー

説明: バリデーションエラー

エラー例

必須フィールドエラー:

{
  "company_name": ["この項目は必須です。"]
}

法人番号重複エラー:

{
  "corporate_number": [
    "この法人番号は既に使用されています。"
  ]
}

401 認証エラー

説明: 認証エラー

エラー例

認証エラー:

{
  "error": "認証に失敗しました。"
}

404 取引先が見つからない

説明: 取引先が見つからない、クエリが間違っている

エラー例

取引先が見つからない:

{
  "error": "取引先が見つかりませんでした。"
}

DELETE /api/v2/customer/detail/{id}

概要: 取引先削除

説明: 指定されたIDの取引先を削除します。関連する調査対象も削除されます。

パスパラメータ

パラメータ名	型	必須	説明	例
id	integer	必須	取引先ID	1

レスポンス

204 取引先削除成功

説明: 取引先削除成功

401 認証エラー

説明: 認証エラー

エラー例

認証エラー:

{
  "error": "認証に失敗しました。"
}

404 取引先が見つからない

説明: 取引先が見つからない、クエリが間違っている

エラー例

取引先が見つからない:

{
  "error": "取引先が見つかりませんでした。"
}

POST /api/v2/customer/create/search

概要: 法人番号検索による取引先作成

説明: 法人番号を使用してRISK EYES企業情報を検索し、その結果を基に取引先を作成します。企業データベースから取得した情報で取引先を自動作成します。

リクエストボディ

パラメータ名	型	必須	説明	例
corporate_number	integer	必須	法人番号（13桁）	3011101058626
customer_unique_id	string	任意	貴社取引先ID	"CUST001"
remarks	string	任意	備考	"重要取引先"

リクエスト例

{
  "corporate_number": 3011101058626,
  "customer_unique_id": "CUST001",
  "remarks": "重要取引先"
}

レスポンス

201 企業情報検索・取引先作成成功

説明: 企業情報検索・取引先作成成功

レスポンス例

企業情報検索・取引先作成成功:

{
  "id": 1,
  "corporate_number": 3011101058626,
  "company_name": "ソーシャルワイヤー株式会社",
  "customer_unique_id": "CUST001",
  "representative_name": "矢田峰之",
  "address": "東京都港区新橋１丁目１－１３アーバンネット内幸町ビル３階",
  "remarks": "重要取引先",
  "research_subjects": [],
  "created_at": "2024-01-01T10:00:00Z",
  "updated_at": "2024-01-01T10:00:00Z"
}

400 バリデーションエラー

説明: バリデーションエラー

エラー例

必須フィールドエラー:

{
  "corporate_number": ["この項目は必須です。"]
}

法人番号重複エラー:

{
  "corporate_number": [
    "この法人番号は既に使用されています。"
  ]
}

401 認証エラー

説明: 認証エラー

エラー例

認証エラー:

{
  "error": "認証に失敗しました。"
}

404 企業情報が見つからない

説明: 企業情報が見つからない

エラー例

企業情報が見つからない:

{
  "error": "企業情報が見つかりませんでした。"
}

データスキーマ

Customer（取引先）

フィールド名	型	説明	例
corporate_number	integer (nullable)	法人番号	3011101058626
company_name	string	会社名	"ソーシャルワイヤー株式会社"
customer_unique_id	string (nullable)	貴社取引先ID	"CUST001"
representative_name	string (nullable)	代表者名	"矢田峰之"
address	string (nullable)	住所	"東京都港区新橋１丁目１－１３アーバンネット内幸町ビル３階"
remarks	string (nullable)	備考	"重要取引先"
research_subjects	array	調査対象配列	[{"word": "藤原直美", "memo": "取締役ＣＯＯ"}]

説明: 取引先に使用できるフィールド

ResearchSubject（調査対象）

フィールド名	型	説明	例
word	string	調査対象ワード	"藤原直美"
memo	string (nullable)	メモ	"取締役ＣＯＯ"

説明: 調査対象（会社名、代表者名以外の調査対象を入力してください）

公開履歴

バージョン	公開日	変更内容
1.0.0	2025年8月19日	初版公開