RoboRoboコンプライアンスチェックAPIv2仕様 (1.2.4)

Download OpenAPI specification:Download

アクセストークン(APIトークン)について

・アクセストークンを付加のうえリクエストを送信することで、各APIに応じた機能が利用できます。
・アクセストークンは、API利用契約時に弊社にて発行・通知いたします。

新聞記事検索契約について

・API契約時に、新聞記事検索契約を行うと、コンプライアンスチェック実行時に新聞記事検索を同時に行うことができます。
・取引先登録・チェックAPIを利用すると、同時に新聞記事検索が行われます。
・新聞記事検索結果は、取引先登録・チェックAPIのコールバック、及びチェック結果詳細取得APIを利用すると取得することができます。
・新聞記事検索は、検索ワードに特殊な文字(文字コード:EUC-JP で変換できない文字)が含まれていると検索を行えません。
(新聞記事検索で連携しているG-Searchデータベースサービスの仕様です。)

World-Check検索契約について

・API契約時に、World-Check検索をしていただくとWorld-Check検索がインターネット検索と同時に実行されます。 ・取引先登録・チェックAPIを利用時に、World-Check検索の実行有無を設定することができます。「組織」「個人」を設定すると同時にWorld-Check検索が行われます。 ・World-Check検索の結果は、取引先登録・チェックAPIのコールバック、及びチェック結果詳細取得APIを利用すると取得することができます。 ・World-Check検索にて「あり」だった場合、候補を選択する必要があります。候補一覧はWorld-Check候補一覧取得APIにて取得をしてください。 ・候補を取得したあと、該当のデータを指定してWorld-Check詳細取得APIをご利用いただくと、詳細情報を取得することができます。

官報情報検索契約について

・API契約時に、官報情報検索を行うと、取引先の官報情報検索が可能になります。 ・取引先登録・チェックAPIを利用時に、官報情報検索の実行有無を設定することができます。「組織」「個人」を設定すると同時に官報情報検索が行われます。
・官報情報検索の結果は、取引先登録・チェックAPIのコールバック、及びチェック結果詳細取得APIを利用すると取得することができます。
・官報情報検索にて「あり」だった場合、候補を選択する必要があります。候補一覧は官報情報候補一覧取得APIにて取得をしてください。
・候補を取得したあと、該当のデータを指定して官報情報詳細取得APIをご利用いただくと、詳細情報を取得することができます。

AI与信契約について

・API契約時に、AI与信契約を行うと、取引先のAI与信レポートの作成・取得が可能になります。
・AI与信レポートの作成完了には〜15分程度かかるため、各API共に即時レスポンスでは受付確認のみを返却します。
・AI与信を実行する方法は2通りあります:
 - 取引先登録・チェック実行APIでisExecuteAiCredit=trueを指定: インターネットチェックと同時にAI与信が実行されます。
  AI与信チェックは法人(組織)を対象とした調査サービスです。
  リクエストデータの種別(entityTypeもしくはisExecuteWorldCheck)が組織の場合のみチェック対象として処理されます。
  種別が組織以外の場合は処理対象外となり、チェックは実行されません。
・AI与信実行結果は以下のいずれかで取得可能です:
 - aiCreditResponseTarget / responseTargetで指定したURLへの完了通知 callback で受け取る
 - AI与信実行結果取得APIに executionHistoryId(AI与信実行履歴ID)を指定して能動取得
 - チェック結果詳細取得API / チェック結果詳細取得(履歴)APIのレスポンスに含まれるaiCreditResultフィールドから参照(同時実行のみ)
・AI与信レポートPDFは公開URLで配信されるため、URLを保管しておけば再ダウンロードが可能です。
・AI与信設定APIで、自己資本比率・資本金などのAI与信スコア計算に利用される閾値を取得・更新できます。

更新履歴

