RoboRoboコンプライアンスチェックAPIv2仕様 (1.3.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をご利用いただくと、詳細情報を取得することができます。

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

・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年8月
日付 Version 更新箇所 更新内容
2026/8/31.2.4ブラックリスト分類項目登録・更新APIclassificationName・colorCodeに文字列以外を指定した場合に400(code:4117 / 4118)を返すよう修正(従来は数値でも登録・更新できていた)
2026/8/31.2.4ブラックリスト登録API存在しない分類項目IDを指定すると、一覧に出てこない行が作られる。指定するIDは分類項目一覧取得APIで取得できるものを使用すること
2026/8/31.2.4ブラックリスト更新API存在しない分類項目IDを指定した場合に404(code:6006)を返すよう修正(従来は200で更新され、対象が一覧から消えていた)
2026/8/31.2.4取引先登録・チェックAPIcheckListが必須である旨をスキーマに反映
2026/8/31.2.4取引先登録・チェックAPIfolderNameに文字列以外を指定した場合に400(code:4116)を返すよう修正(従来は型を検証せずチェックが実行されていた)
2026/8/31.2.4World-Check候補一覧取得APIworldCheckExecutionHistoryIdが必須である旨をスキーマに反映。同じIDを複数指定した場合は1件として扱われる旨を明記
2026/8/31.2.4World-Check候補一覧取得APIresultListが実行履歴IDごとの2次元配列である旨と、並び順が実行履歴IDの昇順である旨を明記
2026/8/31.2.4World-Check候補一覧取得APImatchScoreの型をnumberに修正。countryLocationを配列に修正。sourceCategories・birthに要素の型を追加
2026/8/31.2.4World-Check候補一覧取得API値が無い場合にnullを返す項目(gender / birth / placeOfBirth)にnullableを明記
2026/8/31.2.4World-Check詳細取得API値が無い場合にnullを返す項目(pepStatus / gender / birthDates / placeOfBirth / nationalities / locations.street / locations.city / locations.region / aliases.languageName / keyword.countryName / pepRole.fromDate / pepRole.toDate / source.addedDate)にnullableを明記
2026/8/31.2.4チェック結果詳細取得(履歴)APIexecutionListが必須である旨をスキーマに反映
2026/8/31.2.4チェック結果ファイル作成リクエストAPIcheckExecutionIdsまたはfolderIdのいずれか一方が必須である旨をスキーマに反映
2026/8/31.2.4取引先登録・チェックAPIレスポンスにcheckExecutionIdを追加(実行によって生成されたチェック実行ID。取得できなかった場合はキーごと省略)
2026/8/31.2.4取引先登録・チェックAPI管理番号を追加
2026/8/31.2.4取引先登録・チェックAPISPN検索・官報情報検索・AI与信実行時は取引先種別(entityType)が必須である旨を明記
2026/8/31.2.4取引先登録・チェックAPIisExecuteWorldCheck に指定可能な値(個人/組織)を明記
2026/8/31.2.4取引先登録・チェックAPISPN検索・官報情報検索・AIレポート作成の同時実行フラグ(isExecuteSpnSearch / isExecuteBankruptSearch / isExecuteAiReport)を追加
2026/8/31.2.4取引先登録・チェックAPIコールバックブラックリスト情報を追加
2026/8/31.2.4取引先登録・チェックAPIコールバックコメント情報を追加
2026/8/31.2.4取引先登録・チェックAPIコールバック管理番号を追加
2026/8/31.2.4取引先登録・チェックAPIコールバックSPN検索結果を追加
2026/8/31.2.4取引先登録・チェックAPIコールバック官報情報検索結果を追加
2026/8/31.2.4取引先登録・チェックAPIコールバックAIレポート結果(ステータス)を追加
2026/8/31.2.4取引先登録・チェックAPIコールバックチェック結果詳細画面URL(complianceUrl)に実行済みの検索を判別するクエリパラメータを付与
2026/8/31.2.4チェック結果詳細取得APIブラックリスト登録情報を追加
2026/8/31.2.4チェック結果詳細取得APIコメント情報を追加
2026/8/31.2.4チェック結果詳細取得API管理番号を追加
2026/8/31.2.4チェック結果詳細取得APISPN検索結果を追加
2026/8/31.2.4チェック結果詳細取得API官報情報検索結果を追加
2026/8/31.2.4チェック結果詳細取得APIAIレポート結果(ステータス)を追加
2026/8/31.2.4チェック結果詳細取得APIチェック結果詳細画面URL(complianceUrl)に実行済みの検索を判別するクエリパラメータを付与
2026/8/31.2.4チェック結果詳細取得(履歴)APIブラックリスト登録情報を追加
2026/8/31.2.4チェック結果詳細取得(履歴)APIコメント情報を追加
2026/8/31.2.4チェック結果詳細取得(履歴)API管理番号を追加
2026/8/31.2.4チェック結果詳細取得(履歴)APISPN検索結果を追加
2026/8/31.2.4チェック結果詳細取得(履歴)API官報情報検索結果を追加
2026/8/31.2.4チェック結果詳細取得(履歴)APIAIレポート結果(ステータス)を追加
2026/8/31.2.4チェック結果詳細取得(履歴)APIチェック結果詳細画面URL(complianceUrl)に実行済みの検索を判別するクエリパラメータを付与
2026/8/31.2.4AIレポートPDF取得API追加作成(AIレポートのステータス・スコア・PDFダウンロードURLを取得)
2026/8/31.2.4AIレポートPDF取得APIステータスをAI与信と同じ形式(未実施/実行待ち/実行中/完了/エラー)に統一
2026/8/31.2.4AI与信実行結果取得API説明文を更新(AI与信実行履歴IDの取得元を明確化)
2026/8/31.2.4AI与信設定取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4AI与信設定更新APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4取引先登録・チェックAPIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4World-Check詳細取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/41.2.4World-Check候補一覧取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/41.2.4取引先登録・チェックAPIコールバック後方互換で併せて送信しているスネークケースの項目(publication_date / estimated_year_of_birth)を、説明文だけでなくスキーマにも定義(deprecated)
2026/8/41.2.4AI与信設定更新API本APIが全項目の上書きであり、リクエストに含めなかった項目はnullでクリアされる旨を明記
2026/8/41.2.4ブラックリスト登録API存在しない分類項目IDで作られた行の回収手順(更新APIで直すか削除APIで削除する)をclassificationIdの説明に明記
2026/8/41.2.4取引先登録・チェックAPIcheckExecutionIdについて、同一の取引先に同時実行した場合は直近の実行IDが返ることがある旨を明記
2026/8/41.2.4World-Check系5API403のレスポンスに契約エラー(code:300, World-Check契約なし)の定義を追加(従来はIP制限のcode:200のみ記載)
2026/8/41.2.4取引先登録・チェックAPI同時実行フラグ(isExecuteSpnSearch / isExecuteBankruptSearch / isExecuteAiReport / isExecuteAiCredit)が、checkListの要素ごとではなくリクエスト全体に適用される旨を明記
2026/8/41.2.4ブラックリスト一覧取得API・分類項目取得API値が無い場合にnullを返す項目(representativeName / address / registerReason / notes / classificationColorCode / colorCode)にnullableを明記
2026/8/41.2.4ブラックリスト分類項目 削除API404レスポンスのexampleのメッセージを実装に合わせて修正(「指定されたブラックリストは存在しませんでした。」→「指定された分類項目は存在しませんでした。」)
2026/8/41.2.4取引先登録・チェックAPIisExecuteSpnSearch / isExecuteBankruptSearch を1件でもtrueにした場合、checkListの全要素にentityType(またはisExecuteWorldCheck)が必要になる旨を明記(未設定の取引先が検索に巻き込まれ実行履歴がエラーになるため)
2026/8/31.2.4チェック結果ファイル作成リクエストAPIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4SPN結果取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4官報破産者情報検索結果取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4AIレポートPDF取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4ブラックリスト登録APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4ブラックリスト更新APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4ブラックリスト一覧取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4ブラックリスト削除APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4ブラックリスト分類項目 登録APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4ブラックリスト分類項目 更新APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4ブラックリスト分類項目取得APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4ブラックリスト分類項目 削除APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4取引判断・コメント更新API取引判断更新APIから名称変更
2026/8/31.2.4取引判断・コメント更新APIコメント入力を追加
2026/8/31.2.4取引判断・コメント更新APIコメントへの添付ファイル登録用URL(s3UploadUrl)をレスポンスに追加
2026/8/31.2.4取引判断・コメント更新APIファイルを添付する場合は取引先を1件のみ指定できる旨を明記
2026/8/31.2.4取引判断・コメント更新APIfileNameを指定する場合はfileExtensionが必須である旨を明記
2026/8/31.2.4取引判断・コメント更新APIバックエンドサービス接続エラー(502)のレスポンスを追加
2026/8/31.2.4AI与信設定取得APINotFoundエラー(404)のレスポンスを追加
2026/8/31.2.4AI与信設定更新APINotFoundエラー(404)のレスポンスを追加
2026/8/31.2.4チェック結果ファイル作成リクエストAPINotFoundエラー(404)のレスポンスを追加
2026/8/31.2.4World-Check候補一覧取得APIパラメーターエラー(400)・NotFoundエラー(404)のレスポンスを追加
2026/8/31.2.4World-Check詳細取得APIパラメーターエラー(400)・NotFoundエラー(404)のレスポンスを追加
2026/8/31.2.4World-Check識別番号種別リスト取得APIパラメーターエラー(400)のレスポンスを追加
2026/8/31.2.4所属グループ取得APIIPアドレス制限エラー(403)のレスポンスを追加
2026/8/31.2.4World-Check国リスト取得APIIPアドレス制限エラー(403)のレスポンスを追加
2026/8/31.2.4World-Check国籍リスト取得APIIPアドレス制限エラー(403)のレスポンスを追加
2026/8/31.2.4World-Check識別番号種別リスト取得APIIPアドレス制限エラー(403)のレスポンスを追加
2026/8/31.2.4World-Check候補一覧取得APIIPアドレス制限エラー(403)のレスポンスを追加
2026/8/31.2.4World-Check詳細取得APIIPアドレス制限エラー(403)のレスポンスを追加
2026/8/31.2.4SPN結果取得API生年・現年齢の絞り込みは数値・文字列の両方を受け付ける旨を明記
2026/8/31.2.4SPN結果取得API掲載日の絞り込みはゼロ埋めしたYYYY-MM-DD形式が必須である旨を明記
2026/8/31.2.4AIレポートPDF取得APIaiReportScoreの型を実装に合わせてnumber(小数を含む)に修正
2026/8/31.2.4取引先登録・チェックAPIコールバックcheckExecutionIdの型を実装に合わせてinteger に修正
2026/8/31.2.4取引先登録・チェックAPIコールバック掲載日・推定生年はキャメルケース(publicationDate / estimatedYearOfBirth)が正であり、後方互換のためスネークケースでも併せて送信される旨を明記
2026/8/31.2.4チェック結果詳細取得API値が無い場合にnullを返す項目(folderId / worldCheckExecutionHistoryId / publicationDate / estimatedYearOfBirth)にnullableを明記
2026/8/31.2.4チェック結果詳細取得(履歴)API値が無い場合にnullを返す項目(folderId / worldCheckExecutionHistoryId / publicationDate / estimatedYearOfBirth)にnullableを明記
2026/8/31.2.4取引判断・コメント取得API値が無い場合にnullを返すfolderIdにnullableを明記
2026/8/31.2.4取引先一覧取得API値が無い場合にnullを返すfolderIdにnullableを明記
2026/8/31.2.4SPN結果取得API未指定時にnullを返すoffsetと、値が無い場合にnullを返すgroupAddressにnullableを明記
2026/8/31.2.4官報破産者情報検索結果取得API未指定時にnullを返すoffsetにnullableを明記
2026/8/31.2.4ブラックリスト一覧取得API未指定時にnullを返すoffset・limitにnullableを明記
2026/8/31.2.4チェック結果詳細取得API注目度の絞り込みで解析除外(-1)を指定できるように修正
2026/8/31.2.4チェック結果詳細取得(履歴)API注目度の絞り込みで解析除外(-1)を指定できるように修正
2026/8/31.2.4ブラックリスト登録API代表者名・住所・登録理由・メモの型検証、リスト登録日の形式検証、名前のスペース除去指定の型検証を追加
2026/8/31.2.4ブラックリスト更新API代表者名・住所・登録理由・メモの型検証、リスト登録日の形式検証を追加
2026/8/31.2.4World-Check識別番号種別リスト取得APIcountryCodeの形式検証(ISO 3166-1 alpha-3)を追加し、説明に形式を明記
2026/8/31.2.4ブラックリスト一覧取得API値が無い場合にnullを返すlistRegisteredAtにnullableを明記
2026/8/31.2.4AI与信設定取得API値が無い場合にnullを返すequityRatio・capitalAmountにnullableを明記
2026/8/31.2.4AI与信設定更新API値が無い場合にnullを返すequityRatio・capitalAmountにnullableを明記
2026/8/31.2.4取引先登録・チェックAPIコールバックaiCreditResultを実装に合わせて実行状態(status / executionHistoryId)のみの定義に修正。完了データは含まれない旨と取得方法を明記
2026/8/31.2.4取引先登録・チェックAPIコールバックaiCreditResult.statusの選択肢を実装に合わせて修正(中断中・不明を追加、未実施を削除)
2026/8/31.2.4取引判断・コメント取得API追加作成(取引判断取得APIから名称変更)
2026/8/31.2.4取引判断・コメント取得APIcustomerIds / checkExecutionIds を複数指定可能に
2026/8/31.2.4ファイル取得API追加作成(コメント添付ファイル・チェック結果ファイルのダウンロードURLを取得)
2026/8/31.2.4チェック結果ファイル作成リクエストAPI追加作成(SPN報告書 / SPN個社別報告書 / 調査レポートの作成をリクエスト)
2026/8/31.2.4記事PDFダウンロードAPIPDFダウンロードAPIから名称変更
2026/8/31.2.4SPN結果取得API追加作成(SPN検索結果の実データをJSON取得)
2026/8/31.2.4SPN結果取得API生年・現年齢・掲載日(期間)での絞り込みを追加
2026/8/31.2.4官報破産者情報検索結果取得API追加作成(官報破産者情報検索結果をJSON取得)
2026/8/31.2.4取引先一覧取得API追加作成
2026/8/31.2.4取引先一覧取得APIcheckListをcheckConditionListにリネーム、取引先属性(種別/法人番号/企業URL/年齢生年/World-Check属性等)を取引先トップレベルへ移設
2026/8/31.2.4ブラックリスト登録API追加作成
2026/8/31.2.4ブラックリスト更新API追加作成
2026/8/31.2.4ブラックリスト一覧取得API追加作成
2026/8/31.2.4ブラックリスト削除API追加作成
2026/8/31.2.4ブラックリスト分類項目 登録API追加作成
2026/8/31.2.4ブラックリスト分類項目 更新API追加作成
2026/8/31.2.4ブラックリスト分類項目 削除API追加作成
2026/8/31.2.4ブラックリスト分類項目取得API追加作成
2026年10月(リリース予定)
日付 Version 更新箇所 更新内容
2026/101.3.0登記簿API(新規追加)登記簿の取得・名寄せ・データ抽出・ダウンロード等を行う登記簿API(計22オペレーション)を追加作成
[登記簿の取得]登記簿検索単独実行API/登記簿取得実行API(候補確定)/登記簿再取得API/登記簿取得状況・結果取得API/登記簿取得完了通知用 callback(registryResponseTarget で指定したURLに送付)
[名寄せ]法人名寄せ検索API/重複企業取得API
[一覧・削除]登記一覧検索API/登記簿一覧削除API
[データ抽出]登記データ抽出実行API/抽出データ取得API/抽出データ編集API/抽出設定取得API/抽出設定更新API/登記簿PDFアップロードAPI
[ダウンロード]登記簿PDFダウンロードAPI/抽出データExcelダウンロードAPI/コンプライアンスチェック一括登録用ExcelダウンロードAPI
[マスタ・その他]役職マスタ取得API/登記原因マスタ取得API/登記情報提供サービス稼働状況取得API/登記簿取得件数取得API
2026/101.3.0取引先登録・チェックAPI登記簿検索(名寄せ)・登記簿取得を同時実行するフラグ(isExecuteRegistrySearch)と、登記簿取得結果の返却先(registryResponseTarget)を追加。登記簿取得契約が必要(契約が無い場合は403エラー)。「個人」と判別できる取引先は対象外。登記情報提供サービスの利用料金(実費)が発生する
2026/101.3.0チェック結果通知/チェック結果詳細取得API/チェック結果詳細取得(履歴)API登記簿取得結果(registryResult)を追加。チェック結果の通知には実行状態のみ、チェック結果詳細取得には取得済みの場合の結果も含む。AI与信結果(aiCreditResult)と同じ扱い
2026/101.3.0記事PDFダウンロードAPIPDFファイルがアーカイブ状態の場合のレスポンスを追加

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

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

required
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回) 指定がない場合は返却を行わない

