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

Download OpenAPI specification:Download

アクセストークン（APIトークン）について

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

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

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

更新履歴

日付	Version	更新箇所	更新内容
2024/4/24	1.1.0	所属グループ取得API	追加作成
2024/4/24	1.1.0	取引先登録・チェックAPI	グループを指定して実行できるように修正

取引先登録・チェックAPI

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

Authorizations:

Bearer

Request Body schema: application/json

チェック実行リスト

groupId	integer コンプライアンスチェックを実行するグループID
	Array of objects or objects
	object チェック結果の返却先の指定　トークンが空欄の場合は特に設定をせず返却　ヘッダーに下記を付与してPOSTリクエストを送る　・Authorization: Bearer {token} 結果の返却先URLへの送付はステータスコード：4xx、5xxの場合リトライを行う（最大10回）指定がない場合は返却を行わない

Responses

Request samples

Payload

Content type

application/json

{"groupId": 100000,
"checkList": [{"customerName": ["株式会社〇〇〇",
"株式会社△△△"
],
"checkablePeriodNumber": 3,
"checkablePeriodUnit": "month",
"isSiteFilter": true
},
{"customerName": "株式会社□□□",
"relativeWord": "東京都",
"negativeWord": "架空 偽装 振込",
"searchStartDate": "2023-07-01"
}
],
"responseTarget": {"url": "https://xxxxx.co.jp/recivexxx",
"token": "a0b1c2d3e4f5g6h7i8g9a0b1c2d3e4f5g6h7i8g9"
}
}

Response samples

Content type

application/json

{"checkList": [{"customerId": 100000,
"customerName": "株式会社〇〇〇",
"negativeWord": "粉飾 横領 着服 背任 脱税 申告漏れ 違反 逮捕 送検 検挙 捜査 捜索 指名手配 判決 提訴 告訴 罪 詐欺 不正 偽装 裏 疑 架空 暗躍 闇 グレー 悪 暴力団 ヤクザ 総会屋 インサイダー 相場操縦 行政処分 行政指導",
"checkablePeriodNumber": 3,
"checkablePeriodUnit": "month",
"isSiteFilter": true
},
{"customerId": 100001,
"customerName": "株式会社△△△",
"negativeWord": "粉飾 横領 着服 背任 脱税 申告漏れ 違反 逮捕 送検 検挙 捜査 捜索 指名手配 判決 提訴 告訴 罪 詐欺 不正 偽装 裏 疑 架空 暗躍 闇 グレー 悪 暴力団 ヤクザ 総会屋 インサイダー 相場操縦 行政処分 行政指導",
"checkablePeriodNumber": 3,
"checkablePeriodUnit": "month",
"isSiteFilter": true
},
{"customerId": 100002,
"customerName": "株式会社□□□",
"relativeWord": "東京都",
"negativeWord": "架空 偽装 振込",
"searchStartDate": "2023-07-01",
"isSiteFilter": false
}
],
"responseTarget": {"url": "https://xxxxx.co.jp/recivexxx",
"token": "a0b1c2d3e4f5g6h7i8g9a0b1c2d3e4f5g6h7i8g9"
}
}

取引先登録・チェック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

Payload

Content type

application/json

{"resultList": [{"customerId": 100000,
"customerName": "株式会社〇〇〇",
"negativeWord": "粉飾 横領 着服 背任 脱税 申告漏れ 違反 逮捕 送検 検挙 捜査 捜索 指名手配 判決 提訴 告訴 罪 詐欺 不正 偽装 裏 疑 架空 暗躍 闇 グレー 悪 暴力団 ヤクザ 総会屋 インサイダー 相場操縦 行政処分 行政指導",
"complianceUrl": "https://compliance.roborobo.co.jp/groups/1000/customers/100000/check-results/1000000/detail",
"totalUrlCount": 2,
"riskLevelCount": {"high": 1,
"middle": 0,
"low": 1,
"none": 0
},
"newspaperResult": {"message": "success",
"articleCount": 3,
"url": "https://dbs.g-search.or.jp/aps/RXCN/main.jsp?verb=xxx"
},
"checkResultList": [{"checkExecutionResultId": 10000000,
"title": "xxxxの電話番号検索結果",
"snippet": "11 hours ago ... 050xxxx · 架空請求の電話番号【注意】 · 株式会社〇〇〇 ...",
"url": "https://www.telnavi.jp/search?q=050xxxx",
"domain": "www.telnavi.jp",
"riskLevelScore": 0
},
{"checkExecutionResultId": 10000001,
"title": "△△△△小売価格 ...",
"snippet": "20 hours ago ... お支払いについて□銀行振込(三井住友銀行/三菱東京UFJ銀行/ゆうちょ銀行/ジャパンネットバンク) □Yahoo!かんたん決済注意事項 ...",
"url": "https://finance.yahoo.co.jp/xxxx/1234",
"domain": "finance.yahoo.co.jp",
"domainName": "Yahoo! ファイナンス",
"riskLevelScore": 2
}
]
}
]
}

