Overview

Use this method to retrieve IP check results.

Response explained

The response represents a singleton list of IP checks.

Field	Type	Description
`answer`	String	Check answer: `RED` — the check returned a high risk indication. `YELLOW` — the check ended up with no data found. `GREEN` — the check ended up successfully.
`checkType`	String	Indicates this is the `IP_CHECK` check type.
`createdAt`	Date	Date and time (UTC) of the latest IP check result.
`id`	String	Unique identifier of the check.
`ipCheckInfo`	Object	IP check parameters with results.

`ipCheckInfo` attributes

The following table explains the IP check parameters with results.

Field	Type	Description
`ip`	String	IP address of the device.
`ipInfo`	Object	IP address related data.
`internetServiceProvider`	String	Company name of the internet service provider.
`connectionType`	String	Indicates the type of internet connection (`residential`, `hosting`, `business`, `cellular`, `consumer_privacy_network`, `traveler`).
`organization`	String	Legal name of the internet provider.
`proxy`	String	Indicates whether a proxy server is used and labels it as safe (`GREEN`), suspicious (`YELLOW`), or risky (`RED`).
`vpn`	String	Indicates whether a VPN is used and labels it as safe (`GREEN`), suspicious (`YELLOW`), or risky (`RED`).
`tor`	String	Indicates whether the detected IP address is tunneled through other devices and labels the connection as safe (`GREEN`), suspicious (`YELLOW`), or risky (`RED`).
`riskLevel`	String	Labels the detected IP address as safe (`GREEN`), suspicious (`YELLOW`), or risky (`RED`).
`riskScore`	Double	Indicates the risk score (from 0.01 to 99) calculated by the system where more than 10 is risky.

`ipInfo` attributes

The following table explains the ipInfo attributes representing the IP address related data.

Field	Type	Description
`ip`	String	IP address of the device.
`countryCode2`	String	Country code (ISO 3166-1 alpha-2).
`countryCode3`	String	Country code (ISO 3166-1 alpha-3).
`city`	String	City the IP address belongs to.
`zipCode`	String	ZIP code.
`state`	String	Name of the state or region if applicable.
`stateCode`	String	Code of the state or region if applicable.
`lat`	Double	Returns a double value representing the latitude of the position in decimal degrees.
`lon`	Double	Returns a double value representing the longitude of the position in decimal degrees.
`asn`	Integer	Autonomous System Number.
`asnOrg`	String	ASN organization.
`riskyAsn`	Boolean	Determines whether the ASN is risky (`true`) or not (`false`).

Response example

{
  "checks": [
    {
      "answer": "RED",
      "checkType": "IP_CHECK",
      "createdAt": "2024-05-16 05:55:31",
      "id": "551d88ba-896d-4f4a-970d-44457fe4be0f",
      "ipCheckInfo": {
        "ip": "3.124.154.191",
        "ipInfo": {
          "ip": "3.124.154.191",
          "countryCode2": "DE",
          "countryCode3": "DEU",
          "city": "Frankfurt am Main",
          "zipCode": "60313",
          "lat": 50.1187,
          "lon": 8.6842,
          "asn": 16509,
          "asnOrg": "AMAZON-02",
          "riskyAsn": false
        },
        "internetServiceProvider": "Amazon.com",
        "connectionType": "hosting",
        "organization": "AMAZON-02",
        "proxy": "GREEN",
        "vpn": "RED",
        "tor": "GREEN",
        "riskLevel": "RED",
        "riskScore": 12.5
      }
    }
  ]
}

Overview

Response explained

ipCheckInfo attributes

ipInfo attributes

Response example

`ipCheckInfo` attributes

`ipInfo` attributes