object

登記簿取得結果の返却先の指定【v1.3.0で追加】 isExecuteRegistrySearch=true を指定したリクエストについて、登記簿の取得完了時に指定URLへ送付する。 登記簿の取得は登記情報提供サービスへの請求を1件ずつ順番に行うため、完了までの時間は件数に比例して長くなる(100件をまとめて依頼した場合は数時間を要することがある)。 このため responseTarget / aiCreditResponseTarget とは別経路で通知される。  トークンが空欄の場合は特に設定をせず返却  ヘッダーに下記を付与してPOSTリクエストを送る  ・Authorization: Bearer {token} 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライを行う(最大10回) 指定がない場合は返却を行わない(登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)でポーリングすること)

Responses

Request samples

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

Response samples

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

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

取引先登録・チェックAPIでresponseTargetのurlを指定した場合、指定のURLにチェック結果を送付 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライ(最大10回) ※responseTargetのtokenを指定した場合、BearerTokenに指定のtokenを付与 ※結果の組み立て中にサーバー内部エラーが発生した場合は、resultList ではなく code / message のみの本文が送付される

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
required
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>

掲載日での絞り込み(この日付以降) ※未指定の場合は下限なし ※月日は必ず2桁でゼロ埋めすること(2021-9-1 ではなく 2021-09-01)。ゼロ埋めされていない場合は400エラー

pubDateTo
string <date>

掲載日での絞り込み(この日付以前) ※未指定の場合は上限なし ※月日は必ず2桁でゼロ埋めすること(2021-9-1 ではなく 2021-09-01)。ゼロ埋めされていない場合は400エラー

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

国コード ※ISO 3166-1 alpha-3(英字3文字)。World-Check国リスト取得APIで取得できるcodeを指定する

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
required
Array of integers

World-Check実行履歴ID ※一度のリクエストで最大10件まで ※同じIDを複数指定した場合は1件として扱われる

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与信のスコア計算に利用される閾値設定(自己資本比率・資本金など)を更新する。

※本APIは全項目の上書きです。リクエストに含めなかった項目は null でクリアされます。 片方だけ更新したい場合は、AI与信設定取得API(GET /v2/ai-credit/setting)で現在値を取得し、 変更しない項目も含めて送信してください。

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件まで
※ファイルを添付する場合(fileName 指定時)は1件のみ指定可能

checkDecisionChoice
required
integer
Enum: 0 1 2

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

comment
string
Default: null

コメント

fileName
string
Default: null

添付ファイル名(拡張子を除いた部分) ※ファイルを添付する場合、customerId は1件のみ指定可能(複数指定した場合は400エラー) ※fileExtension の指定が必須

fileExtension
string
Default: null

ファイルの拡張子 ※fileName を指定する場合は必須

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を生成して返却

  • PDFダウンロード用URL生成成功の場合message: successurlを返却
  • PDFが無い場合message: pdf file does not exist

    チェック実行から90日以上経過した場合のPDFダウンロードについて

    【v1.3.0で追加】 90日以上経過したPDFファイルについては、ダウンロード可能な状態となる前に「復旧」処理が必要
  • ダウンロードリクエストした場合は自動的に復旧処理が開始されmessage: restore_startを返却
  • 復旧処理開始後、通常4~5時間(最大48時間)経過後に再リクエストでPDFダウンロードURLを生成して返却
  • 復旧処理中(未完了)のファイルについてはmessage: restoringを返却
  • アーカイブ状態の確認自体に失敗した場合はmessage: restore_check_errorを返却(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
{
  • "pdfUrlList": [
    ]
}

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

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

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

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

checkExecutionIds
required
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) ※存在しない分類IDを指定しても登録は成功します(200)が、 その行はブラックリスト一覧取得API(GET /v2/blacklist)に表示されません。 誤って登録した場合は、本APIのレスポンスで返る blacklistId を使って ブラックリスト更新API(PUT /v2/blacklist)で正しい分類IDに直すか、 ブラックリスト削除API(POST /v2/blacklist/delete)で削除してください。

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": "反社関連"
}

登記簿API

【v1.3.0で追加】 登記簿取得・データ抽出・編集・ダウンロード・アップロード・一覧検索・削除。

登記一覧検索API

【v1.3.0で追加】 登記簿取得契約が必要。 絞り込み条件を指定し、登記簿取得依頼の一覧(取得状況・抽出状況を含む)を返却する。 ※検索条件を1つも指定しない場合は、対象グループの一覧を更新日時(updatedAt)の降順で返却する ※削除済み(登記簿一覧削除API)の依頼は一覧対象外となり返却されない ※取得ステータスが0(登記未取得)/7(抽出可)/8(抽出不可)の依頼も本APIの一覧対象に含まれ返却される(取得実行の受付直後の依頼、および登記簿PDFアップロードAPIでアップロードした登記簿を追跡するため) ※本APIで参照できるのは所属グループ取得API(GET /v2/get-group)で返却されるグループの登記簿取得依頼のみ

Authorizations:
Bearer
Request Body schema: application/json

登記一覧検索条件 ※すべての項目が任意のため、絞り込みを行わない場合は空のJSONオブジェクト({})を指定する

groupIds
Array of integers

絞り込み:グループIDリスト ※未指定の場合は、所属グループ取得API(GET /v2/get-group)で返却されるグループ(所属グループおよびその管理下のグループ)すべてを対象とする ※指定できるのは所属グループ取得API(GET /v2/get-group)で返却されるグループIDのみ ※返却されないグループIDが1件でも含まれている場合は、該当するIDのみを除外することはせず、リクエスト全体を404(code:6003)で拒否する

searchQuery
string

絞り込み:フリーワード検索 ※会社名/法人番号/住所/代表者名を横断して部分一致検索する ※指定文字列はそのままの表記に加え、全角・半角を正規化した表記でも併せて検索する

acquisitionStatus
integer
Enum: 0 1 2 3 4 5 6 7 8 9 11

絞り込み:取得ステータス 0:登記未取得 / 1:登記取得中 / 2:登記取得済 / 3:登記エラー / 4:データ抽出中 / 5:データ抽出済 / 6:データ抽出エラー / 7:抽出可(アップロード) / 8:抽出不可(アップロード) / 9:登記なし / 11:複数候補 ※10は欠番であり、指定も返却もされない ※定義外の値を指定した場合は400(code:5101)を返却する

executeType
integer
Enum: 0 1 2

絞り込み:実行区分 0:自動取得 / 1:データ抽出 / 2:手動アップロード ※定義外の値を指定した場合は400(code:5102)を返却する

operatorId
integer

絞り込み:担当者(最終更新者)のユーザーID ※レスポンスのupdatedByと同じ値を指定する

companyInformationId
integer

絞り込み:会社情報ID ※データ抽出済みの登記簿から作成された会社情報のID

executionHistoryId
integer

絞り込み:実行履歴ID ※登記簿取得の実行単位を表すID。レスポンスのexecutionHistoryIdと同じ値を指定する ※コンプライアンスチェックの実行履歴ID(complianceExecutionHistoryId)とは別のIDである

complianceExecutionHistoryId
integer

絞り込み:コンプライアンスチェック実行履歴ID ※コンプライアンスチェックを起点に登記簿取得を実行した依頼のみ絞り込める

complianceCustomerId
integer

