ScreenVeritAI · API Specv1 · GA · reference
    API Forbairtheoirí

    Cén fáth ainmneacha a chóipeáil idir córais nuair a dhéanann aon ghlao API amháin gach rud?

    Leabaigh fíorú cuideachta, mapáil úinéireachta, seiceálacha PEP, droch-mheáin, agus comharthaí smachtbhannaí go díreach i do shreafaí atá ann cheana féin.

    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

    Tóg é féin vs. comhtháthaigh ScreenVeritAI

    p. 05 / 09
    Am go dtí táirgeadh
    Tóg é féin
    6-12 mí chun liostaí a fháil, meaitseáil a thógáil, cásanna imeallacha a láimhseáil
    API ScreenVeritAI
    Laethanta le comhtháthú — réidh do tháirgeadh ón gcéad ghlao API
    Clúdach liosta smachtbhannaí
    Tóg é féin
    Ionghabháil láimhe de gach formáid liosta; cothabháil scéimre leanúnach
    API ScreenVeritAI
    Gach mórfhoinse, cothabhálaithe agus nuashonraithe go leanúnach
    Cruinneas meaitseála
    Tóg é féin
    Éilíonn meaitseáil dhoiléir shaincheaptha saineolas NLP agus fíneáil leanúnach
    API ScreenVeritAI
    AI le meaitseáil dhoiléir, traslitriú, réiteach ailiasanna, algartaim fhóinéimeacha
    PEP agus droch-mheáin
    Tóg é féin
    Soláthraithe ar leith, comhtháthuithe ar leith, buiséid ar leith
    API ScreenVeritAI
    Sonraí PEP, droch-mheán, agus UBO san fhreagra API céanna
    Cothabháil leanúnach
    Tóg é féin
    Foireann thiomnaithe do nuashonruithe liosta, athruithe scéimre, fíneáil dearfach bréagach
    API ScreenVeritAI
    Bainistithe go hiomlán — nuashonruithe, feabhsuithe, agus bonneagar láimhseáilte duit
    Rian iniúchta
    Tóg é féin
    Tóg do logáil, d'fhianaise, agus do bhonneagar coinneála féin
    API ScreenVeritAI
    Bearta fianaise le stampa ama le tagairtí foinse san áireamh

    Ceithre chéim chuig comhlíonadh leabaithe

    p. 06 / 09
    1

    Faigh d'eochair API

    Cruthaigh eochair raonach ó do dheais le ceadanna leas-íosta: search:read, search:write, batch:read, batch:write.

    2

    Comhtháthaigh an críochphointe

    Aon ghlao POST amháin chuig do shreabhadh oibre ionduchtaithe, íocaíochta, nó CRM — seol ainm, cineál, agus tír an eintitis, faigh aitheantas poist ar ais.

    3

    Próiseáil torthaí

    Vótáil ar chríochphointe na dtorthaí le haghaidh JSON struchtúrtha — comhthéacs cuideachta, úinéireacht, PEP, droch-mheáin, comharthaí smachtbhannaí, agus scóir riosca.

    4

    Déan monatóireacht agus cuir foláireamh

    Cumraigh monatóireacht leanúnach — seolann an API foláirimh nuair a nuashonraítear liostaí smachtbhannaí nó nuair a nochtar droch-mheáin nua.

    Tosú i nóiméid

    p. 07 / 09

    Fillfidh aon ghlao API amháin toradh scagtha iomlán.

    Scag eintiteas
    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 }
    Seiceáil toradh
    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 }

    Feidhmíocht API

    p. 08 / 09

    €0.39

    Quick Check in aghaidh an ghlao, gan táille ardáin

    202

    Stádas HTTP nuair a ghlactar le cuardach; iarrtar an toradh ina dhiaidh sin

    EU

    Óstáilte san Fhionlainn; fanann sonraí stóráilte san AE

    Ceisteanna coitianta faoi chomhtháthú API

    p. 09 / 09
    01Conas a fhíordheimhním iarratais API?
    Fíordheimhnigh iarratais API le heochair rúnda a sheoltar sa cheanntásc X-API-Key. Cruthaítear eochracha ó do dheais le ceadanna raonacha.
    02An bhfuil an API sioncronach nó asincronach?
    Asincrónach. Cuir isteach iarratas, faigh aitheantas poist, aisghabh torthaí trí vótáil. Ní chuireann do phíblíne bac riamh.
    03Cén fhormáid fhreagartha a fhilleann an API?
    JSON struchtúrtha le hamais smachtbhannaí, bratacha PEP, droch-mheáin, scóir mhuiníne, tagairtí foinse, agus aicmiú riosca.
    04Cé na teorainneacha rátaí a bhaineann?
    Sanntar de réir leibhéil suibscríbhinne in aghaidh gach eochrach API. Áirítear i gceanntásca freagartha an cuóta atá fágtha agus an stampa ama athshocraithe.
    05An féidir liom eintitis a scagadh i mbaisc tríd an API?
    Is féidir. Glacann an críochphointe baisce le CSV nó XLSX suas le 100 sraith in aghaidh iarratais, torthaí inaisghabhála in aghaidh gach sraithe nó mar easpórtáil iomlán.
    06Conas a chumraím monatóireacht leanúnach tríd an API?
    Cumraigh monatóireacht tar éis na chéad scagtha. Nuair a nuashonraítear liostaí nó nuair a nochtar droch-mheáin nua, marcálann an mhonatóireacht an t-athrú agus cuireann sí foláireamh chugat san aip.
    07Cé na sonraí comhlíonta atá san áireamh i ngach toradh scagtha?
    Amais smachtbhannaí ar fud gach mórfhoinse, stádas PEP le naisc theaghlaigh, droch-mheáin le luanna ilteangacha, sonraí UBO, aicme riosca, agus beart fianaise le stampa ama.
    08Cá fhad a thógann scagadh?
    Gnáthsheiceáil smachtbhannaí: soicindí. Taighde domhain le droch-mheáin agus mapáil úinéireachta: níos lú ná dhá nóiméad.
    Téarmaíocht API
    API REST
    API gréasáin a úsáideann modhanna caighdeánacha HTTP — comhoiriúnach le haon teanga nó creat is féidir iarratais HTTP a dhéanamh.
    Próiseáil asincrónach
    Glacann an API le post láithreach agus próiseálann sé sa chúlra é — aisghabh torthaí trí vótáil.
    Eochair API
    Comhartha rúnda le haghaidh fíordheimhniú iarratas API, raonach le ceadanna sonracha do rochtain leas-íosta.
    Teorannú ráta
    Cuireann sé srian ar iarratais API in aghaidh fuinneoige ama de réir leibhéil suibscríbhinne — cuóta atá fágtha agus stampaí ama athshocraithe sna ceanntásca freagartha.
    Freagra struchtúrtha
    JSON inléite ag meaisín le hainmneacha agus cineálacha réimse comhsheasmhacha, ag cumasú parsáil uathoibrithe agus loighic chinnteoireachta.
    Foinsí tionscail
    1. 01
    2. 02
      RegTech do Chomhlíonadh AML/CFT

      Banc um Shocraíochtaí Idirnáisiúnta — FSI Insights

    3. 03
      Creat Gealltanas Comhlíonta OFAC

      Roinn Státchiste na SA

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

    End of API specification.

    Tosaigh ag scagadh i nóiméid.

    Gan chárta creidmheasa ag teastáil.