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.
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 matchingentity_type"person", "company" or "any" (default "any")countryOptional context field; does not filter Quick Check matchingsearch_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.
{
"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"
}"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
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"}'{ "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
curl https://screenveritai.com/api/v1/search/SEARCH_ID \
-H 'X-API-Key: YOUR_API_KEY'{ "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
curl -X POST https://screenveritai.com/api/v1/batch \
-H 'X-API-Key: YOUR_API_KEY' \
-F 'file=@portfolio.csv'{ "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
- Customer signup
- POST
/api/v1/search - Poll until completed
- Approve / hold
Payment processing
- Transaction init
- POST
/api/v1/search - Poll until completed
- Release / hold
CRM re-screen
- Record updated
- Your scheduler fires
- POST
/api/v1/search - Write result back
Tóg é féin vs. comhtháthaigh ScreenVeritAI
| Gné | Tóg é féin | API ScreenVeritAI |
|---|---|---|
| Am go dtí táirgeadh | 6-12 mí chun liostaí a fháil, meaitseáil a thógáil, cásanna imeallacha a láimhseáil | Laethanta le comhtháthú — réidh do tháirgeadh ón gcéad ghlao API |
| Clúdach liosta smachtbhannaí | Ionghabháil láimhe de gach formáid liosta; cothabháil scéimre leanúnach | Gach mórfhoinse, cothabhálaithe agus nuashonraithe go leanúnach |
| Cruinneas meaitseála | Éilíonn meaitseáil dhoiléir shaincheaptha saineolas NLP agus fíneáil leanúnach | AI le meaitseáil dhoiléir, traslitriú, réiteach ailiasanna, algartaim fhóinéimeacha |
| PEP agus droch-mheáin | Soláthraithe ar leith, comhtháthuithe ar leith, buiséid ar leith | Sonraí PEP, droch-mheán, agus UBO san fhreagra API céanna |
| Cothabháil leanúnach | Foireann thiomnaithe do nuashonruithe liosta, athruithe scéimre, fíneáil dearfach bréagach | Bainistithe go hiomlán — nuashonruithe, feabhsuithe, agus bonneagar láimhseáilte duit |
| Rian iniúchta | Tóg do logáil, d'fhianaise, agus do bhonneagar coinneála féin | Bearta fianaise le stampa ama le tagairtí foinse san áireamh |
Ceithre chéim chuig comhlíonadh leabaithe
Faigh d'eochair API
Cruthaigh eochair raonach ó do dheais le ceadanna leas-íosta: search:read, search:write, batch:read, batch:write.
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.
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.
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
Fillfidh aon ghlao API amháin toradh scagtha iomlán.
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 }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
€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
Conas 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.
An 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.
Cén fhormáid fhreagartha a fhilleann an API?
JSON struchtúrtha le réimsí do phríomhdhlínsí agus eagair in aghaidh na foinse, chomh maith le torthaí ó liostaí daoine atá á lorg agus PEP/RCA. Déan athbhreithniú ar an markdown, na haitheantóirí agus na tagairtí foinse atá ar fáil. Ní thugann an freagra scór riosca uimhriúil.
Cé 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.
An 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.
Conas 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.
Cé 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.
Cá 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.
API REST do scagadh AML
Comhtháthaigh scagadh smachtbhannaí, PEP, liostaí faire coiriúla, droch-mheáin, agus KYB/UBO go díreach i do shreafaí ionduchtaithe, monatóireachta, agus idirbheart. Tá an API beo: fíordheimhnigh le heochair API agus glaoigh ar an inneall scagtha céanna a úsáideann an tairseach.
Tá críochphointí ar fáil go ginearálta le fíordheimhniú eochrach API agus teorainneacha rátaí de réir leibhéil. Déan iniúchadh ar gach críochphointe sa doiciméadú idirghníomhach OpenAPI ag /api/v1/docs.
Tosú tapa
1. Cruthaigh eochair API
Cruthaigh eochair API raonach i do dheais, nó bain ceann as go ríomhchláraithe le comhartha bearer do chuntais le haghaidh iarratas freastalaí-go-freastalaí.
POST/api/v1/keys 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. Rith do chéad chuardach
Cuir eintiteas isteach leis an gceanntásc X-API-Key. Fillfidh an API aitheantas cuardaigh a aisghabhálann tú nuair a chríochnaíonn an phróiseáil.
POST/api/v1/search 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. Cuir isteach baisc
Seol comhad CSV/XLSX chun go leor eintiteas a scagadh in aon phost amháin, ansin aisghabháil sraitheanna nó easpórtálacha nuair a chríochnaíonn an bhaisc.
POST/api/v1/batch curl -X POST https://screenveritai.com/api/v1/batch \ -H "X-API-Key: <YOUR_API_KEY>" \ -F "file=@entities.csv"
Príomhchríochphointí
- POST
/api/v1/searchCruthaigh iarratas scagtha d'aon eintiteas amháin. Fillfidh sé aitheantas cuardaigh agus stádas próiseála. Tá críochphointí cuntais, clúdaigh agus sláinte ar fáil freisin faoi /api/v1.
Fíordheimhniú: X-API-Key (search:write)
- POST
/api/v1/batchCuir isteach comhaid CSV/XLSX le haghaidh scagadh ar mhórimleabhar, ansin aisghabháil sraitheanna nó easpórtálacha nuair a chríochnaíonn poist.
Fíordheimhniú: X-API-Key (batch:write)
- POST
/api/v1/keysCruthaigh agus bainistigh dintiúir API le ceadanna raonacha, teorainneacha rátaí atá ar an eolas faoi leibhéal, agus rianú úsáide.
Fíordheimhniú: Comhartha Bearer (cuntas)
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}
- 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.
Cén fáth a n-úsáideann foirne an API
- Comhtháthú aonair le haghaidh scagadh smachtbhannaí, PEP, liostaí faire coiriúla, droch-mheáin, agus KYB/UBO
- Fíordheimhniú eochrach API tríd an gceanntásc X-API-Key, le heochracha ceadanna-raonacha do rochtain leas-íosta
- Teorainneacha rátaí de réir leibhéil le logáil úsáide le haghaidh rialachais agus rialú costais
- Críochphointí cuardaigh, baisce, eochracha, cuntais, clúdaigh agus sláinte faoi /api/v1
- Doiciméadú idirghníomhach OpenAPI ag /api/v1/docs móide scéimre OpenAPI inléite ag meaisín
- Aschur struchtúrtha atá oiriúnach do logaí iniúchta, comhaid chásanna, agus cinntí iartheachtacha
Integration playbooks
Developer guides
Endpoint contracts and worked examples for sanctions, PEP, criminal watchlists and batch screening.
PEP screening API guide
Implementation patterns for API-key auth, async jobs, and audit logs.
Batch screening workflow
Connect API and file-based flows for high-volume operations.
Workflow template
Map API responses into deterministic screening and escalation decisions.
Criminal watchlist coverage
See the official criminal and wanted-person lists included with sanctions and PEP checks.
Ceisteanna Coitianta faoin API
Conas a fhíordheimhním iarratais API?
Fíordheimhníonn iarratais scagtha chuig /api/v1/search agus /api/v1/batch le heochair API a sheoltar sa cheanntásc X-API-Key. Cruthaigh eochracha i do dheais, nó go ríomhchláraithe trí /api/v1/keys tar éis duit fíordheimhniú le comhartha bearer do chuntais.
An bhfuil an API ar fáil go ginearálta?
Tá. Tá API v1 beo agus ar fáil go ginearálta. Fíordheimhnigh le heochair API, glaoigh ar na críochphointí cuardaigh, baisce agus bainistíochta eochracha, agus déan iniúchadh ar gach rud sa doiciméadú idirghníomhach OpenAPI ag /api/v1/docs.
An féidir liom ceadanna eochrach API a raonú?
Is féidir. Tacaíonn eochracha le ceadanna ar nós search:read, search:write, batch:read, agus batch:write ionas gur féidir leat rochtain leas-íosta a fhorfheidhmiú in aghaidh gach comhtháthaithe.
Cé na teorainneacha rátaí a bhaineann?
Sanntar teorainneacha rátaí de réir leibhéil API agus forfheidhmítear iad in aghaidh gach eochrach API — rialaíonn an leibhéal trádghluaiseacht na n-iarratas, ní an billeáil. Áirítear i gceanntásca freagartha an teorainn, an cuóta atá fágtha, agus stampaí ama athshocraithe ionas gur féidir leat maolú go glan.
Cá háit ar féidir liom na críochphointí a thástáil go tapa?
Úsáid an doiciméadú idirghníomhach ag /api/v1/docs le haghaidh tástáil Swagger agus /api/v1/redoc le haghaidh doiciméadú stíl-tagartha. Freastalaítear an scéimre OpenAPI ag /api/v1/openapi.json.
Tosaigh ag scagadh i nóiméid.
Gan chárta creidmheasa ag teastáil.