RISK EYES V2 制裁リスト 記事数表示API

API情報

説明: RISK EYES V2 制裁リスト 記事数表示API仕様書

バージョン: 1.0.0

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

サポート: support@riskeyes.jp

公開日: 2025年7月14日

概要

本機能は、APIで反社チェック対象の記事数を返却します。

システム上に、記事数を表示・記録できるよう開発いただくことにより、反社チェック対象の記事の有無・記事数をシステム内で確認することが可能になります。

処理概要

調査対象となる「法人名」「人名(代表者名など)」などの検索条件を指定し、会員ページに事前に設定してあるネガティブワードとの複合条件で検索した、従来は本サービスの会員ページ内で表示される『記事数』を本APIにより出力します。

記事がヒットした取引先に関する記事は会員ページでも検索できます。

注意事項

並行でリクエストを送信せず、1件ずつリクエストを送信してください。

認証

このAPIはBearer認証を使用します。

/api/v2/tokenで取得したアクセストークンを使用してください。

Authorization: Bearer <ACCESS_TOKEN>

エンドポイント

POST /api/v2/search/count/overseas

概要: 制裁リスト 記事数表示

説明: 制裁リスト検索の記事数を表示します

Overseas Search Count

リクエストパラメータ

パラメータ名 型 必須 説明 例
keyword string 必須 検索キーワード "ソーシャルワイヤー"
keyword_en string 任意 キーワード（英語表記） "Test Company"
client_customer_id integer 任意 取引先管理番号 123
remark string 任意 備考 "検索メモ"
strip_corps boolean 任意 法人格除去フラグ（法人名を除去する場合はtrueを指定、デフォルト: false） false

リクエスト例

基本的な検索
{ "keyword": "ソーシャルワイヤー" }
詳細検索
{ "keyword": "ソーシャルワイヤー", "keyword_en": "Social Wire" }

レスポンス

200検索結果件数取得成功

説明: 検索結果件数取得成功

レスポンススキーマ
フィールド名 型 説明
count integer 検索結果件数
レスポンス例
成功レスポンス:
{ "count": 123 }
結果なし:
{ "count": 0 }
400リクエストエラー

説明: リクエストエラー

レスポンススキーマ
フィールド名 型 説明
status integer HTTPステータスコード
result object (nullable) 結果データ（エラー時はnull）
errors object エラー情報
errors.message string エラーメッセージ
errors.error_code string エラーコード
エラー例
不正なリクエスト:
{ "status": 400, "result": null, "errors": { "message": "不正なリクエストです。パラメータを確認してください。", "error_code": "E400000" } }
キーワード未設定:
{ "status": 400, "result": null, "errors": { "message": "{調査キーワード}は必須です。", "error_code": "E400002" } }
案件未設定:
{ "status": 400, "result": null, "errors": { "message": "{案件}が設定されていません。", "error_code": "E400003" } }
DBタイプ未設定:
{ "status": 400, "result": null, "errors": { "message": "{DBタイプ}が設定されていません。", "error_code": "E400003" } }
禁止文字使用:
{ "status": 400, "result": null, "errors": { "message": "{各パラメータ}に使用できない文字が含まれています。", "error_code": "E400005" } }
英語キーワード形式エラー:
{ "status": 400, "result": null, "errors": { "message": "キーワード（英語表記）は英数字・記号のみで入力してください。", "error_code": "E400006" } }
401認証エラー

説明: 認証エラー

レスポンススキーマ
フィールド名 型 説明
status integer HTTPステータスコード
message string エラーメッセージ
エラー例
{ "status": 401, "message": "トークンの有効期限が切れています。" }
500サーバーエラー

説明: サーバーエラー

レスポンススキーマ
フィールド名 型 説明
status integer HTTPステータスコード
result object (nullable) 結果データ（エラー時はnull）
errors object エラー情報
errors.message string エラーメッセージ
errors.error_code string エラーコード
エラー例
システムエラー:
{ "status": 500, "result": null, "errors": { "message": "システムでエラーが発生しました。", "error_code": "E500000" } }
記事数取得エラー:
{ "status": 500, "result": null, "errors": { "message": "記事数の取得中にエラーが発生しました。", "error_code": "E500001" } }
検索結果過多エラー:
{ "status": 500, "result": null, "errors": { "message": "検索結果の件数が多すぎます。詳細条件を指定して再検索ください。", "error_code": "E500003" } }

エラーコード一覧

エラーコード HTTPステータス 説明
E400000 400 不正なリクエストです。パラメータを確認してください。
E400002 400 {調査キーワード}は必須です。
E400003 400 {案件}が設定されていません。
E400003 400 {DBタイプ}が設定されていません。
E400005 400 {各パラメータ}に使用できない文字が含まれています。
E400006 400 キーワード（英語表記）は英数字・記号のみで入力してください。
E500000 500 システムでエラーが発生しました。
E500001 500 記事数の取得中にエラーが発生しました。
E500003 500 検索結果の件数が多すぎます。詳細条件を指定して再検索ください。

公開履歴

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