API reference / Risk & Location
IP quality check
Fraud score, proxy, VPN and Tor flags, ISP and location for an IPv4 or IPv6 address.
POST
/v1/risk/ip- Authentication
- Bearer token
- Scope
kyc:verify
Request body
| Field | Type | Required | Description |
|---|---|---|---|
ip | string | Yes | IPv4 or IPv6 address to check. |
Sample code
Set your key in the GRAPPI_API_KEY environment variable. Sample values are placeholders.
curl -sS -X POST 'https://grappi.ai/v1/risk/ip' \
-H "Authorization: Bearer $GRAPPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ip": "203.0.113.10"
}'Sample response
{
"request_id": "req_01HZY3K8M2",
"result": {
"fraud_score": "12",
"proxy": "false",
"vpn": "false",
"tor": "false",
"recent_abuse": "false",
"bot_status": "false",
"is_crawler": "false",
"mobile": "false",
"isp": "Example Broadband",
"organization": "Example Broadband",
"asn": "64500",
"host": "host.example.com",
"country_code": "IN",
"region": "Maharashtra",
"city": "Pune",
"latitude": "18.52",
"longitude": "73.85",
"timezone": "Asia/Kolkata",
"address": "203.0.113.10"
}
}Response fields
| Field | Type | Description |
|---|---|---|
fraud_score | string | Risk score for the address; a higher number means higher risk. |
proxy | string | Whether the address is a proxy. |
vpn | string | Whether the address is a VPN. |
tor | string | Whether the address is a Tor exit node. |
recent_abuse | string | Whether the address has been reported for abuse recently. |
bot_status | string | Whether the address looks like a bot. |
is_crawler | string | Whether the address belongs to a web crawler. |
mobile | string | Whether the address is on a mobile network. |
isp | string | Internet service provider. |
organization | string | Organisation the address belongs to. |
asn | string | Autonomous system number. |
host | string | Host name of the address. |
country_code | string | Two-letter country code. |
region | string | Region or state. |
city | string | City. |
latitude | string | Approximate latitude. |
longitude | string | Approximate longitude. |
timezone | string | Time zone. |
address | string | The address that was checked. |
Errors
Every failure has the same shape. A call that fails on our side or at the data source is refunded to your wallet; a "no record found" answer is charged. See the error reference.