チェック結果詳細取得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） ※未指定で全取得

Responses

Request samples

Payload

Content type

application/json

{"customerId": 100000,
"limit": 20,
"offset": 10,
"isSiteFilter": true,
"riskLevelScore": 1
}

Response samples

Content type

application/json

{"resultList": [{"customerId": 100000,
"customerName": "株式会社〇〇〇",
"negativeWord": "粉飾 横領 着服 背任 脱税 申告漏れ 違反 逮捕 送検 検挙 捜査 捜索 指名手配 判決 提訴 告訴 罪 詐欺 不正 偽装 裏 疑 架空 暗躍 闇 グレー 悪 暴力団 ヤクザ 総会屋 インサイダー 相場操縦 行政処分 行政指導",
"complianceUrl": "https://compliance.roborobo.co.jp/groups/1000/customers/100000/check-results/1000000/detail",
"totalUrlCount": 2,
"riskLevelCount": {"high": 1,
"middle": 0,
"low": 1,
"none": 0
},
"checkDecisionChoice": 0,
"newspaperResult": {"message": "success",
"articleCount": 3,
"url": "https://dbs.g-search.or.jp/aps/RXCN/main.jsp?verb=xxx"
},
"checkResultList": [{"checkExecutionResultId": 10000000,
"title": "xxxxの電話番号検索結果",
"snippet": "11 hours ago ... 050xxxx · 架空請求の電話番号【注意】 · 株式会社〇〇〇 ...",
"url": "https://www.telnavi.jp/search?q=050xxxx",
"domain": "www.telnavi.jp",
"riskLevelScore": 0
},
{"checkExecutionResultId": 10000001,
"title": "△△△△小売価格 ...",
"snippet": "20 hours ago ... お支払いについて□銀行振込(三井住友銀行/三菱東京UFJ銀行/ゆうちょ銀行/ジャパンネットバンク) □Yahoo!かんたん決済注意事項 ...",
"url": "https://finance.yahoo.co.jp/xxxx/1234",
"domain": "finance.yahoo.co.jp",
"domainName": "Yahoo! ファイナンス",
"riskLevelScore": 2
}
]
}
]
}

取引判断更新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

Payload

Content type

application/json

{"customerId": 100000,
"checkDecisionChoice": 0
}

Response samples

Content type

application/json

{"checkDecisionList": [{"customerId": 100000,
"customerName": "株式会社〇〇〇"
},
{"customerId": 100001,
"customerName": "株式会社△△△",
"relativeWord": "東京都"
}
],
"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

Payload

Content type

application/json

Example

CheckExecutionResultIdList

{"checkExecutionResultId": [1000000,
1000001
]
}

Response samples

200
400
401
403
500

Content type

application/json

{"pdfUrlList": [{"checkExecutionResultId": 100000,
"message": "success",
"url": "https://roborobo-riskcheck-pdf.s3.amazonaws.com/example.pdf?xxx=yyy"
},
{"checkExecutionResultId": 1000001,
"message": "pdf file does not exist"
}
]
}

コンプラチェック件数取得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

200
400
401
403
500

Content type

application/json

{"count": {"check": 93,
"newspaper": 81,
"creditDownload": 9
}
}

所属グループ取得API

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

Authorizations:

Bearer

Responses

Response samples

200
401
500

Content type

application/json

{"groupList": [{"id": 100000,
"name": "〇〇〇グループ"
},
{"id": 100001,
"name": "△△△グループ"
}
]
}