| - | Included in … | -|||||
|---|---|---|---|---|---|---|
| Name | -Type (length) | -Description | -Country? | -City? | -City/ISP/Org? | -Insights (formerly Omni)? | -
| Accuracy radius | -integer | -- The radius in kilometers around the specified location where the IP address is -likely to be. - | -- | - | - | |
| City name | -string | -- The city or town name as defined by GeoNames associated with the IP address. - | -- | |||
| Region code | -string | -
- - The ISO-3166-2 code for - the state/region associated with the IP address. - - -- We previously returned a FIPS 10-4 code for all countries other than the United States and Canada. See our blog post detailing changes to our legacy web services. - - |
- - | |||
| Region name | -string | -- The region name as defined by GeoNames associated with the IP address. - | -- | - | - | |
| Postal code | -string | -- The postal code associated with the IP address. These are available for some IP -addresses in Australia, Canada, France, Germany, Italy, Spain, Switzerland, -United Kingdom, and the US. We return the first 3 characters for Canadian -postal codes. We return the first 2-4 characters (outward code) for -postal codes in the United Kingdom. - | -- | - | ||
| Metro code | -integer | -- The metro code associated with the IP address. These are only - available for IP addresses in the US. - | -- | - | ||
| Area code | -string | -
- Deprecated. This field will be empty in the updated legacy web service. See our blog post detailing changes to our legacy web services. |
- - | - | ||
| Country code | -string (2) | -
- - A ISO - 3166-1 country code for the country associated with the IP address. In - addition to the standard codes, we may also return one of the following: - - -
- The US country code is returned for IP addresses associated - with overseas US military bases. - - - |
- ||||
| Country name | -string | -- The country name as defined by GeoNames associated with the IP address. - - | -- | - | - | |
| Continent code | -string (2) | -
- - A two-character code for the continent associated with the IP - address. The possible codes are: - - -
|
- - | - | - | |
| Latitude | -decimal | -- The approximate latitude of the location associated with the network. This value is not precise and should not be used to identify a particular address or household - | -- | |||
| Longitude | -decimal | -- The approximate longitude of the location associated with the network. Latitude and Longitude are often near the center of population. These values are not precise and should not be used to identify a particular address or household. - | -- | |||
| Time zone | -string | -- The time zone associated with the IP address. Time zone names are taken from -the IANA time zone database. See -the list of possible values. - - | -- | - | - | |
| AS number | -string | -- The autonomous system number associated with the IP address. - | -- | - | - | |
| User type | -enum | -
- - -The user type associated with the IP address. This will be one of the following -values. - - - -
|
- - | - | - | |
| Netspeed | -enum | -
- - -The network speed associated with the IP address. This can be one of the -following values: - - - -
|
- - | - | - | |
| Domain | -string | -- The second level domain associated with the IP address. This will be - -something like "example.com" or "example.co.uk", not "foo.example.com". - - | -- | - | - | |
| ISP name | -string | -- The name of the ISP associated with the IP address. - - | -- | - | ||
| Organization name | -string | -- The name of the organization associated with the IP address. - - | -- | - | ||
| City confidence factor | -string | -- A value from 0-100 representing our confidence that the city is correct. - - | -- | - | - | |
| Region confidence factor | -string | -- A value from 0-100 representing our confidence that the region is correct. - - | -- | - | - | |
| Postal confidence factor | -string | -- A value from 0-100 representing our confidence that the postal code is correct. - - | -- | - | - | |
| Country confidence factor | -string | -- A value from 0-100 representing our confidence that the country is correct. - - | -- | - | - | |
| Error code | -string | -
- - If there was an error or warning with this request, this field - contains an error code string. - - -- The possible error codes are: - - -
|
- ||||
| + | Included in … | +|||||
|---|---|---|---|---|---|---|
| Name | +Type (length) | +Description | +Country? | +City? | +City/ISP/Org? | +Insights (formerly Omni)? | +
| Accuracy radius | +integer | ++ The radius in kilometers around the specified location where the IP address is + likely to be. + | ++ | + | + | YES | +
| City name | +string | ++ The city or town name as defined by GeoNames associated with the IP address. + | ++ | YES | +YES | +YES | +
| Region code | +string | +
+ + The ISO-3166-2 code for + the state/region associated with the IP address. + + ++ We previously returned a FIPS 10-4 code for all countries other than the United States and Canada. See our blog post detailing changes to our legacy web services. + + |
+ + | YES | +YES | +YES | +
| Region name | +string | ++ The region name as defined by GeoNames associated with the IP address. + | ++ | + | + | YES | +
| Postal code | +string | ++ The postal code associated with the IP address. These are available for some IP + addresses in Australia, Canada, France, Germany, Italy, Spain, Switzerland, + United Kingdom, and the US. We return the first 3 characters for Canadian + postal codes. We return the first 2-4 characters (outward code) for + postal codes in the United Kingdom. + | ++ | + | YES | +YES | +
| Metro code | +integer | ++ The metro code associated with the IP address. These are only + available for IP addresses in the US. + | ++ | + | YES | +YES | +
| Area code | +string | +
+ Deprecated. This field will be empty in the updated legacy web service. See our blog post detailing changes to our legacy web services. |
+ + | + | YES | +YES | +
| Country code | +string (2) | +
+ + A ISO + 3166-1 country code for the country associated with the IP address. In + addition to the standard codes, we may also return one of the following: + + +
+ The US country code is returned for IP addresses associated + with overseas US military bases. + + + |
+ YES | +YES | +YES | +YES | +
| Country name | +string | ++ The country name as defined by GeoNames associated with the IP address. + + | ++ | + | + | YES | +
| Continent code | +string (2) | +
+ + A two-character code for the continent associated with the IP + address. The possible codes are: + + +
|
+ + | + | + | YES | +
| Latitude | +decimal | ++ The approximate latitude of the location associated with the network. This value is not precise and should not be used to identify a particular address or household + | ++ | YES | +YES | +YES | +
| Longitude | +decimal | ++ The approximate longitude of the location associated with the network. Latitude and Longitude are often near the center of population. These values are not precise and should not be used to identify a particular address or household. + | ++ | YES | +YES | +YES | +
| Time zone | +string | ++ The time zone associated with the IP address. Time zone names are taken from + the IANA time zone database. See + the list of possible values. + + | ++ | + | + | YES | +
| AS number | +string | ++ The autonomous system number associated with the IP address. + | ++ | + | + | YES | +
| User type | +enum | +
+ + + The user type associated with the IP address. This will be one of the following + values. + + + +
|
+ + | + | + | YES | +
| Netspeed | +enum | +
+ + + The network speed associated with the IP address. This can be one of the + following values: + + + +
|
+ + | + | + | YES | +
| Domain | +string | ++ The second level domain associated with the IP address. This will be + + something like "example.com" or "example.co.uk", not "foo.example.com". + + | ++ | + | + | YES | +
| ISP name | +string | ++ The name of the ISP associated with the IP address. + + | ++ | + | YES | +YES | +
| Organization name | +string | ++ The name of the organization associated with the IP address. + + | ++ | + | YES | +YES | +
| City confidence factor | +string | ++ A value from 0-100 representing our confidence that the city is correct. + + | ++ | + | + | YES | +
| Region confidence factor | +string | ++ A value from 0-100 representing our confidence that the region is correct. + + | ++ | + | + | YES | +
| Postal confidence factor | +string | ++ A value from 0-100 representing our confidence that the postal code is correct. + + | ++ | + | + | YES | +
| Country confidence factor | +string | ++ A value from 0-100 representing our confidence that the country is correct. + + | ++ | + | + | YES | +
| Error code | +string | +
+ + If there was an error or warning with this request, this field + contains an error code string. + + ++ The possible error codes are: + + +
|
+ YES | +YES | +YES | +YES | +
| Service | -Field Order | -
|---|---|
| Country | -
-
|
-
| City | -
-
|
-
| City/ISP/Org | -
-
|
-
| Insights | -
-
|
-
| Service | +Field Order | +
|---|---|
| Country | +
+
|
+
| City | +
+
|
+
| City/ISP/Org | +
+
|
+
| Insights | +
+
|
+
| Action | -Explanation | -
|---|---|
| `accept` | -- This is the default value that is used if none of your custom rules - match the request. - | -
| `reject` | -{' '} | -
| `manual_review` | -{' '} | -
| `test` | -- This value can be used to test custom rules. - | -
| Reason | -Explanation | -
|---|---|
| `default` | -- No custom rules matched the request. - | -
| `custom_rule` | -A custom rule was applied and set the action. | -
| Code | -Explanation | -
|---|---|
| `ANONYMOUS_IP` | -- The IP address belongs to an anonymous network. See the object at - `/ip_address/traits` for more details. - | -
| `BILLING_POSTAL_VELOCITY` | -- Many different billing postal codes have been seen on this IP - address. - | -
| `EMAIL_VELOCITY` | -- Many different email addresses have been seen on this IP address. - | -
| `HIGH_RISK_DEVICE` | -- A high risk device was seen on this IP address. - | -
| `HIGH_RISK_EMAIL` | -- A high risk email address was seen on this IP address in your past - transactions. - | -
| `ISSUER_ID_NUMBER_VELOCITY` | -- Many different issuer ID numbers have been seen on this IP address. - | -
| `MINFRAUD_NETWORK_ACTIVITY` | -- Suspicious activity has been seen on this IP address across minFraud - customers. - | -
| Code | -Reason | -
|---|---|
| `BROWSER_LANGUAGE` | -- Riskiness of the browser user-agent and language associated with the request. - | -
| `BUSINESS_ACTIVITY` | -- Riskiness of business activity associated with the request. - | -
| `COUNTRY` | -- Riskiness of the country associated with the request. - | -
| `CUSTOMER_ID` | -- Riskiness of a customer's activity. - | -
| `EMAIL_DOMAIN` | -- Riskiness of email domain. - | -
| `EMAIL_DOMAIN_NEW` | -- Riskiness of newly-sighted email domain. - | -
| `EMAIL_ADDRESS_NEW` | -- Riskiness of newly-sighted email address. - | -
| `EMAIL_LOCAL_PART` | -- Riskiness of the local part of the email address. - | -
| `EMAIL_VELOCITY` | -- Velocity on email - many requests on same email over short period of time. - | -
| `ISSUER_ID_NUMBER_COUNTRY_MISMATCH` | -- Riskiness of the country mismatch between IP, billing, shipping and IIN country. - | -
| `ISSUER_ID_NUMBER_ON_SHOP_ID` | -- Risk of Issuer ID Number for the shop ID. - | -
| `ISSUER_ID_NUMBER_LAST_DIGITS_ACTIVITY` | -- Riskiness of many recent requests and previous high-risk requests on the IIN and last digits of the credit card. - | -
| `ISSUER_ID_NUMBER_SHOP_ID_VELOCITY` | -- Risk of recent Issuer ID Number activity for the shop ID. - | -
| `INTRACOUNTRY_DISTANCE` | -Risk of distance between IP, billing, and shipping location. | -
| `ANONYMOUS_IP` | -Risk due to IP being an Anonymous IP. | -
| `IP_BILLING_POSTAL_VELOCITY` | -Velocity of distinct billing postal code on IP address. | -
| `IP_EMAIL_VELOCITY` | -Velocity of distinct email address on IP address. | -
| `IP_HIGH_RISK_DEVICE` | -High-risk device sighted on IP address. | -
| `IP_ISSUER_ID_NUMBER_VELOCITY` | -Velocity of distinct IIN on IP address. | -
| `IP_ACTIVITY` | -Riskiness of IP based on minFraud network activity. | -
| `LANGUAGE` | -Riskiness of browser language. | -
| `MAX_RECENT_EMAIL` | -Riskiness of email address based on past minFraud risk scores on email. | -
| `MAX_RECENT_PHONE` | -Riskiness of phone number based on past minFraud risk scores on phone. | -
| `MAX_RECENT_SHIP` | -Riskiness of email address based on past minFraud risk scores on ship address. | -
| `MULTIPLE_CUSTOMER_ID_ON_EMAIL` | -Riskiness of email address having many customer IDs. | -
| `ORDER_AMOUNT` | -Riskiness of the order amount. | -
| `ORG_DISTANCE_RISK` | -Risk of ISP and distance between billing address and IP location. | -
| `PHONE` | -Riskiness of the phone number or related numbers. | -
| `CART` | -Riskiness of shopping cart contents. | -
| `TIME_OF_DAY` | -Risk due to local time of day. | -
| `TRANSACTION_REPORT_EMAIL` | -Risk due to transaction reports on the email address. | -
| `TRANSACTION_REPORT_IP` | -Risk due to transaction reports on the IP address. | -
| `TRANSACTION_REPORT_PHONE` | -Risk due to transaction reports on the phone number. | -
| `TRANSACTION_REPORT_SHIP` | -Risk due to transaction reports on the shipping address. | -
| `EMAIL_ACTIVITY` | -Riskiness of the email address based on minFraud network activity. | -
| `PHONE_ACTIVITY` | -Riskiness of the phone number based on minFraud network activity. | -
| `SHIP_ACTIVITY` | -Riskiness of ship address based on minFraud network activity. | -
| Code | -Description | -
|---|---|
| - `BILLING_CITY_NOT_FOUND` - | -- The billing city could not be found in our database. - This may impact our ability to provide accurate distance calculations. - | -
| - `BILLING_COUNTRY_MISSING` - | -- Billing address information was provided without providing a billing - country. This may impact our ability to provide accurate distance calculations. - | -
| - `BILLING_COUNTRY_NOT_FOUND` - | -- The billing country could not be found in our database. - This may impact our ability to provide accurate distance calculations. - | -
| - `BILLING_POSTAL_NOT_FOUND` - | -- The billing postal could not be found in our database. - This may impact our ability to provide accurate distance calculations. - | -
| - `BILLING_REGION_NOT_FOUND` - | -- The billing region could not be found in our database. - This may impact our ability to provide accurate distance calculations. - | -
| - `EMAIL_ADDRESS_UNUSABLE` - | -- The email address entered is likely incorrect due to an integration issue. - To avoid false positives, it has not been used in scoring. Check how you - are passing your [email address inputs](/minfraud/api-documentation/requests#schema--request--email). - | -
| - `INPUT_INVALID` - | -- The value associated with the key does not meet the required - constraints, e.g., "United States" in a field that requires a - two-letter country code. - | -
| - `INPUT_UNKNOWN` - | -- An unknown key was encountered in the request body. - | -
| - `IP_ADDRESS_INVALID` - | -- The IP address supplied is not a valid IPv4 or IPv6 address. - | -
| - `IP_ADDRESS_NOT_FOUND` - | -- The IP address could not be geolocated. - | -
| - `IP_ADDRESS_RESERVED` - | -- The IP address supplied is in a reserved network. - | -
| - `SHIPPING_CITY_NOT_FOUND` - | -- The shipping city could not be found in our database. - This may impact our ability to provide accurate distance calculations. - | -
| - `SHIPPING_COUNTRY_MISSING` - | -- Shipping address information was provided without providing a - shipping country. This may impact our ability to provide accurate distance calculations. - | -
| - `SHIPPING_COUNTRY_NOT_FOUND` - | -- The shipping country could not be found in our database. - This may impact our ability to provide accurate distance calculations. - | -
| - `SHIPPING_POSTAL_NOT_FOUND` - | -- The shipping postal could not be found in our database. - This may impact our ability to provide accurate distance calculations. - | -
| - `SHIPPING_REGION_NOT_FOUND` - | -- The shipping region could not be found in our database. - This may impact our ability to provide accurate distance calculations. - | -