API SPEC · V1 · GADEVELOPER REFERENCE

    Developer API

    REST API для AML-скрининга

    Интегрируйте скрининг по санкциям, ПДЛ, уголовным спискам, негативным публикациям и 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":"deep_research"}'
    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
    • Единая интеграция для скрининга по санкциям, ПДЛ, уголовным спискам, негативным публикациям и 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-ключу. Заголовки ответов содержат лимит, оставшуюся квоту и время сброса, чтобы вы могли корректно снижать нагрузку.

    Q05

    Где можно быстро протестировать эндпоинты?

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