2024年4月~
日付 Version 更新箇所 更新内容
2024/4/241.1.0所属グループ取得API追加作成
2024/4/241.1.0取引先登録・チェック実行APIグループを指定して実行できるように修正
2024/9/121.1.1取引先登録・チェック実行API契約件数の120%まで実行可能に
併せてエラーメッセージを修正
2025年5月~
日付 Version 更新箇所 更新内容
2025/5/201.1.2取引先登録・チェック実行APIcallbackに解析除外件数を追加
2025/5/201.1.2チェック結果詳細取得API取得結果に解析除外件数を追加
2025/7/221.1.3取引先登録・チェック実行APIフォルダ登録できるように修正
callbackにLLM結果、チェック日、チェック実行ID、フォルダID、フォルダ名を追加
2025/7/221.1.3チェック結果詳細取得API取得結果にLLM結果、チェック日、チェック実行ID、フォルダID、フォルダ名を追加
該当記事0のときもチェック結果詳細URLを戻す
2025/7/221.1.3チェック結果詳細取得(履歴)API追加作成
2025/10/131.1.4取引先登録・チェック実行APIパラメータにWorld Check項目を追加
callbackにWorld Check結果を追加
2025/10/131.1.4チェック結果詳細取得APIWorld Check結果を追加
2025/10/131.1.4チェック結果詳細取得(履歴)APIWorld Check結果を追加
2025/10/131.1.4World-Check国籍リスト取得API追加作成
2025/10/131.1.4World-Check国リスト取得API追加作成
2025/10/131.1.4World-Check識別番号種別取得API追加作成
2025/10/131.1.4World-Check候補一覧取得API追加作成
2025/10/131.1.4World-Check詳細取得API追加作成
2026年5月
日付 Version 更新箇所 更新内容
2026/5/111.2.0取引先登録・チェック実行APIパラメータに entityType(取引先種別) / isExecuteAiCredit を追加
ルートに aiCreditResponseTarget を追加
既存取引先がある場合は指定フィールドを更新する upsert動作に変更
パラメータに excludeWord / managementNumber / companyNumber / customerUrl / ageOrYear を追加(BE/FEに合わせた取引先メタ情報の完全対応)
2026/5/111.2.0取引先登録・チェック実行API のcallback結果に entityType / aiCreditResult / excludeWord / managementNumber / companyNumber / customerUrl / ageOrYear を追加
2026/5/111.2.0チェック結果詳細取得API結果に entityType / aiCreditResult / excludeWord / managementNumber / companyNumber / customerUrl / ageOrYear を追加
2026/5/111.2.0チェック結果詳細取得(履歴)API結果に entityType / aiCreditResult / excludeWord / managementNumber / companyNumber / customerUrl / ageOrYear を追加
2026/5/111.2.0AI与信結果通知用 callback追加作成(aiCreditResponseTargetで指定したURLへ送付)
2026/5/111.2.0AI与信設定取得API追加作成
2026/5/111.2.0AI与信設定更新API追加作成
2026/5/221.2.0AI与信実行結果取得API追加作成(AI与信実行履歴IDを指定して結果を能動取得)
2026年6月
日付 Version 更新箇所 更新内容
2026/6/151.2.1取引先登録・チェック実行API のcallbackcheckResultListに publicationDate / estimatedYearOfBirth を追加
2026/6/151.2.1チェック結果詳細取得APIcheckResultListにpublicationDate / estimatedYearOfBirth を追加
2026/6/151.2.1チェック結果詳細取得API(履歴)checkResultListにpublicationDate / estimatedYearOfBirth を追加
2026/6/191.2.2AI与信契約についてentityTypeについて追記
2026/6/191.2.2取引先登録・チェックAPIisExecuteAiCreditについて追記
2026年7月
日付 Version リリース予定日 更新箇所 更新内容
2026/7/131.2.42026/8/3取引先登録・チェックAPIレスポンスにcheckExecutionIdを追加
2026/7/131.2.42026/8/3取引先登録・チェックAPI管理番号を追加
2026/7/131.2.42026/8/3取引先登録・チェックAPISPN検索・官報情報検索・AI与信実行時は取引先種別(entityType)が必須である旨を明記
2026/7/131.2.42026/8/3取引先登録・チェックAPIisExecuteWorldCheck に指定可能な値(個人/組織)を明記
2026/7/131.2.42026/8/3取引先登録・チェックAPISPN検索・官報情報検索・AIレポート作成の同時実行フラグ(isExecuteSpnSearch / isExecuteBankruptSearch / isExecuteAiReport)を追加
2026/7/131.2.42026/8/3取引先登録・チェックAPIコールバックブラックリスト情報を追加
2026/7/131.2.42026/8/3取引先登録・チェックAPIコールバックコメント情報を追加
2026/7/131.2.42026/8/3取引先登録・チェックAPIコールバック管理番号を追加
2026/7/131.2.42026/8/3取引先登録・チェックAPIコールバックSPN検索結果を追加
2026/7/131.2.42026/8/3取引先登録・チェックAPIコールバック官報情報検索結果を追加
2026/7/131.2.42026/8/3取引先登録・チェックAPIコールバックAIレポート結果(ステータス)を追加
2026/7/131.2.42026/8/3チェック結果詳細取得APIブラックリスト登録情報を追加
2026/7/131.2.42026/8/3チェック結果詳細取得APIコメント情報を追加
2026/7/131.2.42026/8/3チェック結果詳細取得API管理番号を追加
2026/7/131.2.42026/8/3チェック結果詳細取得APISPN検索結果を追加
2026/7/131.2.42026/8/3チェック結果詳細取得API官報情報検索結果を追加
2026/7/131.2.42026/8/3チェック結果詳細取得APIAIレポート結果(ステータス)を追加
2026/7/131.2.42026/8/3チェック結果詳細取得(履歴)APIブラックリスト登録情報を追加
2026/7/131.2.42026/8/3チェック結果詳細取得(履歴)APIコメント情報を追加
2026/7/131.2.42026/8/3チェック結果詳細取得(履歴)API管理番号を追加
2026/7/131.2.42026/8/3チェック結果詳細取得(履歴)APISPN検索結果を追加
2026/7/131.2.42026/8/3チェック結果詳細取得(履歴)API官報情報検索結果を追加
2026/7/131.2.42026/8/3チェック結果詳細取得(履歴)APIAIレポート結果(ステータス)を追加
2026/7/131.2.42026/8/3AIレポートPDF取得API追加作成(AIレポートのステータス・スコア・PDFダウンロードURLを取得)
2026/7/131.2.42026/8/3AIレポートPDF取得APIステータスをAI与信と同じ形式(未実施/実行待ち/実行中/完了/エラー)に統一
2026/7/131.2.42026/8/3AI与信実行結果取得API説明文を更新(AI与信実行履歴IDの取得元を明確化)
2026/7/131.2.42026/8/3AI与信設定取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/7/131.2.42026/8/3AI与信設定更新APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/7/131.2.42026/8/3取引先登録・チェックAPIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/7/131.2.42026/8/3World-Check詳細取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/7/131.2.42026/8/3取引判断・コメント更新API取引判断更新APIから名称変更
2026/7/131.2.42026/8/3取引判断・コメント更新APIコメント入力を追加
2026/7/131.2.42026/8/3取引判断・コメント更新APIコメントへの添付ファイル登録用URL(s3UploadUrl)をレスポンスに追加
2026/7/131.2.42026/8/3取引判断・コメント取得API追加作成(取引判断取得APIから名称変更)
2026/7/131.2.42026/8/3取引判断・コメント取得APIcustomerIds / checkExecutionIds を複数指定可能に
2026/7/131.2.42026/8/3ファイル取得API追加作成(コメント添付ファイル・チェック結果ファイルのダウンロードURLを取得)
2026/7/131.2.42026/8/3チェック結果ファイル作成リクエストAPI追加作成(SPN報告書 / SPN個社別報告書 / 調査レポートの作成をリクエスト)
2026/7/131.2.42026/8/3記事PDFダウンロードAPIPDFダウンロードAPIから名称変更
2026/7/131.2.42026/8/3SPN結果取得API追加作成(SPN検索結果の実データをJSON取得)
2026/7/131.2.42026/8/3SPN結果取得API生年・現年齢・掲載日(期間)での絞り込みを追加
2026/7/131.2.42026/8/3官報破産者情報検索結果取得API追加作成(官報破産者情報検索結果をJSON取得)
2026/7/131.2.42026/8/3取引先一覧取得API追加作成
2026/7/131.2.42026/8/3取引先一覧取得APIcheckListをcheckConditionListにリネーム、取引先属性(種別/法人番号/企業URL/年齢生年/World-Check属性等)を取引先トップレベルへ移設
2026/7/131.2.42026/8/3ブラックリスト登録API追加作成
2026/7/131.2.42026/8/3ブラックリスト更新API追加作成
2026/7/131.2.42026/8/3ブラックリスト一覧取得API追加作成
2026/7/131.2.42026/8/3ブラックリスト削除API追加作成
2026/7/131.2.42026/8/3ブラックリスト分類項目 登録API追加作成
2026/7/131.2.42026/8/3ブラックリスト分類項目 更新API追加作成
2026/7/131.2.42026/8/3ブラックリスト分類項目 削除API追加作成
2026/7/131.2.42026/8/3ブラックリスト分類項目取得API追加作成

