Get Session

cURL

curl --request GET \
  --url https://api.sandbox.verisoul.ai/session/{session_id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.verisoul.ai/session/{session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.verisoul.ai/session/{session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.verisoul.ai/session/{session_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.verisoul.ai/session/{session_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "account_ids": [
    "john-doe"
  ],
  "request_id": "7c1fb7c5-8e5f-43f0-b35e-56b9698dac0f",
  "project_id": "00000000-0000-0000-0000-000000000001",
  "session_id": "56f9a065-1583-48af-a5c4-cd5921b21a12",
  "source": "ios",
  "source_version": "0.4.70",
  "start_time": "2025-06-10T16:45:21.822Z",
  "true_country_code": "US",
  "device_id": "6yONB4zT6k2i7SXvWkwC9s",
  "network": {
    "ip_address": "2600:1700:261:b810:8828:f0b6:3b95:667c",
    "service_provider": "AT&T Enterprises, LLC",
    "connection_type": "isp",
    "asn": 7018,
    "subnet": "107.209.253.0/24"
  },
  "location": {
    "continent": "NA",
    "country_code": "US",
    "state": "Texas",
    "city": "Austin",
    "zip_code": "78729",
    "timezone": "America/Chicago",
    "latitude": 30.4521,
    "longitude": -97.7688
  },
  "browser": {
    "type": "Chrome",
    "version": "137.0.0.0",
    "language": "en-US",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36",
    "timezone": "America/Chicago"
  },
  "device": {
    "category": "desktop",
    "type": "Mac",
    "os": "macOS 10.15.7",
    "cpu_cores": 16,
    "memory": 8,
    "gpu": "ANGLE (Apple, ANGLE Metal Renderer: Apple M4 Max, Unspecified Version)",
    "screen_height": 1329,
    "screen_width": 2056
  },
  "bot": {
    "mouse_num_events": 84,
    "click_num_events": 2,
    "keyboard_num_events": 0,
    "touch_num_events": 0,
    "clipboard_num_events": 1
  },
  "agent": null,
  "risk_signals": {
    "device_risk": false,
    "proxy": false,
    "vpn": false,
    "tor": false,
    "spoofed_ip": false,
    "datacenter": false,
    "recent_fraud_ip": false,
    "impossible_travel": false,
    "device_network_mismatch": false,
    "location_spoofing": false,
    "ip_reputation": false
  },
  "risk_signal_scores": {
    "device_risk": 0.3971,
    "proxy": 0,
    "vpn": 0,
    "tor": 0,
    "datacenter": 0,
    "recent_fraud_ip": 0,
    "impossible_travel": 0,
    "device_network_mismatch": 0.0001,
    "location_spoofing": 0,
    "ip_reputation": 0.0113
  },
  "risk_signal_details": {
    "network": [],
    "device": [
      "browser_tampering_detected"
    ]
  },
  "mobile": {
    "brand": "Apple",
    "model": "iPhone",
    "system_memory_gb": 8,
    "boot_count": null,
    "system_uptime_days": 2,
    "battery_level": 0.82,
    "languages": [
      "en-US"
    ],
    "oem_app_integrity": "unavailable",
    "oem_device_integrity": "passed"
  }
}

Authorizations

x-api-key

string

header

required

Path Parameters

session_id

string

required

ID of the session to retrieve

Response

Session information response

account_ids

string[]

List of account IDs associated with this session

request_id

string

The ID of the request

project_id

string

The ID of the project

session_id

string

The ID of the session

source

enum<string> | null

SDK that produced the session. React Native and Flutter sessions report as their underlying platform. Null for sessions computed before rollout

Available options:

web,

ios,

android

source_version

string | null

Native SDK version that produced the session (e.g. 0.4.70). Null for web sessions

start_time

string<date-time>

Timestamp when the session started

true_country_code

string

The true country code of the session

device_id

string

Device identifier from the session

