ScreenVeritAI

    Developer API

    Developer API is launching soon.

    Our sanctions and compliance API is currently in private beta. You can review the integration model today and request early access while we finalize broader availability.

    Private beta in progress

    API access is currently limited to beta participants. General availability is coming soon.

    Request beta access View preview docsOpen preview OpenAPI spec

    Beta integration preview

    1. Create an API key

    Authenticate with your ScreenVeritAI account and generate a scoped API key for server-to-server requests.

    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"]}'

    2. Submit a screening request

    Send an entity name for processing. The API returns a queued search id for asynchronous retrieval.

    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"}'

    3. Poll for results

    Fetch status and final output by id when processing completes.

    curl https://screenveritai.com/api/v1/search/<SEARCH_ID> \
  -H "X-API-Key: <YOUR_API_KEY>"
    Read ReDoc referenceBrowse Swagger endpoints

    Core endpoints

    POST /api/v1/search

    Create a sanctions/compliance screening request for one entity. Returns a search id and processing status.

    Auth: X-API-Key (search:write)

    POST /api/v1/batch

    Submit CSV/XLSX files for high-volume screening, then retrieve rows or exports when jobs complete.

    Auth: X-API-Key (batch:write)

    POST /api/v1/keys

    Create and manage API credentials with scoped permissions, tier-aware limits, and usage tracking.

    Auth: Bearer token (account)

    Why teams use the API

    • Single integration for sanctions, PEP, adverse media, and ownership intelligence
    • Tier-based rate limits with usage logging for governance and cost control
    • Asynchronous processing model designed for production onboarding flows
    • OpenAPI schema plus Swagger/ReDoc references for fast implementation
    • Structured output suitable for audit logs, case files, and downstream decisions
    • Permission-scoped API keys for least-privilege integration patterns

    Integration playbooks

    PEP screening API guide

    Implementation patterns for API-key auth, async jobs, and audit logs.

    Batch screening workflow

    Connect API and file-based flows for high-volume operations.

    Sanctions screening overview

    See coverage and evidence model behind API screening outputs.

    API FAQ

    How do I authenticate API requests?

    Beta participants use API keys for /api/v1/search and /api/v1/batch requests. Keys are created through /api/v1/keys after account authentication.

    Is the API synchronous or asynchronous?

    Search and batch jobs are asynchronous. You create a job, receive an id, and then poll the corresponding GET endpoint for status and final output.

    Can I scope API key permissions?

    Yes. Keys support permissions such as search:read, search:write, batch:read, and batch:write so you can enforce least-privilege access.

    What rate limits apply?

    Rate limits are assigned by subscription tier and enforced per API key. Response headers include limit, remaining quota, and reset timestamps.

    Where can I test the endpoints quickly?

    Use the built-in documentation at /api/docs for interactive Swagger testing and /api/redoc for reference-style docs.