取引先登録・チェックAPI

取引先の登録(upsert)と各種チェック(インターネットチェック / SPN検索 / 官報破産者情報検索 / World-Check / AI与信 / AIレポート作成)の実行、結果のWebhook通知。

取引先登録・チェックAPI

チェック対象とする取引先名をRoboRoboコンプライアンスチェックへ登録し、チェックを実施、指定のURLに結果を送付。

upsert動作

取引先名(customerName)と関連ワード(relativeWord)の組み合わせで一意性を判定する。

  • 一致する取引先が 存在しない 場合: 新規登録する
  • 一致する取引先が 存在する 場合: リクエストで明示的に指定された他フィールド(entityType / isExecuteWorldCheck と関連項目 / 法人番号 / 企業URL / 取引先管理番号 / フォルダ 等)のうち、現状と異なる値がある項目のみ更新する。リクエストで指定されていないフィールドは更新対象外(null 上書きは行わない)。 ※既存取引先のフィールドを編集する目的にも利用できる(チェック実行と取引先メタ情報の更新を1リクエストで完結)。
Authorizations:
Bearer
Request Body schema: application/json

チェック実行リスト

groupId
integer

コンプライアンスチェックを実行するグループID

folderName
string

コンプライアンスチェックを実行するフォルダ名

Array of objects or objects
object

インターネットチェック結果の返却先の指定  トークンが空欄の場合は特に設定をせず返却  ヘッダーに下記を付与してPOSTリクエストを送る  ・Authorization: Bearer {token} 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライを行う(最大10回) 指定がない場合は返却を行わない

object

AI与信結果の返却先の指定(v1.2.0で追加) isExecuteAiCredit=true を指定した取引先について、AI与信レポート作成完了時に指定URLへ送付する。 AI与信はインターネットチェックよりも完了に時間がかかる(最大15分程度)ため、responseTarget とは別経路で通知される。  トークンが空欄の場合は特に設定をせず返却  ヘッダーに下記を付与してPOSTリクエストを送る  ・Authorization: Bearer {token} 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライを行う(最大10回) 指定がない場合は返却を行わない

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "folderName": "チェック202510",
  • "checkList": [
    ],
  • "responseTarget": {},
  • "aiCreditResponseTarget": {}
}

Response samples

Content type
application/json
{
  • "groupId": 100000,
  • "folderName": "チェック202510",
  • "checkList": [
    ],
  • "responseTarget": {},
  • "aiCreditResponseTarget": {}
}

取引先登録・チェックAPIで指定したURLに対してチェック結果を送付

取引先登録・チェックAPIでresponseTargetのurlを指定した場合、指定のURLにチェック結果を送付
結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライ(最大10回)
※responseTargetのtokenを指定した場合、BearerTokenに指定のtokenを付与

