ScreenlyyIDDocs
Docs › API reference › Device verification

IP probe

Runs a real-time network probe against an IPv4 or IPv6 address. It runs a series of live network scans and service probes to extract useful details about the host provider.

POSThttps://api.screenlyyid.com/api/v1/ip-probe-verify

Headers#

NameTypeRequiredDescription
x-api-keystringYesYour ScreenlyyID API key
x-correlation-idstring (uuid)NoCorrelation ID for this customer check

Request body#

FieldTypeRequiredDescription
IpAdressstringNo

Responses#

StatusDescription
200Successful response

Response body (200)#

FieldTypeRequiredDescription
RegionCodestringNo
CountrystringNo
CountryCodestringNo
ProviderDomainstringNo
CitystringNo
VpnDomainstringNo
IsVpnbooleanYes
AsCidrstringNo
ValidbooleanYes
ProviderTypestringNo
HostnamestringNo
AsAgeinteger (int64)Yes
ContinentCodestringNo
IsBogonbooleanYes
IpstringNo
AsCountryCodestringNo
ProviderDescriptionstringNo
AsCountryCode3stringNo
IsV4MappedbooleanYes
IsIspbooleanYes
ProviderWebsiteobjectNoUri object
AsDescriptionstringNo
IsHostingbooleanYes
AsDomainsarray of stringNo
HostDomainstringNo
IsProxybooleanYes
CurrencyCodestringNo
RegionstringNo
AsnstringNo
CountryCode3stringNo
IsV6booleanYes

Code samples#

curl --request POST \
  --url 'https://api.screenlyyid.com/api/v1/ip-probe-verify' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-correlation-id: YOUR_CORRELATION_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "IpAdress": "<IpAdress>"
}'