GuidesRecipesAPI ReferenceChangelog
API Reference

Login Score

post https://api.fido.id/{version}/login-score-api

Login Score Api

What is Trustfull Login score?

The Login Score API evaluates user login events by analyzing behavioral and device data, returning a risk-based score and cluster to help determine the appropriate authentication action.

Request

following an example of a Trustfull Login score

curl --request POST \
     --url POST http://api.fido.id/1.0/track/results?session_id={session_id} \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]'

Response

Following an example of the response:

{
    "transaction_id": "158db860-67e6-4ef7-8162-1a23a5e16cf5",
    "username": "johndoe",
    "app_key": "TFB-abc",
    "session_id": "session-123",
    "browser_battery_charging": true,
    "browser_battery_level": 85,
    "browser_device_operating_system": "Android",
    "browser_device_type": "desktop",
    "browser_has_privacy_related_plugins": true,
    "browser_name": "Chrome",
    "browser_version": "114.0.1",
    "device_request_time": "2024-12-12T10:00:00Z",
    "ip": "192.168.0.1",
    "ip_black_list_count": 5,
    "ip_city": "New York",
    "ip_company_domain": "google.com",
    "ip_connection_speed": "company/T1",
    "connection_type": "Reserved",
    "ip_country": "US",
    "ip_css_count": 3,
    "ip_css_in_days": 7,
    "ip_is_hosting": true,
    "ip_is_mobile": false,
    "ip_isp": "Comcast",
    "ip_is_proxy": false,
    "ip_is_relay": false,
    "ip_is_tor": false,
    "ip_is_valid_format": true,
    "ip_is_vpn": false,
    "ip_lat": "40.7128",
    "ip_lon": "-74.0060",
    "ip_proxy_name": "ProxyXYZ",
    "ip_proxy_type": "datacenter",
    "ip_timezone": "CET",
    "ip_timezone_request_time": "night",
    "ip_xbl_count": 2,
    "ip_xbl_in_days": 2,
    "ip_zip": "10001",
    "browser_device_model": "Galaxy S7 Edge",
    "browser_device_brand": "Samsung",
    "ip_vpn_name": "NordVPN",
    "score": 649,
    "score_cluster": "high"
}
nametype
transaction_idstring

Unique identifier for the transaction

Ex: 158db860-67e6-4ef7-8162-1a23a5e16cf5
usernamestring

The username associated with the session or transaction

Ex: johndoe
app_keystring

The application key associated with the request

Ex: TFB-abc
session_idstring

Session identifier for the login interaction

Ex: session-123
browser_battery_chargingboolean

Indicates whether the battery is charging

Ex: true
browser_battery_levelinteger

Current battery level as a percentage

Ex: 85
browser_device_operating_systemstring

Operating system of the device running the browser

Ex: Android
browser_device_typestring

Type of device running the browser (e.g., desktop, mobile)

Ex: desktop
browser_has_privacy_related_pluginsboolean

Indicates whether the browser has privacy-related plugins installed

Ex: true
browser_namestring

Name of the browser being used

Ex: Chrome
browser_versionstring

Version of the browser being used

Ex: 114.0.1
device_request_timestring

The timestamp of the request from the device

Ex: 2024-12-12T10:00:00Z
ipstring

IP address of the login event

Ex: 192.168.0.1
ip_black_list_countinteger

The number of providers that have flagged this IP as spam

Ex: 5
ip_citystring

City associated with the IP address

Ex: New York
ip_company_domainstring

The name of the domain of the company that owns the domain, if found

Ex: google.com
ip_connection_speedstring

Internet connection speed associated to the ip address:
- company/T1
- broadband/cable/fiber
- mobile


Ex: company/T1

Enum: company/T1,broadband/cable/fiber,mobile
connection_typestring

Usage type classification of ISP or company:
- Commercial
- Content Delivery Network
- Fixed Line
- Mobile ISP
- Reserved
- University / College / School


Ex: Reserved

Enum: Commercial,Content Delivery Network,Fixed Line,Mobile ISP,Reserved,University / College / School
ip_countrystring

Country associated with the IP address, ISO 3166 alpha-2

Ex: US
ip_css_countinteger

The number of times this IP address has been reported in a Combined Spam Sources (CSS)

Ex: 3
ip_css_in_daysinteger

The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data.

Ex: 7
ip_is_hostingboolean

Indicates if the IP address is an hosting provider

Ex: true
ip_is_mobileboolean

Indicates if the IP address is associated with a mobile connection

Ex: false
ip_ispstring

Internet service provider associated with the IP address

Ex: Comcast
ip_is_proxyboolean

Indicates if the IP address is a proxy

Ex: false
ip_is_relayboolean

Indicates if the IP address is a relay

Ex: false
ip_is_torboolean

Indicates if the IP address is part of the Tor network

Ex: false
ip_is_valid_formatboolean

Indicates if the IP address is in a valid format

Ex: true
ip_is_vpnboolean

Indicates if the IP address is associated with a VPN

Ex: false
ip_latstring

Latitude of the location associated with the IP address

Ex: 40.7128
ip_lonstring

Longitude of the location associated with the IP address

Ex: -74.0060
ip_proxy_namestring

Name of the proxy associated with the IP address, if any

Ex: ProxyXYZ
ip_proxy_typestring

When the IP address is a Proxy, indicates the type of Proxy

Ex: datacenter

Enum: datacenter,residential
ip_timezonestring

The Timezone the IP address belongs to

Ex: CET
ip_timezone_request_timestring

Time of the day the user is requesting your service

Ex: night

Enum: morning,afternoon,evening,night
ip_xbl_countinteger

The number of times this IP address has been reported in a Exploits Blocklist (XBL)

Ex: 2
ip_xbl_in_daysinteger

The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data.

Ex: 2
ip_zipstring

ZIP code associated with the IP address

Ex: 10001
browser_device_modelstring

Device model running the browser

Ex: Galaxy S7 Edge
browser_device_brandstring

Brand of the device running the browser

Ex: Samsung
ip_vpn_namestring

Name of the VPN associated with the IP address, if any

Ex: NordVPN
scoreinteger

A number ranging from 0 to 1000 that represents the quality score of the login

Ex: 649
score_clusterstring

A cluster categorization that summarizes the quality score of the login

Ex: high

Enum: very_low,low,review,high,very_high
Language
URL
Click Try It! to start a request and see the response here!