Fetch Risk Data — XMLsecverify.cgi

This Manage2 function allows you to fetch the estimated probability of fraud risk associated with an IP address. Information such as number of charge backs, fraudulent sign-ups, and other types of similar data are used to generate this score.

Note: An aggregate probable risk score of 3 or higher is usually cause for further examination.

We strongly recommend you implement additional systems to reduce your transaction risk!

Variables
- Input
- Output
Examples

Variables

Input

ip (string) — The IP address corresponding to the license you wish to check.
- Example: 127.0.0.1

Output

reason (string) — Information about the license check just performed.
status (boolean) — Whether the probable risk assessment check was successfully requested.
- 1 — The probable risk assessment check succeeded.
- 0 — The probable risk assessment check failed.
version (float) — Internal information used by the Manage2 API.
riskscore.main.score (int) — Value representing the probable risk score based only on license history. Higher values represent higher risk, lower values represent lower risk, negative values indicate positive order history.
riskscore.aggregate.score (int) — Value representing the probable risk score based on all available databases including the license history and cPanel Store order databases. Higher values represent higher risk, lower values represent lower risk, negative values indicate positive order history.
riskscore.directorder.score (int) — Value representing the probable risk score based on the cPanel Store order database. Higher values represent higher risk, lower values represent lower risk, negative values indicate positive order history.
clientreportingurl — Url to send clients to request removal from database.

Examples

Using HTTP (direct API call)

Show Hide

Calling http://manage2.cpanel.net/XMLsecverify.cgi?ip=127.0.0.1 in a browser should produce output similar to the following:

<XMLsecverify reason="Risk Data Fetched" riskscore.aggregate.score="0" riskscore.directorder.score="0" riskscore.main.score="0" status="1" version="1"/>

Calling the function using the URL above will return XML data by default. To change the output format that will be returned, use either of the following URLs:

JSON — http://manage2.cpanel.net/XMLsecverify.cgi?output=json&ip=127.0.0.1
YAML — http://manage2.cpanel.net/XMLsecverify.cgi?output=yaml&ip=127.0.0.1

For more information about each of these output types, visit our Choosing an Output Type documentation.

Using a Perl module

Show Hide

The following is an example of a Perl module that will call XMLsecverify.cgi. You can use this module to pass input variables to a Manage2 API function. You will need to edit the example below to suit your needs.

use cPanelLicensing;
    my $cpl = cPanelLicensing->new(user => $user, pass => $pass);
    $cpl->fetchLicenseRiskData( ip=>$ip )

In the example above, $ip is meant to stand for the IP address that you would like to check.

You can learn more about using a Perl module to call API functions.

Using a PHP class

Show Hide

The following is an example showing how to call the cPanelLicensing PHP class. You can use this class to pass input variables to the Manage2 API using a few short calls.

&lt;?php

include("cpl.inc.php");

$cpl = new cPanelLicensing("__USERNAME__","__PASSWORD__"); $lisc = $cpl-&gt;fetchLicenseRiskData(array( "ip" =&gt; $ip ) );

?&gt;

In the example above, $ip is meant to stand for the IP address of the machine you would like to check.

Remember: USERNAME and PASSWORD are meant to represent the username and password for your Manage2 account.

You can learn more about using a PHP class to call API functions.

Topic revision: r11 - 22 Apr 2011 - 00:28:42 - Main.JustinSchaefer