Bot Detection
This section contains a reference to a full list of parameters returned by Trustfull for the Bot Detection Solution
You can use this data catalogue as a reference in interpreting fields provided in our API responses.
General Data
| Name | Description |
|---|---|
| customer_id | Customer id provided during the API call |
| resolution_id | Resolution id which identifies user document within TRUSTFULL. |
| device_request_time | The Date Time when the request was made |
| webhook_url | The URL from which the call originated from |
Onboarding Signals
| Name | Type | Description |
|---|---|---|
| ip_value | string | The IP address provided during the API call, can either be an ipv4 or ipv6 Ex: 12.34.56.78 |
| ip_city | string | The city associated to the IP address of the customer Ex: Milan |
| ip_connection_speed | string | Internet connection speed associated to the ip address: - company/T1 - broadband/cable/fiber - mobile Ex: company/T1 Enum: company/T1, broadband/cable/fiber, mobile |
| ip_connection_type | string | 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_country | string | 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, ... |
| ip_isp | string | The service provider used by the customer's device to access the internet Ex: Fastweb |
| ip_timezone | string | The exact current time in the Timezone the IP address belongs to Ex: CET |
| ip_request_time | string | Time of the day the user is requesting your service Ex: night Enum: morning, afternoon, evening, night |
| ip_zip | string | The Postal Code for where the IP Address is located Ex: 20124 |
| ip_is_mobile | boolean | Indicates whether an IP address is associated with a mobile connection Ex: true |
| ip_is_vpn | boolean | Indicates whether an IP address is under a VPN Ex: true |
| ip_vpn_name | string | If the IP address is a VPN, it is the name of the VPN provider Ex: true |
| ip_is_proxy | boolean | Indicates whether an IP address is coming from a proxy Ex: true |
| ip_proxy_name | string | 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 |
| ip_proxy_type | string | When the IP address is a Proxy, indicates the type of Proxy Ex: datacenter Enum: datacenter, residential |
| ip_is_tor | boolean | Indicates whether an IP address is associated to a TOR node Ex: true |
| ip_is_relay | boolean | Indicates whether an IP address configured to act as relay Ex: true |
| ip_is_hosting | boolean | Indicates whether an IP address is a hosting provider Ex: true |
| ip_score | integer | A number ranging from 0 to 1000 represents the quality of the IP information detected Ex: 649 |
| ip_score_cluster | string | A cluster summarizing the quality of the IP address Ex: very_high Enum: very_low, low, review, high, very_high |
| ip_black_list_count | integer | The number of providers that have flagged this IP as spam Ex: 5 |
| ip_company_domain | string | The name of the domain of the company that owns the domain, if found Ex: google.com |
| ip_company_name | string | The name of the company the user works for, contains the full name Ex: Apple |
| ip_company_description | string | A verbose description description of the company the user works for Ex: Apple Inc. is an American... |
| ip_company_industry | string | Indicates the industry/sector of the company using a standard taxonomy Ex: Internet Software & Services |
| ip_company_employees | integer | Indicates the number of employees of the company Ex: 1750 |
| ip_company_founded | integer | Indicates the year when the company was founded Ex: 2014 |
| ip_company_keywords | string | A list of keywords used in the company description Ex: smartphone,tech |
| ip_company_annual_revenue | integer | Indicates our proprietary estimated annual revenue range for company Ex: 32500000 |
| ip_company_logo | string | An url linking to the the logo of the company associated to the ip address Ex: https://... |
| ip_company_country | string | Indicates the full country name of the company headquarter Ex: Italy |
| ip_company_twitter_url | string | Provides a link to the company twitter account, links is always pointing to twitter domain Ex: https://... |
| ip_company_facebook_url | string | Provides the Facebook url of the company, links is always pointing to facebook domain Ex: https://... |
| ip_company_linkedin_url | string | Provides the Linkedin url of the company, links is always pointing to linkedin domain Ex: https://... |
| ip_company_total_funding | integer | Provides the total amount of funding raised by company Ex: https://... |
| ip_company_tech_stack | string | Indicates the set of technologies uses by the company Ex: JavaScript |
| ip_reason_codes | string | 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 |
| ip_identity_device_count | integer | The number of devices associated with this ip address Ex: 2 |
| ip_identity_email_count | integer | The number of email addresses associated with this ip address Ex: 2 |
| ip_identity_msisdn_count | integer | The number of phones associated with this ip address Ex: 2 |
| ip_identity_name_count | integer | The number of names associated with this ip address Ex: 2 |
| ip_remote_desktop_enable | boolean | Indicates if the IP is enabled to accept connections from common remote desktop software Ex: true |
| ip_xbl_count | integer | The number of times this IP address has been reported in a Exploits Blocklist (XBL) Ex: 2 |
| ip_css_count | integer | The number of times this IP address has been reported in a Combined Spam Sources (CSS) Ex: 3 |
| ip_xbl_in_days | integer | The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data. Ex: 2 |
| ip_css_in_days | integer | The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data. Ex: 0 |
| ip_is_valid_format | boolean | Indicates if the IP is in an accepted ipv4 or ipv6 format Ex: true |
| Name | Type | Description |
|---|---|---|
| browser_marketing_channel | string | The traffic source through which the user comes to your website Ex: organic |
| browser_do_not_track | boolean | The browser is requesting to websites not collect or track browsing data. It's turned off by default. Ex: true |
| browser_language | string | The language that is installed on the browser in ISO 639-1 code Ex: en-US |
| browser_timezone | string | The timezone configured on the browser of the user Ex: CET |
| browser_request_location | string | The url (complete with parameters) of the page that triggered the action, usually the url where a form resides Ex: https://... |
| browser_request_referrer | string | The referrer url (complete with parameters) of the page that triggered the action. Ex: https:// |
| browser_score_cluster | string | A cluster summarizing the quality of the browser provided Ex: very_high Enum: very_low, low, review, high, very_high |
| browser_score | integer | A number ranging from 0 to 1000 represents the quality of the IP information detected Ex: 649 |
| browser_battery_charging | boolean | A flag indicating if the devices is charging its battery Ex: true |
| browser_battery_level | integer | A string indicating the battery level percentage of the user's device Ex: 42 |
| browser_color_depth | integer | A string indicating the color depth of the user's video card Ex: 24 |
| browser_cookies_enabled | boolean | A flag indicating if the user has enabled or not the cookies in their browser Ex: false |
| browser_cpu_class | string | A string indicating the cpu class of the user's device Ex: x86 |
| browser_cpu_cores | integer | A string indicating how many cores the cpu of the user's have Ex: 12 |
| browser_extensions_list | string | A string indicating the most common chrome extension the user installed Ex: Google Docs Offline,JSON Viewer,GNOME Shell integration,dataslayer |
| browser_google_topics | string | A string indicating the user Google Topics saved in the browser Ex: Arts & Entertainment/Movie Listings & Theater Showtimes |
| browser_incognito_mode | boolean | A flag indicating if the user was browsing in incognito mode or not Ex: true |
| browser_location_campaign | string | A string indicating the value for the campaign retrieved from the request location url Ex: campaign_001 |
| browser_location_content | string | A string indicating the value for the content retrieved from the request location url Ex: Loans |
| browser_location_keyword | string | A string indicating the value for the keyword retrieved from the request location url Ex: cars |
| browser_location_medium | string | A string indicating the value for the medium retrieved from the request location url Ex: cpc |
| browser_location_source | string | A string indicating the value for the source retrieved from the request location url Ex: bing |
| browser_location_term | string | A string indicating the value for the term retrieved from the request location url Ex: mutui |
| browser_media_devices_count | integer | A string indicating how many media devices the user has Ex: 3 |
| browser_media_devices_list | string | A string indicating which kind of media devices the user has Ex: audioinput,videoinput,audiooutput |
| browser_os | string | A string indicating user's device operating system Ex: Windows 11 |
| browser_referrer_campaign | string | A string indicating the value for the campaign retrieved from the request referrer url Ex: campaign_001 |
| browser_referrer_content | string | A string indicating the value for the content retrieved from the request referrer url Ex: Loans |
| browser_referrer_keyword | string | A string indicating the value for the keyword retrieved from the request referrer url Ex: cars |
| browser_referrer_medium | string | A string indicating the value for the medium retrieved from the request referrer url Ex: cpc |
| browser_referrer_source | string | A string indicating the value for the source retrieved from the request referrer url Ex: bing |
| browser_referrer_term | string | A string indicating the value for the term retrieved from the request referrer url Ex: mutui |
| browser_screen_resolution | string | A string indicating the value for the screen resolution Ex: 2560x1440 |
| browser_video_card_renderer | string | A string indicating the value for the video card renderer Ex: ANGLE (Intel, Mesa Intel(R) Xe Graphics (TGL GT2), OpenGL 4.6) |
| browser_video_card_vendor | string | A string indicating the value for the video card vendor Ex: Google Inc. (Intel) |
| browser_viewport | string | A string indicating the value for the viewport Ex: 1260x1300 |
| browser_name | string | A string indicating the value for the browser name Ex: Chrome Mobile |
| browser_version | string | A string indicating the value for the browser version Ex: 55.0.2883.91 |
| browser_device_type | string | 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, ... |
| browser_device_brand | string | A string indicating the value for the device brand Ex: Samsung |
| browser_device_model | string | A string indicating the value for the device model Ex: Galaxy S7 Edge |
| browser_device_operating_system | string | A string indicating the value for the device operating system Ex: Android |
| browser_reason_codes | string | 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 |
| name | Description |
|---|---|
| score | int A number ranging from 0 to 1000 ex: 649 |
| score_cluster | string A cluster summarizing the score above. ex: very_low, low, review, high, very_high |
| reason_codes | string 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 |
For more information about how to perform an api call you can go to:
Updated 3 days ago