Authorizations:
Bearer
Request Body schema: application/json

チェック実行結果

Array of objects

結果

Responses

Request samples

Content type
application/json
{
  • "resultList": [
    ]
}

取引先一覧取得API

絞り込み条件を指定し、取引先の一覧を返却

Authorizations:
Bearer
Request Body schema: application/json

取引先一覧絞り込み条件

groupId
integer

絞り込み:グループID

customerIds
Array of integers

絞り込み:取引先IDリスト

customerName
string

絞り込み:取引先名 ※部分一致

managementNumber
string

絞り込み:管理番号

folderId
integer

絞り込み:フォルダID

folderName
string

絞り込み:フォルダ名

hasCheckExecution
boolean

絞り込み:チェック実行有無 (実行あり:true / 実行なし:false)

checkExecutionId
integer

絞り込み:チェック実行ID ※これまでのチェック実行履歴のIDを指定可能

registeredAtFrom
string

絞り込み:登録日(開始)(yyyy-MM-dd) ※registeredAtToとセットで指定

registeredAtTo
string

絞り込み:登録日(終了)(yyyy-MM-dd) ※registeredAtFromとセットで指定

checkedExecutionAtFrom
string

絞り込み:チェック実行日(開始)(yyyy-MM-dd) ※checkedExecutionAtToとセットで指定

checkedExecutionAtTo
string

絞り込み:チェック実行日(終了)(yyyy-MM-dd) ※checkedExecutionAtFromとセットで指定

limit
integer
Default: null

取得件数上限数

offset
integer
Default: null

取得するデータの開始位置 最大件数を踏まえるページネーションとして使用する

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "customerIds": [
    ],
  • "customerName": "株式会社〇〇〇",
  • "managementNumber": "001",
  • "folderId": 300000,
  • "folderName": "チェック202510",
  • "hasCheckExecution": true,
  • "checkExecutionId": 200000,
  • "registeredAtFrom": "2026-01-01",
  • "registeredAtTo": "2026-04-15",
  • "checkedExecutionAtFrom": "2026-01-01",
  • "checkedExecutionAtTo": "2026-04-15",
  • "limit": 20,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "totalCount": 100,
  • "customerList": [
    ]
}

チェック結果API

実行済みチェックの結果取得・履歴取得。

チェック結果詳細取得API

コンプライアンスチェック実行済みの取引先を指定し、最新のチェック実行結果の詳細を返却

Authorizations:
Bearer
Request Body schema: application/json

チェック結果取得対象

One of
customerId
required
Array of integers

取引先ID
取引先登録・チェックAPIのチェック実行結果から取得可能
リストで指定することで、複数の取引先に対して一括してチェック結果詳細の取得が可能
※一度のリクエストで、取引先の合計件数最大10件まで

limit
integer
Default: null

取引先ごとの取得件数最大数

offset
integer
Default: null

取得するデータの開始位置
最大取得件数を超える場合にページネーションとして指定できる

isSiteFilter
boolean
Default: false

サイト絞り込みをするか(true/false)
trueにすると、信頼性の高いサイトに絞って結果を取得できる

riskLevelScore
integer
Default: null

取得する注目度(高:0/中:1/低:2/判定不可:3/解析除外:-1)
※未指定で全取得

Responses

Request samples

Content type
application/json
{
  • "customerId": 100000,
  • "limit": 20,
  • "offset": 10,
  • "isSiteFilter": true,
  • "riskLevelScore": 1
}

Response samples

Content type
application/json
{
  • "resultList": [
    ]
}

チェック結果詳細取得(履歴)API

コンプライアンスチェック実行済みの取引先、実行IDを指定し、チェック実行結果の詳細を返却

Authorizations:
Bearer
Request Body schema: application/json

チェック結果取得対象

One of
Array of objects

取引先IDとチェック実行IDの組み合わせリスト
特定のチェック実行結果を1:1で指定したい場合に使用
※一度のリクエストで、最大10件まで

limit
integer
Default: null

取引先ごとの取得件数最大数

offset
integer
Default: null

取得するデータの開始位置
最大取得件数を超える場合にページネーションとして指定できる

isSiteFilter
boolean
Default: false

サイト絞り込みをするか(true/false)
trueにすると、信頼性の高いサイトに絞って結果を取得できる

riskLevelScore
integer
Default: null

取得する注目度(高:0/中:1/低:2/判定不可:3/解析除外:-1)
※未指定で全取得

Responses

Request samples

Content type
application/json
{
  • "executionList": [
    ],
  • "limit": 20,
  • "offset": 10,
  • "isSiteFilter": true,
  • "riskLevelScore": 1
}

Response samples

Content type
application/json
{
  • "resultList": [
    ]
}

SPN連携API

SPN検索結果の取得(PDFデータ・JSON)。

SPN結果取得API

SPN実行履歴IDを指定し、SPN検索結果の実データ(JSON配列)を取得する ※SPN検索契約有のAPIキーのみ利用可 ※SPN結果のPDF(SPN報告書 / SPN個社別報告書)が必要な場合は、チェック結果ファイル作成リクエストAPI(POST /v2/check-result-file/create-request)で作成をリクエストし、ファイル取得API(POST /v2/file/get)でダウンロードURLを取得する

