Advanced Options

Rate this article:

X

Select all that apply:

The content is confusing or hard to follow.

There is missing information or code.

There is inaccurate or outdated information.

This page did not solve my problem.

I would like to speak with someone about this.

Email:

Submit Feedback

Device Fingerprint on Form Triggers

You can optionally process the Device Fingerprint service to collect additional details after the user has performed an action, such as after submitting an order or purchase form. Our system allows you to provide an element to bind to as part of an onclick or onsubmit trigger. When the user clicks or submits that element, the Device Fingerprint code will execute and gather the form elements you've specified to perform fraud analysis.

<form method="POST" action="/" id="testform" >
	<button type="submit" >Submit</button>
</form>
<script type="text/javascript">
	var IPQ = {
		Callback: function(){
			Startup.FormFieldPrepend  = 'ipqs_';
			Startup.Trigger('#testform'); // or Startup.Trigger('.element') or Startup.Trigger('button');
			Startup.Init(); // Tell device tracker to start.
		}
	};
</script>

The trigger will override the default action of the element's onclick or onsubmit function, perform IPQS fraud analysis and Device Fingerprinting service, and then execute the original action of the element. For example, suppose you bind the trigger to a form's submit button; our Device Fingerprint script will run first. In that case, it will append the results of our fraud scoring to your form and submit it to your server. The example above shows that setting Startup.FormFieldPrepend will prepend a title to all appended form variables.

If you would like to prevent submitting the form immediately, you can use the Startup.AfterResult() function detailed above. When using the Startup.AfterResult() function, the Device Fingerprint will not append the results to your form. If the service is unable to bind to your supplied trigger, the console log will report errors.
Suppose you prefer to execute code before calling the API during a trigger event. In that case, you can optionally supply a callback function as the second parameter on Startup.Trigger(). It will pass the event object, so you can optionally use preventDefault() or call any other function as needed.

<script type="text/javascript">
	var IPQ = {
		Callback: function(){
			Startup.Trigger("#element", function(event){
				event.preventDefault();
				Startup.Store('OrderID', 34522);
			});
			
			Startup.Init(); // Tell device tracker to start.
		}
	};
</script>

Device Fingerprinting with Transaction Data

The form trigger framework allows you to specify additional fields for order submission and payment processing. These additional fields allow us to better track your users and provide better fraud analysis to prevent transaction fraud. This feature requires you to use the Startup.Trigger() function as shown above. Without using this function, JavaScript will not correctly append data to each request. Accepted fields and values are listed in the table below. If the API cannot locate a specified field, it will report these in the console logs.

<script type="text/javascript">
	var IPQ = {
		Callback: function(){
			Startup.Field('billing_country', '#country'); // or Startup.Field('billing_city', '.city'); EG: Startup.Field('IPQualityScore_Field_Name', 'htmlelement');
			Startup.Init(); // Tell device tracker to start.
		}
	};
</script>

Additional Methods to Pass Data

Instead of binding to a form, it is possible to delay the initial fingerprint processing using Startup.Pause() and later Startup.Resume(). Doing so pre-loads the necessary JavaScript to fingerprint the user but waits until Startup.Resume() has been called to process the request. Therefore, user-inputted data, not available on the initial page load, can be attached to the initial request as in the example below:

var IPQ = {
	Callback: function(){
		Startup.Pause(); // prevent fingerprint script from loading on page load
		Startup.Init(); // Startup the background processor.
		Startup.Store('OrderID', '34522'); // any custom tracking variable
		Startup.FieldStore('billing_email', 'USEREMAILVALUE'); // any transaction variable
	  
		Startup.AfterResult(function(result){
			// retrieve data here or use the postback API to lookup by Startup.Store() value.
		});

		Startup.Resume(); // resumes fingerprint request
	}
};

Accepted Order & Transaction Parameters

Below is a list of optionally accepted parameters for order and transaction support, along with a brief description and a listing of their required formatting. All fields are optional and should be passed with Startup.FieldStore().

Caching Failures

You can specify a function to execute after our API fails to return its results correctly. This could be due to them blocking some of our tracking or disabling third-party scripts.

The AfterResult() function offers a high degree of flexibility. You can call it multiple times and pass it a variety of functions. Our library will execute each of them in the order you passed them.

<script type="text/javascript">
	var IPQ = {
		Callback: function(){
			Startup.AfterFailure(function(result){
				// Your code here.
			});

			Startup.Init(); // Start the fraud tracker.
		}
	};
</script>

Caching Failures

You can specify a function to execute after our API fails to return its results correctly. This could be due to them blocking some of our tracking or disabling third-party scripts.

The AfterResult() function offers a high degree of flexibility. You can call it multiple times and pass it a variety of functions. Our library will execute each of them in the order you passed them.

<script type="text/javascript">
	var IPQ = {
		Callback: function(){
			Startup.AfterFailure(function(result){
				// Your code here.
			});

			Startup.Init(); // Start the fraud tracker.
		}
	};
</script>