Manage2 API Function - Fetch Risk Data


Last modified: March 12, 2021

Description

This function returns an IP address’s fraud risk score. This function uses the number of charge backs, the number of fraudulent sign-ups, and other information to generate this score.

Examples

XML

https://manage2.cpanel.net/XMLsecverify.cgi?ip=192.0.2.0

JSON

https://manage2.cpanel.net/XMLsecverify.cgi?output=json&ip=192.0.2.0

YAML

https://manage2.cpanel.net/XMLsecverify.cgi?output=yaml&ip=192.0.2.0

1
2
3
4
5
6
7
8
<?php
include("cpl.inc.php");
$cpl = new cPanelLicensing("username@example.com,"123456luggage");
$lisc = $cpl->fetchLicenseRiskData(array(
    "ip" => 192.0.2.0
    )
);
?>

1
2
3
4
5
6
7
8
use cPanelLicensing;
    my $licenseManager = new cPanelLicensing(
        user => 'username\@example.com',
        pass => '123456luggage',
);
    $licensemanager->fetchLicenseRiskData(
        'ip' => '192.0.2.0'
    );

<XMLsecverify clientreportingurl="http://verify.cpanel.net/security/?code=ELeLcLNcPA" reason="Risk Data Fetched" riskscore.aggregate.score="0" riskscore.directorder.score="0" riskscore.main.score="0" status="1" version="1"/>

1
2
3
4
5
6
7
8
9
{
    "version": 1,
    "status": 1,
    "reason": "Risk Data Fetched",
    "clientreportingurl": "http://verify.cpanel.net/security/?code=ELeLcLNcPA",
    "riskscore.main.score": 0,
    "riskscore.directorder.score": 0,
    "riskscore.aggregate.score": 0
}

1
2
3
4
5
6
7
8
---
version: 1
status: 1
reason: Risk Data Fetched
clientreportingurl: http://verify.cpanel.net/security/?code=ELeLcLNcPA
riskscore.main.score: 0
riskscore.directorder.score: 0
riskscore.aggregate.score: 0

Parameters

This function accepts the following parameters:

Parameter Type Description Example
ip string Required
The license’s IP address. The Manage2 List License Information function returns a list of possible values.
192.0.2.0

Returns

This function returns the following values:

Return Type
Description
Example
reason string Information about license check. Risk Data Fetched
status Boolean Whether the function succeeded:
  • 1 — Success.
  • 0 — Failure.
1
clientreportingurl string The URL to send clients who wish to request removal from the database. http://verify.cpanel.net/security/?code=ELeLcLNcPA
version float Internal information that the Manage2 API uses to identify the version. 0.5
riskscore.main.score integer The fraud risk score, based on the license’s history:
  • High integer — High fraud risk.
  • Low integer — Low fraud risk.
  • Negative integer — Positive order history.
0
riskscore.aggregate.score integer The fraud risk score, based on the license’s history and cPanel Store’s order databases:
  • High integer — High fraud risk.
  • Low integer — Low fraud risk.
  • Negative integer — Positive order history.
0
riskscore.directorder.score integer The fraud risk score, based on the cPanel Store’s order databases:
  • High integer — High fraud risk.
  • Low integer — Low fraud risk.
  • Negative integer — Positive order history.
0

Additional Documentation