Fejlesztői API
Miért másolgassa a neveket rendszerek között, ha egyetlen API-hívás mindent elvégez?
Ágyazza be a cégellenőrzést, a tulajdonosi feltérképezést, a PEP-ellenőrzést, a negatív médiát és a szankciós jelzéseket közvetlenül meglévő munkafolyamataiba.
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
Saját fejlesztés vs. ScreenVeritAI integrálása
| Szempont | Saját fejlesztés | ScreenVeritAI API |
|---|---|---|
| Idő az éles indulásig | 6-12 hónap a listák beszerzéséhez, az egyeztetés felépítéséhez, a szélsőséges esetek kezeléséhez | Napok az integrációhoz — az első API-hívástól éles állapotban |
| Szankciós lista lefedettség | Kézi feldolgozás minden listaformátumhoz; folyamatos sémakarbantartás | Minden jelentős forrás, folyamatosan karbantartva és frissítve |
| Egyeztetési pontosság | Az egyedi közelítő egyeztetés NLP-szakértelmet és állandó finomhangolást igényel | AI közelítő egyeztetéssel, átírással, névváltozat-feloldással és fonetikus algoritmusokkal |
| PEP és negatív média | Külön szolgáltatók, külön integrációk, külön költségvetések | PEP-, negatívmédia- és UBO-adat ugyanabban az API-válaszban |
| Folyamatos karbantartás | Dedikált csapat a lista- és sémafrissítésekhez, a téves találatok finomhangolásához | Teljes körűen menedzselt — a frissítéseket, fejlesztéseket és infrastruktúrát mi kezeljük |
| Auditnyom | Építse fel saját naplózási, bizonyítéki és megőrzési infrastruktúráját | Időbélyeges bizonyítékcsomagok forráshivatkozásokkal, beépítve |
Négy lépés a beépített megfelelőségig
Szerezze meg API-kulcsát
Hozzon létre egy hatáskörhöz kötött kulcsot a vezérlőpultján, legkisebb jogosultsági szintű engedélyekkel: search:read, search:write, batch:read, batch:write.
Illessze be a végpontot
Egyetlen POST hívás az ügyfél-befogadási, fizetési vagy CRM-munkafolyamatába — küldje a szervezet nevét, típusát és országát, kapjon vissza egy job id-t.
Dolgozza fel az eredményeket
Kérdezze le az eredmény-végpontot strukturált JSON-ért — cégkontextus, tulajdonlás, PEP, negatív média, szankciós jelzések és kockázati pontszámok.
Monitorozzon és riasszon
Állítson be folyamatos monitorozást — az API riaszt, amikor a szankciós listák frissülnek, vagy új negatív média jelenik meg.
Kezdje el percek alatt
Egyetlen API-hívás teljes szűrési eredményt ad vissza.
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 }API-teljesítmény
€0.39
Quick Check hívásonként, platformdíj nélkül
202
HTTP-státusz a keresés elfogadásakor; az eredményt ezután kell lekérdezni
EU
Finnországban hosztolva; a nyugalmi adatok az EU-ban maradnak
API-integrációs GYIK
Hogyan hitelesítem az API-kéréseket?
Hitelesítse az API-kéréseket az X-API-Key fejlécben átadott titkos kulccsal. A kulcsokat a vezérlőpultján hozza létre, korlátozott, minimálisan szükséges jogosultságokkal.
Az API szinkron vagy aszinkron?
Aszinkron. Küldjön be egy kérést, kapjon egy job id-t, kérje le az eredményeket lekérdezéssel. Folyamata sosem blokkolódik.
Milyen válaszformátumot ad vissza az API?
Strukturált JSON a fő joghatóságok mezőivel és forrásonkénti tömbökkel, valamint körözési listás és PEP/RCA-találatokkal. Tekintse át az elérhető markdown szöveget, azonosítókat és forráshivatkozásokat. A válasz nem ad számszerű kockázati pontszámot.
Milyen sebességkorlátok érvényesek?
Előfizetési szint szerint, API-kulcsonként hozzárendelve. A válaszfejlécek tartalmazzák a fennmaradó kvótát és a visszaállítási időbélyeget.
Szűrhetek szervezeteket tömegesen az API-n keresztül?
Igen. A tömeges végpont CSV-t vagy XLSX-et fogad, kérésenként legfeljebb 100 sorral; az eredmények soronként vagy teljes exportként kérdezhetők le.
Hogyan állítsak be folyamatos monitorozást az API-n keresztül?
Állítsa be a monitorozást az első szűrés után. Amikor a listák frissülnek, vagy új negatív média jelenik meg, a monitorozás megjelöli a változást, és az alkalmazásban riasztja Önt.
Milyen megfelelőségi adat szerepel minden szűrési eredményben?
Szankciós találatok minden jelentős forrásból, PEP-státusz családi kapcsolatokkal, negatív média többnyelvű hivatkozásokkal, UBO-adat, kockázati szint és időbélyeges bizonyítékcsomag.
Mennyi ideig tart egy szűrés?
Standard szankciós ellenőrzés: másodpercek. Deep research negatív médiával és tulajdonosi feltérképezéssel: kevesebb mint két perc.
API-terminológia
- REST API
- Szabványos HTTP-módszereket használó webes API — kompatibilis bármely nyelvvel vagy keretrendszerrel, amely HTTP-kéréseket tud küldeni.
- Aszinkron feldolgozás
- Az API azonnal befogadja a feladatot, és a háttérben dolgozza fel — az eredményeket lekérdezéssel kérheti le.
- API-kulcs
- Titkos token az API-kérések hitelesítéséhez, a legkisebb jogosultsághoz igazított, meghatározott engedélyekkel.
- Sebességkorlátozás
- Előfizetési szint szerint korlátozza az API-kéréseket időablakonként — a fennmaradó kvóta és a visszaállítási időbélyeg a válaszfejlécekben szerepel.
- Strukturált válasz
- Géppel olvasható JSON konzisztens mezőnevekkel és típusokkal, amely lehetővé teszi az automatizált feldolgozást és döntési logikát.
REST API az AML-szűréshez
Illessze be a szankciós, PEP-, bűnügyi figyelőlista-, negatívmédia- és KYB/UBO-szűrést közvetlenül ügyfél-befogadási, monitorozási és tranzakciós folyamataiba. Az API élesben fut: hitelesítsen egy API-kulccsal, és hívja ugyanazt a szűrőmotort, amelyet a portál is használ.
A végpontok általánosan elérhetők API-kulcsos hitelesítéssel és szintenkénti sebességkorlátokkal. Fedezzen fel minden végpontot az interaktív OpenAPI-dokumentációban a /api/v1/docs címen.
Gyorsindítás
1. API-kulcs létrehozása
Hozzon létre egy hatáskörhöz kötött API-kulcsot a vezérlőpultján, vagy generáljon egyet programozottan a fiókjához tartozó bearer tokennel szerver-szerver kérésekhez.
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. Futtassa első keresését
Küldjön be egy szervezetet az X-API-Key fejléccel. Az API visszaad egy search id-t, amelyet a feldolgozás befejeztével lekérdezhet.
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. Küldjön be egy köteget
Küldjön egy CSV/XLSX fájlt, hogy egyetlen feladatban sok szervezetet szűrjön, majd kérdezze le a sorokat vagy exportokat, amikor a köteg befejeződött.
POST/api/v1/batch curl -X POST https://screenveritai.com/api/v1/batch \ -H "X-API-Key: <YOUR_API_KEY>" \ -F "file=@entities.csv"
Alapvető végpontok
- POST
/api/v1/searchSzűrési kérés létrehozása egyetlen szervezethez. Visszaad egy search id-t és feldolgozási állapotot. Fiók-, lefedettségi és állapotellenőrző végpontok is elérhetők a /api/v1 alatt.
Hitelesítés: X-API-Key (search:write)
- POST
/api/v1/batchCSV/XLSX fájlok beküldése nagy volumenű szűréshez, majd sorok vagy exportok lekérdezése a feladatok befejezésekor.
Hitelesítés: X-API-Key (batch:write)
- POST
/api/v1/keysAPI-hitelesítő adatok létrehozása és kezelése hatáskörhöz kötött jogosultságokkal, szintfüggő sebességkorlátokkal és használatkövetéssel.
Hitelesítés: Bearer token (fiók)
Crypto address checks. Source evidence at 0,39 EUR.
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 EUR 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 EUR 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.
Miért használják a csapatok az API-t
- Egyetlen integráció szankciós, PEP-, bűnügyi figyelőlista-, negatívmédia- és KYB/UBO-szűréshez
- API-kulcsos hitelesítés az X-API-Key fejlécen keresztül, hatáskörhöz kötött kulcsokkal a legkisebb jogosultság elve alapján
- Szintfüggő sebességkorlátok használatnaplózással a szabályozáshoz és a költségkontrollhoz
- Kereső-, tömeges, kulcs-, fiók-, lefedettségi és állapotellenőrző végpontok a /api/v1 alatt
- Interaktív OpenAPI-dokumentáció a /api/v1/docs címen, plusz géppel olvasható OpenAPI-séma
- Strukturált kimenet, amely alkalmas audit naplókhoz, ügyaktákhoz és további döntésekhez
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.
API GYIK
Hogyan hitelesítem az API-kéréseket?
A /api/v1/search és /api/v1/batch szűrési kérések az X-API-Key fejlécben küldött API-kulccsal hitelesítenek. Hozzon létre kulcsokat a vezérlőpultján, vagy programozottan a /api/v1/keys végponton keresztül, miután hitelesítette magát a fiókjához tartozó bearer tokennel.
Az API általánosan elérhető?
Igen. Az API v1 élesben fut, és általánosan elérhető. Hitelesítsen egy API-kulccsal, hívja a kereső-, tömeges és kulcskezelő végpontokat, és fedezzen fel mindent az interaktív OpenAPI-dokumentációban a /api/v1/docs címen.
Beállíthatom az API-kulcsok jogosultsági hatáskörét?
Igen. A kulcsok olyan jogosultságokat támogatnak, mint a search:read, search:write, batch:read és batch:write, így integrációnként érvényesítheti a legkisebb jogosultság elvét.
Milyen sebességkorlátok érvényesek?
A sebességkorlátokat API-szint szerint rendeljük hozzá, és API-kulcsonként érvényesítjük — a szint a kérések átviteli sebességét szabályozza, nem a számlázást. A válaszfejlécek tartalmazzák a korlátot, a fennmaradó kvótát és a visszaállítási időbélyeget, így tisztán tud visszaállni.
Hol tesztelhetem gyorsan a végpontokat?
Használja az interaktív dokumentációt a /api/v1/docs címen Swagger-teszteléshez, és a /api/v1/redoc oldalt referencia jellegű dokumentációhoz. Az OpenAPI-sémát a /api/v1/openapi.json cím szolgáltatja.
Indítsa el a szűrést percek alatt.
Válasszon csomagot, és kezdje el a szűrést még ma.