ScreenVeritAI
    Menu
    Ibda skrining

    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.

    Ikseb API keyAra l-ipprezzar
    POST/api/v1/searchbash
    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"
  }'
# 202 Accepted
# { "search_id": "SEARCH_ID", "status": "processing",
#   "estimated_time_seconds": 15 }

    The request

    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 context field; does not filter Quick Check matching
    • search_type"sanctions_check", "adverse_media" or "full_search"

    The response

    Structured JSON. Findings, not a score.

    Core-jurisdiction fields and per-source arrays, plus criminal-watchlist and PEP/RCA findings. Review the available markdown, identifiers and source references; the response does not provide a numeric risk score.

    GET/api/v1/search/{search_id}200 OK
    {
  "id": "SEARCH_ID",
  "entity_name": "Acme Trading LLC",
  "entity_type": "company",
  "status": "completed",
  "search_type": "sanctions_check",
  "ofac_sanctions": "## OFAC Sanctions Findings\n\n**Status:** *Sanctioned*\n\n**Details:**\n- **Matched entity:** ACME TRADING LLC\n- **Authority:** US Treasury OFAC\n...",
  "eu_sanctions": "## EU Sanctions Findings\n\n**Status:** *No relevant listing found*\n...",
  "sanctions_sources": [
    { "source_id": "ofac_sanctions", "title": "OFAC Sanctions",
      "authority": "US Treasury OFAC", "hit_count": 1 },
    { "source_id": "eu_sanctions", "title": "EU Sanctions",
      "authority": "", "hit_count": 0 }
  ],
  "criminal_watchlists": null,
  "pep": null,
  "news_summary": null,
  "final_report": null,
  "created_at": "2026-09-04T09:20:03.771000+00:00",
  "completed_at": "2026-09-04T09:20:19.088000+00:00"
}
    No relevant listing found / nullSanctioned / potential matchPer-source hit_countStatus and search_type
    • "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

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

    POST/api/v1/searchQueue a screening run. Returns immediately with a search_id; the work happens in the background.202 Accepted
    Requestbash
    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"}'
    Response202 Accepted
    { "search_id": "SEARCH_ID", "status": "processing",
  "message": "Search queued successfully. Poll the GET endpoint for results.",
  "estimated_time_seconds": 15 }
    GET/api/v1/search/{search_id}Poll for the result. Terminal status is completed; failures land in an error_* status.200 OK
    Requestbash
    curl https://screenveritai.com/api/v1/search/SEARCH_ID \
  -H 'X-API-Key: YOUR_API_KEY'
    Response200 OK
    { "id": "SEARCH_ID", "status": "completed", "search_type": "sanctions_check",
  "ofac_sanctions": "## OFAC Sanctions Findings ... *Sanctioned* ...",
  "eu_sanctions": "... *No relevant listing found* ...",
  "sanctions_sources": [{ "source_id": "ofac_sanctions", "hit_count": 1 }],
  "criminal_watchlists": null, "pep": null }
    POST/api/v1/batchUpload a CSV or XLSX with a name column — up to 100 rows and 2 MB. Poll the job, then export the CSV.202 Accepted
    Requestbash
    curl -X POST https://screenveritai.com/api/v1/batch \
  -H 'X-API-Key: YOUR_API_KEY' \
  -F 'file=@portfolio.csv'
    Response202 Accepted
    { "job_id": "JOB_ID", "total_rows": 100, "credits_charged": 100,
  "search_type": "sanctions_check", "status": "pending",
  "message": "Batch job created successfully. Poll the GET endpoint for status." }

    Integration patterns

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

    • Customer onboarding

      1. Customer signup
      2. POST/api/v1/search
      3. Poll until completed
      4. Approve / hold

    • Payment processing

      1. Transaction init
      2. POST/api/v1/search
      3. Poll until completed
      4. Release / hold

    • CRM re-screen

      1. Record updated
      2. Your scheduler fires
      3. POST/api/v1/search
      4. Write result back

    Ibni fid-dar vs. integra ScreenVeritAI

    Ibni fid-dar vs. integra ScreenVeritAI
    AspettIbni fid-darAPI ta' ScreenVeritAI
    Żmien sal-produzzjoni6-12-il xahar biex issib is-sorsi tal-listi, tibni t-tqabbil, timmaniġġja każijiet limitrofiĠranet biex tintegra — lest għall-produzzjoni mill-ewwel sejħa tal-API
    Kopertura tal-listi tas-sanzjonijietInġestjoni manwali ta' kull format ta' lista; manutenzjoni kontinwa tal-iskemaKull sors ewlieni, miżmum u aġġornat kontinwament
    Preċiżjoni tat-tqabbilTqabbil approssimattiv personalizzat jeħtieġ għarfien tal-NLP u aġġustament kostantiAI b'tqabbil approssimattiv, traslitterazzjoni, riżoluzzjoni tal-aliases, algoritmi fonetiċi
    PEP u midja avversaFornituri separati, integrazzjonijiet separati, budgets separatiDejta PEP, midja avversa, u UBO fl-istess risposta tal-API
    Manutenzjoni kontinwaTim dedikat għal aġġornamenti tal-listi, bidliet fl-iskema, aġġustament tal-pożittivi folozĠestjoni sħiħa — aġġornamenti, titjib, u infrastruttura mmaniġġjati għalik
    Traċċa tal-verifikaIbni l-infrastruttura tiegħek stess ta' reġistrazzjoni, evidenza, u żammaPakketti ta' evidenza b'timbru taż-żmien b'referenzi tas-sors inklużi

    Erba' passi lejn konformità integrata

    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

    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żultatbash
    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

    • €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

    Kif 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.

    L-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.

    Liema format ta' risposta tirritorna l-API?

    JSON strutturat b’oqsma għall-ġurisdizzjonijiet prinċipali u arrays għal kull sors, flimkien ma’ sejbiet minn listi ta’ persuni mfittxija u PEP/RCA. Irrevedi l-markdown, l-identifikaturi u r-referenzi disponibbli. Ir-risposta ma tipprovdix punteġġ numeriku tar-riskju.

    Liema 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.

    Nista' 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.

    Kif 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.

    Liema 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.

    Kemm 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.

    REST API għall-iskrining AML

    Integra l-iskrining tas-sanzjonijiet, tal-PEP, tal-listi ta' sorveljanza kriminali, tal-midja avversa, u tal-KYB/UBO direttament fil-flussi tiegħek ta' onboarding, monitoraġġ, u tranżazzjonijiet. L-API hija diretta: awtentika b'API key u sejjaħ l-istess magna ta' skrining li juża l-portal.

    L-endpoints huma ġeneralment disponibbli b'awtentikazzjoni b'API key u limiti tar-rata skont il-livell. Esplora kull endpoint fid-dokumentazzjoni interattiva OpenAPI fuq /api/v1/docs.

    Quickstart API referenceOpenAPI schema

    Bidu Malajr

    1. 1. Oħloq API key

      Oħloq API key bi skop definit fid-dashboard tiegħek, jew iġġenera waħda b'mod programmatiku bit-token bearer tal-kont tiegħek għal talbiet server-to-server.

      POST/api/v1/keyscurl
      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. 2. Mexxi l-ewwel tiftixa tiegħek

      Issottometti entità bl-header X-API-Key. L-API tirritorna search id li tirkupra meta l-ipproċessar jitlesta.

      POST/api/v1/searchcurl
      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"}'

    3. 3. Issottometti lott

      Ibgħat fajl CSV/XLSX biex tiskrinja bosta entitajiet f'xogħol wieħed, imbagħad irkupra r-ringieli jew l-esportazzjonijiet meta l-lott jispiċċa.

      POST/api/v1/batchcurl
      curl -X POST https://screenveritai.com/api/v1/batch \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -F "file=@entities.csv"
    API reference (EN)OpenAPI schema

    Endpoints ewlenin

    • POST/api/v1/search

      Oħloq talba ta' skrining għal entità waħda. Tirritorna search id u l-istatus tal-ipproċessar. Endpoints tal-kont, tal-kopertura, u tas-saħħa huma disponibbli wkoll taħt /api/v1.

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

    • POST/api/v1/batch

      Issottometti fajls CSV/XLSX għal skrining ta' volum għoli, imbagħad irkupra r-ringieli jew l-esportazzjonijiet meta x-xogħlijiet jitlestew.

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

    • POST/api/v1/keys

      Oħloq u ġġestixxi kredenzjali tal-API b'permessi bi skop definit, limiti tar-rata skont il-livell, u traċċar tal-użu.

      Awtentikazzjoni: Bearer token (kont)

    Crypto address checks. Source evidence at €0.39.

    Check an address against OFAC’s published digital-currency identifiers. Add native-USDC issuer-block status on Ethereum in the same request, at the same price.

    €0.39 per completed address check · prepaid PAYG only

    • POST/api/v1/crypto-address/checks
    • GET/api/v1/crypto-address/checks/{id}
    API documentation (EN)
    OFAC address match
    Exact address lookup under the requested OFAC currency label, such as ETH, XBT, TRX, USDT or USDC. Evidence includes the publication date, source URL, export hash and matching OFAC record.
    Ethereum USDC
    Set network to ethereum to check native-USDC issuer-block status at a finalized Ethereum mainnet block. The result includes the contract address, block number, block hash and contract response. Omit network for an OFAC-only check.
    Create a check
    POST requires X-API-Key with search:write, an Idempotency-Key of 16–128 ASCII letters, digits, underscores, dots, colons or hyphens, and address, currency and integer max_prepaid_cents fields. Set max_prepaid_cents to 39 to authorize the current price. A completed request returns HTTP 200 synchronously.
    Retrieve and retry
    GET requires search:read and returns your saved check without another charge. If a POST response is lost, reuse the same Idempotency-Key and payload. Keep that key while the outcome is uncertain; create a new key only for a deliberate new check.
    Billing
    Completed checks debit €0.39 from your EUR prepaid balance. Minimum balance top-up: €5. Subscription allowances do not apply. Source failures are unpaid.

    A negative result means no published OFAC match or no native-USDC issuer block in the checked source. It does not establish wallet ownership or clear an address of all risk.

    This is an address-level source check. Transaction tracing, exposure scoring and continuous KYT monitoring are outside its scope. Crypto checks use this separate API; they are not available through name-screening batch uploads, portal history or PDF reports.

    Għaliex it-timijiet jużaw l-API

    • Integrazzjoni waħda għall-iskrining tas-sanzjonijiet, tal-PEP, tal-listi ta' sorveljanza kriminali, tal-midja avversa, u tal-KYB/UBO
    • Awtentikazzjoni b'API key permezz tal-header X-API-Key, b'keys bi skop definit għal aċċess ta' privileġġ minimu
    • Limiti tar-rata skont il-livell b'reġistrazzjoni tal-użu għall-governanza u l-kontroll tal-ispejjeż
    • Endpoints ta' tiftixa, lott, keys, kont, kopertura, u saħħa taħt /api/v1
    • Dokumentazzjoni interattiva OpenAPI fuq /api/v1/docs flimkien ma' skema OpenAPI li tinqara mill-magni
    • Output strutturat adattat għal logs tal-awditu, fajls tal-każijiet, u deċiżjonijiet sussegwenti

    Integration playbooks

    Mistoqsijiet Frekwenti dwar l-API

    Kif nawtentika talbiet tal-API?

    Talbiet ta' skrining lejn /api/v1/search u /api/v1/batch jawtentikaw b'API key mibgħuta fl-header X-API-Key. Oħloq keys fid-dashboard tiegħek, jew b'mod programmatiku permezz ta' /api/v1/keys wara li tawtentika bit-token bearer tal-kont tiegħek.

    L-API hija ġeneralment disponibbli?

    Iva. API v1 hija diretta u ġeneralment disponibbli. Awtentika b'API key, sejjaħ l-endpoints ta' tiftixa, lott, u ġestjoni tal-key, u esplora kollox fid-dokumentazzjoni interattiva OpenAPI fuq /api/v1/docs.

    Nista' niddefinixxi l-iskop tal-permessi tal-API key?

    Iva. Il-keys jappoġġjaw permessi bħal search:read, search:write, batch:read, u batch:write biex tinforza aċċess ta' privileġġ minimu għal kull integrazzjoni.

    Liema limiti tar-rata japplikaw?

    Il-limiti tar-rata jiġu assenjati skont il-livell tal-API u infurzati għal kull API key — il-livell jirregola l-flussi ta' talbiet, mhux il-fatturazzjoni. L-headers tar-risposta jinkludu l-limitu, il-kwota li fadal, u l-marki taż-żmien tal-irkupru biex tkun tista' tnaqqas ir-rata b'mod nadif.

    Fejn nista' nittestja l-endpoints malajr?

    Uża d-dokumentazzjoni interattiva fuq /api/v1/docs għal ttestjar Swagger u /api/v1/redoc għal dokumentazzjoni ta' referenza. L-iskema OpenAPI tinsab fuq /api/v1/openapi.json.

    Ibda skrining fi ftit minuti.

    Agħżel pjan u ibda skrining illum.

    Ikseb API keyAra l-ipprezzar