絞り込み:コンプライアンス取引先ID ※コンプライアンスチェックを起点に登記簿取得を実行した依頼のみ絞り込める

toukiDateFrom
string <date>

絞り込み:登記簿取得日(開始)(yyyy-MM-dd) ※登記簿取得依頼の更新日時(updatedAt)を対象に絞り込む ※日本時間(JST, UTC+09:00)の指定日00:00:00以降が対象 ※形式に誤りがある場合は400(code:5105)を返却する

toukiDateTo
string <date>

絞り込み:登記簿取得日(終了)(yyyy-MM-dd) ※登記簿取得依頼の更新日時(updatedAt)を対象に絞り込む ※日本時間(JST, UTC+09:00)の指定日23:59:59までが対象 ※形式に誤りがある場合は400(code:5105)を返却する

createdAtFrom
string <date>

絞り込み:登録日(開始)(yyyy-MM-dd) ※登記簿取得依頼の登録日時(createdAt)を対象に絞り込む ※日本時間(JST, UTC+09:00)の指定日00:00:00以降が対象 ※形式に誤りがある場合は400(code:5105)を返却する

createdAtTo
string <date>

絞り込み:登録日(終了)(yyyy-MM-dd) ※登記簿取得依頼の登録日時(createdAt)を対象に絞り込む ※日本時間(JST, UTC+09:00)の指定日23:59:59までが対象 ※形式に誤りがある場合は400(code:5105)を返却する

orderBy
string
Enum: "companyName" "corporateNumber" "address" "representativeName" "acquisitionStatus" "executeType" "executeStatus" "createdAt" "updatedAt"

並び替え項目(未指定時はupdatedAt) companyName:会社名 / corporateNumber:法人番号 / address:住所 / representativeName:代表者名 / acquisitionStatus:取得ステータス / executeType:実行区分 / executeStatus:実行ステータス / createdAt:登録日時 / updatedAt:更新日時(登記簿取得日) ※登記簿取得日順に並び替える場合はupdatedAtを指定する ※定義外の値を指定した場合は400(code:5103)を返却する

orderDirection
string
Enum: "asc" "desc"

並び順(asc:昇順 / desc:降順) ※orderByを指定した場合の未指定時はasc、orderByも未指定の場合はupdatedAtのdescで返却する ※定義外の値を指定した場合は400(code:5104)を返却する

limit
integer
Default: 10

取得件数上限数(未指定時は10、最大100) ※1以上100以下の整数で指定する ※0以下の値・100を超える値・数値として解釈できない値を指定した場合は、既定値や上限値への補正は行わずリクエスト全体をパラメーターエラー(code:400)とする ※100件を超えて取得する場合はoffsetを進めて複数回リクエストすること

offset
integer
Default: 0

取得するデータの開始位置(未指定時は0) ※0以上の整数で指定する ※総件数(totalCount)を踏まえたページネーションとして使用する ※負数・数値として解釈できない値を指定した場合は、既定値への補正は行わずリクエスト全体をパラメーターエラー(code:400)とする

Responses

Request samples

Content type
application/json
{
  • "groupIds": [
    ],
  • "searchQuery": "株式会社〇〇〇",
  • "acquisitionStatus": 2,
  • "executeType": 0,
  • "operatorId": 700000,
  • "companyInformationId": 800000,
  • "executionHistoryId": 900000,
  • "complianceExecutionHistoryId": 200000,
  • "complianceCustomerId": 100001,
  • "toukiDateFrom": "2026-07-01",
  • "toukiDateTo": "2026-07-31",
  • "createdAtFrom": "2026-07-01",
  • "createdAtTo": "2026-07-31",
  • "orderBy": "updatedAt",
  • "orderDirection": "desc",
  • "limit": 20,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "totalCount": 128,
  • "offset": 0,
  • "limit": 20,
  • "acquisitions": [
    ]
}

登記簿一覧削除API

【v1.3.0で追加】 登記簿取得契約が必要。 指定した登記簿取得依頼を削除する。 ・削除は 論理削除 であり、登記簿取得依頼と、それに紐づく実行履歴に削除フラグを立てる。以降、登記一覧検索API(POST /v2/registry/list)の結果には含まれない。 ・削除すると、その依頼に紐づく登記簿PDF・抽出データはAPIから取得できなくなる。 削除済みの依頼を指定した場合、登記簿PDFダウンロードAPI(POST /v2/registry/download/pdf)・抽出データ取得API(GET /v2/registry/extraction/data)・抽出データExcelダウンロードAPI(POST /v2/registry/download/extraction-excel)は410(code:8100)を返却する。  登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)でも削除済みの依頼は結果に含まれず、指定した全てのIDが削除済みの場合は410(code:8100)となる。必要なPDF・抽出データは削除前に取得しておくこと。 ・登記情報提供サービスの課金実績は削除されない。既に発生した利用料は取り消されない。 ・削除済みの依頼は再取得できない(登記簿再取得API(POST /v2/registry/reacquire)は410(code:8100)を返却する)。同一の会社を再度取得する場合は、登記簿取得実行API(候補確定)(POST /v2/registry/duplicate-acquisition)で新規の依頼として実行すること。 ・1リクエストで指定できる acquisitionIds は最大100件。100件を超える場合は、先頭100件に丸めることはせず、リクエスト全体をパラメーターエラー(code:5111)とする。 ・本APIは全件エラー方式 である。指定した acquisitionIds のうち1件でも削除できないものが含まれる場合は、いずれの依頼も削除せずエラーを返却する(部分成功はしない)。 ・削除可否は以下の順序で判定する。複数の理由が同時に成立する場合は、先に該当した理由のコードを返却する。  1. リクエストのパラメーター検証(code:400 / 5107 / 5108 / 5111 / HTTP 400)  2. groupId が利用者の所属グループか(code:6003 / HTTP 404)  3. acquisitionIds が指定グループに存在するか(code:6006 / HTTP 404)※他グループの登記簿取得依頼IDは「存在しない」として扱う  4. 既に削除済みでないか(code:8100 / HTTP 410) ・取得実行中(acquisitionStatus が 1:登記取得中)の依頼も削除できるため、実行中を理由とする競合エラー(409)は返却しない。削除後に取得処理が完了しても、一覧・PDF取得の対象にはならない。 ・エラー時は、該当した acquisitionId をmessageに併記する。複数該当する場合は先頭の1件を併記する。 ・他グループの登記簿取得依頼は削除できない(所属していないグループIDを指定した場合は404(code:6003)を返却する)。

Authorizations:
Bearer
Request Body schema: application/json

削除対象のグループIDと登記簿取得依頼IDリスト

groupId
required
integer

削除を実行するグループID ※アクセストークンの利用者が所属しているグループID(所属グループ取得API(GET /v2/get-group)で取得できるグループ)を指定する ※所属していないグループを指定した場合は404(code:6003)を返却する ※未指定の場合は400(code:5108)を返却する

acquisitionIds
required
Array of integers

削除する登記簿取得依頼IDのリスト(1件以上100件以下) ※登記一覧検索API(POST /v2/registry/list)の acquisitionId を指定する ※未指定、または配列でない場合は400(code:5107)を返却する ※101件以上を指定した場合は、先頭100件に丸めずにパラメーターエラー(code:5111)を返却する ※groupId に存在しないIDが1件でも含まれる場合は404(code:6006)となり、いずれの依頼も削除されない

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "acquisitionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "deletedCount": 2,
  • "acquisitionIds": [
    ],
  • "deletedExecutionHistoryCount": 2
}

登記簿検索単独実行API

【v1.3.0で追加】 登記簿取得契約が必要。 既に登録済みの取引先に対して、インターネットチェック等を伴わず登記簿検索(名寄せ)のみを単独実行する。 取得処理は非同期で実行され、本APIは受付結果のみを即時に返却する。 完了は registryResponseTarget.url へのcallback(登記簿取得完了通知用 callback)、もしくは登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)のポーリングで受け取る(ポーリング間隔は1分以上を推奨)。 ※callbackは、同一リクエストで受け付けた依頼が全て終了状態(2:登記取得済/3:登記エラー/9:登記なし/11:複数候補)になった時点で1回送付する。

課金についての注意

本APIによる登記簿の取得は、登記情報提供サービス(一般財団法人 民事法務協会)への実際の請求を伴い、取得1件ごとに登記情報提供サービスの利用料金(実費)が発生する。 課金対象となるのは登記簿PDFを実際に取得できた依頼のみであり、登記簿取得件数取得API(GET /v2/registry/usage-count)の集計対象と一致する。 同一の法人を重複して実行した場合は重複して請求されるため、呼び出し側で重複排除を行うこと(リクエストの重複を検知する冪等性キーは提供していない)。 既に登記簿を取得済みの取引先に対して本APIを再度実行した場合も、新たな請求となりあらためて課金が発生する。 ※実請求の前に停止した依頼は課金されない。具体的には acquisitionStatus が 9(登記なし)で終了した依頼、11(複数候補)で候補の確定を待っている依頼、及び rejectedList に格納された取引先が該当する。 ※acquisitionStatus 3(登記エラー)は課金件数に計上されないが、登記情報提供サービスへの実費は請求が成立した後に失敗した場合でも発生しうる(message に「請求開始後にログインセッションが切れました」「請求開始後に処理時間を超過しました」等が設定された依頼)。再実行を行う前に登記簿取得状況・結果取得APIの message を確認すること。

取引先種別(entityType)の扱い

登記簿検索は法人(組織)を対象とした機能のため、種別が「個人」と判別できる取引先は対象外とする。

  • entityType もしくは isExecuteWorldCheck が「個人」の取引先:登記簿検索を実行せず、rejectedList に code:7111 で格納する
  • entityType が未設定の取引先:「組織」として扱い、登記簿検索を実行する ※entityType は本APIのリクエストでは指定できない。種別を登録・変更する場合は取引先登録・チェックAPI(POST /v2/execution)で行う。

    受付時間

    登記情報提供サービスの受付時間(平日 8:30〜22:30 / 土日祝 8:30〜17:30。年末年始休業 12/29〜1/3 及びメンテナンス時間帯を除く)外に実行した場合は受付のみを行い、次回の受付時間開始後に自動で実行される。 この場合、受け付けた依頼は取得が開始されないまま acquisitionStatus 0(登記未取得)で滞留する。 土曜・日曜・祝日も 8:30〜17:30 は受付時間内であるため、金曜夜に受け付けた依頼が土曜の 8:30 に実行されることがある。 提供時間内かどうかは、実行前に登記情報提供サービス稼働状況取得API(GET /v2/registry/service-status)で判定できる。

    上限

    1リクエストあたり customerIds は最大100件。 100件を超えた場合は先頭100件に丸めることはせず、リクエスト全体をエラー(HTTPステータス400、code:5121)とする。

    受付可否の判定順序

    複数の理由が同時に成立する場合は、先に該当した理由のコードを返却する。
  1. リクエストのパラメーター検証(400/5108/5120/5121。HTTPステータス400)
  2. groupId が利用者の所属グループか(6003。HTTPステータス404)
  3. customerIds が指定グループに存在するか(6000。HTTPステータス404)※1件でも存在しない場合はいずれの取引先も実行せず、課金も発生しない
  4. 取引先の種別が「個人」でないか(7111。要素単位。全件が該当する場合は 5122/HTTPステータス400)
  5. 同一取引先の登記簿取得が実行中でないか(7100。要素単位。全件が該当する場合はHTTPステータス409) ※一部の取引先のみが受付不可の場合はHTTPステータス200を返し、受け付けた取引先を acceptedList に、受け付けられなかった取引先を rejectedList に格納する。rejectedList に格納された取引先は実行されず、課金も発生しない。
Authorizations:
Bearer
Request Body schema: application/json

登記簿検索対象の取引先リスト

groupId
required
integer

登記簿検索を実行するグループID ※所属グループ取得API(GET /v2/get-group)で取得できるグループIDを指定する。所属していないグループを指定した場合はエラー(code:6003)

customerIds
required
Array of integers

登記簿検索対象の取引先IDリスト ※一度のリクエストで最大100件まで。101件以上を指定した場合は、先頭100件に丸めることはせずパラメーターエラー(code:5121)を返却する ※種別(entityType もしくは isExecuteWorldCheck)が「個人」の取引先は対象外となり、rejectedList に格納される。種別が未設定の取引先は「組織」として扱う

