API SPEC · V1 · GADEVELOPER REFERENCE

    開発者向けAPI

    AMLスクリーニングのためのREST API

    制裁リスト、PEP、犯罪ウォッチリスト、アドバースメディア、KYB・UBOのスクリーニングを、オンボーディング、モニタリング、トランザクションフローに直接組み込めます。APIはすでに稼働中です — APIキーで認証し、Web版と同じスクリーニングエンジンをそのまま呼び出せます。

    API v1 は稼働中です

    APIキー認証とプラン別レート制限を備え、一般提供中です。/api/v1/docs のインタラクティブなOpenAPIドキュメントで全エンドポイントをご確認いただけます。

    §01クイックスタート

    01 / 05
    STEP 01

    1. APIキーを作成する

    ダッシュボードでスコープ付きAPIキーを作成するか、サーバー間リクエスト用にアカウントのベアラートークンでプログラム的に発行します。

    curl
    curl -X POST https://screenveritai.com/api/v1/keys \
      -H "Authorization: Bearer <SUPABASE_JWT>" \
      -H "Content-Type: application/json" \
      -d '{"name":"server-key","permissions":["search:read","search:write"]}'
    STEP 02

    2. 最初の検索を実行する

    X-API-Keyヘッダーを付けてエンティティを送信します。APIは検索IDを返し、処理完了後に結果を取得できます。

    curl
    curl -X POST https://screenveritai.com/api/v1/search \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -H "Content-Type: application/json" \
      -d '{"entity_name":"Acme Ltd","entity_type":"company","search_type":"deep_research"}'
    STEP 03

    3. 一括ジョブを送信する

    CSV/XLSXファイルを送信して、1回のジョブで多数のエンティティをスクリーニングします。ジョブ完了後に行データやエクスポートを取得できます。

    curl
    curl -X POST https://screenveritai.com/api/v1/batch \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -F "file=@entities.csv"

    §02主要エンドポイント

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    1件のエンティティに対するスクリーニングリクエストを作成します。検索IDと処理ステータスを返します。アカウント、収録範囲、稼働状況の各エンドポイントも /api/v1 配下でご利用いただけます。

    認証:X-API-Key(search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    大量スクリーニング用にCSV/XLSXファイルを送信し、ジョブ完了後に行データまたはエクスポートを取得します。

    認証:X-API-Key(batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    スコープ付き権限、プラン別レート制限、利用状況の追跡機能を備えたAPI認証情報を作成・管理します。

    認証:ベアラートークン(account)

    §03チームがAPIを利用する理由

    03 / 05
    • 制裁、PEP、犯罪ウォッチリスト、アドバースメディア、KYB・UBOスクリーニングを1つの統合でカバー
    • X-API-Keyヘッダーによるキー認証。権限をスコープしたキーで最小権限アクセスを実現
    • 利用状況ログ付きのプラン別レート制限で、ガバナンスとコストを管理
    • 検索、一括処理、キー管理、アカウント、収録範囲、稼働状況の各エンドポイントを /api/v1 配下に用意
    • /api/v1/docs のインタラクティブなOpenAPIドキュメントと、機械可読なOpenAPIスキーマ
    • 監査ログ、案件ファイル、後続の意思決定にそのまま使える構造化された出力

    §05API FAQ

    05 / 05
    Q01

    APIリクエストはどのように認証しますか?

    /api/v1/search および /api/v1/batch へのスクリーニングリクエストは、X-API-Keyヘッダーで送信するAPIキーで認証します。キーはダッシュボードで作成するか、アカウントのベアラートークンで認証した後に /api/v1/keys からプログラム的に作成できます。

    Q02

    APIは一般提供されていますか?

    はい。API v1は稼働中で、一般提供されています。APIキーで認証し、検索・一括処理・キー管理の各エンドポイントを呼び出せます。/api/v1/docs のインタラクティブなOpenAPIドキュメントですべてを確認できます。

    Q03

    APIキーの権限をスコープできますか?

    できます。キーはsearch:read、search:write、batch:read、batch:writeなどの権限に対応しており、統合ごとに最小権限アクセスを設定できます。

    Q04

    どのようなレート制限が適用されますか?

    レート制限はサブスクリプションのプランごとに割り当てられ、APIキー単位で適用されます。レスポンスヘッダーには上限、残りクォータ、リセット時刻が含まれるため、余裕を持って調整できます。

    Q05

    エンドポイントをすぐに試すにはどうすればよいですか?

    /api/v1/docs のインタラクティブなドキュメントでSwaggerによる動作確認ができ、/api/v1/redoc ではリファレンス形式のドキュメントをご利用いただけます。OpenAPIスキーマは /api/v1/openapi.json で提供しています。