Skip to main content
POST
fraud.ip.inspect

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ip
string
required

Public IP address.

Minimum string length: 1
includeLocation
boolean

Include approximate location; default off.

includeNetwork
boolean

Include network facts; default off.

includePorts
boolean

Include observed open ports; default off.

includeSignalScore
boolean

Include the address-level rule score, not an abuse probability; default off.

Response

The result

ip
string
required

Checked IP address.

Required string length: 1 - 45
vpn
boolean

VPN observed.

tor
boolean

Tor observed.

webProxy
boolean

Web proxy observed.

publicProxy
boolean

Public proxy observed.

hostingProxy
boolean

Data-centre proxy observed.

residentialProxy
boolean

Residential proxy observed.

privacyNetwork
boolean

Consumer privacy network observed.

enterpriseNetwork
boolean

Enterprise private network observed.

spider
boolean

Search-engine crawler observed.

harmful
boolean

Address flagged as harmful.

spamObservations
integer

Spam-list observations.

Required range: 0 <= x <= 9007199254740991
signalScore
number

IP-level rule score; not an abuse probability.

location
object

Location facts, when available.

network
object

Requested network facts.

openPorts
integer[]

Requested observed open ports.

Required range: 0 <= x <= 65535