object

登記簿取得完了通知の返却先の指定  トークンが空欄の場合は特に設定をせず返却  ヘッダーに下記を付与してPOSTリクエストを送る  ・Authorization: Bearer {token} 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライを行う(最大10回) 指定がない場合は返却を行わない(登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)でポーリングすること)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "groupId": 100000,
  • "concurrentExecutionId": "3f2b7c1a-9d64-4f0e-8f6b-2a1c5d7e9b04",
  • "acceptedList": [
    ],
  • "rejectedList": [
    ],
  • "registryResponseTarget": {}
}

登記簿再取得API

【v1.3.0で追加】 登記簿取得契約が必要。 登記エラーなどで完了しなかった登記簿取得依頼を、あらためて取得し直す。 ・再取得は元の依頼を上書きせず、新しい登記簿取得依頼(acquisitionId・executionHistoryId)として登録される。元の依頼はそのまま登記一覧検索API(POST /v2/registry/list)の結果に残る。 ・再取得は登記情報提供サービスへの新たな請求となるため、あらためて課金が発生する。エラー内容を確認のうえ実行すること。 ・登記情報提供サービスへの請求開始後に、ログインセッション失効または処理時間超過で中断した対象は、二重請求防止のため自動での再取得を行わない。  該当する依頼は登記エラー(acquisitionStatus:3)となり、登記一覧検索APIの message にその旨が設定されるため、内容を確認のうえ本APIで再取得すること。 ・登記簿取得は非同期処理のため、本APIは受付結果のみを即時に返却する。完了は登記簿取得完了通知 callback、または登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)の acquisitionStatus で確認すること。 ・進捗の確認には登記簿取得状況・結果取得APIを使用すること。登記一覧検索APIは受付直後の依頼を返却しないため、再取得の進捗確認には使用できない。 ・registryResponseTarget を指定した場合の完了通知は、登記簿取得完了通知用 callback と同じ本文で送付する。通知との突合にはレスポンスの concurrentExecutionId、または新規採番された acquisitionId を使用する。 ・本APIは全件エラー方式である。指定した acquisitionIds のうち1件でも受け付けられないものが含まれる場合は、いずれの依頼も実行せずエラーを返却する(部分成功しない)。  再取得は課金が発生する処理のため、一部だけ実行された中途半端な状態を作らないようにしている。エラーとなった場合は1件も実行されず、課金も発生しない。 ・受付可否は以下の順序で判定する。複数の理由が同時に成立する場合は、先に該当した理由のコードを返却する。  1. リクエストのパラメーター検証(code:400 / 5107 / 5108 / 5111、HTTPステータス400)  2. groupId が利用者の所属グループか(code:6003、HTTPステータス404)  3. 対象グループに登記情報提供サービスのアカウントが設定されているか(code:6104、HTTPステータス404)  4. acquisitionIds が指定グループに存在するか(code:6100、HTTPステータス404)※他グループの登記簿取得依頼IDは「存在しない」として扱う  5. 削除済みでないか(code:8100、HTTPステータス410)※削除済みの依頼は時間をおいても再取得できないため、取得実行中より先に判定する  6. 取得実行中(acquisitionStatus:1)でないか(code:7100、HTTPステータス409) ・エラー時は、該当した acquisitionId を message に併記する。複数該当する場合は先頭の1件を併記する。 ・他グループの登記簿取得依頼は指定できない(所属していないグループIDを指定した場合は code:6003 を返却)。 ・削除済みの依頼は再取得できない。同一の会社をあらためて取得する場合は、登記簿取得実行API(POST /v2/registry/duplicate-acquisition)で新規の依頼として実行すること。

課金について

本APIによる登記情報の取得は、登記情報提供サービスへの実際の請求を伴い、取得1件ごとに登記情報提供サービスの利用料金が発生する。 同一の依頼を重複して再取得した場合は重複して請求されるため、呼び出し側で重複排除を行うこと(リクエストの重複を検知する冪等性キーは提供していない)。 ※実請求の前に停止した場合は課金されない。取得ステータスが 9(登記なし)で終了した依頼(検索結果が0件の場合、閉鎖された登記記録しか存在しない場合、法人番号の6〜7桁目が 01/02/03/04/05 以外の場合)が該当する。 ※同一法人について複数の登記記録がヒットした場合も請求は現に効力を有する登記記録の1件のみであり、重複して課金されることはない。 ※ただし登記情報提供サービスへの実費は、請求が成立した後に失敗した場合でも発生しうる(message に「請求開始後にログインセッションが切れました」「請求開始後に処理時間を超過しました」等が設定された依頼)。  取得ステータス 3(登記エラー)は請求前の失敗と請求成立後の失敗の双方を含むため、再取得を行う前に message を確認すること。

上限

1リクエストあたり acquisitionIds は最大100件。 100件を超えた場合は先頭100件に丸めることはせず、リクエスト全体をエラー(HTTPステータス400、code:5111)とする。

Authorizations:
Bearer
Request Body schema: application/json

再取得対象の登記簿取得依頼

groupId
required
integer

グループID ※アクセストークンの利用者が所属しているグループIDを指定する

acquisitionIds
required
Array of integers

再取得する登記簿取得依頼IDのリスト ※登記一覧検索API(POST /v2/registry/list)の acquisitionId を指定する ※一度のリクエストで最大100件まで。101件以上を指定した場合は、先頭100件に丸めずパラメーターエラー(code:5111)を返却する

object

登記簿取得完了通知の返却先の指定 本APIで受け付けた再取得の完了時に、指定URLへ登記簿取得完了通知 callback を送付する。  トークンが空欄の場合は特に設定をせず返却  ヘッダーに下記を付与してPOSTリクエストを送る  ・Authorization: Bearer {token} 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライを行う(最大10回) 指定がない場合は返却を行わない(登記簿取得状況・結果取得APIでポーリングすること)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "concurrentExecutionId": "9c1d4e7a-2b58-41f3-9a0d-6e3f8b2c5d71",
  • "acceptedCount": 2,
  • "acquisitions": [
    ]
}

重複企業取得API

【v1.3.0で追加】 登記簿取得契約が必要。 コンプライアンスチェックの登記簿名寄せで候補を1社に絞り込めなかった取引先について、検出された候補(重複企業)の一覧を取得する。 ※複数候補(取得ステータス 11)は、会社名を起点とした名寄せ(コンプライアンスチェック経由)で登録された取得依頼にのみ発生する。  法人番号を指定して取得する経路(登記簿取得実行API・登記簿再取得API)では発生しない。 ※複数候補の状態では登記情報提供サービスへの請求を行っていないため、登記簿PDF・抽出データは存在せず、課金も発生していない。 ※候補を1社に確定して登記簿を取得する場合は、本APIで取得した候補の法人番号・会社名・住所・代表者名と、  同じ行の complianceCustomerId を登記簿取得実行API(POST /v2/registry/duplicate-acquisition)に指定して実行する。  取得を実行した時点で登記情報提供サービスへの実費請求を伴う課金が発生する。 ※1回のリクエストで取得できるのは最大100件。件数が多い場合は offset を進めて複数回リクエストすること。

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

グループID ※所属グループ取得API(GET /v2/get-group)で取得できるグループIDを指定する ※所属していないグループを指定した場合は404(code:6003)を返却する

complianceExecutionHistoryId
required
integer
Example: complianceExecutionHistoryId=700000

コンプライアンス実行履歴ID 取引先登録・チェック実行APIのレスポンス/コールバックで返却される実行履歴ID ※指定したグループに紐づかない実行履歴を指定した場合は、存在しないものとして404(code:6004)を返却する

limit
integer
Example: limit=20

取得件数上限数(未指定時は10、最大100) ※100を超える値を指定した場合は、100に丸めずにパラメーターエラー(code:400)を返却する

offset
integer
Example: offset=0

取得するデータの開始位置(未指定時は0) ※総件数(totalCount)を踏まえたページネーションとして使用する ※負数を指定した場合は、既定値への補正は行わずパラメーターエラー(code:400)を返却する

Responses

Response samples

Content type
application/json
{
  • "totalCount": 42,
  • "offset": 0,
  • "limit": 20,
  • "duplicateCompanies": [
    ]
}

登記簿取得実行API(候補確定)

【v1.3.0で追加】 登記簿取得契約が必要。 取得対象の法人を法人番号で確定して、登記情報(PDF)の取得を実行する。 次のいずれの経路からも利用できる汎用の実行APIである。

  • 法人名寄せ検索API(POST /v2/registry/corporation/search)で得た候補の法人番号を指定して取得する
  • 重複企業取得API(GET /v2/registry/duplicate-companies)で得た複数候補(取得ステータス 11:複数候補)から対象の法人を確定して取得する 取得できるのは登記情報提供サービス(一般財団法人 民事法務協会)から提供される登記情報(PDF)であり、登記事項証明書(法務局が発行する公文書)ではないため、証明文言は付されない。 取得する登記情報の種別は固定で、リクエストでの指定はできない。 取得処理は非同期で実行され、本APIは受付結果のみを即時に返却する。 完了は registryResponseTarget.url へのcallback(登記簿取得完了通知)、もしくは登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)のポーリングで受け取る。 ※本APIが行うのは登記簿PDFの取得までである。抽出データが必要な場合は、取得完了後に登記データ抽出実行API(POST /v2/registry/extraction/execute)を実行すること

    部分成功について

    要素単位で受付可否を判定し、受け付けた依頼を acceptedList に、受け付けられなかった依頼を理由コード付きで rejectedList に格納してHTTPステータス200を返却する。 ただし全要素が同一の理由で受け付けられなかった場合は、1件も受け付けていないことをHTTPステータスで判別できるようリクエスト全体のエラーとする(7101 のみなら400(code:5100)、7100 のみなら409)。

    課金について

    本APIによる登記情報の取得は、登記情報提供サービスへの実際の請求を伴い、取得1件ごとに登記情報提供サービスの利用料金が発生する。 同一法人を重複して依頼した場合は重複して請求されるため、呼び出し側で重複排除を行うこと(リクエストの重複を検知する冪等性キーは提供していない)。 登記簿再取得API(POST /v2/registry/reacquire)による再取得も登記情報提供サービスへの新たな請求となるため、あらためて課金が発生する。 ※実請求の前に停止した場合は課金されない。取得ステータスが 9(登記なし)で終了した依頼(検索結果が0件の場合、閉鎖された登記記録しか存在しない場合、法人番号の6〜7桁目が 01/02/03/04/05 以外の場合)、および rejectedList に格納された要素が該当する。 ※同一法人について複数の登記記録がヒットした場合も請求は現に効力を有する登記記録の1件のみであり、重複して課金されることはない。閉鎖された登記記録は請求の対象としない。 ※RoboRoboの課金件数は登記簿取得件数取得API(GET /v2/registry/usage-count)の集計対象(登記簿PDFを実際に取得できた依頼のみ)と一致し、取得ステータス 3(登記エラー)は件数に計上されない。 ※ただし登記情報提供サービスへの実費は、請求が成立した後に失敗した場合でも発生しうる。取得ステータス 3(登記エラー)は請求前の失敗と請求成立後の失敗の双方を含むため、再取得を行う前に登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)の message を確認すること。

    事前準備

    本APIの利用には、対象グループに登記情報提供サービスのアカウントが登録されている必要がある(設定方法は契約時に案内する)。 対象グループに個別の設定が無い場合は、グループオーナー(親グループ)の設定にフォールバックして実行する。 いずれも未登録の場合はリクエスト全体がエラー(HTTPステータス404、code:6104)となる。

    受付時間

    登記情報提供サービスの受付時間(平日 8:30〜22:30 / 土日祝 8:30〜17:30。年末年始休業 12/29〜1/3 及びメンテナンス時間帯を除く)外に実行した場合は、受付のみを行い、次回の受付時間開始後に自動で実行される。 この場合、受付した依頼は取得ステータス 1(登記取得中)のまま滞留する。 提供時間内かどうかは、実行前に登記情報提供サービス稼働状況取得API(GET /v2/registry/service-status)で判定できる。

    上限

    1リクエストあたり acquisitions は最大100件。 100件を超えた場合は先頭100件に丸めることはせず、リクエスト全体をエラー(HTTPステータス400、code:5102)とする。
