Операции с запросами верификации

В разделе описано, как получить метаданные, собираемые BAF при запросах верификации.

Получение списка запросов верификации с метаданными

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

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

Параметры:

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

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

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

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

curl -X 'GET' \
  'https://baf.3divi.ai/publicapi/api/v2/private/RequestMetadata?Page=1&PageSize=10' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer sk_3938a***'

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

{
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "totalPages": 0,
  "items": [
    {
      "validationRequestId": "3fa85f***",
      "requestCreated": "2023-09-20T09:36:19.898Z",
      "firstName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "string",
      "requestStatus": 0,
      "validationResponseId": 0,
      "responseCreated": "2023-09-20T09:36:19.898Z",
      "documentType": 1,
      "responseStatus": 0,
      "clientGeolocation": {
        "source": 0,
        "continentCode": "string",
        "continent": "string",
        "countryCode": "string",
        "country": "string",
        "stateCode": "string",
        "state": "string",
        "city": "string",
        "postCode": "string",
        "accuracyRadius": 0,
        "latitude": 0,
        "longitude": 0,
        "timeZone": "string",
        "network": "string",
        "autonomousSystemNumber": 0,
        "autonomousSystemOrganization": "string",
        "isp": "string",
        "organization": "string",
        "phoneNumberCountryMatches": true,
        "timeZoneMatches": true
      },
      "requestGeolocation": {
        "source": 0,
        "continentCode": "string",
        "continent": "string",
        "countryCode": "string",
        "country": "string",
        "stateCode": "string",
        "state": "string",
        "city": "string",
        "postCode": "string",
        "accuracyRadius": 0,
        "latitude": 0,
        "longitude": 0,
        "timeZone": "string",
        "network": "string",
        "autonomousSystemNumber": 0,
        "autonomousSystemOrganization": "string",
        "isp": "string",
        "organization": "string",
        "phoneNumberCountryMatches": true,
        "timeZoneMatches": true
      },
      "deviceGeolocation": {
        "latitude": 0,
        "longitude": 0,
        "accuracy": 0
      },
      "stepsTiming": {
        "face": 0,
        "front": 0,
        "back": 0,
        "mrz": 0,
        "pdf417": 0
      },
      "clientIp": "string",
      "requestIp": "string",
      "ipMatches": true,
      "vpnUsage": true,
      "root": true,
      "jailBreak": true,
      "virtualCamera": true,
      "cookieEnabled": true,
      "systemLanguage": "string",
      "userLanguage": "string",
      "timeZone": "string",
      "torBrowser": true,
      "clientType": 0,
      "clientVersion": "string",
      "batteryInfo": "string",
      "browserInfo": "string",
      "canvasInfo": "string",
      "connectionInfo": "string",
      "fontsInfo": "string",
      "navigatorInfo": "string",
      "screenInfo": "string",
      "webGlInfo": "string",
      "html5Info": "string",
      "userAgent": "string",
      "userAgentFamily": "string",
      "userAgentVersion": "string",
      "deviceFamily": "string",
      "deviceBrand": "string",
      "deviceModel": "string",
      "osFamily": "string",
      "osVersion": "string"
    }
  ]
}

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

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