Skip to main content
Version: 1.8.0 (latest)

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 nameDescriptionValue
PagePage numberFrom 1 to 2147483647
PageSizeMaximum number of applicants listed on the pageFrom 1 to 400

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

Field nameDescription
CreatedFromLower date limit: dd-mm-yyyy
CreatedToUpper date limit: dd-mm-yyyy
SortFieldSorting field. You can specify firstName, lastName, phone, etc.
OrderThe sorting order for the selected field. For descending order, specify the value: descending. Ascending order is set by the default.
TextFilterText 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
},
"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:

CodeMessageDescriptionCode
400No sorting by selected property.Wrong sorting field selected120026