Authorizations:
Bearer
Request Body schema: application/json

取得対象の企業情報

groupId
required
integer

登記簿取得を実行するグループID ※アクセストークンの所有者が所属していないグループを指定した場合はエラー(code:6003)

required
Array of objects

登記簿取得の依頼リスト(1件以上100件以下) ※101件以上を指定した場合は、先頭100件に丸めずにパラメーターエラー(code:5102)を返却する

object

登記簿取得完了通知の返却先の指定  トークンが空欄の場合は特に設定をせず返却  ヘッダーに下記を付与してPOSTリクエストを送る  ・Authorization: Bearer {token} 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライを行う(最大10回) 指定がない場合は返却を行わない(登記簿取得状況・結果取得APIでポーリングすること)

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "acquisitions": [
    ],
  • "registryResponseTarget": {}
}

Response samples

Content type
application/json
{
  • "groupId": 100000,
  • "concurrentExecutionId": "3f2b7c1a-9d64-4f0e-8f6b-2a1c5d7e9b04",
  • "acceptedList": [
    ],
  • "rejectedList": [
    ]
}

登記データ抽出実行API

【v1.3.0で追加】 登記簿取得契約が必要。 取得済み、またはアップロード済みの登記簿PDFからデータ抽出(会社情報・役員情報の読み取り)を実行する。 acquisitionIds には、登記一覧検索API(POST /v2/registry/list)・登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)・登記簿PDFアップロードAPI(POST /v2/registry/pdf/upload)のレスポンスで返却される取得依頼ID(acquisitionId)を指定する。 データ抽出は非同期で実行され、本APIは受付結果のみを即時に返却する。抽出結果は本APIのレスポンスには含まれない。

結果の受け取り方

抽出の完了は、登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)に acquisitionIds を指定してポーリングし、acquisitionStatus で判定する。  ・4:データ抽出中 … 実行中。本APIで受け付けた直後はこの値になる  ・5:データ抽出済 … 抽出完了。返却された companyInformationId を抽出データ取得API(GET /v2/registry/extraction/data)に指定して抽出データを取得する  ・6:データ抽出エラー … 抽出失敗。失敗の理由は message を参照する executeStatus は 0:実行待ち → 1:実行中 → 2:正常終了 もしくは 8:エラー終了 と遷移する。本APIで受け付けた直後は 0:実行待ち。 終了したかどうかの判定は executeStatus ではなく acquisitionStatus で行うこと。 ※抽出の所要時間は登記簿PDFの内容により変動する。ポーリング間隔は1分以上を推奨する。 ※本APIでは完了通知(callback)の返却先を指定できない。callbackで受け取る場合は、登記簿取得を実行する各API(取引先登録・チェックAPI(POST /v2/execution)の isExecuteRegistrySearch /登記簿検索単独実行API(POST /v2/registry/execution)/登記簿取得実行API(候補確定)(POST /v2/registry/duplicate-acquisition)/登記簿再取得API(POST /v2/registry/reacquire))で registryResponseTarget を指定し、登記簿の取得からデータ抽出までを一括で依頼すること。

抽出の対象

※対象は登記簿PDFが存在する取得依頼(取得ステータスが 2:登記取得済 / 5:データ抽出済 / 6:データ抽出エラー / 7:抽出可(アップロード))。それ以外のステータスの取得依頼は受け付けられず、rejectedList に格納する(1:登記取得中 / 4:データ抽出中 は code:7100、それ以外のステータスは code:7104)。 ※11:複数候補 の取得依頼は登記簿PDFを取得していない状態であるため抽出できず、code:7104 で rejectedList に格納する。登記簿取得実行API(候補確定)(POST /v2/registry/duplicate-acquisition)で候補を確定し、登記簿を取得してから実行すること。 ※既にデータ抽出済みの取得依頼を指定した場合は再抽出を行い、既存の会社情報(companyInformationId)を上書き更新する。抽出データ編集API(PUT /v2/registry/extraction/data)で編集した内容も失われるため、編集内容を残す必要がある場合は再抽出を行わないこと。 ※データ抽出に対応するのはデジタル原本の登記簿PDF(テキスト情報を持つPDF)のみ。原本をスキャンした画像PDFは抽出対象外となり、acquisitionStatus 6:データ抽出エラー で終了する。 ※退任済みの役員を抽出するかどうかは抽出設定(isExtractResignedOfficers)に従い、本APIのリクエストでは指定できない。設定の参照・変更は抽出設定取得API(GET /v2/registry/extraction/setting)/抽出設定更新API(PUT /v2/registry/extraction/setting)で行う。 ※本APIによるデータ抽出は登記情報提供サービスへの請求を伴わないため、再抽出を行っても登記簿取得の課金は発生しない。

受付結果の判定(部分成功)

本APIは要素単位の部分成功とする。指定した取得依頼のうち実行できるものを受け付けて acceptedList に、実行できないものを理由コード付きで rejectedList に格納し、HTTPステータスは200を返却する。 受け付けられない取得依頼(実行中・抽出対象外のステータス・存在しない取得依頼ID・削除済みの取得依頼ID)が含まれていても、リクエスト全体をエラーとすることはない。 ※全ての取得依頼が受け付けられなかった場合も200を返却する。この場合 acceptedList は空配列となり、指定した全件が rejectedList に格納される。 ※リクエスト全体がエラーとなるのは、パラメーターの不備(400)・認証/権限/契約の不備(401/403)・所属していないグループの指定(404、code:6003)・サーバー側の異常(500/502)の場合に限られる。 ※受付可否は次の順序で判定する。複数の理由が同時に成立する場合は、先に該当した理由のコードを返却する。  1. リクエストのパラメーター検証(400・5107・5108・5111/HTTP 400)  2. groupIdが利用者の所属グループか(6003/HTTP 404)  3. 取得依頼IDが指定グループに存在するか(7105)※他グループの取得依頼IDは「存在しない」として扱う  4. 削除済みでないか(7106)※削除済みの依頼は時間をおいても抽出できないため、実行中より先に判定する  5. 登記取得中・データ抽出中でないか(7100)  6. データ抽出の対象となる取得ステータスか(7104)

上限

1リクエストあたり acquisitionIds は最大100件。 ※100件を超えて指定した場合、先頭100件に丸めることはせずリクエスト全体をエラー(HTTPステータス400、code:5111)とする。

Authorizations:
Bearer
Request Body schema: application/json

データ抽出対象の取得依頼

groupId
required
integer

データ抽出を実行するグループID ※APIアクセストークンの所有者が所属していないグループを指定した場合はエラー(code:6003)

acquisitionIds
required
Array of integers

データ抽出を実行する取得依頼IDのリスト(1件以上100件以下) ※101件以上を指定した場合は、先頭100件に丸めずにパラメーターエラー(code:5111)を返却する ※存在しない取得依頼ID・削除済みの取得依頼IDが含まれていてもリクエスト全体はエラーとせず、該当の取得依頼を rejectedList(code:7105/7106)に格納して200を返却する

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "acquisitionIds": [
    ]
}

Response samples

Content type
application/json
{
  • "concurrentExecutionId": "8c41d0e2-7b35-4a19-9c7d-6e0f3b52a184",
  • "acceptedList": [
    ],
  • "rejectedList": [
    ]
}

抽出データ取得API

【v1.3.0で追加】 登記簿取得契約が必要。 グループIDと会社情報IDを指定し、抽出済みの登記データ(会社情報・役員情報)を取得する。 ・companyInformationIdには、登記データ抽出実行API(POST /v2/registry/extraction/execute)/登記一覧検索API(POST /v2/registry/list)のレスポンスで返却される会社情報IDを指定する。 ・データ抽出が完了していない場合(登記簿取得ステータスが「5:データ抽出済」以外の場合)は抽出データが存在しないため、404(code:6006)を返却する。 ・抽出できる項目は下記に限られる。事業目的・支店・発行済株式総数・株式の譲渡制限に関する規定等は抽出対象外。  ・会社情報 … 会社法人等番号/商号/本店所在地/設立年月日/資本金/代表者名/登記簿取得日  ・役員情報 … 役職/氏名/就任日(任期開始日)/退任日(任期満了日)/登記原因 ・company.corporateNumberは、登記簿に記載された会社法人等番号(12桁)を返却する。法人番号(13桁)から先頭の検査用数字1桁を除いた値にあたる。 ・役職ID(executiveId)・登記原因ID(registrationReasonId)は、マスタを参照しなくても利用できるよう名称(executiveNameregistrationReasonName)を併せて返却する。役職マスタ取得API(GET /v2/registry/masters/executives)/登記原因マスタ取得API(GET /v2/registry/masters/registration-reasons)の値と同じ。 ・退任済みの役員を返却するかどうかは抽出設定(isExtractResignedOfficers)に従う。既定では退任済みの役員は返却しない。設定の参照・変更は抽出設定取得API(GET /v2/registry/extraction/setting)/抽出設定更新API(PUT /v2/registry/extraction/setting)で行う。 ・抽出設定は組織(親グループのオーナーユーザー)単位で保持されるため、同一組織配下のどのグループ・ユーザーで実行しても同じ設定が適用される。 ・抽出データ編集API(PUT /v2/registry/extraction/data)で編集されたかどうかはisEditededitedAtで判別できる。 ・updatedAtは抽出データ編集APIの条件付き更新に指定する値。編集する場合は、本APIで取得したupdatedAtをそのまま抽出データ編集APIに指定すること。 ・指定した会社情報に紐づく登記簿取得依頼が削除済み(登記簿取得依頼削除APIで削除された場合)は、抽出データを取得できず410(code:8100)を返却する。

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

グループID ※APIアクセストークンの所有者が所属していないグループを指定した場合は404(code:6003)

companyInformationId
required
integer
Example: companyInformationId=800000

会社情報ID ※指定したグループに存在しない会社情報IDを指定した場合は404(code:6006)。他グループの会社情報IDは「存在しない」として扱う

Responses

Response samples

Content type
application/json
{
  • "companyInformationId": 800000,
  • "groupId": 100000,
  • "acquisitionId": 300000,
  • "company": {
    },
  • "executives": [
    ],
  • "isEdited": true,
  • "editedAt": "2026-08-05T10:00:00+09:00",
  • "updatedAt": "2026-08-05T10:00:00+09:00"
}

抽出データ編集API

【v1.3.0で追加】 登記簿取得契約が必要。 抽出済みの登記データ(会社情報・役員情報)を編集し、更新後のデータを返却する。

更新方式

本APIは指定した会社情報の全置換である。部分更新は行わない。 リクエストに含めなかったcompanyの項目はnullで上書きされ、executivesに含めなかった役員は削除される。 一部の項目だけを変更する場合も、抽出データ取得API(GET /v2/registry/extraction/data)で現在値を取得し、変更しない項目・役員も含めて送信すること。 役員の追加・更新・削除はregistryExecutiveIdで判定する。 ・registryExecutiveIdを指定した要素 … 該当の役員を更新する ・registryExecutiveIdを指定しない(null)要素 … 役員を新規に追加する。registryExecutiveIdは登記簿側で採番し、レスポンスで返却する ・リクエストに含めなかったregistryExecutiveId … 該当の役員を削除する ※registryExecutiveIdの採番は登記簿側で行い、コンプライアンス側は値をそのまま透過する(コンプライアンス側で独自の採番・変換は行わない)。 ※対象の会社情報に存在しないregistryExecutiveIdを指定した場合は、リクエスト全体をエラー(400、code:5116)とする。

更新競合の検出(条件付き更新)

リクエストのupdatedAtには、抽出データ取得API(GET /v2/registry/extraction/data)で取得したupdatedAtをそのまま指定する。 指定したupdatedAtがサーバー側で保持している最新の値と一致しない場合は更新を行わず、409(code:7110)を返却する。他のユーザー・他の経路による更新、または再抽出が行われた場合に発生する。 409(code:7110)が返却された場合は、抽出データ取得APIで最新のデータを取得し直し、編集をやり直すこと。 データ抽出中(登記簿取得ステータスが「4:データ抽出中」)の会社情報は編集できず、409(code:7100)を返却する。

