IP Quality Check

4 min

Introduction

This API is designed to provide risk scores based on the provided IP address. The API accepts a POST request with the task parameter set to "ipQuality" and the IP address passed in the essentials object. The API then returns a response with the risk score and additional details.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../riskscores \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"ipQuality","essentials":{"ip":"...ip..."}}'

Parameter	Type	Description
task	string	The name of the task to be performed. In this case, "ipQuality" for IP quality check.
essentials	object	An object containing the essential information for performing the task.
essentials.ip	string	The IP address that needs to be checked.

Sample API Response

{
  	"result": {
        "asn": "..asn..",
        "isp": "..isp..",
        "countryCode": "..countryCode..",
        "region": "..region..",
        "city": "..city..",
        "organization": "..organization..",
        "latitude": "..latitude..",
        "longitude": "..longitude..",
        "isCrawler": "..isCrawler..",
        "timezone": "..timezone..",
        "mobile": "..mobile..",
        "host": "..host..",
        "proxy": "..proxy..",
        "vpn": "..vpn..",
        "tor": "..tor..",
        "recentAbuse": "..recentAbuse..",
        "botStatus": "..botStatus..",
        "fraudScore": "..fraudScore..",
        "address": "..address.."
    }
  }

Parameter	Description
asn	The Autonomous System Number (ASN) of the Internet Service Provider (ISP) that provides the IP address.
isp	The name of the Internet Service Provider (ISP) that provides the IP address.
countryCode	The country code of the location where the IP address is registered.
region	The region of the location where the IP address is registered.
city	The city of the location where the IP address is registered.
organization	The name of the organization that owns the IP address.
latitude	The latitude of the location where the IP address is registered.
longitude	The longitude of the location where the IP address is registered.
isCrawler	A Boolean value that indicates whether the IP address is associated with a web crawler.
timezone	The timezone of the location where the IP address is registered.
mobile	A Boolean value that indicates whether the IP address is associated with a mobile device.
host	The hostname associated with the IP address.
proxy	A Boolean value that indicates whether the IP address is associated with a proxy server.
vpn	A Boolean value that indicates whether the IP address is associated with a Virtual Private Network (VPN).
tor	A Boolean value that indicates whether the IP address is associated with The Onion Router (TOR) network.
recentAbuse	A Boolean value that indicates whether the IP address has been recently associated with abusive activity.
botStatus	A Boolean value that indicates whether the IP address is associated with a known bot.
fraudScore	A numeric value between 0 and 1 that indicates the likelihood of the IP address being associated with fraudulent activity.
address	The complete address of the location where the IP address is registered.