Справочник API

Подписки мониторинга

Повторный скрининг и события компаний после завершения проверки.

Подписки мониторинга

GET/v1/monitoring-subscriptions

Области доступа
monitoring:read

Параметры

ПолеТипОбязательно
cursorзапросstringнет
limitзапросintegerнет

Ответы

  • 200MonitoringList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Подписка на мониторинг

POST/v1/monitoring-subscriptions

Области доступа
monitoring:write
Обязательный заголовок
Idempotency-Key

Тело запросаMonitoringCreate

ПолеТипОбязательно
applicant_idstring (uuid)да
policy_version_idstring (uuid)да
source_idsarray of stringда
kybMonitoringKybнет
basis_record_idstring (uuid)да
frequencyenum: daily, weekly, monthlyда
expires_atstring (date-time)да
reverificationMonitoringReverificationнет

Ответы

  • 201Monitoring
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Отменить мониторинг

POST/v1/monitoring-subscriptions/{subscription_id}/cancel

Области доступа
monitoring:write
Обязательный заголовок
Idempotency-Key
Обязательный заголовок
If-Match

Параметры

ПолеТипОбязательно
subscription_idпутьstring (uuid)да

Тело запросаReasonAction

ПолеТипОбязательно
reason_codestringда
notestringнет

Ответы

  • 200Monitoring
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503