再抽出による上書き(重要)

登記データ抽出実行API(POST /v2/registry/extraction/execute)で同じ取得依頼の再抽出を実行すると、既存の会社情報は抽出結果で上書き更新されるため、本APIで編集した内容は失われる。 再抽出後に編集内容を反映するには、本APIで編集をやり直すこと。

編集の記録

本APIで更新した抽出データはisEditedがtrue、editedAtおよびupdatedAtが更新日時となる。再抽出を行うと抽出結果で上書きされるため、isEditedはfalseに戻る。 ※本APIは抽出データのみを更新する。登記簿PDF(fileId)および登記簿取得ステータスは変更されない。

エラーの判定順序

 1. リクエストのパラメーター検証(400・5108・5112〜5115・5117/HTTP 400)  2. groupIdが利用者の所属グループか(6003/HTTP 404)  3. companyInformationIdが指定グループに存在するか(6006/HTTP 404)※他グループの会社情報IDは「存在しない」として扱う  4. 紐づく登記簿取得依頼が削除済みでないか(8100/HTTP 410)※削除済みの会社情報は時間をおいても編集できないため、データ抽出中より先に判定する  5. データ抽出中でないか(7100/HTTP 409)  6. updatedAtが最新か(7110/HTTP 409)  7. registryExecutiveIdが対象の会社情報に存在するか(5116/HTTP 400)※対象の会社情報を特定した後に判定するため、上記2〜6のエラーが優先する ※いずれのエラーの場合も、会社情報・役員情報は一切更新されない(部分的に更新された状態にはならない)。

Authorizations:
Bearer
Request Body schema: application/json

更新する会社情報・役員情報

groupId
required
integer

グループID ※APIアクセストークンの所有者が所属していないグループを指定した場合は404(code:6003)

companyInformationId
required
integer

会社情報ID ※指定したグループに存在しない会社情報IDを指定した場合は404(code:6006)。他グループの会社情報IDは「存在しない」として扱う

updatedAt
required
string <date-time>

更新の基準とする最終更新日時(ISO8601、JST:yyyy-MM-ddTHH:mm:ss+09:00) ※抽出データ取得API(GET /v2/registry/extraction/data)で取得したupdatedAtをそのまま指定する ※サーバー側で保持している最新の値と一致しない場合は更新を行わず409(code:7110)を返却する

required
object

更新後の会社情報(全置換) ※含めなかった項目はnullで上書きされる ※corporateNumberには会社法人等番号(12桁)を指定する ※corporateNumbercompanyNameは会社情報の識別に使用するため、全置換であっても必ず指定すること ※fileIdextractionDateはサーバー側で保持している値を使用するため、指定しても無視する

required
Array of objects

更新後の役員情報一覧(全置換。0件以上100件以下) ※リクエストに含めなかった役員は削除される。役員を全て削除する場合は空配列を指定する ※101件以上を指定した場合は、先頭100件に丸めずにリクエスト全体をパラメーターエラー(code:5117)とする ※executiveNameregistrationReasonNameはマスタ由来の名称のため、指定しても無視し、executiveIdregistrationReasonIdから解決した名称を返却する

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "companyInformationId": 800000,
  • "updatedAt": "2026-08-01T12:00:00+09:00",
  • "company": {
    },
  • "executives": [
    ]
}

Response samples

Content type
application/json
{
  • "companyInformationId": 800000,
  • "groupId": 100000,
  • "acquisitionId": 300000,
  • "company": {
    },
  • "executives": [
    ],
  • "isEdited": true,
  • "editedAt": "2026-08-05T10:00:00+09:00",
  • "updatedAt": "2026-08-05T10:00:00+09:00"
}

登記簿PDFダウンロードAPI

【v1.3.0で追加】 登記簿取得契約が必要。 グループIDとファイルIDを指定し、登記簿PDFのダウンロードURLを取得する。次のいずれのファイルにも対応する。 ・自動取得した登記簿PDF … 登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)のレスポンスに含まれる fileId ・アップロードした登記簿PDF … 登記簿PDFアップロードAPI(POST /v2/registry/pdf/upload)のレスポンスで返却される fileId ※ダウンロードURLは署名付きURLで、有効期限はAPI実行から1時間。 ※ファイル自体はご契約期間中保存されるため、有効期限が切れた場合は本APIを再実行すること。 ※本APIの fileId は登記簿PDFのファイルIDであり、ファイル取得API(POST /v2/file/get)が扱う fileId とは別のID空間である。 ※一度に指定できるファイルは100件まで。超過した場合は先頭100件に丸めることはせず、リクエスト全体を400エラー(code:5113)とする。 ※指定したファイルが1件でも存在しない場合(指定した groupId の配下に無い場合を含む)は、先頭から処理できた分だけを返却することはせず、リクエスト全体を404エラー(code:6006)とする。 ※指定したファイルに紐づく登記簿取得依頼が削除済み(登記簿一覧削除API(POST /v2/registry/delete)で削除された場合)は、ダウンロードURLを発行できず410エラー(code:8100)を返却する。削除した取得依頼のPDFはダウンロードできない。

Authorizations:
Bearer
Request Body schema: application/json

ダウンロード対象のグループIDとファイルID一覧

groupId
required
integer

対象のファイルが属するグループID ※所属グループ取得API(GET /v2/get-group)で取得できるグループのみ指定できる

fileIds
required
Array of integers [ 1 .. 100 ] items

ダウンロード対象のファイルID一覧 ※一度のリクエストで最大100件まで

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "fileIds": [
    ]
}

Response samples

Content type
application/json
{}

抽出データExcelダウンロードAPI

【v1.3.0で追加】 登記簿取得契約が必要。 指定した会社情報IDの抽出データをExcelファイルとして出力し、そのダウンロードURLを返却する。 ※ダウンロードURLは署名付きURLで、有効期限はAPI実行から1時間。 ※有効期限が切れた場合は本APIを再実行すること。 ※Excelは本APIの実行時に生成し、ダウンロードURLを即時に返却する(非同期生成ではないため、生成完了を待つポーリングは不要)。

出力内容

シートは「Company Information」の1枚のみで、会社情報1件につき1行(1行1社)を出力する。 列は下記の固定列から始まる。  商号/法人番号/都道府県/住所/設立年月日/資本金 固定列に続けて、対象データに含まれる役職名が動的に列として追加される(役職名でソート)。 ※役職名の列には、当該役職に該当する役員の氏名を出力する。 ※追加される役職名はリクエストで指定した会社情報に含まれるものに限られるため、リクエストの内容によって列数・列名が変わる。 ※役職名は役職マスタ取得API(GET /v2/registry/masters/executives)で取得できる名称と同じ。

上限

1リクエストあたり companyInformationIds は最大100件。 100件を超えた場合は先頭100件に丸めることはせず、リクエスト全体をエラー(HTTPステータス400、code:5113)とする。

出力できない会社情報が含まれる場合

本APIは要素単位の部分成功とする。指定した会社情報のうち出力できるものだけをExcelに出力して acceptedList に格納し、出力できなかったものを理由コード付きで rejectedList に格納する。 指定した会社情報が1件も出力できない場合は、Excelを生成せずリクエスト全体をエラーとする。 ・所属していないグループを指定した場合は、会社情報の内容にかかわらず404(code:6003)でリクエスト全体を拒否する ・指定した全ての会社情報が存在しない場合(データ抽出が完了していない場合を含む)は404(code:6006) ・指定した全ての会社情報に紐づく登記簿取得依頼が削除済みの場合は410(code:8100)

Authorizations:
Bearer
Request Body schema: application/json

ダウンロード対象の会社情報ID一覧

groupId
required
integer

グループID ※APIアクセストークンの所有者が所属していないグループを指定した場合はエラー(code:6003)

companyInformationIds
required
Array of integers

会社情報ID一覧(1件以上100件以下) ※会社情報IDは登記一覧検索API(POST /v2/registry/list)/抽出データ取得API(GET /v2/registry/extraction/data)で取得できる ※101件以上を指定した場合は、先頭100件に丸めずにパラメーターエラー(code:5113)を返却する

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "companyInformationIds": [
    ]
}

Response samples

Content type
application/json
{}

コンプライアンスチェック一括登録用ExcelダウンロードAPI

【v1.3.0で追加】 登記簿取得契約が必要。 指定した会社情報IDの抽出データから、コンプライアンスチェックの一括登録用Excelテンプレートを作成し、そのダウンロードURLを返却する。 ※ダウンロードURLは署名付きURLで、有効期限はAPI実行から1時間。 ※有効期限が切れた場合は本APIを再実行すること。

出力内容

シートは「取引先リスト」の1枚のみで、会社1件につき「会社行1行+その会社の役員の人数分の行」を出力する。 ・会社行の項目 … 会社名/ネガティブワード/検索開始日/検索終了日/種別(「組織」固定)/住所/法人番号 ・役員行の項目 … 氏名/ネガティブワード/検索期間 ・国籍/出生地/所在国/登録国の列には、選択可能な値のプルダウン(入力規則)が設定される。 ※ご契約のサービス内容(SPRSの契約有無)によってテンプレートが異なり、シートの列構成が変わる。

本ファイルの用途

本ファイルは、RoboRoboコンプライアンスチェックに取引先を一括登録するためのテンプレートであり、APIで取り込むためのファイルではない。 APIから取引先を登録してチェックを実行する場合は、抽出データ取得API(GET /v2/registry/extraction/data)で会社情報・役員情報を取得し、取引先登録・チェックAPI(POST /v2/execution)に渡すこと。本ファイルを経由する必要は無い。

上限

1リクエストあたり companyInformationIds は最大100件。 100件を超えた場合は先頭100件に丸めることはせず、リクエスト全体をエラー(HTTPステータス400、code:5113)とする。

出力できない会社情報を指定した場合

指定した会社情報のうち1件でも出力できないものが含まれる場合は、いずれの会社情報も出力せず、リクエスト全体をエラーとする(全件エラー方式)。 ・所属していないグループを指定した場合は404(code:6003) ・指定した会社情報が存在しない場合、及びデータ抽出が完了していない場合は404(code:6006) ・指定した会社情報に紐づく登記簿取得依頼が削除済みの場合は410(code:8100)

Authorizations:
Bearer
Request Body schema: application/json

ダウンロード対象の会社情報ID一覧

groupId
required
integer

グループID ※APIアクセストークンの所有者が所属していないグループを指定した場合はエラー(code:6003)

companyInformationIds
required
Array of integers

会社情報ID一覧(1件以上100件以下) ※会社情報IDは登記一覧検索API(POST /v2/registry/list)/抽出データ取得API(GET /v2/registry/extraction/data)で取得できる ※101件以上を指定した場合は、先頭100件に丸めずにパラメーターエラー(code:5113)を返却する

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "companyInformationIds": [
    ]
}

Response samples

登記簿PDFアップロードAPI

【v1.3.0で追加】 登記簿取得契約が必要。 手元にある登記簿PDFをアップロードする。リクエストは multipart/form-data 形式で送信する。 アップロードしたファイルは 7:抽出可(アップロード)の取得依頼として登録され、レスポンスで返却する acquisitionId を登記データ抽出実行API(POST /v2/registry/extraction/execute)に指定してデータ抽出を実行できる。 登録した取得依頼は登記一覧検索API(POST /v2/registry/list)・登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)でも参照できる。 ※データ抽出に対応するのはデジタル原本の登記簿PDF(テキスト情報を持つPDF)のみ。原本をスキャンした画像PDFはアップロードできるが、データ抽出は対象外となる。 ※アップロードしたファイルはご契約期間中保存され、レスポンスで返却する fileId を登記簿PDFダウンロードAPI(POST /v2/registry/download/pdf)に指定してダウンロードできる。ただし登記簿一覧削除API(POST /v2/registry/delete)で削除した場合はダウンロードできなくなる。 ※アップロードは登記情報提供サービスへの請求を伴わないため、本APIの実行による課金は発生しない。登記簿取得件数取得API(GET /v2/registry/usage-count)の集計対象にもならない。

上限

