GuidesRecipesAPI ReferenceChangelog
API Reference

Bot Detection

get https://api.fido.id/{version}/bot-detection/

Get the data of a previously enriched customer via the Bot Detection Solution using the customerId

Response

Following an example of the response:

{
    "resolution_id": "...",
    "customer_id": "...",
    "device_request_time": "...",
    "claims": [
        "phone",
        "email",
        "name",
        "device",
        "ip",
        "score"
    ],
    "browser": {
        "marketing_channel": "organic",
        "do_not_track": true,
        "language": "en-US",
        "timezone": "CET",
        "request_location": "https:\/\/...",
        "request_referrer": "https:\/\/",
        "score_cluster": "very_high",
        "score": 649,
        "battery_charging": "true",
        "battery_level": "42",
        "color_depth": "24",
        "cookies_enabled": "false",
        "cpu_class": "x86",
        "cpu_cores": "12",
        "extensions_list": "Google Docs Offline,JSON Viewer,GNOME Shell integration,dataslayer",
        "google_topics": "Arts & Entertainment\/Movie Listings & Theater Showtimes",
        "incognito_mode": "true",
        "location_campaign": "campaign_001",
        "location_content": "Loans",
        "location_keyword": "cars",
        "location_medium": "cpc",
        "location_source": "bing",
        "location_term": "mutui",
        "media_devices_count": "3",
        "media_devices_list": "audioinput,videoinput,audiooutput",
        "os": "Windows 11",
        "referrer_campaign": "campaign_001",
        "referrer_content": "Loans",
        "referrer_keyword": "cars",
        "referrer_medium": "cpc",
        "referrer_source": "bing",
        "referrer_term": "mutui",
        "screen_resolution": "2560x1440",
        "video_card_renderer": "ANGLE (Intel, Mesa Intel(R) Xe Graphics (TGL GT2), OpenGL 4.6)",
        "video_card_vendor": "Google Inc. (Intel)",
        "viewport": "1260x1300",
        "name": "Chrome Mobile",
        "version": "55.0.2883.91",
        "device_type": "Mobile Phone",
        "device_brand": "Samsung",
        "device_model": "Galaxy S7 Edge",
        "device_operating_system": "Android",
        "reason_codes": "TP001,RP001"
    },
    "ip": {
        "value": "12.34.56.78",
        "city": "Milan",
        "connection_speed": "company\/T1",
        "connection_type": "Reserved",
        "country": "IT",
        "isp": "Fastweb",
        "timezone": "CET",
        "request_time": "night",
        "zip": "20124",
        "is_mobile": true,
        "is_vpn": true,
        "vpn_name": true,
        "is_proxy": true,
        "proxy_name": "Bright Data",
        "proxy_type": "datacenter",
        "is_tor": true,
        "is_relay": true,
        "is_hosting": true,
        "score": 649,
        "score_cluster": "very_high",
        "black_list_count": 5,
        "company_domain": "google.com",
        "company_name": "Apple",
        "company_description": "Apple Inc. is an American...",
        "company_industry": "Internet Software & Services",
        "company_employees": 1750,
        "company_founded": 2014,
        "company_keywords": "smartphone,tech",
        "company_annual_revenue": 32500000,
        "company_logo": "https:\/\/...",
        "company_country": "Italy",
        "company_twitter_url": "https:\/\/...",
        "company_facebook_url": "https:\/\/...",
        "company_linkedin_url": "https:\/\/...",
        "company_total_funding": "https:\/\/...",
        "company_tech_stack": "JavaScript",
        "reason_codes": "TP001,RP001",
        "identity_device_count": 2,
        "identity_email_count": 2,
        "identity_msisdn_count": 2,
        "identity_name_count": 2,
        "remote_desktop_enable": true,
        "xbl_count": 2,
        "css_count": 3,
        "xbl_in_days": 2,
        "css_in_days": 0,
        "is_valid_format": true
    },
    "score": {
        "scoreCluster": "very_high",
        "reason_codes": "TP001,RP001"
    }
}

Signals

nametype
marketing_channelstring

The traffic source through which the user comes to your website

Ex: organic
do_not_trackboolean

The browser is requesting to websites not collect or track browsing data. It's turned off by default.

Ex: true
languagestring

The language that is installed on the browser in ISO 639-1 code

Ex: en-US
timezonestring

