Advanced detection tool that can spot suspicious behavior and activity within a browser

Fido's API endpoints are quite flexible and you can request a range of services from a single endpoint

What is Fido Browser?

Fido browser is an advanced detection tool that can spot suspicious behavior and activity within a browser. Contrary to other APIs this module requires a javascript snippet in order to be active.

Request

following an example of a Fido Browser

curl --request POST \
     --url https://api.fido.id/1.0/ \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data '
{
     "customer_id": "c426ad68-8987-11ec-a8a3-0242ac120002",
     "claims": [
          "browser"
     ],
}'

Response

Following an example of the response:

{
  "resolution_id": "...",
  "customer_id": "...",
  "device_request_time": "...",
  "claims": [
    "browser"
  ],
  "browser": {
    "marketing_channel": "unknown",
    "do_not_track": true,
    "language": "it-IT",
    "timezone": "Europe/Rome",
    "request_location": "https://www.google.com?utm_source=the_source_param&medium=the_medium_param&something_term=the_term_param&a_content=the_content_param&key_campaign=the_campaign_param&key_keyword=the_keyword_param",
    "request_referrer": "https://www.google.com/something?utm_source=the_source_param&medium=the_medium_param&something_term=the_term_param&a_content=the_content_param&key_campaign=the_campaign_param&key_keyword=the_keyword_param",
    "score": 100,
    "score_cluster": "very_low",
    "location_source": "the_source_param",
    "location_medium": "the_medium_param",
    "location_term": "the_term_param",
    "location_content": "the_content_param",
    "location_campaign": "the_campaign_param",
    "location_keyword": "the_keyword_param",
    "referrer_source": "the_source_param",
    "referrer_medium": "the_medium_param",
    "referrer_term": "the_term_param",
    "referrer_content": "the_content_param",
    "referrer_campaign": "the_campaign_param",
    "referrer_keyword": "the_keyword_param"
  }
}

RESPONSE

All fields of the fingerprint module require the js probe installed on the page.

name

type

do_not_track

boolean

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

ex: true/false

language

string

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

ex: en-US

timezone

string

The timezone configured on the browser of the user

ex: CET, UTC, PT

marketing_channel

string

The traffic source through which the user comes to your website.

ex: paid search, organic, social

request_location

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

ex: http://mywebsite.com/my-form.html

request_referrer

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

ex: http://mywebsite.com/

score

number

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

ex: 649

score_cluster

string

A cluster summarizing the quality of the IP information detected

ex:

  • poor
  • bad
  • moderate
  • good
  • high

location_source

?string

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

ex: bing

location_medium

?string

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

ex: cpc

location_term

?string

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

ex: mutui

location_content

?string

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

ex: Hakure

location_campaign

?string

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

ex: MUTUI+-+Zona+A+e+B+-+LEAD+-+Housing+Category+-+101221

location_keyword

?string

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

ex: prestito

referrer_source

?string

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

ex: search

referrer_medium

?string

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

ex: cpc

referrer_term

?string

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

ex: Prospecting

referrer_content

?string

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

ex: Perfm

referrer_campaign

?string

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

ex: G_C2_C2F_Adwords_Search_BrandT

referrer_keyword

?string

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

ex: prestito

COLLECTING BROWSER INFORMATION

The browser module requires inserting in a web page a javascript snippet.

The snippet's responsibility is to collect and extract all signals coming from the browser and the user interaction.

Below is an example of the snippet:

<script>
   (function(f,i,d,o,c,od,e){f['FidoObject']=c;f[c]=f[c]||function(){
        (f[c].q=f[c].q||[]).push(arguments)},f[c].l=1*new Date();od=i.createElement(d),
        e=i.getElementsByTagName(d)[0];od.async=1;od.src=o;e.parentNode.insertBefore(od,e)
   })(window,document,'script','https://code.fido.id/fd.js','fido');
   
   fido('set_autocapture',  false);
   fido('claims', ['browser']);  
   fido('customer_id',  "89754d62-8a7e-11ec-9db7-1b736d0d6767"); // the same value you will pass in the customer_id field
   fido('create', 'FIDO-123456'); // your KEY 

</script>
  • fido('set_autocapture', false);: This statement disables the auto-capture feature, the snippet will not send any API call other than the one related to the browser collection.
  • fido('claims', ['browser']); : This enables the browser data collection.
  • fido('customer_id', "[customer_id_generated_runtime]"); : This identifiers needs to be provided runtime, most tag manager allows for variable base include.
  • fido('create', 'FIDO-123456'); Your Key, this will link all data to your account

❗️

Snippet required

Without installing the snippet fido browser cannot be enabled. If you make the API call before the snippet collected information, you will receive an error message.

FAQ

📘

What happen if i don't pass the customer_id?

The customer id is mandatory for the browser collection, if no value or an invalid value is passed no browser information will be collected

Language
Authentication
Header
Click Try It! to start a request and see the response here!