1リクエストで指定できるファイルは最大100件、1ファイルあたり20MBまで。 101件以上を指定した場合は、先頭100件に丸めることはせずリクエスト全体をエラー(HTTPステータス400、code:5110)とする。 files を指定していない場合・空配列の場合も、リクエスト全体をエラー(HTTPステータス400、code:5109)とする。 ※1ファイルあたり20MBの上限はファイル単位で判定し、超過したファイルのみ rejectedList(code:7103)に格納する(リクエスト全体はエラーとしない)。

部分成功

本APIは要素単位の部分成功とする。ファイル単位で処理するため、一部のファイルを受け付けられなかった場合も、受け付けたファイルは登録される。 受け付けたファイルを acceptedList に、受け付けられなかったファイルを理由コード付きで rejectedList に格納し、HTTPステータスは200を返却する。 ※全てのファイルが受け付けられなかった場合も200を返却する。この場合 acceptedList は空配列となり、指定した全件が rejectedList に格納される。 ※同名のファイルを複数指定できる。ファイル名では突合できないため、リクエストで指定した並び順(index、0始まり)で突合すること。 ※エラーの判別はcodeで行うこと(messageの文言は予告なく変わる場合がある)。

Authorizations:
Bearer
Request Body schema: multipart/form-data

アップロード対象のPDFファイルと付随情報

groupId
required
integer

アップロード先のグループID ※所属グループ取得API(GET /v2/get-group)で取得できるグループのみ指定できる。所属していないグループを指定した場合は404(code:6003)

files
required
Array of strings <binary>

アップロードする登記簿PDFファイル(複数可) ※最大100件、1ファイルあたり20MBまで ※未指定・空配列の場合は400(code:5109)、101件以上を指定した場合は400(code:5110) ※下記の例はファイル名を示したもの

complianceCustomerId
integer

コンプライアンス取引先ID ※任意。指定した場合、このリクエストでアップロードした全てのファイルを当該取引先に紐づける ※ファイルごとに異なる取引先へ紐づける場合は、取引先ごとにリクエストを分けること ※指定した取引先が存在しない場合は404(code:6000)

complianceExecutionHistoryId
integer

コンプライアンス側実行履歴ID ※任意。指定した場合、このリクエストでアップロードした全てのファイルを当該実行履歴に紐づける ※指定した実行履歴が存在しない場合は404(code:6004)

Responses

Response samples

Content type
application/json
{
  • "groupId": 100000,
  • "acceptedList": [
    ],
  • "rejectedList": [
    ]
}

登記簿取得状況・結果取得API

【v1.3.0で追加】 登記簿取得契約が必要。 取引先登録・チェックAPI(isExecuteRegistrySearch)/登記簿検索単独実行API/登記簿取得実行API(候補確定)/登記簿再取得APIで受け付けた登記簿取得の進捗状況と結果を取得する。 登記データ抽出実行API(POST /v2/registry/extraction/execute)で受け付けたデータ抽出の進捗・結果も本APIで確認する。 acquisitionIds もしくは executionHistoryIds のいずれかは必須(両方を指定した場合は和集合を返す)。 acquisitionIds には登記簿取得を受け付ける各APIが acceptedList で返却する acquisitionIdexecutionHistoryIds には登記一覧検索API(POST /v2/registry/list)が返却する executionHistoryId を指定する。 registryResponseTarget を指定せずに受け付けた場合は、本APIをポーリングして完了を判定する。

完了判定

acquisitionStatus が 2(登記取得済)となった時点でPDFが取得済みとなり、fileId を登記簿PDFダウンロードAPI(POST /v2/registry/download/pdf)の fileIds に指定してダウンロードURLを取得できる。 データ抽出まで実行する場合は、5(データ抽出済)が最終の完了状態となる。 3(登記エラー)・6(データ抽出エラー)・9(登記なし)・11(複数候補)は終了状態であり、それ以上ステータスは変化しない。 0(登記未取得)・1(登記取得中)・4(データ抽出中)は処理中である。 1(登記取得中)が継続している場合は処理中、もしくは登記情報提供サービスの提供時間外による待機(次回の提供時間開始後に自動で実行される)のいずれかであり、message で区別できる。 ※提供時間外による待機中は executeStatus が 8(エラー終了)、一時エラーによる再試行待ちの間は executeStatus が 0(実行待ち)となる。いずれも処理は継続するため、終了したかどうかの判定は必ず acquisitionStatus で行うこと。 ※message の文言は予告なく変更されるため、成否の判定に使用しないこと。

データ抽出の完了判定

登記データ抽出実行API(POST /v2/registry/extraction/execute)は抽出を受け付けるのみで、抽出処理は非同期で実行される。 受付直後の acquisitionStatus は 4(データ抽出中)となり、抽出が完了すると 5(データ抽出済)、抽出に失敗すると 6(データ抽出エラー)へ遷移する。 したがって抽出の完了は、登記データ抽出実行APIの acceptedList に含まれる acquisitionId を本APIに指定してポーリングし、4 から 5(成功)もしくは 6(失敗)へ遷移したことで判定する。 ※登記データ抽出実行APIの rejectedList に格納された依頼(実行中・抽出対象外のステータス・存在しない取得依頼ID・削除済みの取得依頼ID)は抽出が開始されないため、ポーリングの対象外となる。 ※登記データ抽出実行APIは完了通知(callback)の返却先を指定できないため、データ抽出の完了判定は本APIのポーリングでのみ行える。 抽出が完了した依頼は companyInformationId が設定され、抽出データ取得API(GET /v2/registry/extraction/data)に指定して抽出結果を取得できる。

ポーリング間隔

登記簿の取得は1件あたり数十秒から数分を要するため、ポーリング間隔は1分以上を推奨する。 データ抽出の完了のみを待つ場合も、所要時間は登記簿PDFの内容により変動するため、同じくポーリング間隔は1分以上を推奨する。

上限

acquisitionIds / executionHistoryIds は1リクエストあたりそれぞれ最大100件。 ※100件を超えて指定した場合、先頭100件に丸めることはせずリクエスト全体をエラー(HTTPステータス400)とする。

レスポンスの要素

results の要素は、登記簿取得完了通知(POST /registry-responseTarget.url)の resultList の要素と同一のスキーマである。 ※指定したIDのうち、参照権限のあるもの(APIアクセストークンの所有者の所属グループ、及び管理グループ配下のもの)だけが返却される。 ※本APIの実行では登記情報提供サービスへの請求は発生しない。

Authorizations:
Bearer
Request Body schema: application/json

取得状況・結果を照会するIDリスト

acquisitionIds
Array of integers

登記簿取得依頼IDのリスト(1件以上100件以下) ※acquisitionIds / executionHistoryIds のいずれかは必須(両方を指定した場合は和集合を返す) ※101件以上を指定した場合は、先頭100件に丸めずにパラメーターエラー(code:5111)を返却する

executionHistoryIds
Array of integers

登記簿取得の実行履歴IDのリスト(1件以上100件以下) ※コンプライアンスチェックの実行履歴ID(complianceExecutionHistoryId)とは別のIDである ※acquisitionIds / executionHistoryIds のいずれかは必須(両方を指定した場合は和集合を返す) ※101件以上を指定した場合は、先頭100件に丸めずにパラメーターエラー(code:400)を返却する(executionHistoryIds の件数超過に専用のコードは設けていない)

Responses

Request samples

Content type
application/json
{
  • "acquisitionIds": [
    ],
  • "executionHistoryIds": [
    ]
}

Response samples

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

登記簿取得完了通知用 callback(registryResponseTarget で指定したURLに送付)

【v1.3.0で追加】 取引先登録・チェック実行API(isExecuteRegistrySearch に true を指定した場合)、登記簿検索単独実行API(POST /v2/registry/execution)、 登記簿取得実行API(候補確定)(POST /v2/registry/duplicate-acquisition)、登記簿再取得API(POST /v2/registry/reacquire)で registryResponseTarget.url を指定した場合、登記簿取得の完了時に指定のURLへ結果を送付する。 結果の返却先URLへの送付はステータスコード:4xx、5xxの場合リトライ(最大10回) ※registryResponseTargetのtokenを指定した場合、BearerTokenに指定のtokenを付与 ※送付は同一リクエストで受け付けた依頼が全て終了状態になった時点で1回行う。 終了状態は 2(登記取得済)/3(登記エラー)/9(登記なし)/11(複数候補)であり、 0(登記未取得)/1(登記取得中)の依頼が残っている間は送付しない ※本通知が対象とするのは登記簿PDFの取得完了までである。データ抽出は登記データ抽出実行API(POST /v2/registry/extraction/execute)で 別途受け付けるため、4(データ抽出中)/5(データ抽出済)/6(データ抽出エラー)への遷移は本通知の対象外となる。 同APIは完了通知(callback)の返却先を指定できないため、抽出の完了は登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)を ポーリングして判定すること ※登記情報提供サービスの提供時間外により次回の提供時間へ持ち越された依頼がある場合、送付はその依頼の完了時点となる ※終了状態に到達しない依頼が残る場合の打ち切り条件は別途定める ※通知とリクエストの突合には concurrentExecutionId、または acquisitionId を使用する ※結果の組み立て中にサーバー内部エラーが発生した場合は、resultList ではなく code / message のみの本文が送付される ※resultList の要素は、登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)の results の要素と同一のスキーマである

Authorizations:
Bearer
Request Body schema: application/json

登記簿取得完了結果

concurrentExecutionId
string

同時実行ID(UUID) 登記簿取得を受け付けたAPIのレスポンスで返却した値と同じ 1リクエストで受け付けた依頼群に共通で払い出される

Array of objects

結果 ※要素のスキーマは登記簿取得状況・結果取得API(POST /v2/registry/acquisition-status)の results の要素と同一

Responses

Request samples

Content type
application/json
{
  • "concurrentExecutionId": "3f2b7c1a-9d64-4f0e-8f6b-2a1c5d7e9b04",
  • "resultList": [
    ]
}

役職マスタ取得API

【v1.3.0で追加】 登記簿取得契約が必要。 登記簿からのデータ抽出対象となる役職(役員)のマスタを返却する。 ※executiveId は、抽出データ取得API(GET /v2/registry/extraction/data)が返却する役職の識別子(executiveId)と対応する ※株式会社・合同会社・一般社団法人・特定非営利活動法人等、法人形態を問わず全ての役職を返却する ※返却順は固定であり、同じ内容のリクエストに対しては常に同じ順序で返却される ※グループの指定は不要。返却内容はグループ・ユーザーによって変わらない ※役職マスタが1件も存在しない場合も、200で executives が空配列のレスポンスを返却する(404は返却しない)

Authorizations:
Bearer

Responses

Response samples

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

登記原因マスタ取得API

【v1.3.0で追加】 登記簿取得契約が必要。 登記簿の役員欄から抽出される登記原因(就任・退任等)のマスタを返却する。 ※id は、抽出データ取得API(GET /v2/registry/extraction/data)が返却する登記原因の識別子(registrationReasonId)と対応する ※type は登記原因の区分で、APPOINTMENT(就任系)/RESIGNED(退任系)のいずれか  APPOINTMENT:役員の就任・継続に関する登記原因(就任・重任・加入・資格・住所移転)  RESIGNED:役員の退任・消滅に関する登記原因(退任・辞任・解任・脱退・退社・資格喪失・死亡・抹消) ※value は登記原因の識別子、description は登記簿上の日本語表記 ※返却順は sortOrder の昇順であり、同じ内容のリクエストに対しては常に同じ順序で返却される ※グループの指定は不要。返却内容はグループ・ユーザーによって変わらない ※絞り込み条件に該当する登記原因が1件も存在しない場合も、200で registrationReasons が空配列のレスポンスを返却する(404は返却しない) ※type に APPOINTMENT/RESIGNED/ALL 以外の値を指定した場合もパラメーターエラーとはせず、該当0件として200で空配列を返却する

Authorizations:
Bearer
query Parameters
type
string
Enum: "APPOINTMENT" "RESIGNED" "ALL"
Example: type=APPOINTMENT

登記原因の区分での絞り込み(大文字で指定する) ・APPOINTMENT:就任系の登記原因のみを返却 ・RESIGNED:退任系の登記原因のみを返却 ・ALL:全件を返却 ※指定がない場合・空文字を指定した場合はALLと同じく全件を返却する ※上記以外の値を指定した場合もパラメーターエラーとはせず、該当0件として200で空配列を返却する