network

object

Show child attributes

location

object

Show child attributes

browser

object

Show child attributes

device

object

Show child attributes

bot

object

Show child attributes

agent

object · null · null

The identified AI agent, assistant, crawler or automation tool. null when no agent was identified. See AI Agent Detection in the docs.

Show child attributes

risk_signals

object

Show child attributes

risk_signal_scores

object

Show child attributes

risk_signal_details

object

Show child attributes

mobile

object

Native mobile SDK device facts. An empty object for sessions that did not come from the native iOS/Android SDK.

Show child attributes

cURL

curl --request GET \
  --url https://api.sandbox.verisoul.ai/session/{session_id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.verisoul.ai/session/{session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.verisoul.ai/session/{session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.verisoul.ai/session/{session_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.verisoul.ai/session/{session_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "account_ids": [
    "john-doe"
  ],
  "request_id": "7c1fb7c5-8e5f-43f0-b35e-56b9698dac0f",
  "project_id": "00000000-0000-0000-0000-000000000001",
  "session_id": "56f9a065-1583-48af-a5c4-cd5921b21a12",
  "source": "ios",
  "source_version": "0.4.70",
  "start_time": "2025-06-10T16:45:21.822Z",
  "true_country_code": "US",
  "device_id": "6yONB4zT6k2i7SXvWkwC9s",
  "network": {
    "ip_address": "2600:1700:261:b810:8828:f0b6:3b95:667c",
    "service_provider": "AT&T Enterprises, LLC",
    "connection_type": "isp",
    "asn": 7018,
    "subnet": "107.209.253.0/24"
  },
  "location": {
    "continent": "NA",
    "country_code": "US",
    "state": "Texas",
    "city": "Austin",
    "zip_code": "78729",
    "timezone": "America/Chicago",
    "latitude": 30.4521,
    "longitude": -97.7688
  },
  "browser": {
    "type": "Chrome",
    "version": "137.0.0.0",
    "language": "en-US",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36",
    "timezone": "America/Chicago"
  },
  "device": {
    "category": "desktop",
    "type": "Mac",
    "os": "macOS 10.15.7",
    "cpu_cores": 16,
    "memory": 8,
    "gpu": "ANGLE (Apple, ANGLE Metal Renderer: Apple M4 Max, Unspecified Version)",
    "screen_height": 1329,
    "screen_width": 2056
  },
  "bot": {
    "mouse_num_events": 84,
    "click_num_events": 2,
    "keyboard_num_events": 0,
    "touch_num_events": 0,
    "clipboard_num_events": 1
  },
  "agent": null,
  "risk_signals": {
    "device_risk": false,
    "proxy": false,
    "vpn": false,
    "tor": false,
    "spoofed_ip": false,
    "datacenter": false,
    "recent_fraud_ip": false,
    "impossible_travel": false,
    "device_network_mismatch": false,
    "location_spoofing": false,
    "ip_reputation": false
  },
  "risk_signal_scores": {
    "device_risk": 0.3971,
    "proxy": 0,
    "vpn": 0,
    "tor": 0,
    "datacenter": 0,
    "recent_fraud_ip": 0,
    "impossible_travel": 0,
    "device_network_mismatch": 0.0001,
    "location_spoofing": 0,
    "ip_reputation": 0.0113
  },
  "risk_signal_details": {
    "network": [],
    "device": [
      "browser_tampering_detected"
    ]
  },
  "mobile": {
    "brand": "Apple",
    "model": "iPhone",
    "system_memory_gb": 8,
    "boot_count": null,
    "system_uptime_days": 2,
    "battery_level": 0.82,
    "languages": [
      "en-US"
    ],
    "oem_app_integrity": "unavailable",
    "oem_device_integrity": "passed"
  }
}

API Documentation

Session

Account

Lists

Phone

Email Intelligence API

Face Match

ID Check

Types

Authorizations

Path Parameters

Response