DIVE Online API - Request Metadata

The request metadata API endpoint provides the developer with past request information such as IP address, user agent, and geolocation data.


/api/v2/public/RequestMetadata

[GET] /api/v2/public/RequestMetadata

Use Case - Retrieve request metadata for an applicant attempt.

Token - public API token (pk_) or secret API Token (sk_)

Required Parameters None

Optional Parameters

  • Page - specifies the page number to return. The value must be between 1 and 2147483647.
  • PageSize - specifies the number of items to return per page. The value must be between 1 and 400.
  • SortField - TODO: Add description for SortField.
  • Order - can be either asc or desc to specify the order of the results.
  • TextFilter - specifies a text string to filter the request metadata by.
  • CreatedFrom - specifies the start date for filtering request metadata. The value must be in ISO 8601 format.
  • CreatedTo - specifies the end date for filtering request metadata. The value must be in ISO 8601 format.

Request Body None

Response Body

{
  "succeeded": true,
  "isError": true,
  "errors": [
    {
      "code": "string",
      "description": "string",
      "data": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "data": {
    "page": 0,
    "pageSize": 0,
    "total": 0,
    "totalPages": 0,
    "items": [
      {
        "validationRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "requestCreated": "2026-01-09T16:48:15.091Z",
        "firstName": "string",
        "lastName": "string",
        "phone": "string",
        "email": "string",
        "requestStatus": 0,
        "validationResponseId": 0,
        "responseCreated": "2026-01-09T16:48:15.091Z",
        "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"
      }
    ]
  }
}

Response Fields

  • succeeded (boolean) - Indicates if the request was successful.
  • isError (boolean) - Indicates if there was an error with the request.
errors — An array of error objects. This will populate if isError = true
  • errors.code The error code.
  • errors.description A description of the error.
  • errors.data Additional data related to the error.
  • errors.data.additionalProp1 Additional property 1. TODO : Add description for additionalProp1.
  • errors.data.additionalProp2 Additional property 2. TODO : Add description for additionalProp2.
  • errors.data.additionalProp3 Additional property 3. TODO : Add description for additionalProp3.
data — The main data object containing pagination and items information.
  • data.page (number) - The current page number.
  • data.pageSize (number) - The number of items per page.
  • data.total (number) - The total number of items.
  • data.totalPages (number) - The total number of pages.
items — An array of request metadata objects.
  • items.validationRequestId (string) - The unique identifier for the validation request.
  • items.requestCreated (string) - The date and time when the request was created in ISO 8601 format.
  • items.firstName (string) - The first name of the applicant.
  • items.lastName (string) - The last name of the applicant.
  • items.phone (string) - The phone number of the applicant.
  • items.email (string) - The email address of the applicant.
  • items.requestStatus (number) - The status of the request. TODO: add description for requestStatus.
  • items.validationResponseId (number) - The unique identifier for the validation response.
  • items.responseCreated (string) - The date and time when the response was created in ISO 8601 format.
  • items.documentType (number) - The type of document used in the validation.
    • ID – 1
    • Passport - 2
    • PassportCard – 3
    • Common Access Card – 4
    • Uniformed Services ID – 5
    • GreenCard – 6
    • InternationalId – 7
  • items.responseStatus (number) - The status of the response. TODO: add description for responseStatus.
clientGeolocation — Geolocation data based on the client IP address.
  • items.clientGeolocation.source (number) - The source of the geolocation data. TODO: add description for source.
  • items.clientGeolocation.continentCode (string) - The continent code. ToDO: add description for continentCode.
  • items.clientGeolocation.continent (string) - The continent name.
  • items.clientGeolocation.countryCode (string) - The country code.
  • items.clientGeolocation.country (string) - The country name.
  • items.clientGeolocation.stateCode (string) - The state code.
  • items.clientGeolocation.state (string) - The state name.
  • items.clientGeolocation.city (string) - The city name.
  • items.clientGeolocation.postCode (string) - The postal code.
  • items.clientGeolocation.accuracyRadius (number) - The accuracy radius in kilometers.
  • items.clientGeolocation.latitude (number) - The latitude coordinate.
  • items.clientGeolocation.longitude (number) - The longitude coordinate.
  • items.clientGeolocation.timeZone (string) - The time zone.
  • items.clientGeolocation.network (string) - The network IP range.
  • items.clientGeolocation.autonomousSystemNumber (number) - The autonomous system number (ASN).
  • items.clientGeolocation.autonomousSystemOrganization (string) - The organization associated with the ASN.
  • items.clientGeolocation.isp (string) - The internet service provider (ISP).
  • items.clientGeolocation.organization (string) - The organization name.
  • items.clientGeolocation.phoneNumberCountryMatches (boolean) - Indicates if the phone number country matches the geolocation country.
  • items.clientGeolocation.timeZoneMatches (boolean) - Indicates if the time zone matches the geolocation country. TODO: ask why null]]
