POST
/
session
/
authenticate
curl --request POST \
  --url https://api.sandbox.verisoul.ai/session/authenticate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "account": {
    "id": "<string>",
    "email": "<string>",
    "metadata": {}
  },
  "session_id": "<string>"
}'
{
  "project_id": "<string>",
  "session_id": "<string>",
  "account_id": "<string>",
  "request_id": "<string>",
  "decision": "<string>",
  "account_score": 123,
  "bot": 123,
  "multiple_accounts": 123,
  "risk_signals": 123,
  "accounts_linked": 123,
  "lists": [
    "<string>"
  ],
  "session": {
    "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>"
    },
    "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
    }
  },
  "account": {
    "account": {
      "id": "<string>",
      "email": "<string>",
      "metadata": {}
    },
    "num_sessions": 123,
    "first_seen": "2023-11-07T05:31:56Z",
    "last_seen": "2023-11-07T05:31:56Z",
    "last_session": "<string>",
    "country": "<string>",
    "countries": [
      "<string>"
    ],
    "unique_devices": {
      "1_day": 123,
      "7_day": 123
    },
    "unique_networks": {
      "1_day": 123,
      "7_day": 123
    },
    "email": {
      "email": "<string>",
      "disposable": true,
      "personal": true,
      "valid": true
    },
    "risk_signal_average": {
      "device_risk": 123,
      "proxy": 123,
      "vpn": 123,
      "tor": 123,
      "spoofed_ip": 123,
      "datacenter": 123,
      "recent_fraud_ip": 123,
      "impossible_travel": 123,
      "device_network_mismatch": 123
    }
  },
  "linked_accounts": [
    {
      "account_id": "<string>",
      "score": 123,
      "email": "<string>",
      "match_type": [
        "<string>"
      ],
      "lists": [
        "<string>"
      ],
      "metadata": {}
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
accounts_linked
boolean

Whether to include linked accounts in the response

Body

application/json
Session authentication information
​
account
object
required

The account to authenticate. See Account Object for more information.

​
session_id
string
required

The ID of the session to authenticate

Response

200
application/json
Session authentication response
​
project_id
string

The ID of the project

​
session_id
string

The ID of the session

​
account_id
string

The ID of the account

​
request_id
string

The ID of the request

​
decision
string

Decision about the authenticity (Real/Fake)

​
account_score
number

Overall account risk score

​
bot
number

Bot detection score

​
multiple_accounts
number

Multiple accounts detection score

​
risk_signals
number

Risk signals score

​
accounts_linked
integer

Number of accounts linked to this account

​
lists
string[]

Lists the account belongs to

​
session
object
​
account
object
​
linked_accounts
object[]

List of accounts linked to the authenticated account (only included when accounts_linked=true)