OSINT SCANNER

API ドキュメント

OSINT SCANNER REST API リファレンス

Enterprise プラン専用

認証

全てのAPIリクエストにはBearerトークンが必要です。トークンはダッシュボードの設定画面から生成できます。

Authorization: Bearer your_api_token_here

レートリミット

リクエスト上限

100 req/min

スキャン上限

プラン上限に準拠

レスポンスヘッダー

X-RateLimit-Remaining

エンドポイント

POST/api/v1/scans

スキャンの実行

Request Body

{
  "scanType": "person" | "company",
  "targetName": "山田太郎",
  "targetNameKana": "ヤマダタロウ",
  "targetMetadata": {
    "birthDate": "1980-01-01",
    "address": "東京都",
    "employer": "株式会社〇〇"
  },
  "depth": "standard",
  "skills": ["web_intel", "sns_intel", "legal_intel"]
}

Response

{
  "data": {
    "scanId": "uuid",
    "status": "pending",
    "estimatedTimeMs": 30000
  }
}
GET/api/v1/scans/:id

スキャン結果の取得

Response

{
  "data": {
    "id": "uuid",
    "status": "completed",
    "riskScore": { "total": 42, "level": "medium", ... },
    "executiveSummary": "...",
    "findings": [...],
    "generatedAt": "2026-03-17T..."
  }
}
GET/api/v1/scans

スキャン一覧の取得

Response

{
  "data": [...],
  "meta": { "page": 1, "total": 25, "perPage": 20 }
}
POST/api/v1/watchlist

ウォッチリストへの登録

Request Body

{
  "targetName": "山田太郎",
  "scanType": "person",
  "interval": "weekly"
}

Response

{
  "data": { "id": "uuid", "status": "active" }
}