Responses

Response samples

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

法人名寄せ検索API

【v1.3.0で追加】 登記簿取得契約が必要。 法人名・住所・代表者名・法人番号を条件に、法人番号公表サイト由来の法人基本情報(基本3情報)を検索し、一致度順に候補を返却する。 ※本APIは登記簿の取得を行わないため、課金は発生しない。  候補を確認して法人番号を特定するためのAPIであり、実際の取得は  登記簿取得実行API(POST /v2/registry/duplicate-acquisition)に特定した法人番号を指定して実行する。

検索条件について

1リクエストにつき1件以上100件以下のクエリ(queries)を指定できる。 クエリごとに独立して検索し、リクエストで指定した並び順のまま結果を返却する。 法人番号(corporateNumber)を指定した場合は、ハイフン等の数字以外の文字を除去したうえで完全一致検索を行い、 該当があればその法人のみを候補として返却する(法人名・住所・代表者名の条件は評価しない)。 法人番号を指定しない場合、及び法人番号が該当しなかった場合は、法人名(companyName)を必須条件として検索する。 ※法人名は、空白の除去・半角から全角への統一・(株)/㈱/(有)/㈲/(同)等の略記の展開を行ったうえで、前方一致もしくは後方一致で照合する ※法人名に数字・記号を含まない場合は、フリガナも同様に前方一致もしくは後方一致で照合する ※住所(address)を指定した場合は、都道府県・市区町村・丁目番地等に分割し、法人名の条件に加えた絞り込み条件として使用する ※代表者名(representativeName)を指定した場合は、法人名の条件に加えた絞り込み条件として使用する ※検索対象は、国税庁 法人番号公表サイトに登録されている法人のうち登記記録が閉鎖されていないもの。登記記録の閉鎖等年月日が設定されている法人(閉鎖済み法人)は検索対象外 ※候補は内部で算出した一致度の降順、一致度が同一の場合は法人番号の昇順で返却する ※一致度が内部基準に満たない候補は返却対象外(totalCountにも含まない) ※ページングはクエリ単位で指定する(offset/limit)。limitの既定値は10件、上限は100件 ※offset/limitに範囲外の値を指定した場合は、既定値や上限値への補正は行わず400エラーとなる

返却するデータについて

候補(candidates)には、国税庁 法人番号公表サイト由来の法人基本情報(基本3情報)と、 経済産業省 法人インフォメーション由来の法人活動情報を保持している全項目を返却する。 ※法人活動情報由来の項目(代表者名・資本金・従業員数・企業規模詳細・営業品目・事業概要・企業ホームページ・設立年月日・創業年・資格等級)は、  出典側での登録がある法人が限られるため、多くの法人ではnullとなる。取得できることを前提とした処理は行わないこと ※値が存在しない項目はキーを省略せずnullを返却する。  ただし corporateNumber・companyName・address・matchScore の4項目は常に値が入り、nullとならない

上限

1リクエストあたり queries は最大100件。 100件を超えた場合は先頭100件に丸めることはせず、リクエスト全体をエラー(400、code:5104)とする。

Authorizations:
Bearer
Request Body schema: application/json

名寄せ検索条件

required
Array of objects [ 1 .. 100 ] items

名寄せ検索条件リスト ※1件以上100件以下で指定すること ※未指定・配列でない・空配列・要素がオブジェクトでない場合は400(code:5103)、100件を超える場合は400(code:5104)

Responses

Request samples

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

Response samples

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

抽出設定取得API

【v1.3.0で追加】 登記簿取得契約が必要。 登記簿PDFからのデータ抽出時に適用される抽出設定を取得する。 本設定は登記データ抽出実行API(POST /v2/registry/extraction/execute)で実行する抽出に適用され、抽出データ取得API(GET /v2/registry/extraction/data)で取得できる役員情報の内容に反映される。

設定の適用単位(重要)

抽出設定は、指定したグループの親グループ(親グループが無い場合は自グループ)× そのグループのオーナーユーザーの1行に正規化して保持される。 そのため、同一組織配下のどのグループ・どのユーザーで実行しても常に同じ設定が適用される。グループごと・ユーザーごとに異なる抽出設定を持つことはできない。 本APIは groupId に指定したグループが属する組織の設定(=実際に抽出で使用される値)を返却する。

既定値

設定が一度も登録されていない場合は、既定値(isExtractResignedOfficers が false = 退任済みの役員を抽出しない)を返却する。 ※本APIは設定の参照のみを行い、登記簿取得・データ抽出の実行は伴わない。

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

抽出設定を取得するグループID ※APIアクセストークンの所有者が所属していないグループを指定した場合はエラー(code:6003)

Responses

Response samples

Content type
application/json
{
  • "groupId": 100000,
  • "isExtractResignedOfficers": false
}

抽出設定更新API

【v1.3.0で追加】 登記簿取得契約が必要。 登記簿PDFからのデータ抽出時に適用される抽出設定を更新する。 本設定は登記データ抽出実行API(POST /v2/registry/extraction/execute)で実行する抽出に適用され、抽出データ取得API(GET /v2/registry/extraction/data)で取得できる役員情報の内容に反映される。

更新の影響範囲(重要)

抽出設定は、指定したグループの親グループ(親グループが無い場合は自グループ)× そのグループのオーナーユーザーの1行に正規化して保持される。 そのため、本APIによる更新は同一組織配下の全てのグループ・全てのユーザーの抽出結果に影響する。特定のグループだけ異なる設定にすることはできない。 RoboRobo登記簿の設定「退任者の抽出」も同じ1行を参照しており、本APIでの更新はそちらにも反映される。

更新の適用タイミング

更新後に実行したデータ抽出から新しい設定が適用される。本APIの実行によって、既に抽出済みの会社情報・役員情報が再抽出されることはない。 設定変更を既存の抽出データに反映するには、登記データ抽出実行API(POST /v2/registry/extraction/execute)で再抽出すること。

更新方式

本APIは全項目の上書きである。リクエストに含めなかった設定項目は既定値で上書きされるため、変更しない項目も含めて送信すること。 ※本APIは設定の更新のみを行い、登記簿取得・データ抽出の実行は伴わない。

Authorizations:
Bearer
Request Body schema: application/json

更新する抽出設定

groupId
required
integer

抽出設定を更新するグループID ※APIアクセストークンの所有者が所属していないグループを指定した場合はエラー(code:6003) ※指定したグループが属する組織(親グループのオーナーユーザー)の設定を更新するため、同一組織配下の全グループ・全ユーザーに影響する

isExtractResignedOfficers
required
boolean

退任済みの役員を抽出するか(true/false) true:退任済みの役員(登記原因が退任・辞任・脱退・死亡・資格喪失・解任のいずれか)も抽出データに含める false:退任済みの役員を抽出データに含めない(既定値)

Responses

Request samples

Content type
application/json
{
  • "groupId": 100000,
  • "isExtractResignedOfficers": true
}

Response samples

Content type
application/json
{
  • "groupId": 100000,
  • "isExtractResignedOfficers": true
}

登記情報提供サービス稼働状況取得API

【v1.3.0で追加】 登記簿取得契約が必要。 登記簿取得の実行基盤である登記情報提供サービスについて、リクエスト時点(日本時間)の稼働状況を返却する。 リクエストパラメータは無い(グループごとではなく、登記情報提供サービス全体の稼働状況を返却するため)。

判定の仕組み

・稼働スケジュール(通常の受付時間・年末年始休業・不定期メンテナンス)を日本時間の現在時刻と突き合わせて判定する ・年末年始休業に該当する時間帯は利用不可 ・日付を指定して設定されたメンテナンス・臨時休業に該当する時間帯は利用不可 ・上記のいずれにも該当しない場合、当日の区分(平日/土日祝)の通常の受付時間内であれば利用可能 ・平日/土日祝の区分は、土曜・日曜及び日本の国民の祝日を「土日祝」として判定する ・開始時刻・終了時刻はいずれも境界値を含む(終了時刻ちょうどは利用可能)

現在の稼働スケジュール

・通常の受付時間:平日 8:30〜22:30 / 土日祝 8:30〜17:30 ・年末年始休業:12月29日〜1月3日は終日利用不可 ※稼働スケジュールは運用側で随時変更されるため、上記の時刻は参考値。実際の可否は本APIのavailableを正とすること

登記簿取得の実行前の確認に利用すること

受付時間外に登記簿取得を依頼した場合は受付のみが行われ、次回の受付時間開始後に自動で実行される(リクエストが破棄されるわけではない)。 この場合、受付直後の取得ステータス(acquisitionStatus)は 1(登記取得中)のまま次回の受付時間まで滞留する。即時に結果を得たい場合は、本APIでavailableがtrueであることを確認してから実行すること。 土曜・日曜・祝日も 8:30〜17:30 は受付時間内であるため、金曜夜に受け付けた依頼が土曜の 8:30 に実行されることがある。 ※登記簿取得を実行する以下のAPIに共通の事前確認として利用できる。  ・取引先登録・チェックAPI(POST /v2/execution)のisExecuteRegistrySearchにtrueを指定した場合  ・登記簿検索単独実行API(POST /v2/registry/execution)  ・登記簿取得実行API(候補確定)(POST /v2/registry/duplicate-acquisition)  ・登記簿再取得API(POST /v2/registry/reacquire) ※本APIは稼働状況の参照のみを行い、登記簿取得の実行・課金は伴わない。

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "available": false
}

登記簿取得件数取得API

【v1.3.0で追加】 登記簿取得契約が必要。 グループと年月の範囲を指定し、実際に取得した登記簿の件数を年月単位で返却する。 登記簿取得は登記情報提供サービスへの実費請求を伴うため、本APIが返却する件数がそのまま課金対象の件数となる。ご利用状況・ご請求件数の確認には本APIを利用する。

集計対象

・登記情報提供サービスから登記簿PDFを実際に取得できた取得依頼のみを1件として計上する。 ・登記簿PDFが紐づいていない取得依頼(登記なし・登記エラー・複数候補など、取得に至らなかったもの)は計上しない。複数候補(acquisitionStatus:11)は、候補を確定して登記簿を取得した時点で1件計上する。 ・手動アップロードした登記簿PDF、及びデータ抽出のみの実行は計上しない(自動取得のみが対象)。 ・削除済みの取得依頼・登記簿PDFは計上しない。 ・同一法人の登記簿を複数回取得した場合は、取得した回数分を計上する(再取得も再課金の対象となるため)。 ・取得依頼の経路(取引先登録・チェックAPIの登記簿検索/登記簿検索単独実行API/登記簿取得実行API(候補確定)/登記簿再取得API/RoboRoboの画面からの実行)は区別せず、いずれも1件として計上する。 ・集計対象はgroupIdで指定したグループで実行された取得のみ。配下グループ分は含まないため、配下グループの件数が必要な場合はグループごとに本APIを実行する。

集計年月

・年月の基準は取得依頼の登録日ではなく、登記簿PDFを取得した日(取得完了日)。 ・集計年月は日本時間(JST)基準。取得完了日時を日本時間に換算した年月に計上する。 ・fromYearMonth・toYearMonth も日本時間の年月として解釈し、fromYearMonth の月初(1日 0:00:00)から toYearMonth の末日(23:59:59)までを集計対象とする。 ・取得件数が0件の年月は results に含まれない。 ・fromYearMonth に toYearMonth より後の年月を指定した場合は、集計対象期間が存在しないため results は空配列を返却する(エラーにはしない)。 ・指定できる集計期間の長さに上限は設けない(期間が長いことを理由にエラーとしたり、期間を丸めて集計したりはしない)。

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

集計対象のグループID ※所属グループ取得API(GET /v2/get-group)で取得できるグループIDを指定する

fromYearMonth
required
integer
Example: fromYearMonth=202501

集計対象開始年月(yyyyMMの形式で設定) 日本時間(JST)基準の年月で指定する。指定した月の1日からが集計対象に含まれる

toYearMonth
required
integer
Example: toYearMonth=202503

集計対象終了年月(yyyyMMの形式で設定) 日本時間(JST)基準の年月で指定する。指定した月の末日までが集計対象に含まれる ※fromYearMonth より前の年月を指定した場合はエラーとせず、results が空配列で返却される

Responses

Response samples

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