Authorizations:
Bearer
Request Body schema: application/json
spnExecutionHistoryId
required
integer

SPN実行履歴ID ※コールバック・チェック結果詳細取得APIの spnResult.spnExecutionHistoryId を指定

offset
integer

取得開始位置(省略時0)

limit
integer

取得件数上限(省略時は全件)

birthyearFrom
string

生年での絞り込み(西暦4桁・この年以降) ※未指定の場合は下限なし

birthyearTo
string

生年での絞り込み(西暦4桁・この年以前) ※未指定の場合は上限なし

ageFrom
string

現年齢での絞り込み(この年齢以上) ※未指定の場合は下限なし

ageTo
string

現年齢での絞り込み(この年齢以下) ※未指定の場合は上限なし

pubDateFrom
string <date>

掲載日での絞り込み(この日付以降) ※未指定の場合は下限なし

pubDateTo
string <date>

掲載日での絞り込み(この日付以前) ※未指定の場合は上限なし

Responses

Request samples

Content type
application/json
{
  • "spnExecutionHistoryId": 300000,
  • "offset": 0,
  • "limit": 100,
  • "birthyearFrom": "1970",
  • "birthyearTo": "1990",
  • "ageFrom": "30",
  • "ageTo": "60",
  • "pubDateFrom": "2020-01-01",
  • "pubDateTo": "2026-12-31"
}

Response samples

Content type
application/json
{
  • "spnExecutionHistoryId": 300000,
  • "total": 2,
  • "offset": 0,
  • "limit": 100,
  • "rows": [
    ]
}

官報破産者情報API

官報破産者情報検索結果の取得。

官報破産者情報検索結果取得API

官報破産者情報検索の実行履歴IDを指定し、検索結果(JSON)を取得する。 ※官報破産者情報検索契約有のAPIキーのみ利用可

Authorizations:
Bearer
Request Body schema: application/json
bankruptSearchExecutionHistoryId
required
integer

官報破産者情報検索実行履歴ID ※コールバック・チェック結果詳細取得APIの bankruptSearchResult.bankruptSearchExecutionHistoryId を指定

offset
integer

取得開始位置(省略時0)

limit
integer

取得件数上限(省略時は全件)

Responses

Request samples

Content type
application/json
{
  • "bankruptSearchExecutionHistoryId": 400000,
  • "offset": 0,
  • "limit": 100
}

Response samples

Content type
application/json
{
  • "bankruptSearchExecutionHistoryId": 400000,
  • "total": 1,
  • "offset": 0,
  • "limit": 100,
  • "rows": [
    ]
}

AIレポート

AIレポートPDFの取得。

AIレポートPDF取得API

取引先ID・チェック実行IDを指定し、AIレポートのステータスとPDFダウンロードURLを返却(※AIレポート契約有の場合のみ)。 PDFはチャットでレポート内容が更新されるたびに同一URL上のファイルが上書き再生成されるため、常に最新版が取得される。

Authorizations:
Bearer
Request Body schema: application/json
customerId
required
integer

取引先ID

checkExecutionId
required
integer

チェック実行ID

Responses

Request samples

Content type
application/json
{
  • "customerId": 100000,
  • "checkExecutionId": 200000
}

Response samples

Content type
application/json
{}

World-CheckAPI

World-Check検索の補助情報(国籍/国/識別番号種別)取得、候補一覧および詳細取得。

World-Check国籍リスト取得API

World-Check国籍リストを返却

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "nationalities": [
    ]
}

World-Check国リスト取得API

World-Check国リストを返却

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "countries": [
    ]
}

World-Check識別番号種別リスト取得API

World-Check識別番号種別リストを返却

Authorizations:
Bearer
query Parameters
countryCode
required
string
Example: countryCode=JPN

国コード

entityType
required
string
Example: entityType=個人

World Check種別 (個人/組織)

Responses

Response samples

Content type
application/json
{
  • "identification": [
    ]
}

World-Check候補一覧取得API

World-Check候補一覧を返却

Authorizations:
Bearer
Request Body schema: application/json
worldCheckExecutionHistoryId
Array of integers

World-Check実行履歴ID
※一度のリクエストで最大10件まで

limit
integer
Default: null

取引先ごとの取得件数最大数

offset
integer
Default: null

取得するデータの開始位置
最大取得件数を超える場合にページネーションとして指定できる

Responses

Request samples

Content type
application/json
{
  • "worldCheckExecutionHistoryId": [
    ],
  • "limit": 20,
  • "offset": 10
}

Response samples

Content type
application/json
{
  • "resultList": [
    ]
}

World-Check詳細取得API

World-Check詳細を返却

Authorizations:
Bearer
query Parameters
worldCheckSearchResultId
required
integer
Example: worldCheckSearchResultId=20000

World-Check候補一覧ID

referenceId
required
string
Example: referenceId=e_tr_wci_△△△

参照ID

Responses

Response samples

Content type
application/json
{
  • "master": {
    },
  • "furtherInfo": [
    ],
  • "alias": {
    },
  • "keyword": [
    ],
  • "connection": {
    },
  • "pepRole": [
    ],
  • "source": []
}

AI与信API

AI与信レポート作成の完了通知Webhook、設定(自己資本比率・資本金等の閾値)の取得・更新。AI与信の実行は取引先登録・チェック実行APIのisExecuteAiCreditフラグから行う。

