--- title: "Trustfull IP" method: POST path: "/ip" tags: ["Products"] --- # Trustfull IP `POST /ip` Trustfull IP ## Headers - `content-type` string - `accept` string - `x-api-key` string, required - `x-demo` string ## Request body - HubRequestIp — HubRequestBase - `customer_id` string, required — A string representing the unique identifier of the user you are requesting information about. Each request requires a different customer_id - `max_enrichment_time` number, float — Specifies the maximum duration for data enrichment, allowing you to fine-tune the process to enhance accuracy or reduce response time. [Read more](https://docs.trustfull.com/docs/response-times#working-with-max-enrichment-time) - `ip` string, required — Ip address you want to lookup. Both Ipv4 and Ipv6 formats are supported. - `claims` string[], required ## Response `200` OK - HubResponseIp — Base - `resolution_id` string - `device_request_time` string - `customer_id` CustomerId — unresolved $ref - `ip` Ip — Ip - `value` string, nullable — The IP address provided during the API call, can either be an ipv4 or ipv6 - `city` string, nullable — The city associated to the IP address of the customer - `connection_speed` 'company/T1' | 'broadband/cable/fiber' | 'mobile', nullable — Internet connection speed associated to the ip address: - **company/T1** - **broadband/cable/fiber** - **mobile** - `connection_type` 'Commercial' | 'Content Delivery Network' | 'Fixed Line' | 'Mobile ISP' | 'Reserved' | 'University / College / School', nullable — Usage type classification of ISP or company: - **Commercial** - **Content Delivery Network** - **Fixed Line** - **Mobile ISP** - **Reserved** - **University / College / School** - `country` 'AB' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'OS' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'XK', nullable — The name of the country where the IP Address is located, ISO 3166 alpha-2 - `lat` string, nullable — The latitude for where place where the IP Address is located - `lon` string, nullable — The longitude for where place where the IP Address is located - `isp` string, nullable — The service provider used by the customer's device to access the internet - `timezone` string, nullable — The exact current time in the Timezone the IP address belongs to - `request_time` 'morning' | 'afternoon' | 'evening' | 'night', nullable — Time of the day the user is requesting your service - `zip` string, nullable — The Postal Code for where the IP Address is located - `is_mobile` boolean, nullable — Indicates whether an IP address is associated with a mobile connection - `is_vpn` boolean, nullable — Indicates whether an IP address is under a VPN - `vpn_name` string, nullable — **DEPRECATED** If the IP address is a VPN, it is the name of the VPN provider - `is_proxy` boolean, nullable — Indicates whether an IP address is coming from a proxy - `proxy_name` 'Bright Data' | 'Smartproxy' | 'Oxylabs' | 'Netnut' | 'Webshare' | 'GoProxy', nullable — When the IP address is a Proxy, indicates the name of the Proxy provider - `proxy_type` 'datacenter' | 'residential', nullable — When the IP address is a Proxy, indicates the type of Proxy - `is_tor` boolean, nullable — Indicates whether an IP address is associated to a TOR node - `is_relay` boolean, nullable — Indicates whether an IP address configured to act as relay - `is_hosting` boolean, nullable — Indicates whether an IP address is a hosting provider - `score` integer, nullable — A number ranging from 0 to 1000 represents the quality of the IP information detected - `score_cluster` 'very_low' | 'low' | 'review' | 'high' | 'very_high', nullable — A cluster summarizing the quality of the IP address - `black_list_count` integer, nullable — The number of providers that have flagged this IP as spam - `company_domain` string, nullable — The name of the domain of the company that owns the domain, if found - `company_name` string, nullable — The name of the company the user works for, contains the full name - `company_description` string, nullable — A verbose description description of the company the user works for - `company_industry` string, nullable — Indicates the industry/sector of the company using a standard taxonomy - `company_employees` integer, nullable — Indicates the number of employees of the company - `company_founded` integer, nullable — Indicates the year when the company was founded - `company_keywords` string, nullable — A list of keywords used in the company description - `company_annual_revenue` integer, nullable — Indicates our proprietary estimated annual revenue range for company - `company_logo` string, nullable — An url linking to the the logo of the company associated to the ip address - `company_country` string, nullable — Indicates the full country name of the company headquarter - `company_twitter_url` string, nullable — Provides a link to the company twitter account, links is always pointing to twitter domain - `company_facebook_url` string, nullable — Provides the Facebook url of the company, links is always pointing to facebook domain - `company_linkedin_url` string, nullable — Provides the Linkedin url of the company, links is always pointing to linkedin domain - `company_total_funding` integer, nullable — Provides the total amount of funding raised by company - `company_tech_stack` string, nullable — Indicates the set of technologies uses by the company - `reason_codes` string, nullable — Comma separated risk and trust signal for the product ip. For more information about reason codes you can go to [Reason Codes]() - `identity_device_count` integer, nullable — **DEPRECATED** The number of devices associated with this ip address - `identity_email_count` integer, nullable — The number of email addresses associated with this ip address - `identity_msisdn_count` integer, nullable — The number of phones associated with this ip address - `identity_name_count` integer, nullable — The number of names associated with this ip address - `remote_desktop_enable` boolean, nullable — Indicates if the IP is enabled to accept connections from common remote desktop software - `xbl_count` integer, nullable — The number of times this IP address has been reported in a Exploits Blocklist (XBL) - `css_count` integer, nullable — The number of times this IP address has been reported in a Combined Spam Sources (CSS) - `xbl_in_days` integer, nullable — The how many days has passed since the most recent report in a Exploits Blocklist (XBL). Recency indicates more accurate data. - `css_in_days` integer, nullable — The how many days has passed since the most recent report in a Combined Spam Source (CSS). Recency indicates more accurate data. - `is_valid_format` boolean, nullable — Indicates if the IP is in an accepted ipv4 or ipv6 format - `is_private_internal_address` boolean, nullable — Indicates if the IP belongs to a private internal address --- [API](https://skmtc.dev/trustfull/apis/products.md) · [All operations](https://skmtc.dev/trustfull/apis/products/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/trustfull/products/revisions/cb4f72972276/schema)