ScreenVeritAI · API Specv1 · GA · reference
    API għall-Iżviluppaturi

    Għaliex tikkopja u tinkolla ismijiet bejn is-sistemi meta sejħa waħda tal-API tagħmilhom kollha?

    Daħħal verifika tal-kumpaniji, immappjar tas-sjieda, kontrolli PEP, midja avversa, u sinjali tas-sanzjonijiet direttament fil-flussi tax-xogħol eżistenti tiegħek.

    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

    Ibni fid-dar vs. integra ScreenVeritAI

    p. 05 / 09
    Żmien sal-produzzjoni
    Ibni fid-dar
    6-12-il xahar biex issib is-sorsi tal-listi, tibni t-tqabbil, timmaniġġja każijiet limitrofi
    API ta' ScreenVeritAI
    Ġranet biex tintegra — lest għall-produzzjoni mill-ewwel sejħa tal-API
    Kopertura tal-listi tas-sanzjonijiet
    Ibni fid-dar
    Inġestjoni manwali ta' kull format ta' lista; manutenzjoni kontinwa tal-iskema
    API ta' ScreenVeritAI
    Kull sors ewlieni, miżmum u aġġornat kontinwament
    Preċiżjoni tat-tqabbil
    Ibni fid-dar
    Tqabbil approssimattiv personalizzat jeħtieġ għarfien tal-NLP u aġġustament kostanti
    API ta' ScreenVeritAI
    AI b'tqabbil approssimattiv, traslitterazzjoni, riżoluzzjoni tal-aliases, algoritmi fonetiċi
    PEP u midja avversa
    Ibni fid-dar
    Fornituri separati, integrazzjonijiet separati, budgets separati
    API ta' ScreenVeritAI
    Dejta PEP, midja avversa, u UBO fl-istess risposta tal-API
    Manutenzjoni kontinwa
    Ibni fid-dar
    Tim dedikat għal aġġornamenti tal-listi, bidliet fl-iskema, aġġustament tal-pożittivi foloz
    API ta' ScreenVeritAI
    Ġestjoni sħiħa — aġġornamenti, titjib, u infrastruttura mmaniġġjati għalik
    Traċċa tal-verifika
    Ibni fid-dar
    Ibni l-infrastruttura tiegħek stess ta' reġistrazzjoni, evidenza, u żamma
    API ta' ScreenVeritAI
    Pakketti ta' evidenza b'timbru taż-żmien b'referenzi tas-sors inklużi

    Erba' passi lejn konformità integrata

    p. 06 / 09
    1

    Ikseb l-API key tiegħek

    Oħloq key bi skop definit mid-dashboard tiegħek b'permessi ta' privileġġ minimu: search:read, search:write, batch:read, batch:write.

    2

    Integra l-endpoint

    Sejħa POST waħda lejn il-fluss tal-onboarding, tal-pagamenti, jew tas-CRM tiegħek — ibgħat l-isem tal-entità, it-tip, u l-pajjiż, u ikseb job ID lura.

    3

    Ipproċessa r-riżultati

    Agħmel polling fuq l-endpoint tar-riżultati għal JSON strutturat — kuntest tal-kumpanija, sjieda, PEP, midja avversa, sinjali ta' sanzjonijiet u punteġġi tar-riskju.

    4

    Immonitorja u avża

    Ikkonfigura monitoraġġ kontinwu — l-API tibgħat avviżi meta l-listi tas-sanzjonijiet jiġu aġġornati jew tinstab midja avversa ġdida.

    Ibda fi ftit minuti

    p. 07 / 09

    Sejħa waħda tal-API tirritorna riżultat sħiħ ta' skrining.

    Iskrinja entità
    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 }
    Ikkontrolla r-riżultat
    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 }

    Prestazzjoni tal-API

    p. 08 / 09

    €0.39

    Quick Check għal kull sejħa, mingħajr ħlas tal-pjattaforma

    202

    Status HTTP meta tiġi aċċettata tfittxija; ir-riżultat jintalab wara

    EU

    Ospitat fil-Finlandja; id-data maħżuna tibqa' fl-UE

    Mistoqsijiet Frekwenti dwar l-Integrazzjoni tal-API

    p. 09 / 09
    01Kif nawtentika talbiet tal-API?
    Awtentika t-talbiet tal-API b'ċavetta sigrieta mgħoddija fl-header X-API-Key. Il-keys jinħolqu mid-dashboard tiegħek b'permessi bi skop definit u ta' privileġġ minimu.
    02L-API hija sinkronika jew asinkronika?
    Asinkronika. Issottometti talba, tikseb job ID, u tirkupra r-riżultati permezz tal-polling. Il-pipeline tiegħek qatt ma jissakkar.
    03Liema format ta' risposta tirritorna l-API?
    JSON strutturat bi tqabbiliet tas-sanzjonijiet, marki PEP, midja avversa, punteġġi ta' kunfidenza, referenzi tas-sors, u klassifikazzjoni tal-livell tar-riskju.
    04Liema limiti tar-rata japplikaw?
    Assenjati skont il-livell tas-sottoskrizzjoni għal kull API key. L-headers tar-risposta jinkludu l-kwota li fadal u l-marka taż-żmien tal-irkupru.
    05Nista' niskrinja entitajiet bil-lott permezz tal-API?
    Iva. L-endpoint tal-lott jaċċetta CSV jew XLSX sa 100 ringiela għal kull talba, bir-riżultati li jistgħu jiġu rkuprati għal kull ringiela jew bħala esportazzjoni sħiħa.
    06Kif nissettja monitoraġġ kontinwu permezz tal-API?
    Ikkonfigura l-monitoraġġ wara l-iskrining inizjali. Meta l-listi jiġu aġġornati jew tinstab midja avversa ġdida, il-monitoraġġ jimmarka l-bidla u javżak fl-app.
    07Liema dejta ta' konformità hija inkluża f'kull riżultat ta' skrining?
    Tqabbiliet tas-sanzjonijiet fost kull sors ewlieni, l-istatus PEP b'konnessjonijiet tal-familja, midja avversa b'ċitazzjonijiet f'ħafna lingwi, dejta tal-UBO, il-livell tar-riskju, u pakkett ta' evidenza b'timbru taż-żmien.
    08Kemm jieħu żmien skrining?
    Kontroll standard tas-sanzjonijiet: sekondi. Deep research bil-midja avversa u l-immappjar tas-sjieda: inqas minn żewġ minuti.
    Terminoloġija tal-API
    REST API
    API tal-web li tuża metodi standard HTTP — kompatibbli ma' kwalunkwe lingwa jew qafas li jista' jagħmel talbiet HTTP.
    Ipproċessar asinkroniku
    L-API taċċetta job immedjatament u tipproċessah fl-isfond — iġbor ir-riżultati permezz tal-polling.
    API key
    Token sigriet biex jawtentika talbiet tal-API, bi skop definit b'permessi speċifiċi għal aċċess ta' privileġġ minimu.
    Limitazzjoni tar-rata
    Tirrestrinġi t-talbiet tal-API għal kull tieqa ta' ħin skont il-livell tas-sottoskrizzjoni — kwota li fadal u marki taż-żmien tal-irkupru fl-headers tar-risposta.
    Risposta strutturata
    JSON li tinqara mill-magni b'ismijiet u tipi konsistenti tal-oqsma, li jippermettu parsing awtomatiku u loġika ta' deċiżjoni.
    Sorsi tal-industrija
    1. 01
    2. 02
      Regulatory Technology for AML/CFT Compliance

      Bank for International Settlements — FSI Insights

    3. 03
      OFAC Compliance Commitments Framework

      U.S. Department of the Treasury

    4. 04
      EU Anti-Money Laundering Authority (AMLA) Regulation

      Official Journal of the European Union

    chk api-v1svai-api-specv1 · ga2 samples · reference

    End of API specification.

    Ibda skrining fi ftit minuti.

    Agħżel pjan u ibda skrining illum.