AI与信実行結果取得API

AI与信実行で受け付けた実行の結果を取得する。 AI与信実行履歴ID(取引先登録・チェック実行APIのレスポンスや callback の aiCreditResult.executionHistoryId)を指定して、AI与信レポート作成の進捗・結果を能動的に取得できる。 AI与信契約が必要。

Authorizations:
Bearer
query Parameters
executionHistoryId
required
integer
Example: executionHistoryId=5000000

AI与信実行履歴ID AI与信実行を受け付けた際に発行される一意なID。 取引先登録・チェック実行APIのレスポンス / callback の aiCreditResult.executionHistoryId で返却される値。

Responses

Response samples

Content type
application/json
{}

AI与信完了通知用 callback(aiCreditResponseTarget で指定したURLに送付)

取引先登録・チェック実行APIで aiCreditResponseTarget.url を指定した場合、AI与信レポートの作成完了時に指定のURLへ結果を送付する。 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライ(最大10回) ※aiCreditResponseTargetのtokenを指定した場合、BearerTokenに指定のtokenを付与

Authorizations:
Bearer
Request Body schema: application/json

AI与信完了結果

Array of objects

結果

Responses

Request samples

Content type
application/json
{
  • "resultList": []
}

AI与信設定取得API

AI与信のスコア計算に利用される閾値設定(自己資本比率・資本金など)を取得する。

Authorizations:
Bearer
query Parameters
groupId
required
integer
Example: groupId=100000

グループID

Responses

Response samples

Content type
application/json
{
  • "groupId": 100000,
  • "equityRatio": 20,
  • "capitalAmount": 10000000
}

AI与信設定更新API

AI与信のスコア計算に利用される閾値設定(自己資本比率・資本金など)を更新する。

Authorizations:
Bearer
Request Body schema: application/json

AI与信設定

groupId
required
integer

グループID

equityRatio
number

自己資本比率の閾値(%)

capitalAmount
integer

資本金の閾値(円)

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "equityRatio": 20,
  • "capitalAmount": 10000000
}

Response samples

Content type
application/json
{
  • "groupId": 100000,
  • "equityRatio": 20,
  • "capitalAmount": 10000000
}

取引判断・コメントAPI

取引判断・コメントの更新/取得と、コメントに添付されたファイルの取得。

取引判断・コメント更新API

コンプライアンスチェック実行済みの取引先に対し、取引判断(取引承認/取引否認/取引保留)とコメントを更新する。

コメントへのファイル添付について

コメントにファイルを添付する場合は、本APIのリクエストで fileName / fileExtension / fileSize を指定する。 レスポンスで返却される s3UploadUrl(アップロード用の署名付きURL)に対してファイル本体を直接 PUT することで、添付が完了する(2ステップ)。

① 本APIでファイルのメタ情報を送信し、s3UploadUrl を取得する

PUT /v2/check-decision
Authorization: Bearer {アクセストークン}
Content-Type: application/json

{
  "customerId": 100000,
  "checkDecisionChoice": 1,
  "comment": "反社チェック結果を確認済み",
  "fileName": "証跡資料",
  "fileExtension": "pdf",
  "fileSize": 102400
}

レスポンス:

{
  "checkDecisionList": [
    { "customerId": 100000, "customerName": "株式会社〇〇〇" }
  ],
  "checkDecisionChoice": 1,
  "s3UploadUrl": "https://compliance-files-production.s3.ap-northeast-1.amazonaws.com/check-decision/900000/1a2b3c4d.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=xxxxx"
}

② 取得した s3UploadUrl へファイル本体を直接 PUT する

curl -X PUT "https://compliance-files-production.s3.ap-northeast-1.amazonaws.com/check-decision/900000/1a2b3c4d.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Signature=xxxxx" \
  -H "Content-Type: application/pdf" \
  --data-binary @./証跡資料.pdf

s3UploadUrl は署名付きURLのため、Authorization ヘッダーは付与しないこと(付与すると認証エラーになる) ※ Content-Type にはアップロードするファイルのMIMEタイプを指定する ※ 添付したファイルは ファイル取得API(POST /v2/file/get)で取得できる

Authorizations:
Bearer
Request Body schema: application/json

取引判断更新

One of
customerId
required
Array of integers

取引先ID
取引先登録・チェックAPIのチェック実行結果から取得可能
リストで指定することで、複数の取引先に対して一括して取引判断が可能
※一度のリクエストで、取引先の合計件数最大1,000件まで

checkDecisionChoice
required
integer
Enum: 0 1 2

取引判断(保留:0/承認:1/否認:2)

comment
string
Default: null

コメント

fileName
string
Default: null

添付ファイル名

fileExtension
string
Default: null

ファイルの拡張子

fileSize
integer
Default: null

ファイルサイズ

Responses

Request samples

Content type
application/json
{
  • "customerId": 100000,
  • "checkDecisionChoice": 0,
  • "comment": "コメント",
  • "fileName": "ファイル名",
  • "fileExtension": "pdf",
  • "fileSize": 1024
}

Response samples

Content type
application/json
{}

取引判断・コメント取得API

取引判断を取得して返却

Authorizations:
Bearer
Request Body schema: application/json

取引判断取得条件

groupId
integer

絞り込み:グループID

folderId
integer

絞り込み:フォルダID