requestGeolocation — Geolocation data based on the request IP address.
  • items.requestGeolocation.source (number) - The source of the geolocation data. TODO: add description for source.
  • items.requestGeolocation.continentCode (string) - The continent code. ToDO: add description for continentCode.
  • items.requestGeolocation.continent (string) - The continent name.
  • items.requestGeolocation.countryCode (string) - The country code.
  • items.requestGeolocation.country (string) - The country name.
  • items.requestGeolocation.stateCode (string) - The state code.
  • items.requestGeolocation.state (string) - The state name.
  • items.requestGeolocation.city (string) - The city name.
  • items.requestGeolocation.postCode (string) - The postal code.
  • items.requestGeolocation.accuracyRadius (number) - The accuracy radius in kilometers.
  • items.requestGeolocation.latitude (number) - The latitude coordinate.
  • items.requestGeolocation.longitude (number) - The longitude coordinate.
  • items.requestGeolocation.timeZone (string) - The time zone.
  • items.requestGeolocation.network (string) - The network IP range.
  • items.requestGeolocation.autonomousSystemNumber (number) - The autonomous system number (ASN).
  • items.requestGeolocation.autonomousSystemOrganization (string) - The organization associated with the ASN.
  • items.requestGeolocation.isp (string) - The internet service provider (ISP).
  • items.requestGeolocation.organization (string) - The organization name.
  • items.requestGeolocation.phoneNumberCountryMatches (boolean) - Indicates if the phone number country matches the geolocation country.
  • items.requestGeolocation.timeZoneMatches (boolean) - Indicates if the time zone matches the geolocation country. TODO: ask why null]]
deviceGeolocation — Geolocation data based on the device location.
  • items.deviceGeolocation.latitude (number) - The latitude coordinate.
  • items.deviceGeolocation.longitude (number) - The longitude coordinate.
  • items.deviceGeolocation.accuracy (number) - The accuracy of the geolocation data in meters.
stepsTiming — Timing information for each step of the validation process.
  • items.stepsTiming.face (number) - The time taken for the face recognition step in milliseconds.
  • items.stepsTiming.front (number) - The time taken for the front document scan step in milliseconds.
  • items.stepsTiming.back (number) - The time taken for the back document scan step in milliseconds.
  • items.stepsTiming.mrz (number) - The time taken for the MRZ scan step in milliseconds.
  • items.stepsTiming.pdf417 (number) - The time taken for the PDF417 scan step in milliseconds.
  • items.clientIp (string) - The client IP address.
  • items.requestIp (string) - The request IP address.
  • items.ipMatches (boolean) - Indicates if the client IP matches the request IP.
  • items.vpnUsage (boolean) - Indicates if a VPN was used.
  • items.root (boolean) - Indicates if the device is rooted.
  • items.jailBreak (boolean) - Indicates if the device is jailbroken.
  • items.virtualCamera (boolean) - Indicates if a virtual camera was used.
  • items.cookieEnabled (boolean) - Indicates if cookies are enabled.
  • items.systemLanguage (string) - The system language of the device.
  • items.userLanguage (string) - The user language preference.
  • items.timeZone (string) - The time zone of the device.
  • items.torBrowser (boolean) - Indicates if the Tor browser was used.
  • items.clientType (number) - The type of client used.
  • items.clientVersion (string) - The version of the IDScan.net UI.
  • items.batteryInfo (string) - Information about the device's battery.
  • items.browserInfo (string) - Information about the browser used.
  • items.canvasInfo (string) - Information about the HTML5 canvas.
  • items.connectionInfo (string) - Information about the network connection.
  • items.fontsInfo (string) - Information about the fonts installed on the device.
  • items.navigatorInfo (string) - Information about the browser's navigator object.
  • items.screenInfo (string) - Information about the device's screen.
  • items.webGlInfo (string) - Information about the WebGL capabilities of the device.
  • items.html5Info (string) - Information about the HTML5 features supported by the device.
  • items.userAgent (string) - The user agent string of the browser.
  • items.userAgentFamily (string) - The family of the user agent.
  • items.userAgentVersion (string) - The version of the user agent.
  • items.deviceFamily (string) - The family of the device.
  • items.deviceBrand (string) - The brand of the device.
  • items.deviceModel (string) - The model of the device.
  • items.osFamily (string) - The family of the operating system.
  • items.osVersion (string) - The version of the operating system.