On this page

User risk API

Introduction

The User Risk API endpoint is a wrap-up for our comprehensive Hazard Report API. It provides a simple go/no-go first line of defence solution for some common access control scenarios. 

'Low' risk response - means that the IP address passes all the security checks and can be considered safe. Please only be aware that although the risk is low - it is still not zero! 

'Moderate' risk response is when the hosting likelihood is above zero or detected as either VPN or PROXY.

'High' risk indicates whether the address is blocklisted, a TOR is detected, or it is bogon or unreachable. 

Therefore, it can, for example, help build a less annoying CAPTCHA solution when defending some less critical resources. The API response, in such a case, can be interpreted as:

  • 'Low' risk - let it go with no CAPTCHA
  • 'Moderate' risk - challenge with a CAPTCHA
  • 'High' risk - drop

Get started

This API is part of the IP Geolocation package and is available in free and paid plans. Please visit the IP Geolocation package page for limits and pricing information.

Endpoint

GET
https://api.bigdatacloud.net/data/user-risk

Request

Parameter
Type
Required
Description
Parameter
ip
Type
string
Required
Optional, default value: [Caller's IP]
Description
IPv4 IP address in a string or numeric format. If omitted, the caller’s IP address is assumed
Parameter
key
Type
string
Required
Yes
Description
Your API key

Responses

Example query

https://api.bigdatacloud.net/data/user-risk?ip=193.114.112.1&key=[YOUR API KEY]
  

Example response

  • 1
    {
  • 2
    "risk": "Low",
  • 3
    "description": "low risk"
  • 4
    }

Schema

application/json