Risks

Risk Level

There are two levels of risk:

• Significant. risk that should be addressed first.
• Moderate. risk that should be considered second.

The risk level is used only as an additional filter in the publicapi.

Get a list of risks

The request returns a list of occurred risks. The list of risks can be filtered by time. If you do not set filtering, all created risks will be displayed, starting with the last one.

Endpoint: GET /publicapi/api/v2/private/RiskEvents

Parameters:

Field name	Description	Value
Page	Page number	From 1 to 2147483647
PageSize	Maximum number of applicants listed on the page	От 1 до 400

The following optional fields can be used to search and sort:

Field name	Description
CreatedFrom	Lower date limit: dd-mm-yyyy
CreatedTo	Upper date limit: dd-mm-yyyy
SortField	Sorting field. You can specify firstName, lastName, phone, etc.
Order	Sorting order for the selected field. For descending order specify the value: descending. Ascending order is set by default.
TextFilter	Text search
Level	Risk level. From 0 (Moderate) to 1 (Significant)
Type	Risk type number

Request example:

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'

Response example:

Status Code

200

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

Possible errors:

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

Get a List of Risk Types Being Monitored

The request returns a list of available risk types and their statuses.

Endpoint: GET /publicapi/api/v2/private/RiskManagement/ActiveRisks

Request example:

curl -X 'GET' \
  'https://baf.ai/publicapi/api/v2/private/RiskManagement/ActiveRisks' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer sk_3938ab7b-cdbf-4a1a-952b-e3782f061f4b'

Response example:

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
  }
]

Enable/disable risk activity

The request allows you to specify active risks that will affect the verification progress. If the risk affects the validation progress and is triggered, the attempt will be considered failed. As the body of the request it is necessary to pass an array of the types of risks that will be enabled. To disable all risks, you must pass an empty list.

Endpoint: PUT /publicapi/api/v2/private/RiskManagement/ActiveRisks

Request body:

[
  0,1,6
]

Request example:

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
]'

Response example:

Status Code

200