The timezone configured on the browser of the user

Ex: CET
request_locationstring

The url (complete with parameters) of the page that triggered the action, usually the url where a form resides

Ex: https://...
request_referrerstring

The referrer url (complete with parameters) of the page that triggered the action.

Ex: https://
score_clusterstring

A cluster summarizing the quality of the browser provided

Ex: very_high

Enum: very_low,low,review,high,very_high
scoreinteger

A number ranging from 0 to 1000 represents the quality of the IP information detected

Ex: 649
battery_chargingboolean

A flag indicating if the devices is charging its battery

Ex: true
battery_levelinteger

A string indicating the battery level percentage of the user's device

Ex: 42
color_depthinteger

A string indicating the color depth of the user's video card

Ex: 24
cookies_enabledboolean

A flag indicating if the user has enabled or not the cookies in their browser

Ex: false
cpu_classstring

A string indicating the cpu class of the user's device

Ex: x86
cpu_coresinteger

A string indicating how many cores the cpu of the user's have

Ex: 12
extensions_liststring

A string indicating the most common chrome extension the user installed

Ex: Google Docs Offline,JSON Viewer,GNOME Shell integration,dataslayer
google_topicsstring

A string indicating the user Google Topics saved in the browser

Ex: Arts & Entertainment/Movie Listings & Theater Showtimes
incognito_modeboolean

A flag indicating if the user was browsing in incognito mode or not

Ex: true
location_campaignstring

A string indicating the value for the campaign retrieved from the request location url

Ex: campaign_001
location_contentstring

A string indicating the value for the content retrieved from the request location url

Ex: Loans
location_keywordstring

A string indicating the value for the keyword retrieved from the request location url

Ex: cars
location_mediumstring

A string indicating the value for the medium retrieved from the request location url

Ex: cpc
location_sourcestring

A string indicating the value for the source retrieved from the request location url

Ex: bing
location_termstring

A string indicating the value for the term retrieved from the request location url

Ex: mutui
media_devices_countinteger

A string indicating how many media devices the user has

Ex: 3
media_devices_liststring

A string indicating which kind of media devices the user has

Ex: audioinput,videoinput,audiooutput
osstring

A string indicating user's device operating system

Ex: Windows 11
referrer_campaignstring

A string indicating the value for the campaign retrieved from the request referrer url

Ex: campaign_001
referrer_contentstring

A string indicating the value for the content retrieved from the request referrer url

Ex: Loans
referrer_keywordstring

A string indicating the value for the keyword retrieved from the request referrer url

Ex: cars
referrer_mediumstring

A string indicating the value for the medium retrieved from the request referrer url

Ex: cpc
referrer_sourcestring

A string indicating the value for the source retrieved from the request referrer url

Ex: bing
referrer_termstring

A string indicating the value for the term retrieved from the request referrer url

Ex: mutui
screen_resolutionstring

A string indicating the value for the screen resolution

Ex: 2560x1440
video_card_rendererstring

A string indicating the value for the video card renderer

Ex: ANGLE (Intel, Mesa Intel(R) Xe Graphics (TGL GT2), OpenGL 4.6)
video_card_vendorstring

A string indicating the value for the video card vendor

Ex: Google Inc. (Intel)
viewportstring

A string indicating the value for the viewport

Ex: 1260x1300
namestring

A string indicating the value for the browser name

Ex: Chrome Mobile
versionstring

A string indicating the value for the browser version

Ex: 55.0.2883.91
device_typestring

A string indicating the value for the device type

Ex: Mobile Phone

Enum: Mobile Phone, Games Console, Digital Home Assistant, Refrigerator, Desktop, Data Collection Terminal, Telematics Control Unit, Tablet, TV, Set Top Box, ...
device_brandstring

A string indicating the value for the device brand

Ex: Samsung
device_modelstring

A string indicating the value for the device model

Ex: Galaxy S7 Edge
device_operating_systemstring

A string indicating the value for the device operating system

Ex: Android
reason_codesstring

Comma separated risk and trust signal for the product browser.
For more information about reason codes you can go to Reason Codes

Ex: TP001,RP001
nametype
marketing_channelstring

The traffic source through which the user comes to your website

Ex: organic
do_not_trackboolean

The browser is requesting to websites not collect or track browsing data. It's turned off by default.

Ex: true
languagestring

