API Documentation
Account
Lists
Face Match
Types
Get Session
Returns detailed information about a specific session
curl --request GET \
--url https://api.sandbox.verisoul.ai/session/{session_id} \
--header 'x-api-key: <api-key>'
{
"account_ids": [
"<string>"
],
"request_id": "<string>",
"project_id": "<string>",
"session_id": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"true_country_code": "<string>",
"network": {
"ip_address": "<string>",
"service_provider": "<string>",
"connection_type": "<string>"
},
"location": {
"continent": "<string>",
"country_code": "<string>",
"state": "<string>",
"city": "<string>",
"zip_code": "<string>",
"timezone": "<string>",
"latitude": 123,
"longitude": 123
},
"browser": {
"type": "<string>",
"version": "<string>",
"language": "<string>",
"user_agent": "<string>",
"timezone": "<string>"
},
"device": {
"category": "<string>",
"type": "<string>",
"os": "<string>",
"cpu_cores": 123,
"memory": 123,
"gpu": "<string>",
"screen_height": 123,
"screen_width": 123
},
"bot": {
"mouse_num_events": 123,
"click_num_events": 123,
"keyboard_num_events": 123,
"touch_num_events": 123,
"clipboard_num_events": 123
},
"risk_signals": {
"device_risk": true,
"proxy": true,
"vpn": true,
"tor": true,
"spoofed_ip": true,
"datacenter": true,
"recent_fraud_ip": true,
"impossible_travel": true,
"device_network_mismatch": true
},
"risk_signal_scores": {
"device_risk": 123,
"proxy": 123,
"vpn": 123,
"tor": 123,
"datacenter": 123,
"recent_fraud_ip": 123,
"impossible_travel": 123,
"device_network_mismatch": 123
}
}
Authorizations
Path Parameters
ID of the session to retrieve
Response
List of account IDs associated with this session
The ID of the request
The ID of the project
The ID of the session
Timestamp when the session started
The true country code of the session
Continent code
Country code
State or region
City name
Postal/ZIP code
Timezone of the location
Latitude coordinate
Longitude coordinate
Device category (desktop, mobile, etc.)
Device type
Operating system
Number of CPU cores
Amount of memory in GB
GPU information
Screen height in pixels
Screen width in pixels
Device risk flag
Proxy usage flag
VPN usage flag
Tor usage flag
Spoofed IP flag
Datacenter IP flag
Recent fraud IP flag
Impossible travel flag
Device network mismatch flag
Device risk score
Proxy detection score
VPN detection score
Tor detection score
Datacenter detection score
Recent fraud IP detection score
Impossible travel detection score
Device network mismatch score
curl --request GET \
--url https://api.sandbox.verisoul.ai/session/{session_id} \
--header 'x-api-key: <api-key>'
{
"account_ids": [
"<string>"
],
"request_id": "<string>",
"project_id": "<string>",
"session_id": "<string>",
"start_time": "2023-11-07T05:31:56Z",
"true_country_code": "<string>",
"network": {
"ip_address": "<string>",
"service_provider": "<string>",
"connection_type": "<string>"
},
"location": {
"continent": "<string>",
"country_code": "<string>",
"state": "<string>",
"city": "<string>",
"zip_code": "<string>",
"timezone": "<string>",
"latitude": 123,
"longitude": 123
},
"browser": {
"type": "<string>",
"version": "<string>",
"language": "<string>",
"user_agent": "<string>",
"timezone": "<string>"
},
"device": {
"category": "<string>",
"type": "<string>",
"os": "<string>",
"cpu_cores": 123,
"memory": 123,
"gpu": "<string>",
"screen_height": 123,
"screen_width": 123
},
"bot": {
"mouse_num_events": 123,
"click_num_events": 123,
"keyboard_num_events": 123,
"touch_num_events": 123,
"clipboard_num_events": 123
},
"risk_signals": {
"device_risk": true,
"proxy": true,
"vpn": true,
"tor": true,
"spoofed_ip": true,
"datacenter": true,
"recent_fraud_ip": true,
"impossible_travel": true,
"device_network_mismatch": true
},
"risk_signal_scores": {
"device_risk": 123,
"proxy": 123,
"vpn": 123,
"tor": 123,
"datacenter": 123,
"recent_fraud_ip": 123,
"impossible_travel": 123,
"device_network_mismatch": 123
}
}