API для продуктов и интеграций

A3.Trust поставляет вердикты другим системам: A3.HR, A3.Sales, кадровым и закупочным системам компании. Публичный API и вебхуки работают с первого релиза, а песочница в продукте помогает подключиться без чтения кода.

Принципы

  • API-ключ с правами доступа

    Ключ выпускается в разделе интеграций с набором прав: создание проверок, чтение проверок, мониторинг, чтение субъектов, проверка заказов. Ключ можно перевыпустить без простоя.

  • Идемпотентность

    Повторная отправка запроса с тем же Idempotency-Key не создаёт второй проверки и не списывает её из пакета. Тот же ключ с другим телом вернёт ошибку.

  • Ограничение частоты

    Лимит запросов в минуту задаётся на ключ. Превышение возвращает понятную ошибку, а журнал запросов показывает каждый вызов.

  • Вердикт, а не материалы

    API отдаёт решение в объёме заказчика: тип, ограничения, срок. Поиск субъекта только по идентификатору, перебрать досье по фамилии нельзя.

Основные операции

Методы доступны по адресу PublicApi в регионе хранения вашей организации. Полный перечень полей в документации API.

POSTCreateCheckRequest

Создать запрос на проверку

GETGetCheckRequestStatus

Статус запроса и вердикт

GETGetActiveVerdict

Действующий вердикт без новой проверки

POSTSetSubjectMonitoring

Поставить субъекта на мониторинг

DELETERemoveSubjectMonitoring

Снять субъекта с мониторинга

GETGetSubjectRiskLabels

Метки риска субъекта

GETFindSubject

Поиск субъекта по идентификатору

POSTCheckOrderCompliance

Проверить заказ по реестру запрещённых услуг

Пример: действующий вердикт по субъекту

Основной сценарий для систем-потребителей: получить решение без создания новой проверки.

GET /PublicApi/GetActiveVerdict?subjectId=1024
API-KEY: a3t_7c41…
Domain: company
{
  "verdictType": "ApprovedWithRestrictions",
  "riskLevel": "Moderate",
  "restrictions": [
    { "type": "FullPrepayment" },
    { "type": "AmountLimit", "amount": 25000000, "currency": "KZT" }
  ],
  "validUntil": "2027-10-14",
  "reasonForRequester": "Налоговая задолженность погашена, судебные споры в работе"
}

Вебхуки

Системы-потребители не опрашивают API в цикле: события приходят сами. Каждый вызов подписан HMAC-SHA256, журнал доставки показывает ответ получателя, неудачную доставку можно повторить.

trust.check.accepted

Запрос принят в работу

trust.check.rejected

Запрос отклонён с причиной

trust.check.info_requested

Запрошены дополнительные сведения

trust.check.completed

Вердикт сформирован

trust.check.verdict_revoked

Вердикт отозван или пересмотрен

trust.monitoring.alert

Критичный алерт мониторинга

Песочница в продукте

В разделе интеграций администратор выбирает ключ и операцию, правит готовый пример запроса и видит ответ и команду curl. Операции, которые меняют данные, требуют отдельного подтверждения.

Контракт с A3.HR

Проверка кандидатов работает из коробки: события hr.background_check и trust.check согласованы на уровне API-контрактов продуктов.