Finance OS / API

AML Screening API

Compliance-as-a-Service: проверяйте риск любого блокчейн-адреса одним HTTP-запросом и получайте готовый обезличенный отчёт — в JSON и PDF. Движок скоринга, правила и источники данных работают на нашей стороне; вам остаётся вызвать API и применить готовый вердикт. Одна проверка возвращает единый risk_score (0–100), уровень risk_level, готовую рекомендацию recommendation, набор сигналов, факторы риска и агрегаты по сетям.

ℹ
Обезличенный скоринг
Итоговый вердикт — собственный скоринг Finance OS. Факторы, сигналы и коды в ответе — это наша модель оценки; внутренние источники данных наружу не раскрываются и не влияют на структуру интеграции. Полагайтесь на стабильные поля (risk_score, risk_level, recommendation, signals.*), а не на конкретный состав factors[] — он может пополняться.

Как это работает

Проверка синхронная: один POST выполняет всю оценку и возвращает полный отчёт в теле ответа 201 — очереди и опроса результата нет. Каждой проверке присваивается id, по которому отчёт можно перечитать или выгрузить в PDF без повторной тарификации.

⚠
Латентность и нагрузка
На «холодном» адресе оценка выполняется по многим источникам и может занимать несколько секунд. Задавайте щедрый таймаут HTTP-клиента и вызывайте проверку вне «горячего» пути (фоновый воркер/очередь), а не в обработчике, ожидающем мгновенного ответа. На нашей стороне лимитер не гарантируется — реализуйте собственный троттлинг и экспоненциальный backoff на 429.

Аутентификация и окружения

Все запросы авторизуются секретным ключом в заголовке Authorization: Bearer sk_live_... (боевой контур) или sk_test_... (sandbox). Окружение выбирается по префиксу ключа — отдельного заголовка нет. Подробнее — в разделе Authentication.

⚠
Sandbox = детерминированный синтетический отчёт
Ключи sk_test_* работают в окружении sandbox и не расходуют реальные квоты: отчёт вычисляется детерминированно по самому адресу — один и тот же адрес всегда даёт один и тот же risk_score. Удобно для написания и прогонки тестов. Реальный on-chain-скоринг выполняется только под sk_live_*.
ℹ
Подключение доступа
Доступ к AML API включается администратором после подключения: выдаётся пара ключей sk_test_ / sk_live_ и активируется сервис aml. До активации любой вызов вернёт 403 B2B_ACCESS_REQUIRED. За подключением обращайтесь на admin@fin-os.io.

Эндпоинты раздела

  • POST /api/v1/aml/checks — проверить адрес и получить полный отчёт. Проверка адреса →
  • GET /api/v1/aml/checks — последние проверки текущего окружения. Отчёты и PDF →
  • GET /api/v1/aml/checks/{id} — перечитать сохранённую проверку по id. Отчёты и PDF →
  • GET /api/v1/aml/checks/{id}/report.pdf — скачать обезличенный отчёт в PDF. Отчёты и PDF →

Коды ошибок и конверт — Error Codes →.

Быстрый старт

Проверьте адрес в sandbox (ключ sk_test_) и примите решение по единому вердикту recommendation. Панель справа — тот же вызов на cURL, JavaScript, PHP и Python.