ScreenVeritAI · API Specv1 · GA · reference
    API dla deweloperów

    Wbuduj screening compliance w dowolny workflow

    Twój pipeline onboardingowy, bramka płatnicza i CRM już codziennie podejmują decyzje dotyczące ryzyka. API ScreenVeritAI pozwala wbudować screening sankcyjny, weryfikację PEP, analizę negatywnych doniesień medialnych i mapowanie UBO bezpośrednio w te procesy — bez ręcznych wyszukiwań, bez kopiowania, bez luk compliance między systemami. Jedno wywołanie API uruchamia tego samego agenta AI, który napędza naszą platformę, a ustrukturyzowany JSON wraca gotowy dla Twojego silnika decyzyjnego.

    The request

    p. 01 / 09

    One POST call, then your poll loop.

    Entity name, type, country, screening type. The call returns 202 with a search_id and an ETA, and the agent works in the background — you poll for the result rather than hold the connection open.

    entity_nameRequired, 1-500 characters. Alias-aware matching
    entity_type"person", "company" or "any" (default "any")
    countryOptional jurisdiction hint that sharpens identity resolution
    search_type"sanctions_check", "adverse_media" or "full_search"
    POST /api/v1/search
    bash
    1curl -X POST https://screenveritai.com/api/v1/search \
    2 -H 'X-API-Key: YOUR_API_KEY' \
    3 -H 'Content-Type: application/json' \
    4 -d '{
    5 "entity_name": "Acme Trading LLC",
    6 "entity_type": "company",
    7 "country": "AE",
    8 "search_type": "sanctions_check"
    9 }'
    10# 202 Accepted
    11# { "search_id": "SEARCH_ID", "status": "processing",
    12# "estimated_time_seconds": 15 }

    The response

    p. 02 / 09
    GET /api/v1/search/{search_id} — response
    200 OK
    1{
    2"id": "SEARCH_ID",
    3"entity_name": "Acme Trading LLC",
    4"entity_type": "company",
    5"status": "completed",
    6"search_type": "sanctions_check",
    7"ofac_sanctions": "## OFAC Sanctions Findings\n\n
    8**Status:** *Sanctioned*\n\n**Details:**\n
    9- **Matched entity:** ACME TRADING LLC\n
    10- **Authority:** US Treasury OFAC\n...",
    11"eu_sanctions": "## EU Sanctions Findings\n\n
    12**Status:** *No relevant listing found*\n...",
    13"sanctions_sources": [
    14{ "source_id": "ofac_sanctions", "title": "OFAC Sanctions",
    15"authority": "US Treasury OFAC", "hit_count": 1 },
    16{ "source_id": "eu_sanctions", "title": "EU Sanctions",
    17"authority": "", "hit_count": 0 }
    18],
    19"criminal_watchlists": null,
    20"pep": null,
    21"news_summary": null,
    22"final_report": null,
    23"created_at": "2026-09-04T09:20:03.771000+00:00",
    24"completed_at": "2026-09-04T09:20:19.088000+00:00"
    25}
    No relevant listing found / null
    Sanctioned / potential match
    Per-source hit_count
    Status and search_type

    Structured JSON. Findings, not a score.

    One field per sanctions source, plus criminal watchlists and PEP. Each finding is markdown carrying the status line, the matched entity, the authority and an evidence URL — there is no numeric score and no risk tier, because a number hides the line an auditor asks to see.

    "ofac_sanctions"One markdown field per jurisdiction; read the *Status:* line
    "sanctions_sources"source_id, title, authority, details, hit_count per source
    "criminal_watchlists"Markdown when matched, null when nothing matched
    "pep"Markdown when matched, null when nothing matched
    "news_summary"Adverse-media report on adverse_media and full_search
    "status"completed when done; error_* on failure

    API reference

    p. 03 / 09

    Three calls cover a screening integration: queue it, poll it, or hand over a file.

    API reference — endpoints
    v1 · rest
    POST
    /api/v1/search

    Queue a screening run. Returns immediately with a search_id; the work happens in the background.

    Request

    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 Trading LLC", "entity_type": "company",
    "country": "AE", "search_type": "sanctions_check"}'

    Response

    202 Accepted
    { "search_id": "SEARCH_ID", "status": "processing",
    "message": "Search queued successfully. Poll the GET endpoint for results.",
    "estimated_time_seconds": 15 }

    Integration patterns

    p. 04 / 09

    The API sits between data entry and decision — wherever you need a risk signal.

    Customer onboarding
    Customer signupPOST /api/v1/searchPoll until completedApprove / hold
    Payment processing
    Transaction initPOST /api/v1/searchPoll until completedRelease / hold
    CRM re-screen
    Record updatedYour scheduler firesPOST /api/v1/searchWrite result back

    Budować czy kupić

    p. 05 / 09
    Czas do produkcji
    Budowa wewnętrzna
    6–12 miesięcy na pozyskanie list, budowę logiki dopasowywania i obsługę przypadków brzegowych
    API ScreenVeritAI
    Dni na integrację; gotowe do produkcji od pierwszego wywołania API
    Pokrycie list sankcyjnych
    Budowa wewnętrzna
    Ręczne pozyskiwanie każdego formatu listy; ciągła konserwacja przy zmianach schematów
    API ScreenVeritAI
    Każde główne źródło, utrzymywane i aktualizowane na bieżąco
    Dokładność dopasowania
    Budowa wewnętrzna
    Własne dopasowanie rozmyte wymaga ekspertyzy NLP i ciągłego dostrajania
    API ScreenVeritAI
    Agent AI z dopasowaniem rozmytym, transliteracją, rozwiązywaniem aliasów i algorytmami fonetycznymi
    PEP i negatywne doniesienia medialne
    Budowa wewnętrzna
    Osobni dostawcy danych, osobne integracje, osobne budżety
    API ScreenVeritAI
    PEP, negatywne doniesienia medialne i dane UBO zawarte w tej samej odpowiedzi API
    Bieżąca konserwacja
    Budowa wewnętrzna
    Dedykowany zespół inżynieryjny do aktualizacji list, zmian schematów i strojenia fałszywych pozytywów
    API ScreenVeritAI
    W pełni zarządzane — aktualizacje list, ulepszenia modeli i infrastruktura obsługiwane za Ciebie
    Ścieżka audytu
    Budowa wewnętrzna
    Budowa własnego logowania, generowania dowodów i infrastruktury przechowywania
    API ScreenVeritAI
    Pakiety dowodowe z datą i godziną z referencjami źródłowymi i uzasadnieniem decyzji w zestawie

    Cztery kroki do produkcji

    p. 06 / 09
    1

    Uzyskaj klucz API

    Utwórz klucz API z ograniczonymi uprawnieniami z poziomu panelu ScreenVeritAI. Przypisz uprawnienia — search:read, search:write, batch:read, batch:write — dla dostępu z minimalnym zakresem uprawnień.

    2

    Zintegruj endpoint

    Dodaj pojedyncze wywołanie POST do procesu onboardingu, płatności lub CRM. Wyślij nazwę podmiotu, typ i kraj. API zwraca ID zadania do asynchronicznego pobierania wyników.

    3

    Przetwórz wyniki

    Odpytuj endpoint wyników o ustrukturyzowany JSON — kontekst firmy, struktura właścicielska, PEP, negatywne doniesienia medialne, sygnały sankcyjne i oceny ryzyka.

    4

    Monitoruj i alertuj

    Skonfiguruj bieżący monitoring dla zweryfikowanych podmiotów. Gdy listy sankcyjne zostaną zaktualizowane lub pojawią się nowe negatywne doniesienia medialne, API wysyła alerty, aby Twój system mógł automatycznie uruchomić ponowną weryfikację.

    Zacznij w kilka minut

    p. 07 / 09

    Jedno wywołanie API zwraca pełny wynik screeningu.

    Zweryfikuj podmiot
    bash
    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 Trading LLC", "country": "AE", "search_type": "sanctions_check"}'
    
    # 202 Accepted
    # { "search_id": "SEARCH_ID", "status": "processing", "estimated_time_seconds": 15 }
    Sprawdź wynik
    bash
    curl https://screenveritai.com/api/v1/search/SEARCH_ID \
      -H 'X-API-Key: YOUR_API_KEY'
    
    # 200 OK
    # { "id": "SEARCH_ID", "status": "completed",
    #   "ofac_sanctions": "## OFAC Sanctions Findings ... *No relevant listing found* ...",
    #   "criminal_watchlists": null, "pep": null }

    Wydajność API

    p. 08 / 09

    €0.39

    Quick Check za jedno sprawdzenie, bez opłaty za platformę

    202

    Status HTTP po przyjęciu wyszukiwania; wynik odpytujesz cyklicznie

    EU

    Hosting w Finlandii; dane w spoczynku nie opuszczają UE

    FAQ — integracja API

    p. 09 / 09
    01Jak uwierzytelniać żądania API?
    Wszystkie żądania API są uwierzytelniane kluczem API przekazywanym w nagłówku X-API-Key. Klucze tworzy się z poziomu panelu ScreenVeritAI z ograniczonymi uprawnieniami (search:read, search:write, batch:read, batch:write) wymuszającymi dostęp z minimalnym zakresem uprawnień.
    02Czy API jest synchroniczne czy asynchroniczne?
    Asynchronicznie. Prześlij żądanie, otrzymaj ID zadania, wyniki pobieraj przez odpytywanie. Twój pipeline nigdy się nie blokuje.
    03W jakim formacie API zwraca odpowiedzi?
    Wszystkie odpowiedzi są ustrukturyzowanym JSON ze spójnymi nazwami pól i typami. Wyniki screeningu zawierają szczegóły trafień sankcyjnych, flagi PEP, trafienia negatywnych doniesień medialnych, wskaźniki pewności, referencje źródłowe i klasyfikację poziomu ryzyka — gotowe do automatycznego parsowania i logiki decyzyjnej bez ręcznej ekstrakcji.
    04Jakie limity żądań obowiązują?
    Limity żądań są przypisywane według poziomu subskrypcji i egzekwowane per klucz API. Nagłówki odpowiedzi zawierają aktualny limit, pozostałą liczbę żądań i czas resetu. Jeśli potrzebujesz wyższej przepustowości do przetwarzania masowego, endpoint wsadowy akceptuje przesyłanie plików CSV/XLSX do screeningu dużych wolumenów.
    05Czy mogę weryfikować podmioty wsadowo przez API?
    Tak. Endpoint wsadowy akceptuje pliki CSV lub XLSX z maksymalnie 100 wierszami na żądanie. Każdy wiersz jest przetwarzany jako indywidualny screening, a wyniki można pobierać per wiersz lub jako kompletny eksport po zakończeniu zadania.
    06Jak skonfigurować bieżący monitoring przez API?
    Skonfiguruj monitoring po wstępnym screeningu. Gdy listy zostaną zaktualizowane lub pojawią się nowe negatywne doniesienia medialne, monitoring oznacza zmianę i powiadamia Cię w aplikacji.
    07Jakie dane compliance zawiera każdy wynik screeningu?
    Każdy wynik zawiera trafienia sankcyjne w każdym głównym źródle, status PEP z powiązaniami rodzinnymi i współpracownikami, trafienia negatywnych doniesień medialnych z wielojęzycznymi cytowaniami źródeł, dane własności UBO, klasyfikację poziomu ryzyka i pakiet dowodowy z datą i godziną odpowiedni do audytu i przeglądu regulacyjnego.
    08Jak długo trwa screening?
    Standardowa weryfikacja sankcyjna zazwyczaj kończy się w sekundach. Pogłębiony screening — obejmujący analizę negatywnych doniesień medialnych i mapowanie własności — trwa średnio poniżej dwóch minut. Model asynchroniczny oznacza, że Twój system nigdy nie jest blokowany w oczekiwaniu na wyniki.
    Terminologia API
    REST API
    Architektura API webowego wykorzystująca standardowe metody HTTP (GET, POST, PUT, DELETE) do interakcji z zasobami. API ScreenVeritAI stosuje konwencje REST, dzięki czemu jest kompatybilne z dowolnym językiem programowania lub frameworkiem zdolnym do wykonywania żądań HTTP.
    Przetwarzanie asynchroniczne
    API natychmiast przyjmuje zadanie i przetwarza je w tle — wyniki pobierasz przez odpytywanie.
    Klucz API
    Tajny token używany do uwierzytelniania żądań API między serwerami. Klucze API ScreenVeritAI mają określone uprawnienia (search:read, search:write, batch:read, batch:write) wymuszające wzorce dostępu z minimalnym zakresem uprawnień.
    Ograniczenie liczby żądań (rate limiting)
    Mechanizm ograniczający liczbę żądań API, które klient może wykonać w określonym oknie czasowym. Limity są przypisywane według poziomu subskrypcji i komunikowane przez nagłówki odpowiedzi zawierające pozostały limit i czas resetu.
    Ustrukturyzowana odpowiedź
    Format odpowiedzi API czytelny maszynowo (JSON) ze spójnymi nazwami pól, typami i zagnieżdżeniem. Ustrukturyzowane odpowiedzi umożliwiają automatyczne parsowanie, logikę decyzyjną i generowanie ścieżki audytu bez ręcznej ekstrakcji danych.
    Źródła branżowe
    1. 01
      Wytyczne FATF dotyczące tożsamości cyfrowej i należytej staranności wobec klienta

      Grupa Specjalna ds. Przeciwdziałania Praniu Pieniędzy (FATF)

    2. 02
      Technologia regulacyjna dla compliance AML/CFT

      Bank Rozrachunków Międzynarodowych — FSI Insights

    3. 03
    4. 04
    chk api-v1svai-api-specv1 · ga2 samples · reference

    End of API specification.

    Zacznij screening w kilka minut.

    Wybierz plan i zacznij sprawdzać już dziś.