API SPEC · V1 · GADEVELOPER REFERENCE

    Utvecklar-API

    REST API för AML-screening

    Integrera sanktions-, PEP-, brottsbevaknings-, negativ media- och KYB/UBO-screening direkt i dina flöden för onboarding, övervakning och transaktioner. API:et är live: autentisera med en API-nyckel och anropa samma screeningmotor som portalen använder.

    API v1 är live

    Ändpunkterna är allmänt tillgängliga med API-nyckelautentisering och gränser per prisnivå. Utforska varje ändpunkt i den interaktiva OpenAPI-dokumentationen på /api/v1/docs.

    §01Kom igång

    01 / 05
    STEP 01

    1. Skapa en API-nyckel

    Skapa en scoped API-nyckel i din dashboard, eller generera en programmatiskt med ditt kontos bearer-token för server-till-server-förfrågningar.

    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. Kör din första sökning

    Lämna in en entitet med X-API-Key-headern. API:et returnerar ett sök-ID som du hämtar när bearbetningen är klar.

    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. Skicka in en batch

    Skicka en CSV/XLSX-fil för att screena många entiteter i ett enda jobb, och hämta sedan rader eller exporter när batchen är klar.

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

    §02Centrala ändpunkter

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Skapa en screeningförfrågan för en entitet. Returnerar ett sök-ID och bearbetningsstatus. Ändpunkter för konto, täckning och hälsokontroll finns också under /api/v1.

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

    EP 02ENDPOINT

    POST /api/v1/batch

    Skicka in CSV/XLSX-filer för högvolymscreening, och hämta sedan rader eller exporter när jobben är klara.

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

    EP 03ENDPOINT

    POST /api/v1/keys

    Skapa och hantera API-autentiseringsuppgifter med scoped behörigheter, nivåanpassade gränser och användningsspårning.

    Autentisering: Bearer-token (konto)

    §03Varför team använder API:et

    03 / 05
    • En enda integration för sanktions-, PEP-, brottsbevaknings-, negativ media- och KYB/UBO-screening
    • API-nyckelautentisering via X-API-Key-headern, med behörighetsavgränsade nycklar för åtkomst med minsta privilegium
    • Gränser per prisnivå med användningsloggning för styrning och kostnadskontroll
    • Ändpunkter för sökning, batch, nycklar, konto, täckning och hälsokontroll under /api/v1
    • Interaktiv OpenAPI-dokumentation på /api/v1/docs plus ett maskinläsbart OpenAPI-schema
    • Strukturerad utdata lämplig för granskningsloggar, ärendeakter och nedströms beslut

    §05Vanliga frågor om API:et

    05 / 05
    Q01

    Hur autentiserar jag API-förfrågningar?

    Screeningförfrågningar till /api/v1/search och /api/v1/batch autentiseras med en API-nyckel som skickas i X-API-Key-headern. Skapa nycklar i din dashboard, eller programmatiskt via /api/v1/keys efter att du autentiserat med ditt kontos bearer-token.

    Q02

    Är API:et allmänt tillgängligt?

    Ja. API v1 är live och allmänt tillgängligt. Autentisera med en API-nyckel, anropa ändpunkterna för sökning, batch och nyckelhantering, och utforska allt i den interaktiva OpenAPI-dokumentationen på /api/v1/docs.

    Q03

    Kan jag avgränsa API-nyckelns behörigheter?

    Ja. Nycklar stödjer behörigheter som search:read, search:write, batch:read och batch:write så att du kan tillämpa åtkomst med minsta privilegium per integration.

    Q04

    Vilka hastighetsgränser gäller?

    Hastighetsgränser tilldelas per API-nivå och tillämpas per API-nyckel — nivån styr förfrågningsgenomströmningen, inte faktureringen. Svarsheaders inkluderar gränsen, kvarvarande kvot och tidsstämplar för återställning så att du kan anpassa dig utan avbrott.

    Q05

    Var kan jag snabbt testa ändpunkterna?

    Använd den interaktiva dokumentationen på /api/v1/docs för Swagger-testning och /api/v1/redoc för referensdokumentation. OpenAPI-schemat serveras på /api/v1/openapi.json.