customerIds
Array of integers

絞り込み:取引先IDリスト(複数指定可) 指定したグループ・フォルダ内の複数取引先を一括で対象にできる

checkExecutionIds
Array of integers

絞り込み:チェック実行IDリスト(複数指定可)

checkedExecutionAtFrom
string

絞り込み:チェック実行日(開始)(yyyy-MM-dd) ※checkedExecutionAtToとセットで指定

checkedExecutionAtTo
string

絞り込み:チェック実行日(終了)(yyyy-MM-dd) ※checkedExecutionAtFromとセットで指定

updatedAtFrom
string

絞り込み:取引判断/コメント更新日(開始)(yyyy-MM-dd) ※updatedAtToとセットで指定

updatedAtTo
string

絞り込み:取引判断/コメント更新日(終了)(yyyy-MM-dd) ※updatedAtFromとセットで指定

limit
integer
Default: null

取得件数上限数

offset
integer
Default: null

取得するデータの開始位置 ページネーションとして使用する

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "folderId": 300000,
  • "customerIds": [
    ],
  • "checkExecutionIds": [
    ],
  • "checkedExecutionAtFrom": "2026-01-01",
  • "checkedExecutionAtTo": "2026-04-30",
  • "updatedAtFrom": "2026-04-01",
  • "updatedAtTo": "2026-04-05",
  • "limit": 20,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "totalCount": 2,
  • "checkDecisionList": [
    ]
}

ファイル作成・取得API

チェック結果ファイル(SPN報告書 / SPN個社別報告書 / 調査レポート)の作成リクエストと、ファイル(記事PDF / コメント添付ファイル / チェック結果ファイル)の取得。

記事PDFダウンロードAPI

コンプライアンスチェック実行結果から記事を指定し、当該記事のPDFダウンロード用URLを生成して返却

Authorizations:
Bearer
Request Body schema: application/json

PDFダウンロードURLの取得対象のチェック結果ID

One of
checkExecutionResultId
required
Array of integers

チェック結果ID
取引先登録・チェックAPI、或いはチェック結果詳細取得APIのチェック実行結果から取得可能
リストで指定することで、複数のチェック結果に対して一括してPDFダウンロードURLの取得が可能
※一度のリクエストで、チェック結果の合計件数最大100件まで

Responses

Request samples

Content type
application/json
Example
{
  • "checkExecutionResultId": [
    ]
}

Response samples

Content type
application/json
{}

チェック結果ファイル作成リクエストAPI

チェック結果に関するファイル(SPN報告書 / SPN個社別報告書 / 調査レポート)の作成をリクエストする。 ファイルの生成は非同期で行われるため、本APIでは受付完了とファイルID(fileId)のみを返却する。 生成完了後、ファイル取得API(POST /v2/file/get)に fileId を指定してダウンロードURLを取得する。 ※生成されるファイルはいずれもZIP形式。 ※対象は checkExecutionIds(チェック実行IDのリスト)または folderId(フォルダ単位)のいずれか一方で指定する。

Authorizations:
Bearer
Request Body schema: application/json
fileType
required
string
Enum: "SPN" "SPN_INDIVIDUAL" "REPORT"

作成するファイルの種別 ・SPN … SPN報告書(対象の取引先を1つのPDFにまとめた一括版) ・SPN_INDIVIDUAL … SPN個社別報告書(取引先ごとに1PDF) ・REPORT … 調査レポート(チェック結果レポートPDF) ※SPN / SPN_INDIVIDUAL はSPN検索契約が必要

checkExecutionIds
Array of integers non-empty

対象のチェック実行IDのリスト ※folderId との併用不可。いずれか一方を指定する

folderId
integer

対象のフォルダID(フォルダ内のチェック実行が対象) ※checkExecutionIds との併用不可。いずれか一方を指定する

Responses

Request samples

Content type
application/json
{
  • "fileType": "SPN",
  • "checkExecutionIds": [
    ],
  • "folderId": 300000
}

Response samples

Content type
application/json
{
  • "fileId": 900000
}

ファイル取得API

fileId を指定し、ファイルのダウンロードURLを取得する。次のいずれのファイルにも対応する。 ・コメント添付ファイル … チェック結果詳細取得API / チェック結果詳細取得(履歴)API / 取引判断・コメント取得API のレスポンスに含まれる fileId ・チェック結果ファイル(SPN報告書 / SPN個社別報告書 / 調査レポート)… チェック結果ファイル作成リクエストAPI(POST /v2/check-result-file/create-request)で発行された fileId ※チェック結果ファイルは非同期生成のため、生成が完了するまでは status が「作成中」となり url は返却されない(コメント添付ファイルは常に「完了」)。

Authorizations:
Bearer
Request Body schema: application/json
fileId
required
integer

ファイルID ※コメント添付ファイルの fileId、またはチェック結果ファイル作成リクエストAPIで取得した fileId

Responses

Request samples

Content type
application/json
{
  • "fileId": 900000
}

Response samples

Content type
application/json

アカウントAPI

契約・アカウントに紐づく情報(チェック実行件数、所属グループ)の取得。

コンプラチェック件数取得API

期間を指定し、期間内のコンプライアンスチェックの実行件数を返却

Authorizations:
Bearer
query Parameters
startDate
required
string
Example: startDate=2023-07-01