The language that is installed on the browser in ISO 639-1 code

Ex: en-US
timezonestring

The timezone configured on the browser of the user

Ex: CET
request_locationstring

The url (complete with parameters) of the page that triggered the action, usually the url where a form resides

Ex: https://...
request_referrerstring

The referrer url (complete with parameters) of the page that triggered the action.

Ex: https://
score_clusterstring

A cluster summarizing the quality of the browser provided

Ex: very_high

Enum: very_low,low,review,high,very_high
scoreinteger

A number ranging from 0 to 1000 represents the quality of the IP information detected

Ex: 649
battery_chargingboolean

A flag indicating if the devices is charging its battery

Ex: true
battery_levelinteger

A string indicating the battery level percentage of the user's device

Ex: 42
color_depthinteger

A string indicating the color depth of the user's video card

Ex: 24
cookies_enabledboolean

A flag indicating if the user has enabled or not the cookies in their browser

Ex: false
cpu_classstring

A string indicating the cpu class of the user's device

Ex: x86
cpu_coresinteger

A string indicating how many cores the cpu of the user's have

Ex: 12
extensions_liststring

A string indicating the most common chrome extension the user installed

Ex: Google Docs Offline,JSON Viewer,GNOME Shell integration,dataslayer
google_topicsstring

A string indicating the user Google Topics saved in the browser

Ex: Arts & Entertainment/Movie Listings & Theater Showtimes
incognito_modeboolean

A flag indicating if the user was browsing in incognito mode or not

Ex: true
location_campaignstring

A string indicating the value for the campaign retrieved from the request location url

Ex: campaign_001
location_contentstring

A string indicating the value for the content retrieved from the request location url

Ex: Loans
location_keywordstring

A string indicating the value for the keyword retrieved from the request location url

Ex: cars
location_mediumstring

A string indicating the value for the medium retrieved from the request location url

Ex: cpc
location_sourcestring

A string indicating the value for the source retrieved from the request location url

Ex: bing
location_termstring

A string indicating the value for the term retrieved from the request location url

Ex: mutui
media_devices_countinteger

A string indicating how many media devices the user has

Ex: 3
media_devices_liststring

A string indicating which kind of media devices the user has

Ex: audioinput,videoinput,audiooutput
osstring

A string indicating user's device operating system

Ex: Windows 11
referrer_campaignstring

A string indicating the value for the campaign retrieved from the request referrer url

Ex: campaign_001
referrer_contentstring

A string indicating the value for the content retrieved from the request referrer url

Ex: Loans
referrer_keywordstring

A string indicating the value for the keyword retrieved from the request referrer url

Ex: cars
referrer_mediumstring

A string indicating the value for the medium retrieved from the request referrer url

Ex: cpc
referrer_sourcestring

A string indicating the value for the source retrieved from the request referrer url

Ex: bing
referrer_termstring

A string indicating the value for the term retrieved from the request referrer url

Ex: mutui
screen_resolutionstring

A string indicating the value for the screen resolution

Ex: 2560x1440
video_card_rendererstring

A string indicating the value for the video card renderer

Ex: ANGLE (Intel, Mesa Intel(R) Xe Graphics (TGL GT2), OpenGL 4.6)
video_card_vendorstring

A string indicating the value for the video card vendor

Ex: Google Inc. (Intel)
viewportstring

A string indicating the value for the viewport

Ex: 1260x1300
namestring

A string indicating the value for the browser name

Ex: Chrome Mobile
versionstring

A string indicating the value for the browser version

Ex: 55.0.2883.91
device_typestring

A string indicating the value for the device type

Ex: Mobile Phone

Enum: Mobile Phone, Games Console, Digital Home Assistant, Refrigerator, Desktop, Data Collection Terminal, Telematics Control Unit, Tablet, TV, Set Top Box, ...
device_brandstring

A string indicating the value for the device brand

Ex: Samsung
device_modelstring

A string indicating the value for the device model

Ex: Galaxy S7 Edge
device_operating_systemstring

A string indicating the value for the device operating system

Ex: Android
reason_codesstring

Comma separated risk and trust signal for the product browser.
For more information about reason codes you can go to Reason Codes

Ex: TP001,RP001
valuestring

The IP address provided during the API call, can either be an ipv4 or ipv6

Ex: 12.34.56.78
citystring

