API SPEC · V1 · GADEVELOPER REFERENCE

    API за разработчици

    REST API за AML скрининг

    Интегрирайте проверка на санкции, PEP, списъци на издирвани лица, неблагоприятни медии и KYB/UBO директно във вашите процеси за приемане, мониторинг и транзакции. API-то работи: удостоверете се с API ключ и извикайте същия механизъм за скрининг, който използва порталът.

    API v1 работи

    Крайните точки са общодостъпни с удостоверяване чрез API ключ и ограничения на честотата по ниво. Разгледайте всяка крайна точка в интерактивната OpenAPI документация на /api/v1/docs.

    §01Започнете за минути

    01 / 05
    STEP 01

    1. Създайте API ключ

    Създайте API ключ с ограничени права от таблото си за управление или го генерирайте програмно с bearer токена на профила си за заявки от сървър към сървър.

    curl
    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"]}'
    STEP 02

    2. Изпълнете първото си търсене

    Подайте субект със заглавието X-API-Key. API-то връща идентификатор на търсенето, който извличате при завършване на обработката.

    curl
    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"}'
    STEP 03

    3. Подайте партида

    Изпратете CSV/XLSX файл, за да проверите много субекти в една задача, след което извлечете редовете или експорта, когато партидата приключи.

    curl
    curl -X POST https://screenveritai.com/api/v1/batch \
      -H "X-API-Key: <YOUR_API_KEY>" \
      -F "file=@entities.csv"

    §02Основни крайни точки

    02 / 05
    EP 01ENDPOINT

    POST /api/v1/search

    Създава заявка за скрининг на един субект. Връща идентификатор на търсенето и статус на обработката. Достъпни са и крайни точки за профил, покритие и здравословно състояние под /api/v1.

    Удостоверяване: X-API-Key (search:write)

    EP 02ENDPOINT

    POST /api/v1/batch

    Подава CSV/XLSX файлове за скрининг с висок обем, след което извлича редове или експорти при завършване на задачите.

    Удостоверяване: X-API-Key (batch:write)

    EP 03ENDPOINT

    POST /api/v1/keys

    Създава и управлява API идентификационни данни с ограничени разрешения, ограничения на честотата по ниво и проследяване на употребата.

    Удостоверяване: Bearer токен (профил)

    §03Защо екипите използват API-то

    03 / 05
    • Единна интеграция за проверка на санкции, PEP, списъци на издирвани лица, неблагоприятни медии и KYB/UBO
    • Удостоверяване с API ключ чрез заглавието X-API-Key, с ключове с ограничени разрешения за достъп с минимални привилегии
    • Ограничения на честотата по ниво с логване на употребата за управление и контрол на разходите
    • Крайни точки за търсене, партиди, ключове, профил, покритие и здравословно състояние под /api/v1
    • Интерактивна OpenAPI документация на /api/v1/docs плюс машинночетима OpenAPI схема
    • Структуриран изход, подходящ за одитни записи, досиета по случаи и последващи решения

    §05Въпроси за API-то

    05 / 05
    Q01

    Как се удостоверяват API заявките?

    Заявките за скрининг към /api/v1/search и /api/v1/batch се удостоверяват с API ключ, изпратен в заглавието X-API-Key. Създавайте ключове от таблото си за управление или програмно чрез /api/v1/keys, след като се удостоверите с bearer токена на профила си.

    Q02

    Общодостъпно ли е API-то?

    Да. API v1 работи и е общодостъпно. Удостоверете се с API ключ, извикайте крайните точки за търсене, партиди и управление на ключове и разгледайте всичко в интерактивната OpenAPI документация на /api/v1/docs.

    Q03

    Мога ли да ограничавам разрешенията на API ключа?

    Да. Ключовете поддържат разрешения като search:read, search:write, batch:read и batch:write, така че можете да прилагате достъп с минимални привилегии за всяка интеграция.

    Q04

    Какви ограничения на честотата се прилагат?

    Ограниченията на честотата се задават по ниво на API и се налагат за всеки API ключ — нивото управлява пропускателната способност на заявките, а не таксуването. Заглавките на отговорите включват лимита, оставащата квота и времевите печати за нулиране, така че можете да намалите темпото плавно.

    Q05

    Къде мога бързо да тествам крайните точки?

    Използвайте интерактивната документация на /api/v1/docs за тестване чрез Swagger и /api/v1/redoc за референтна документация. OpenAPI схемата се обслужва на /api/v1/openapi.json.