Skip to main content

# Request metadata

This section describes how to obtain the metadata collected by BAF during verification requests.

### Get a list of verification requests with metadata​

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

Endpoint: GET /publicapi/api​/v2​/private​/RequestMetadata

Parameters:

Field name | Description | Value
Page | Page number | From 1 to 2147483647
PageSize | Maximum number of applicants listed on the page | From 1 to 400

The following optional fields can be used for search and sorting:

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 | The sorting order for the selected field. For descending order, specify the value: descending. Ascending order is set by the default.
TextFilter | Text search

Request example:

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

Response example:

    {
      "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
          },
          "agent": {
            "architecture": "string",
            "bitness": "string",
            "cookieEnabled": true,
            "fullVersionList": [
              {
                "brand": "string",
                "version": "string"
              }
            ],
            "isBotActivity": true,
            "mobile": true,
            "platform": "string",
            "platformVersion": "string",
            "userAgent": "string",
            "vendor": "string",
            "wow64": true
          },
          "browserApi": {
            "mediaRecorder": true,
            "webCodec": true,
            "webRTC": true,
            "canShare": true,
            "clearAppBadge": true,
            "clipboard": true,
            "credentials": true,
            "geolocation": true,
            "getBattery": true,
            "getGamepads": true,
            "getInstalledRelatedApps": true,
            "getUserMedia": true,
            "gpu": true,
            "hid": true,
            "ink": true,
            "javaEnabled": true,
            "keyboard": true,
            "locks": true,
            "managed": true,
            "mediaCapabilities": true,
            "mediaDevices": true,
            "mediaSession": true,
            "presentation": true,
            "registerProtocolHandler": true,
            "requestMIDIAccess": true,
            "requestMediaKeySystemAccess": true,
            "scheduling": true,
            "sendBeacon": true,
            "serial": true,
            "serviceWorker": true,
            "setAppBadge": true,
            "share": true,
            "storage": true,
            "unregisterProtocolHandler": true,
            "usb": true,
            "userActivation": true,
            "userAgentData": true,
            "vibrate": true,
            "virtualKeyboard": true,
            "wakeLock": true,
            "webkitGetUserMedia": true,
            "webkitPersistentStorage": true,
            "webkitTemporaryStorage": true,
            "windowControlsOverlay": true,
            "xr": true
          },
          "camera": {
            "availableCameras": [
              "string"
            ],
            "selectedCamera": {
              "label": "string",
              "capabilities": {
                "aspectRatio": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "brightness": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "colorTemperature": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "contrast": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "exposureMode": [
                  "string"
                ],
                "exposureTime": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "facingMode": [
                  "string"
                ],
                "frameRate": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "height": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "resizeMode": [
                  "string"
                ],
                "saturation": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "sharpness": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                },
                "whiteBalanceMode": [
                  "string"
                ],
                "width": {
                  "max": 0,
                  "min": 0,
                  "step": 0
                }
              },
              "settings": {
                "aspectRatio": 0,
                "brightness": 0,
                "colorTemperature": 0,
                "contrast": 0,
                "exposureMode": "string",
                "exposureTime": 0,
                "frameRate": 0,
                "height": 0,
                "resizeMode": "string",
                "saturation": 0,
                "sharpness": 0,
                "whiteBalanceMode": "string",
                "width": 0
              }
            }
          },
          "connection": {
            "downlink": "string",
            "effectiveConnectionType": "string",
            "enabledTrafficSavings": "string",
            "ip": "string",
            "roundTripTime": "string"
          },
          "deviceGeolocation": {
            "accuracy": 0,
            "altitude": 0,
            "altitudeAccuracy": 0,
            "datetime": "string",
            "heading": 0,
            "latitude": 0,
            "longitude": 0,
            "speed": 0,
            "timestamp": 0
          },
          "hardware": {
            "battery": {
              "charging": true,
              "chargingTime": 0,
              "dischargingTime": 0,
              "level": 0
            },
            "cpu": 0,
            "deviceMemorypu": "string",
            "gpu": {
              "renderer": "string",
              "vendor": "string"
            }
          },
          "videoFormats": {
            "codecs": {
              "additionalProp1": true,
              "additionalProp2": true,
              "additionalProp3": true
            },
            "combinations": {
              "additionalProp1": true,
              "additionalProp2": true,
              "additionalProp3": true
            },
            "containers": {
              "additionalProp1": true,
              "additionalProp2": true,
              "additionalProp3": true
            },
            "pixelFormat": {
              "additionalProp1": true,
              "additionalProp2": true,
              "additionalProp3": true
            }
          },
          "internationalization": {
            "currentLanguage": "string",
            "preferredLanguages": "string",
            "dateTime": {
              "calendar": "string",
              "datetime": "string",
              "numberingSystem": "string",
              "timezone": "string",
              "weekInfo": {
                "firstDay": 0,
                "minimalDays": 0,
                "weekend": [
                  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"
        }
      ]
    }

Possible errors:

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