Arendaja API
Lisage sanktsioonide kontroll oma töövoogu
ScreenVeritAI API käivitab sanktsioonide, PEP-i, kriminaalnimekirjade ja negatiivse meedia kontrolli seal, kus otsus tehakse — näiteks kliendi liitumisel, makse kinnitamisel või CRM-is. Vastus saabub struktureeritud JSON-ina ja selle saab suunata otse teie otsustusloogikasse.
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
Ehitada või osta
| Aspekt | Ehitada ise | ScreenVeritAI API |
|---|---|---|
| Aeg tootmiseni | 6–12 kuud nimekirjade hankimiseks, sobitamisloogika ehitamiseks ja erijuhtude käsitlemiseks | Päevad integreerimiseks; tootmisvalmis esimesest API-kutsest |
| Sanktsiooninimekirjade katvus | Iga nimekirja formaadi käsitsi sisestamine; pidev hooldus skeemide muutudes | Iga suurem allikas hooldatud ja pidevalt uuendatud — OFAC, EL, ÜRO, Ühendkuningriik ja rohkem |
| Sobitamise täpsus | Kohandatud hägune sobitamine nõuab NLP-ekspertiisi ja pidevat häälestamist | TI-agent häguse sobitamise, transliteratsiooni, varjunimede lahendamise ja foneetiliste algoritmidega |
| PEP ja negatiivne meedia | Eraldi andmepakkujad, eraldi integratsioonid, eraldi eelarved | PEP, negatiivse meedia ja tegelike kasusaajate andmed sisalduvad samas API-vastuses |
| Pidev hooldus | Pühendatud insenerimeeskond nimekirjade uuenduste, skeemimuutuste ja valepositiivsete häälestamise jaoks | Täielikult hallatav — nimekirjade uuendused, mudeli parandused ja infrastruktuur käideldakse teie eest |
| Auditijälg | Ehitage oma logimise, tõendite genereerimise ja säilitamise infrastruktuur | Ajatempliga tõendipaketid allikaviidete ja otsuse põhjendusega sisalduvad |
Neli sammu tootmiseni
Saage oma API-võti
Looge piiritletud API-võti ScreenVeritAI juhtpaneelilt. Määrake õigused — search:read, search:write, batch:read, batch:write — vähimate privileegide juurdepääsuks.
Integreerige lõpp-punkt
Lisage üks POST-kutse oma liitumise, maksete või CRM-i töövoole. Saatke üksuse nimi, tüüp ja riik. API tagastab töö ID asünkroonseks tulemuste saamiseks.
Töötlege tulemused
Pollige tulemuste lõpp-punkti struktureeritud JSON-i saamiseks — ettevõtte kontekst, omandistruktuur, PEP, negatiivne meedia, sanktsioonisignaalid ja riskiskoorid.
Jälgige ja teavitage
Konfigureerige pidev jälgimine kontrollitud üksuste jaoks. Kui sanktsiooninimekirju uuendatakse või ilmneb uus negatiivne meedia, saadab API teavitusi, et teie süsteem saaks automaatselt käivitada taaskontrolli.
Alustage minutitega
Üks API-kutse tagastab täieliku kontrollimistulemuse.
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 jõudlus
€0.39
Quick Check päringu kohta, ilma platvormitasuta
202
HTTP-olek, kui otsing on vastu võetud; tulemust päritakse seejärel
EU
Majutatud Soomes; salvestatud andmed jäävad ELi
API integratsiooni KKK
Kuidas autentida API-päringuid?
Kõik API-päringud autentitakse API-võtmega, mis edastatakse X-API-Key-päises. Võtmed luuakse ScreenVeritAI juhtpaneelilt piiritletud õigustega (search:read, search:write, batch:read, batch:write) vähimate privileegide juurdepääsu tagamiseks.
Kas API on sünkroonne või asünkroonne?
Asünkroonne. Saadate päringu, saate töö ID ja saate tulemused kätte pollimise teel. Teie konveier ei blokeeru kunagi.
Millist vastuse formaati API tagastab?
Struktureeritud JSON peamiste jurisdiktsioonide väljade ja allikapõhiste massiividega ning tagaotsitavate nimekirjade ja PEP/RCA leidudega. Vaadake üle saadaval olev markdown, identifikaatorid ja allikaviited. Vastus ei anna arvulist riskiskoori.
Millised kiirusepiirangud kehtivad?
Kiirusepiirangud määratakse tellimusetaseme järgi ja jõustatakse API-võtme kaupa. Vastuse päised sisaldavad teie praegust limiiti, järelejäänud kvooti ja lähtestamise ajatemplit. Kui vajate suuremat läbilaskevõimet massitöötluseks, aktsepteerib pakklõpp-punkt CSV/XLSX üleslaadimisi suure mahuga kontrollimiseks.
Kas saan kontrollida üksusi pakina API kaudu?
Jah. Pakklõpp-punkt aktsepteerib CSV- või XLSX-faile kuni 100 reaga päringu kohta. Iga rida töödeldakse individuaalse kontrollimisena ja tulemused on kättesaadavad rea kaupa või täieliku allalaetava ekspordina, kui töö lõpeb.
Kuidas seadistada pidevat jälgimist API kaudu?
Konfigureerige seire pärast esialgset kontrollimist. Kui nimekirju uuendatakse või ilmneb uus negatiivne meedia, märgib seire muutuse ja teavitab teid rakenduses.
Millised vastavusandmed sisalduvad igas kontrollimistulemustes?
Iga tulemus sisaldab sanktsioonivasteid kõigi peamiste allikate ulatuses, PEP-staatust koos pere ja kaastöötajate seostega, negatiivse meedia leide mitmekeelsete allikaviidatega, tegelike kasusaajate omandiandmeid, riskitaseme klassifikatsiooni ja ajatempliga tõendipakett, mis sobib auditiks ja regulatiivseks ülevaatuseks.
Kui kaua kontrollimine kestab?
Standardne sanktsioonikontroll valmib tavaliselt sekunditega. Süvauuringu kontrollimine — sealhulgas negatiivse meedia analüüs ja omandi kaardistamine — kestab keskmiselt alla kahe minuti. Asünkroonne mudel tähendab, et teie süsteem ei blokeeru kunagi tulemusi oodates.
API terminoloogia
- REST API
- Veebi API arhitektuur, mis kasutab standardseid HTTP-meetodeid (GET, POST, PUT, DELETE) ressurssidega suhtlemiseks. ScreenVeritAI API järgib REST-konventsioone, muutes selle ühilduvaks mis tahes keele või raamistikuga, mis suudab teha HTTP-päringuid.
- Asünkroonne töötlus
- API võtab töö kohe vastu ja töötleb seda taustal — tulemused saate kätte pollimise teel.
- API-võti
- Salajane token, mida kasutatakse serveri-serveri API-päringute autentimiseks. ScreenVeritAI API-võtmed on piiritletud konkreetsete õigustega (search:read, search:write, batch:read, batch:write) vähimate privileegide juurdepääsumustrite tagamiseks.
- Kiirusepiirang
- Mehhanism, mis piirab API-päringute arvu, mida klient saab antud ajaaknas teha. Kiiruspiirangud määratakse tellimusetaseme järgi ja edastatakse vastuse päiste kaudu, sealhulgas järelejäänud kvoodi ja lähtestamise ajatemplid.
- Struktureeritud vastus
- Masinloetav API vastuse formaat (JSON) järjepidevate väljade nimede, tüüpide ja pesastumisega. Struktureeritud vastused võimaldavad automatiseeritud parsimist, otsusteloogikat ja auditijälje genereerimist ilma käsitsi andmete eraldamiseta.
REST API AML kontrolliks
Integreerige sanktsioonide, PEP, kriminaalsete jälgimisnimekirjade, negatiivse meedia ja KYB/UBO kontroll otse oma liitumise, seire ja tehingute töövoogudesse. API on töötav: autentige API-võtmega ja kutsuge sama kontrollimootorit, mida kasutab meie portaal.
Lõpp-punktid on üldiselt kättesaadavad API-võtme autentimise ja tasemepõhiste päringulimiitidega. Uurige iga lõpp-punkti interaktiivses OpenAPI dokumentatsioonis aadressil /api/v1/docs.
Alustamine
1. Looge API-võti
Looge piiritletud API-võti oma juhtpaneelilt või genereerige see programmiliselt oma konto kandja-tokeniga serveripoolsete päringute jaoks.
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. Käivitage esimene otsing
Esitage üksus X-API-Key päisega. API tagastab otsingu ID, mille abil hangite tulemuse pärast töötlemise lõppu.
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. Esitage hulgipäring
Saatke CSV/XLSX-fail paljude üksuste kontrollimiseks ühe tööga, seejärel hankige read või ekspordid, kui hulgitöö lõpeb.
POST/api/v1/batch curl -X POST https://screenveritai.com/api/v1/batch \ -H "X-API-Key: <YOUR_API_KEY>" \ -F "file=@entities.csv"
Põhilised lõpp-punktid
- POST
/api/v1/searchLoob kontrollipäringu ühe üksuse jaoks. Tagastab otsingu ID ja töötlemise oleku. Konto, katvuse ja tervisekontrolli lõpp-punktid on samuti saadaval /api/v1 all.
Autentimine: X-API-Key (search:write)
- POST
/api/v1/batchEsitage CSV/XLSX-failid suuremahuliseks kontrollimiseks, seejärel hankige read või ekspordid, kui tööd lõpevad.
Autentimine: X-API-Key (batch:write)
- POST
/api/v1/keysLooge ja hallake API mandaate piiritletud õiguste, taseme järgi kohandatud päringulimiitide ja kasutuse jälgimisega.
Autentimine: kandja-token (konto)
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.
Miks meeskonnad seda API-t kasutavad
- Üks integratsioon sanktsioonide, PEP, kriminaalsete jälgimisnimekirjade, negatiivse meedia ja KYB/UBO kontrollimiseks
- API-võtme autentimine X-API-Key päise kaudu, õigustega piiritletud võtmed vähimate privileegide juurdepääsuks
- Tasemepõhised päringulimiidid koos kasutuse logimisega juhtimise ja kulude kontrolli jaoks
- Otsingu, hulgipäringu, võtmete, konto, katvuse ja tervisekontrolli lõpp-punktid /api/v1 all
- Interaktiivne OpenAPI dokumentatsioon aadressil /api/v1/docs ja masinloetav OpenAPI skeem
- Struktureeritud väljund, mis sobib auditilogideks, juhtumitoimikuteks ja allavoolu otsusteks
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 korduma kippuvad küsimused
Kuidas autentida API-päringuid?
Kontrollipäringud lõpp-punktidele /api/v1/search ja /api/v1/batch autenditakse API-võtmega, mis saadetakse X-API-Key päises. Looge võtmed oma juhtpaneelilt või programmiliselt /api/v1/keys kaudu pärast autentimist oma konto kandja-tokeniga.
Kas API on üldiselt kättesaadav?
Jah. API v1 on töötav ja üldiselt kättesaadav. Autentige API-võtmega, kutsuge otsingu, hulgipäringu ja võtmehalduse lõpp-punkte ning uurige kõike interaktiivses OpenAPI dokumentatsioonis aadressil /api/v1/docs.
Kas saan piiritleda API-võtme õigusi?
Jah. Võtmed toetavad õigusi nagu search:read, search:write, batch:read ja batch:write, nii et saate iga integratsiooni jaoks kehtestada vähimate privileegide juurdepääsu.
Millised päringulimiidid kehtivad?
Päringulimiidid määratakse API-taseme järgi ja jõustatakse API-võtme kaupa — tase juhib päringute läbilaskevõimet, mitte arveldust. Vastuse päised sisaldavad limiiti, järelejäänud kvooti ja lähtestamise ajatempleid, nii et saate koormust õigel ajal vähendada.
Kus saan lõpp-punkte kiiresti testida?
Kasutage interaktiivset dokumentatsiooni aadressil /api/v1/docs Swaggeri testimiseks ja /api/v1/redoc viitestiilis dokumentatsiooni jaoks. OpenAPI skeem on saadaval aadressil /api/v1/openapi.json.
Alustage kontrollimist minutitega.
Valige plaan ja alustage kontrollimist juba täna.