API SPEC · V1 · GADEVELOPER REFERENCE

    Developer API

    REST-API für AML-Screening

    Binden Sie Sanktions-, PEP-, Fahndungslisten-, Adverse-Media- und KYB/UBO-Screening direkt in Ihre Onboarding-, Monitoring- und Transaktionsabläufe ein. Die API ist live: Authentifizieren Sie sich mit einem API-Schlüssel und nutzen Sie dieselbe Screening-Engine wie das Portal.

    API v1 ist live

    Die Endpoints sind allgemein verfügbar — mit API-Key-Authentifizierung und Rate-Limits je Tarifstufe. Erkunden Sie jeden Endpoint in der interaktiven OpenAPI-Dokumentation unter /api/v1/docs.

    §01Schnellstart

    01 / 05
    STEP 01

    1. API-Schlüssel erstellen

    Erstellen Sie im Dashboard einen API-Schlüssel mit eingegrenztem Berechtigungsumfang oder generieren Sie ihn programmatisch mit Ihrem Konto-Bearer-Token für Server-zu-Server-Anfragen.

    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. Erste Suche ausführen

    Übergeben Sie eine Entität im X-API-Key-Header. Die API gibt eine Such-ID zurück, die Sie nach Abschluss der Verarbeitung abrufen.

    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":"full_search"}'
    STEP 03

    3. Batch übermitteln

    Senden Sie eine CSV-/XLSX-Datei, um viele Entitäten in einem Auftrag zu prüfen, und rufen Sie Zeilen oder Exporte ab, sobald der Batch abgeschlossen ist.

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

    §02Kern-Endpoints

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Erstellt eine Screening-Anfrage für eine Entität. Gibt eine Such-ID und den Verarbeitungsstatus zurück. Konto-, Abdeckungs- und Health-Endpoints sind ebenfalls unter /api/v1 verfügbar.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Nimmt CSV-/XLSX-Dateien für hochvolumiges Screening entgegen; Zeilen oder Exporte rufen Sie ab, sobald die Aufträge abgeschlossen sind.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Erstellt und verwaltet API-Zugangsdaten mit eingegrenzten Berechtigungen, Rate-Limits je Tarifstufe und Nutzungsverfolgung.

    Auth: Bearer-Token (Konto)

    §03Warum Teams die API nutzen

    03 / 05
    • Eine einzige Integration für Sanktions-, PEP-, Fahndungslisten-, Adverse-Media- und KYB/UBO-Screening
    • API-Key-Authentifizierung über den X-API-Key-Header, mit berechtigungsbeschränkten Schlüsseln für Zugriff nach dem Least-Privilege-Prinzip
    • Rate-Limits je Tarifstufe mit Nutzungsprotokollierung für Governance und Kostenkontrolle
    • Such-, Batch-, Keys-, Konto-, Abdeckungs- und Health-Endpoints unter /api/v1
    • Interaktive OpenAPI-Dokumentation unter /api/v1/docs sowie ein maschinenlesbares OpenAPI-Schema
    • Strukturierte Ausgabe, geeignet für Prüfprotokolle, Fallakten und nachgelagerte Entscheidungen

    §05API-FAQ

    05 / 05
    Q01

    Wie authentifiziere ich API-Anfragen?

    Screening-Anfragen an /api/v1/search und /api/v1/batch authentifizieren Sie über einen API-Schlüssel im X-API-Key-Header. Erstellen Sie Schlüssel im Dashboard oder programmatisch über /api/v1/keys, nachdem Sie sich mit Ihrem Konto-Bearer-Token authentifiziert haben.

    Q02

    Ist die API allgemein verfügbar?

    Ja. API v1 ist live und allgemein verfügbar. Authentifizieren Sie sich mit einem API-Schlüssel, rufen Sie die Such-, Batch- und Key-Management-Endpoints auf und erkunden Sie alles in der interaktiven OpenAPI-Dokumentation unter /api/v1/docs.

    Q03

    Kann ich die Berechtigungen eines API-Schlüssels eingrenzen?

    Ja. Schlüssel unterstützen Berechtigungen wie search:read, search:write, batch:read und batch:write, sodass Sie pro Integration Zugriff nach dem Least-Privilege-Prinzip durchsetzen.

    Q04

    Welche Rate-Limits gelten?

    Rate-Limits werden je API-Stufe vergeben und pro API-Schlüssel durchgesetzt — die Stufe bestimmt den Anfrage-Durchsatz, nicht die Abrechnung. Die Antwort-Header enthalten das Limit, das verbleibende Kontingent und die Reset-Zeitstempel, sodass Sie sauber drosseln können.

    Q05

    Wo kann ich die Endpoints schnell testen?

    Nutzen Sie die interaktive Dokumentation unter /api/v1/docs für Swagger-Tests und /api/v1/redoc für die Referenzdokumentation. Das OpenAPI-Schema wird unter /api/v1/openapi.json bereitgestellt.