API docs by Redocly

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

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をご利用いただくと、詳細情報を取得することができます。

AI与信契約について

・API契約時に、AI与信契約を行うと、取引先のAI与信レポートの作成・取得が可能になります。 ・AI与信レポートの作成完了には〜15分程度かかるため、各API共に即時レスポンスでは受付確認のみを返却します。 ・AI与信を実行する方法は2通りあります: 　- 取引先登録・チェック実行APIでisExecuteAiCredit=trueを指定: インターネットチェックと同時にAI与信が実行されます。 ・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月～
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月
日付 Version 更新箇所 更新内容
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を指定して結果を能動取得）

取引先登録・チェックAPI

取引先の登録（upsert）と各種チェック（インターネットチェック / World-Check / 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

実行済みチェックの結果取得・履歴取得、取引判断の更新、結果PDFダウンロード。

チェック結果詳細取得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": [
    ]
}

取引判断更新API

コンプライアンスチェック実行済みの取引先に対し、取引判断（取引承認/取引否認/取引保留）を更新

Authorizations:
Bearer
Request Body schema: application/json

取引判断更新

One of
customerId
required
Array of integers

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

checkDecisionChoice
required
integer

取引判断（保留：0/承認：1/否認：2）

Responses

Request samples

Content type
application/json
{
  • "customerId": 100000,
  • "checkDecisionChoice": 0
}

Response samples

Content type
application/json
{
  • "checkDecisionList": [
    ],
  • "checkDecisionChoice": 1
}

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
{}

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（AI与信単体実行APIのレスポンス executionList[*].executionHistoryId、または取引先登録・チェック実行APIのレスポンスや callback の aiCreditResult.executionHistoryId）を指定して、AI与信レポート作成の進捗・結果を能動的に取得できる。 AI与信契約が必要。

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

AI与信実行履歴ID AI与信実行を受け付けた際に発行される一意なID。 AI与信単体実行APIのレスポンス executionList[*].executionHistoryId、または 取引先登録・チェック実行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

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

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": [
    ]
}