Справочник API

Проверки

Отдельные проверки дела с исходами, причинами и доказательствами.

Получить проверку

GET/v1/checks/{check_id}

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

Параметры

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

Ответы

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

Разбор результата скрининга

GET/v1/checks/{check_id}/screening-explanation

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

Параметры

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

Ответы

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

Повторить скрининг

POST/v1/cases/{case_id}/checks/{kind}/rerun

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

Repeats screening of a case under manual review without refuting a match, for example when the list snapshot became stale before the decision. Only a screening kind executed by the case policy; If-Match is the case ETag. Creates a new attempt over the current active snapshots with its own explanation package; the review task stays open and an approval still requires the new result to pass.

Параметры

ПолеТипОбязательно
case_idпутьstring (uuid)да
kindпутьenum: person_screening, company_screeningда

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

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

Ответы

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