API за разработчици
Вградете скрининг за съответствие във всеки работен процес
Вашият тръбопровод за приемане, платежен шлюз и CRM вече вземат рискови решения всеки ден. API на ScreenVeritAI ви позволява да вградите скрининг за санкции, PEP проверки, анализ на негативни медии и картографиране на КДС директно в тези работни процеси — без ръчни справки, без копиране и поставяне, без пропуски в съответствието между системите. Едно API извикване задейства същия AI агент, който захранва нашата платформа, и структуриран JSON се връща, готов за вашия двигател за вземане на решения.
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
Собствена разработка срещу интеграция с ScreenVeritAI
| Аспект | Собствена разработка | API на ScreenVeritAI |
|---|---|---|
| Време до продукция | 6-12 месеца за набавяне на списъци, изграждане на логика за съвпадение и обработка на крайни случаи | Дни за интеграция; готово за продукция от първото API извикване |
| Покритие на санкционни списъци | Ръчно приемане на всеки формат на списък; текуща поддръжка при промяна на схемите | Всеки основен източник, поддържан и актуализиран непрекъснато — OFAC, ЕС, ООН, Обединеното кралство и други |
| Точност на съвпадение | Потребителско неточно съвпадение изисква NLP експертиза и непрекъсната настройка | AI агент с неточно съвпадение, транслитерация, разрешаване на псевдоними и фонетични алгоритми |
| PEP и негативни медии | Отделни доставчици на данни, отделни интеграции, отделни бюджети | PEP, негативни медии и КДС данни, включени в същия API отговор |
| Текуща поддръжка | Специализиран инженерен екип за актуализации на списъци, промени в схеми и настройка на фалшиви положителни | Изцяло управлявано — актуализации на списъци, подобрения на модели и инфраструктура се обработват вместо вас |
| Одитна следа | Изграждане на собствена инфраструктура за логване, генериране на доказателства и съхранение | Доказателствени пакети с времеви печат, референции към източници и обосновка на решението, включени |
Четири стъпки до вградено съответствие
Вземете вашия API ключ
Създайте API ключ с ограничени права от таблото за управление на ScreenVeritAI. Задайте разрешения — search:read, search:write, batch:read, batch:write — за достъп с минимални привилегии.
Интегрирайте крайната точка
Добавете едно POST извикване към работния процес за приемане, плащане или CRM. Изпратете наименование на субекта, тип и държава. API-то връща идентификатор на задачата за асинхронно извличане на резултати.
Обработете резултатите
Запитвайте крайната точка за резултати за структуриран JSON — фирмен контекст, собственост, PEP, негативни медии, санкционни сигнали и рискови оценки.
Мониторинг и известия
Конфигурирайте текущ мониторинг за проверените субекти. Когато санкционните списъци се актуализират или се появят нови негативни медии, API-то изпраща известия, така че системата ви може автоматично да задейства повторен скрининг.
Започнете за минути
Едно API извикване връща пълен резултат от скрининг.
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-то
€0.39
Quick Check на заявка, без такса за платформа
202
HTTP статус при приета проверка; резултатът се изтегля след това
EU
Хостван във Финландия; данните в покой остават в ЕС
Често задавани въпроси за API интеграция
Как се удостоверяват API заявките?
Всички API заявки се удостоверяват с API ключ, предаден в заглавието X-API-Key. Ключовете се създават от таблото за управление на ScreenVeritAI с ограничени разрешения (search:read, search:write, batch:read, batch:write) за налагане на достъп с минимални привилегии.
API-то синхронно ли е или асинхронно?
Асинхронен. Изпращате заявка, получавате ID на задача и извличате резултатите чрез периодично запитване. Вашият процес никога не блокира.
Какъв формат на отговор връща API-то?
Структуриран JSON с полета за основните юрисдикции и масиви по източници, както и резултати за издирвани лица и PEP/RCA. Прегледайте наличния markdown, идентификаторите и източниците. Отговорът не предоставя числова оценка на риска.
Какви ограничения на честотата се прилагат?
Ограниченията на честотата се задават по ниво на абонамент и се налагат за всеки API ключ. Заглавките на отговорите включват текущото ви ограничение, оставаща квота и времеви печат за нулиране. Ако ви е необходима по-висока пропускателна способност за масова обработка, крайната точка за партиди приема CSV/XLSX качвания за скрининг с висок обем.
Мога ли да проверявам субекти пакетно чрез API-то?
Да. Крайната точка за партиди приема CSV или XLSX файлове с до 100 реда на заявка. Всеки ред се обработва като индивидуален скрининг и резултатите могат да бъдат извлечени по ред или като пълен изтегляем експорт, когато задачата приключи.
Как да настроя текущ мониторинг чрез API-то?
Конфигурирайте мониторинга след първоначалния скрининг. Когато списъците се актуализират или се появят нови негативни медии, мониторингът отбелязва промяната и ви уведомява в приложението.
Какви данни за съответствие са включени във всеки резултат от скрининг?
Всеки резултат включва санкционни съвпадения от всеки основен източник, PEP статус с връзки към семейство и сътрудници, констатации за негативни медии с многоезични цитирани източници, данни за собственост на КДС, рисково ниво и доказателствен пакет с времеви печат, подходящ за одит и регулаторен преглед.
Колко време отнема скринингът?
Стандартна проверка за санкции обикновено приключва за секунди. Скрининг със задълбочено проучване — включващ анализ на негативни медии и картографиране на собствеността — отнема средно под две минути. Асинхронният модел означава, че системата ви никога не е блокирана в очакване на резултати.
API терминология
- REST API
- Архитектура на уеб API, която използва стандартни HTTP методи (GET, POST, PUT, DELETE) за взаимодействие с ресурси. API-то на ScreenVeritAI следва REST конвенциите, което го прави съвместимо с всеки език или рамка, способни да правят HTTP заявки.
- Асинхронна обработка
- API-то приема задачата незабавно и я обработва във фонов режим — извлечете резултатите чрез периодично запитване.
- API ключ
- Секретен токен, използван за удостоверяване на API заявки от сървър към сървър. API ключовете на ScreenVeritAI са с ограничени разрешения (search:read, search:write, batch:read, batch:write) за налагане на модели за достъп с минимални привилегии.
- Ограничаване на честотата
- Механизъм, който ограничава броя API заявки, които клиентът може да направи в даден времеви прозорец. Ограниченията на честотата се задават по ниво на абонамент и се комуникират чрез заглавки на отговорите, включващи оставаща квота и времеви печати за нулиране.
- Структуриран отговор
- Машинночетим формат на API отговор (JSON) с последователни имена на полета, типове и вложеност. Структурираните отговори позволяват автоматизирано парсване, логика за вземане на решения и генериране на одитна следа без ръчно извличане на данни.
REST API за AML скрининг
Интегрирайте проверка на санкции, PEP, списъци на издирвани лица, неблагоприятни медии и KYB/UBO директно във вашите процеси за приемане, мониторинг и транзакции. API-то работи: удостоверете се с API ключ и извикайте същия механизъм за скрининг, който използва порталът.
Крайните точки са общодостъпни с удостоверяване чрез API ключ и ограничения на честотата по ниво. Разгледайте всяка крайна точка в интерактивната OpenAPI документация на /api/v1/docs.
Започнете за минути
1. Създайте API ключ
Създайте API ключ с ограничени права от таблото си за управление или го генерирайте програмно с bearer токена на профила си за заявки от сървър към сървър.
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. Изпълнете първото си търсене
Подайте субект със заглавието X-API-Key. API-то връща идентификатор на търсенето, който извличате при завършване на обработката.
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. Подайте партида
Изпратете CSV/XLSX файл, за да проверите много субекти в една задача, след което извлечете редовете или експорта, когато партидата приключи.
POST/api/v1/batch curl -X POST https://screenveritai.com/api/v1/batch \ -H "X-API-Key: <YOUR_API_KEY>" \ -F "file=@entities.csv"
Основни крайни точки
- POST
/api/v1/searchСъздава заявка за скрининг на един субект. Връща идентификатор на търсенето и статус на обработката. Достъпни са и крайни точки за профил, покритие и здравословно състояние под /api/v1.
Удостоверяване: X-API-Key (search:write)
- POST
/api/v1/batchПодава CSV/XLSX файлове за скрининг с висок обем, след което извлича редове или експорти при завършване на задачите.
Удостоверяване: X-API-Key (batch:write)
- POST
/api/v1/keysСъздава и управлява API идентификационни данни с ограничени разрешения, ограничения на честотата по ниво и проследяване на употребата.
Удостоверяване: Bearer токен (профил)
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.
Защо екипите използват API-то
- Единна интеграция за проверка на санкции, PEP, списъци на издирвани лица, неблагоприятни медии и KYB/UBO
- Удостоверяване с API ключ чрез заглавието X-API-Key, с ключове с ограничени разрешения за достъп с минимални привилегии
- Ограничения на честотата по ниво с логване на употребата за управление и контрол на разходите
- Крайни точки за търсене, партиди, ключове, профил, покритие и здравословно състояние под /api/v1
- Интерактивна OpenAPI документация на /api/v1/docs плюс машинночетима OpenAPI схема
- Структуриран изход, подходящ за одитни записи, досиета по случаи и последващи решения
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-то
Как се удостоверяват API заявките?
Заявките за скрининг към /api/v1/search и /api/v1/batch се удостоверяват с API ключ, изпратен в заглавието X-API-Key. Създавайте ключове от таблото си за управление или програмно чрез /api/v1/keys, след като се удостоверите с bearer токена на профила си.
Общодостъпно ли е API-то?
Да. API v1 работи и е общодостъпно. Удостоверете се с API ключ, извикайте крайните точки за търсене, партиди и управление на ключове и разгледайте всичко в интерактивната OpenAPI документация на /api/v1/docs.
Мога ли да ограничавам разрешенията на API ключа?
Да. Ключовете поддържат разрешения като search:read, search:write, batch:read и batch:write, така че можете да прилагате достъп с минимални привилегии за всяка интеграция.
Какви ограничения на честотата се прилагат?
Ограниченията на честотата се задават по ниво на API и се налагат за всеки API ключ — нивото управлява пропускателната способност на заявките, а не таксуването. Заглавките на отговорите включват лимита, оставащата квота и времевите печати за нулиране, така че можете да намалите темпото плавно.
Къде мога бързо да тествам крайните точки?
Използвайте интерактивната документация на /api/v1/docs за тестване чрез Swagger и /api/v1/redoc за референтна документация. OpenAPI схемата се обслужва на /api/v1/openapi.json.
Започнете скрининг за минути.
Изберете план и започнете скрининг още днес.