Перейти к основному содержимому

# Операции с рисками

### Уровень риска​

Существует два уровня риска:

- Significant. Значительный, риск на который следует обратить внимание первым.
- Moderate. Умеренный, риск которы следует рассматривать во вторую очередь.

Уровень риска используются только как дополнительный фильтр в publicapi.

### Получение списка рисков​

Запрос возвращает список случившихся рисков. Список рисков можно отфильтровать по времени. Если не задать фильтрацию для списка рисков, будут выведены все созданные риски, начиная с последнего.

Эндпоинт GET /publicapi/api/v2/private/RiskEvents

Параметры:

Название поля | Описание | Значение
Page | Номер страницы | От 1 до 2147483647
PageSize | Максимальное количество аппликантов на странице | От 1 до 400

Для поиска и сортировки можно использовать следующие необязательные поля:

Название поля | Описание
CreatedFrom | Нижняя граница даты: дд-мм-гггг
CreatedTo | Верхняя граница даты: дд-мм-гггг
SortField | Поле для сортировки. Можно указать firstName, lastName, phone и т.д.
Order | Порядок сортировки для выбранного поля. Для порядка по убыванию укажите значение: descending. Порядок по возрастанию задан по умолчанию.
TextFilter | Текстовый поиск.
Level | Уровень риска. Значения 0 (Moderate) или 1 (Significant)
Type | Номер типа риска

Пример запроса:

    curl -X 'GET' \
      'https:/baf.ai/publicapi/api/v2/private/RiskEvents?Page=1&PageSize=10' \
      -H 'accept: text/plain' \
      -H 'Authorization: Bearer sk_3938ab7b-cdbf-4a1a-952b-e3782f061f4b'

Пример ответа:

Status Code | 200

    {
      "page": 0,
      "pageSize": 0,
      "total": 0,
      "totalPages": 0,
      "items": [
        {
          "id": "3fa85***", / ID риска
          "validationResponseId": 0,
          "validationRequestId": "3fa85***",
          "level": 0,
          "type": 0,
          "created": "2023-09-20T10:45:37.851Z"
        }
      ]
    }

Возможные ошибки:

Code | Message | Description | Code
400 | No sorting by selected property. | Wrong sorting field selected | 120026

### Получение списка типов отслеживаемых рисков​

Запрос возвращает список доступных в системе типов рисков и их статусы.

Эндпоинт GET /publicapi/api/v2/private/RiskManagement/ActiveRisks

Пример запроса:

    curl -X 'GET' \
      'https:/baf.ai/publicapi/api/v2/private/RiskManagement/ActiveRisks' \
      -H 'accept: text/plain' \
      -H 'Authorization: Bearer sk_3938***'

Пример ответа:

Status Code | 200

    [
      {
        "riskType": 0,
        "description": "Mass Attack",
        "isActive": false
      },
      {
        "riskType": 1,
        "description": "Periodic Attack",
        "isActive": false
      },
      {
        "riskType": 6,
        "description": "Duplicate Face",
        "isActive": true
      },
      {
        "riskType": 7,
        "description": "Inconsistent Metadata",
        "isActive": false
      },
      {
        "riskType": 8,
        "description": "Missing Metadata",
        "isActive": false
      },
      {
        "riskType": 9,
        "description": "Untrusted Ip",
        "isActive": false
      },
      {
        "riskType": 10,
        "description": "Motion Control Failed",
        "isActive": false
      },
      {
        "riskType": 11,
        "description": "Untrusted device",
        "isActive": false
      }
    ]

### Включение/отключение активности рисков​

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

Эндпоинт PUT /publicapi/api/v2/private/RiskManagement/ActiveRisks

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

    [
      0,1,6
    ]

Пример запроса:

    curl -X 'PUT' \
      'https:/baf.ai/publicapi/api/v2/private/RiskManagement/ActiveRisks' \
      -H 'accept: */*' \
      -H 'Authorization: Bearer sk_3938ab7b-cdbf-4a1a-952b-e3782f061f4b' \
      -H 'Content-Type: application/json' \
      -d '[
      0,1,6
    ]'

Пример ответа:

Status Code | 200