/ 
WebService-MinFraud-1.010000
River stage zero No dependents
/ WebService::MinFraud::Record::IPAddress

NAME

WebService::MinFraud::Record::IPAddress - Contains data for the IPAddress record returned from a minFraud web service query

VERSION

version 1.010000

SYNOPSIS

use 5.010;

use WebService::MinFraud::Client;

my $client = WebService::MinFraud::Client->new(
    account_id  => 42,
    license_key => 'abcdef123456',
);
my $request    = { device => { ip_address => '24.24.24.24' } };
my $insights   = $client->insights($request);
my $ip_address = $insights->ip_address;
say $ip_address->city->name;

DESCRIPTION

This class contains the GeoIP2 location data returned from a minFraud service query for the given ip_address.

METHODS

This class provides the following methods:

city

Returns a GeoIP2::Record::City object representing city data for the IP address.

continent

Returns a GeoIP2::Record::Continent object representing continent data for the IP address.

country

Returns a WebService::MinFraud::Record::Country object for the IP address. This record represents the country where MaxMind believes the IP is located.

location

Returns a WebService::MinFraud::Record::Location object for the IP address.

most_specific_subdivision

Returns a GeoIP2::Record::Subdivision object which is the most specific (smallest) subdivision.

If the response did not contain any subdivisions, this method returns a GeoIP2::Record::Subdivision object with no values.

postal

Returns a GeoIP2::Record::Postal object representing postal code data for the IP address.

registered_country

Returns a GeoIP2::Record::Country object representing the registered country data for the IP address. This record represents the country where the ISP has registered a given IP block and may differ from the user's country.

represented_country

Returns a GeoIP2::Record::RepresentedCountry object for the country represented by the IP address. The represented country may differ from the country returned by the country method, for locations such as military bases.

risk

Returns the risk associated with the IP address. The value ranges from 0.01 to 99. A higher value indicates a higher risk. The IP address risk is distinct from the value returned by risk_score methods of WebService::MinFraud::Model::Insights and WebService::MinFraud::Model::Score modules.

subdivisions

Returns an array of GeoIP2::Record::Subdivision objects representing the country divisions for the IP address. The number and type of subdivisions varies by country, but a subdivision is typically a state, province, county, or administrative region.

traits

Returns a GeoIP2::Record::Traits object representing traits for the IP address, such as autonomous system number (ASN).

PREDICATE METHODS

The following predicate methods are available, which return true if the related data was present in the response body, false if otherwise:

has_country

has_location

has_risk

SUPPORT

Bugs may be submitted through https://github.com/maxmind/minfraud-api-perl/issues.

AUTHOR

Mateu Hunter <mhunter@maxmind.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 - 2020 by MaxMind, Inc.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.