The city associated to the IP address of the customer

Ex: Milan
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
countrystring

The name of the country where the IP Address is located, ISO 3166 alpha-2

Ex: IT

Enum: AB, AD, AE, AF, AG, AI, AL, AM, AO, AQ, ...
ispstring

The service provider used by the customer's device to access the internet

Ex: Fastweb
timezonestring

The exact current time in the Timezone the IP address belongs to

Ex: CET
request_timestring

Time of the day the user is requesting your service

Ex: night

Enum: morning,afternoon,evening,night
zipstring

The Postal Code for where the IP Address is located

Ex: 20124
is_mobileboolean

Indicates whether an IP address is associated with a mobile connection

Ex: true
is_vpnboolean

Indicates whether an IP address is under a VPN

Ex: true
vpn_namestring

If the IP address is a VPN, it is the name of the VPN provider

Ex: true
is_proxyboolean

Indicates whether an IP address is coming from a proxy

Ex: true
proxy_namestring

When the IP address is a Proxy, indicates the name of the Proxy provider

Ex: Bright Data

Enum: Bright Data,Smartproxy,Oxylabs,Netnut,Webshare,GoProxy
proxy_typestring

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

Ex: datacenter

Enum: datacenter,residential
is_torboolean

Indicates whether an IP address is associated to a TOR node

Ex: true
is_relayboolean

Indicates whether an IP address configured to act as relay

Ex: true
is_hostingboolean

Indicates whether an IP address is a hosting provider

Ex: true
scoreinteger

A number ranging from 0 to 1000 represents the quality of the IP information detected

Ex: 649
score_clusterstring

A cluster summarizing the quality of the IP address

Ex: very_high

Enum: very_low,low,review,high,very_high
black_list_countinteger

The number of providers that have flagged this IP as spam

Ex: 5
company_domainstring

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

Ex: google.com
company_namestring

The name of the company the user works for, contains the full name

Ex: Apple
company_descriptionstring

A verbose description description of the company the user works for

Ex: Apple Inc. is an American...
company_industrystring

Indicates the industry/sector of the company using a standard taxonomy

Ex: Internet Software & Services
company_employeesinteger

Indicates the number of employees of the company

Ex: 1750
company_foundedinteger

Indicates the year when the company was founded

Ex: 2014
company_keywordsstring

A list of keywords used in the company description

Ex: smartphone,tech
company_annual_revenueinteger

Indicates our proprietary estimated annual revenue range for company

Ex: 32500000
company_logostring

An url linking to the the logo of the company associated to the ip address

Ex: https://...
company_countrystring

Indicates the full country name of the company headquarter

Ex: Italy
company_twitter_urlstring

Provides a link to the company twitter account, links is always pointing to twitter domain

Ex: https://...
company_facebook_urlstring

Provides the Facebook url of the company, links is always pointing to facebook domain

Ex: https://...
company_linkedin_urlstring

Provides the Linkedin url of the company, links is always pointing to linkedin domain

Ex: https://...
company_total_fundinginteger

Provides the total amount of funding raised by company

Ex: https://...
company_tech_stackstring

Indicates the set of technologies uses by the company

Ex: JavaScript
reason_codesstring

Comma separated risk and trust signal for the product ip.
For more information about reason codes you can go to Reason Codes

Ex: TP001,RP001
identity_device_countinteger

The number of devices associated with this ip address

Ex: 2
identity_email_countinteger

The number of email addresses associated with this ip address

Ex: 2
identity_msisdn_countinteger

The number of phones associated with this ip address

Ex: 2
identity_name_countinteger

The number of names associated with this ip address

Ex: 2
remote_desktop_enableboolean

Indicates if the IP is enabled to accept connections from common remote desktop software

Ex: true
xbl_countinteger

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

Ex: 2
css_countinteger

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

Ex: 3
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
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: 0
is_valid_formatboolean

Indicates if the IP is in an accepted ipv4 or ipv6 format

Ex: true
nametype
scoreint

A number ranging from 0 to 1000

ex: 649
score_clusterstring

A cluster summarizing the score above.

ex: very_low, low, review, high, very_high
reason_codesstring

Coma separated risk and trust signal for all the products.

ex: RC001,TC002,TP002

For more information about reason codes you can go to Reason Codes
Language
URL
Click Try It! to start a request and see the response here!