GuidesRecipesAPI ReferenceChangelog
API Reference

IP Address

post https://api.fido.id/{version}/ip

IP Address

Trustfull's API endpoints are quite flexible and you can request a range of services from a single endpoint

One of the possible use cases is IP Address Data

What is IP Address Data?

IP Address Data is a product that combines advanced ip validation, data enrichment, and a specific AI model all based on a single touch point, the ip address.

Request

following an example of an IP Address Data

curl --request POST \
     --url https://api.fido.id/1.0/ip \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: [your_app_key]' \
     --data '
{
     "customer_id": "c426ad68-8987-11ec-a8a3-0242ac120002",
     "claims": [
          "ip"
     ],
     "ip": "162.168.1.0"
}'

Response

Following an example of the response:

{
    "resolution_id": "...",
    "customer_id": "...",
    "device_request_time": "...",
    "webhook_url": "...",
    "claims": [
        "ip"
    ],
    "value": "12.34.56.78",
    "city": "Milan",
    "connection_speed": "company/T1",
    "connection_type": true,
    "country": "IT",
    "isp": "Fastweb",
    "timezone": "CET",
    "request_time": "night",
    "zip": "20124",
    "is_mobile": true,
    "is_vpn": true,
    "vpn_name": true,
    "is_proxy": true,
    "proxy_name": "Bright Data",
    "proxy_type": "datacenter",
    "is_tor": true,
    "is_relay": true,
    "is_hosting": true,
    "score": 649,
    "score_cluster": "very_high",
    "black_list_count": 5,
    "company_domain": "google.com",
    "company_name": "Apple",
    "company_description": "Apple Inc. is an American...",
    "company_industry": "Internet Software & Services",
    "company_employees": 1750,
    "company_founded": 2014,
    "company_keywords": "smartphone,tech",
    "company_annual_revenue": 32500000,
    "company_logo": "https://...",
    "company_country": "Italy",
    "company_twitter_url": "https://...",
    "company_facebook_url": "https://...",
    "company_linkedin_url": "https://...",
    "company_total_funding": "https://...",
    "company_tech_stack": "JavaScript",
    "reason_codes": "TP001,RP001",
    "identity_device_count": 2,
    "identity_email_count": 2,
    "identity_msisdn_count": 2,
    "identity_name_count": 2,
    "remote_desktop_enable": true,
    "xbl_count": 2,
    "css_count": 3,
    "xbl_in_days": 2,
    "css_in_days": 0,
    "is_valid_format": true
}

The following fields can be found under the "ip" object

nametype
valuestring

The IP address provided during the API call, can either be an ipv4 or ipv6

Ex: 12.34.56.78
citystring

The city associated to the IP address of the customer

Ex: Milan
connection_speedstring

Internet connection speed associated to the ip address:
- company/T1:
- broadband/cable/fiber:
- mobile:


Ex: company/T1

Enum: company/T1,broadband/cable/fiber,mobile
connection_typestring

Usage type classification of ISP or company:
- Commercial:
- Content Delivery Network:
- Fixed Line:
- Mobile ISP:
- Reserved:
- University / College / School:


Ex: true

Enum: Commercial,Content Delivery Network,Fixed Line,Mobile ISP,Reserved,University / College / School
countrystring

The name of the country where the IP Address is located, ISO 3166 alpha-2

Ex: IT

Enum: AB, AD, AE, AF, AG, AI, AL, AM, AO, AQ, ...
ispstring

The service provider used by the customer's device to access the internet

Ex: Fastweb
timezonestring

The exact current time in the Timezone the IP address belongs to

Ex: CET
request_timestring

Time of the day the user is requesting your service

Ex: night

Enum: morning,afternoon,evening,night
zipstring

The Postal Code for where the IP Address is located

Ex: 20124
is_mobileboolean

Indicates whether an IP address is associated with a mobile connection

Ex: true
is_vpnboolean

Indicates whether an IP address is under a VPN

Ex: true
vpn_namestring

If the IP address is a VPN, it is the name of the VPN provider

Ex: true
is_proxyboolean

Indicates whether an IP address is coming from a proxy

Ex: true
proxy_namestring

When the IP address is a Proxy, indicates the name of the Proxy provider

Ex: Bright Data

Enum: Bright Data,Smartproxy,Oxylabs,Netnut,Webshare,GoProxy
proxy_typestring

When the IP address is a Proxy, indicates the type of Proxy

Ex: datacenter

Enum: datacenter,residential
is_torboolean

Indicates whether an IP address is associated to a TOR node

Ex: true
is_relayboolean

Indicates whether an IP address configured to act as relay

Ex: true
is_hostingboolean

Indicates whether an IP address is a hosting provider

Ex: true
scoreinteger

A number ranging from 0 to 1000 represents the quality of the IP information detected

Ex: 649
score_clusterstring

A cluster summarizing the quality of the IP address

Ex: very_high

Enum: very_low,low,review,high,very_high
black_list_countinteger

The number of providers that have flagged this IP as spam

Ex: 5
company_domainstring

The name of the domain of the company that owns the domain, if found

Ex: google.com
company_namestring

The name of the company the user works for, contains the full name

Ex: Apple
company_descriptionstring

A verbose description description of the company the user works for

Ex: Apple Inc. is an American...
company_industrystring

Indicates the industry/sector of the company using a standard taxonomy

Ex: Internet Software & Services
company_employeesinteger

Indicates the number of employees of the company

Ex: 1750
company_foundedinteger

Indicates the year when the company was founded

Ex: 2014
company_keywordsstring

A list of keywords used in the company description

Ex: smartphone,tech
company_annual_revenueinteger

Indicates our proprietary estimated annual revenue range for company

Ex: 32500000
company_logostring

An url linking to the the logo of the company associated to the ip address

Ex: https://...
company_countrystring

Indicates the full country name of the company headquarter

Ex: Italy
company_twitter_urlstring

Provides a link to the company twitter account, links is always pointing to twitter domain

Ex: https://...
company_facebook_urlstring

Provides the Facebook url of the company, links is always pointing to facebook domain

Ex: https://...
company_linkedin_urlstring

Provides the Linkedin url of the company, links is always pointing to linkedin domain

Ex: https://...
company_total_fundinginteger

Provides the total amount of funding raised by company

Ex: https://...
company_tech_stackstring

Indicates the set of technologies uses by the company

Ex: JavaScript
reason_codesstring

Comma separated risk and trust signal for the product ip.
For more information about reason codes you can go to Reason Codes

Ex: TP001,RP001
identity_device_countinteger

The number of devices associated with this ip address

Ex: 2
identity_email_countinteger

The number of email addresses associated with this ip address

Ex: 2
identity_msisdn_countinteger

The number of phones associated with this ip address

Ex: 2
identity_name_countinteger

The number of names associated with this ip address

Ex: 2
remote_desktop_enableboolean

Indicates if the IP is enabled to accept connections from common remote desktop software

Ex: true
xbl_countinteger

The number of times this IP address has been reported in a Exploits Blocklist (XBL)

Ex: 2
css_countinteger

The number of times this IP address has been reported in a Combined Spam Sources (CSS)

Ex: 3
xbl_in_daysinteger

The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data.

Ex: 2
css_in_daysinteger

The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data.

Ex: 0
is_valid_formatboolean

Indicates if the IP is in an accepted ipv4 or ipv6 format

Ex: true
Language
URL
Click Try It! to start a request and see the response here!