検索対象開始日(yyyy-MM-ddの形式で設定)

endDate
required
string
Example: endDate=2023-08-31

検索対象終了日(yyyy-MM-ddの形式で設定)
前日までの件数(検索終了日の件数は含まれない)

Responses

Response samples

Content type
application/json
{
  • "count": {
    }
}

所属グループ取得API

実行ユーザの所属しているグループを返却

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "groupList": [
    ]
}

ブラックリストAPI

ブラックリスト(取引先)の登録・更新・削除・一覧取得と、分類項目の登録・更新・削除・取得。

ブラックリスト登録API

ブラックリストへ新規登録する(オーナー権限のAPIキーのみ)。

Authorizations:
Bearer
Request Body schema: application/json
customerName
required
string

取引先名

representativeName
string

代表者名

classificationId
required
integer

分類ID(分類項目取得APIで取得したID)

address
string

住所

listRegisteredAt
string <date>

リスト登録日(yyyy-MM-dd)

registerReason
string

登録理由

notes
string

メモ

removeSpaceInName
boolean

取引先名の空白を除去してから登録するか(default false)

Responses

Request samples

Content type
application/json
{
  • "customerName": "株式会社サンプル",
  • "representativeName": "山田太郎",
  • "classificationId": 101,
  • "address": "東京都千代田区〇〇1-2-3",
  • "listRegisteredAt": "2026-06-30",
  • "registerReason": "反社会的勢力との関連が確認されたため",
  • "notes": "参考資料あり",
  • "removeSpaceInName": false
}

Response samples

Content type
application/json
{
  • "blacklistId": 100231
}

ブラックリスト更新API

既存のブラックリストを更新する(オーナー権限のAPIキーのみ)。blacklistId で対象を指定する。

Authorizations:
Bearer
Request Body schema: application/json
blacklistId
required
integer

更新対象のブラックリストID

customerName
string

取引先名

representativeName
string

代表者名

classificationId
integer

分類ID(分類項目取得APIで取得したID)

address
string

住所

listRegisteredAt
string <date>

リスト登録日(yyyy-MM-dd)

registerReason
string

登録理由

notes
string

メモ

Responses

Request samples

Content type
application/json
{
  • "blacklistId": 100231,
  • "customerName": "株式会社サンプル",
  • "representativeName": "山田太郎",
  • "classificationId": 101,
  • "address": "東京都千代田区〇〇1-2-3",
  • "listRegisteredAt": "2026-06-30",
  • "registerReason": "反社会的勢力との関連が確認されたため",
  • "notes": "参考資料あり"
}

Response samples

Content type
application/json
{
  • "blacklistId": 100231
}

ブラックリスト一覧取得API

ブラックリストの一覧を取得する(オーナー権限のAPIキーのみ)

Authorizations:
Bearer
query Parameters
offset
integer
Example: offset=0

取得開始位置(省略時0)

limit
integer
Example: limit=50

取得件数上限(省略時は全件)

names
Array of strings
Example: names=株式会社サンプル

取引先名での絞り込み(複数指定可)

exactMatchSearchName
boolean
Example: exactMatchSearchName=false

取引先名を完全一致で検索するか(default false。false時は部分一致)

Responses

Response samples

Content type
application/json
{
  • "total": 42,
  • "offset": 0,
  • "limit": 50,
  • "blacklist": [
    ]
}

ブラックリスト削除API

指定したブラックリストを一括削除する(オーナー権限のAPIキーのみ)

Authorizations:
Bearer
Request Body schema: application/json
blacklistIds
required
Array of integers non-empty

削除するブラックリストIDのリスト

Responses

Request samples

Content type
application/json
{
  • "blacklistIds": [
    ]
}

Response samples

Content type
application/json
{
  • "blacklistIds": [
    ]
}

ブラックリスト分類項目 登録API

ブラックリストの分類項目を新規登録する(オーナー権限のAPIキーのみ)。複数件をまとめて登録できる。

Authorizations:
Bearer
Request Body schema: application/json
required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "classifications": [
    ]
}

Response samples

Content type
application/json
{
  • "classificationIdList": [
    ]
}

ブラックリスト分類項目 更新API

既存のブラックリスト分類項目を更新する(オーナー権限のAPIキーのみ)。複数件をまとめて更新できる。 classificationId で対象を指定し、指定したフィールド(classificationName / colorCode)のみ更新する(省略したフィールドは変更しない)。

Authorizations:
Bearer
Request Body schema: application/json
required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "classifications": [
    ]
}

Response samples

Content type
application/json
{
  • "classificationIdList": [
    ]
}

ブラックリスト分類項目取得API

ブラックリストの分類項目一覧を取得する(オーナー権限のAPIキーのみ)

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "classifications": [
    ]
}

ブラックリスト分類項目 削除API

指定したブラックリスト分類項目を削除する(オーナー権限のAPIキーのみ)。複数件をまとめて削除できる。 使用中(ブラックリストに紐づく)の分類は削除されず、notDeleteNames に返却する。

Authorizations:
Bearer
Request Body schema: application/json
classificationIds
required
Array of integers non-empty

削除する分類IDのリスト

Responses

Request samples

Content type
application/json
{
  • "classificationIds": [
    ]
}

Response samples

Content type
application/json
{
  • "classificationIdList": [
    ],
  • "notDeleteNames": "反社関連"
}