IPQualityScore

the ipqualityscore connector offers a variety of different risk analysis apis designed to proactively prevent fraud™ for your company, website, or app prerequisites this section shows you how to create your account and obtain the private key needed for the swimlane connector account setup get started with ipqualityscore by following this link ipqualityscore sign up https //www ipqualityscore com/?r=314077 how to obtain an api token create an account using the link above if you have an existing account, log in and skip to step 4 select get free api key on the landing page this will prompt the registration follow the registration steps to create your account once you arrive at the dashboard page, select api docs located in the middle of the screen select proxy and vpn detection api and scroll down until you see the private key copy and paste the private key into the swimlane asset capabilities this connector integrates with email validation, proxy/vpn, request, and fraudulent posting apis the following are just some of the example use cases bot detection low quality users ip reputation account takeover geo filtering high risk behavior lead generation & user data verification report fraudulent ips, email addresses and previous lookups spam traps list cleaning asset setup this section provides instructions for obtaining information for the swimlane asset action setup retrieve previous requests you can use any standard datetime format, or put in a relative time, on start date or stop date inputs relative datetime format for the current time now any other time (+/ )(integer) (milliseconds|seconds|minutes|days|weeks|months|years) examples now 1 months +3 days 123 seconds limitations currently, swimlane does not support the device tracking api or transaction api if this is something crucial to you, please contact swimlane support documentation email validation documentation https //www ipqualityscore com/documentation/email validation/overviewproxy and vpn detection documentation https //www ipqualityscore com/documentation/proxy detection/overviewfraudulent reporting documentation https //www ipqualityscore com/documentation/fraud reporting/overviewrequest list documentation https //www ipqualityscore com/documentation/request list/overview this connector was last tested against product version 10 3 0 configurations api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required ipqs key api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions email validation detect fraudulent email addresses, spam traps, and honeypots endpoint url api/json/email method get input argument name type required description email string required parameter for email validation output parameter type description status code number http status code of the response reason string response reason phrase message string response message success boolean whether the operation was successful valid boolean unique identifier disposable boolean output field disposable smtp score number score value overall score number score value first name string name of the resource generic boolean output field generic common boolean output field common dns valid boolean unique identifier honeypot boolean output field honeypot deliverability string output field deliverability frequent complainer boolean output field frequent complainer spam trap score string score value catch all boolean output field catch all timed out boolean output field timed out suspect boolean output field suspect recent abuse boolean output field recent abuse fraud score number score value suggested domain string output field suggested domain leaked boolean output field leaked domain age object output field domain age human string output field human example \[ { "status code" 200, "response headers" { "date" "thu, 08 dec 2022 20 51 28 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "cf cache status" "dynamic", "report to" "{\\"endpoints\\" \[{\\"url\\" \\"https \\\\/\\\\/a nel cloudflare com\\\\/report\\\\/v3?s=kqdvfjyjpurxp ", "nel" "{\\"success fraction\\" 0,\\"report to\\" \\"cf nel\\",\\"max age\\" 604800}", "server" "cloudflare", "cf ray" "776861110e35a62f gru", "content encoding" "gzip", "alt svc" "h3=\\" 443\\"; ma=86400, h3 29=\\" 443\\"; ma=86400" }, "reason" "ok", "json body" { "message" "success ", "success" true, "valid" false, "disposable" false, "smtp score" 1, "overall score" 1, "first name" "corporate", "generic" true, "common" false, "dns valid" true, "honeypot" false, "deliverability" "low", "frequent complainer" false, "spam trap score" "none", "catch all" false } } ] proxy and vpn detection provides over 25 data points for risk analysis, geo location, and ip intelligence endpoint url api/json/ip method get input argument name type required description ip string required parameter for proxy and vpn detection strictness string optional parameter for proxy and vpn detection mobile string optional parameter for proxy and vpn detection fast string optional parameter for proxy and vpn detection transaction strictness string optional parameter for proxy and vpn detection user agent string optional parameter for proxy and vpn detection user language string optional parameter for proxy and vpn detection allow public access points string optional parameter for proxy and vpn detection lighter penalties string optional parameter for proxy and vpn detection output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful message string response message fraud score number score value country code string output field country code region string output field region city string output field city isp string output field isp asn number output field asn operating system string output field operating system browser string output field browser organization string output field organization is crawler boolean output field is crawler timezone string output field timezone mobile boolean output field mobile host string output field host proxy boolean output field proxy vpn boolean output field vpn tor boolean output field tor active vpn boolean output field active vpn active tor boolean output field active tor device brand string output field device brand device model string output field device model recent abuse boolean output field recent abuse example \[ { "status code" 200, "response headers" { "date" "thu, 08 dec 2022 21 00 41 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "cf cache status" "dynamic", "report to" "{\\"endpoints\\" \[{\\"url\\" \\"https \\\\/\\\\/a nel cloudflare com\\\\/report\\\\/v3?s=wk3u8ojkeyw73 ", "nel" "{\\"success fraction\\" 0,\\"report to\\" \\"cf nel\\",\\"max age\\" 604800}", "server" "cloudflare", "cf ray" "77686e8d2fc1a4cf gru", "content encoding" "gzip", "alt svc" "h3=\\" 443\\"; ma=86400, h3 29=\\" 443\\"; ma=86400" }, "reason" "ok", "json body" { "success" true, "message" "success", "fraud score" 0, "country code" "hk", "region" "hong kong", "city" "hong kong", "isp" "cloudflare", "asn" 13335, "operating system" "unk unk", "browser" "unk unk", "organization" "cloudflare", "is crawler" false, "timezone" "asia/hong kong", "mobile" false, "host" "one one one one" } } ] report fraudulent addresses this data trains your account's machine learning algorithms that identify high risk behavior among your users, clicks, and transactions endpoint url api/json/report/{{private key}} method get input argument name type required description private key string required parameter for report fraudulent addresses ip string optional parameter for report fraudulent addresses billing first name string optional name of the resource billing last name string optional name of the resource billing company string optional parameter for report fraudulent addresses billing country string optional parameter for report fraudulent addresses billing address 1 string optional parameter for report fraudulent addresses billing address 2 string optional parameter for report fraudulent addresses billing city string optional parameter for report fraudulent addresses billing region string optional parameter for report fraudulent addresses billing postcode string optional parameter for report fraudulent addresses billing email string optional parameter for report fraudulent addresses billing phone string optional parameter for report fraudulent addresses shipping first name string optional name of the resource shipping last name string optional name of the resource shipping company string optional parameter for report fraudulent addresses shipping country string optional parameter for report fraudulent addresses shipping address 1 string optional parameter for report fraudulent addresses shipping address 2 string optional parameter for report fraudulent addresses shipping city string optional parameter for report fraudulent addresses shipping region string optional parameter for report fraudulent addresses shipping postcode string optional parameter for report fraudulent addresses shipping email string optional parameter for report fraudulent addresses shipping phone string optional parameter for report fraudulent addresses username string optional name of the resource output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful message string response message request id string unique identifier example \[ { "status code" 200, "response headers" { "date" "thu, 08 dec 2022 21 55 36 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "cf cache status" "dynamic", "report to" "{\\"endpoints\\" \[{\\"url\\" \\"https \\\\/\\\\/a nel cloudflare com\\\\/report\\\\/v3?s=evza%2f4skd43 ", "nel" "{\\"success fraction\\" 0,\\"report to\\" \\"cf nel\\",\\"max age\\" 604800}", "server" "cloudflare", "cf ray" "7768befc4beca52c gru", "content encoding" "gzip", "alt svc" "h3=\\" 443\\"; ma=86400, h3 29=\\" 443\\"; ma=86400" }, "reason" "ok", "json body" { "success" true, "message" "success", "request id" "9shqtepx4o" } } ] retrieve previous requests allows you to retrieve previous proxy detection api, email validation api and device fingerprinting technology requests based on the date they occurred endpoint url api/json/requests method get input argument name type required description ip address string optional parameter for retrieve previous requests start date string required date value stop date string optional date value tracker id string optional unique identifier limit string optional parameter for retrieve previous requests type string optional type of the resource page string optional parameter for retrieve previous requests device id string optional unique identifier output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful message string response message request id string unique identifier example \[ { "status code" 200, "response headers" { "date" "thu, 08 dec 2022 21 45 37 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "cf cache status" "dynamic", "report to" "{\\"endpoints\\" \[{\\"url\\" \\"https \\\\/\\\\/a nel cloudflare com\\\\/report\\\\/v3?s=svmrvroa39ewu ", "nel" "{\\"success fraction\\" 0,\\"report to\\" \\"cf nel\\",\\"max age\\" 604800}", "server" "cloudflare", "cf ray" "7768b0620d4da511 gru", "content encoding" "gzip", "alt svc" "h3=\\" 443\\"; ma=86400, h3 29=\\" 443\\"; ma=86400" }, "reason" "ok", "json body" { "success" false, "message" "no requests could be found matching your query ", "request id" "9sh8fcvhfz" } } ] response headers header description example alt svc http response header alt svc h3=" 443 "; ma=86400, h3 29=" 443 "; ma=86400 cf cache status http response header cf cache status dynamic cf ray http response header cf ray 776861110e35a62f gru connection http response header connection keep alive content encoding http response header content encoding gzip content type the media type of the resource application/json; charset=utf 8 date the date and time at which the message was originated thu, 08 dec 2022 21 55 36 gmt nel http response header nel {"success fraction" 0 ,"report to" "cf nel","max age" 604800 } report to http response header report to {"endpoints" \[{"url" " https //a nel cloudflare com/report/v3?s=svmrvroa39ewuke4fqdfbtfpviseds1wo3zs25hntveoowwh0cz3m6lbrlcc7ok9xdd4cs08jyt%2feymgavjijjokwuc5qtka1xahm5jpd%2fw6ofc9vcxquldzbljxd8d5d5wkqfyz1ow%3d"}],"group" "cf nel","max age https //a nel cloudflare com/report/v3?s=svmrvroa39ewuke4fqdfbtfpviseds1wo3zs25hntveoowwh0cz3m6lbrlcc7ok9xdd4cs08jyt%2feymgavjijjokwuc5qtka1xahm5jpd%2fw6ofc9vcxquldzbljxd8d5d5wkqfyz1ow%3d"}],"group" "cf nel","max age " 604800 } server information about the software used by the origin server cloudflare transfer encoding http response header transfer encoding chunked notes detailed instructions for how to use each api/connector action are available in the documentation below please read thoroughly to fully understand the use cases that can be set up from within your environment