Overview

Use this method to retrieve IP check results.

Response explained

The response represents a list of IP checks.

Root variables
- ipCheckInfo
- ipInfo attributes
Response example

Root variables

The root variables are the core check result data items. Some of them may include nested attributes and element fields.

Field	Type	Description
`answer`	String	Check answer. Always `GREEN`, that means the IP check was processed and completed 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`, `cellular`, `business`, `hosting`, `educational`.
`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.

`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`).
`riskScore`	Double	Indicates the risk score (from 0.01 to 99) calculated by the system.
`timezone`	String	Timezone in which the applicant is located.
`connectionType`	String	Indicates the type of internet connection.
`proxy`	Boolean	Determines whether a proxy server is used (`true`) or not (`false`).
`vpn`	Boolean	Determines whether a VPN is used (`true`) or not (`false`).

Response example

{
    "checks": [
        {
            "answer": "GREEN",
            "checkType": "IP_CHECK",
            "createdAt": "2025-05-28 15:42:24",
            "id": "142965bb-6775-4d85-a6ed-39aa94f7726a",
            "ipCheckInfo": {
                "ip": "33.199.219.172",
                "ipInfo": {
                    "ip": "33.199.219.172",
                    "countryCode2": "US",
                    "countryCode3": "USA",
                    "city": "Ashburn",
                    "state": "Virginia",
                    "stateCode": "US-VA",
                    "lat": 39.04,
                    "lon": -77.49,
                    "asn": 14618,
                    "asnOrg": "Amazon.com",
                    "org": "Amazon.com",
                    "riskyAsn": false,
                    "riskScore": 75.0,
                    "timezone": "America/New_York",
                    "connectionType": "hosting",
                    "proxy": true,
                    "vpn": true
                },
                "internetServiceProvider": "Amazon.com",
                "connectionType": "hosting",
                "organization": "Amazon.com",
                "proxy": "RED",
                "vpn": "RED",
                "tor": "GREEN",
                "riskLevel": "GREEN",
                "riskScore": 75.0
            }
        }
    ]
}