--- title: Ipqualityscore slug: connectors/ipqualityscore docTags: createdAt: 2026-06-09T16:30:03.411Z --- 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 1. Create an account using the link above. If you have an existing account, log in and skip to step 4. 2. Select **Get Free API Key** on the landing page. This will prompt the registration. 3. Follow the registration steps to create your account. 4. Once you arrive at the Dashboard page, select **API Docs** located in the middle of the screen. 5. Select **Proxy and VPN Detection API** and scroll down until you see the private key. 6. 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. ```javascript 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. ## 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. ### Documentation - [Email Validation Documentation](https://www.ipqualityscore.com/documentation/email-validation/overview) - [Proxy and VPN Detection Documentation](https://www.ipqualityscore.com/documentation/proxy-detection/overview) - [Fraudulent Reporting Documentation](https://www.ipqualityscore.com/documentation/fraud-reporting/overview) - [Request List Documentation](https://www.ipqualityscore.com/documentation/request-list/overview) This connector was last tested against product version: 10.3.0 ## Additional Documentation - [Ipqualityscore Connector Documentation](https://docs.swimlane.com/connectors/ipqualityscore) - [Ipqualityscore API Documentation](https://www.ipqualityscore.com/documentation/overview) - [Ipqualityscore Authentication Guide](https://docs.swimlane.com/authentication-guides/ipqualityscore) # 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** | | ------------------ | -------- | ------------ | ------------------------------------------ | | `parameters.email` | string | Required | Parameters for the Email Validation action | ### Input Example `{"parameters":{"email":"SOAR@swimlane.com"}}` ### 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 | | `domain_age.human` | string | Output field: domain\_age.human | ### Output 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\"; m...` ## 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** | | --------------------------------------- | -------- | ------------ | ------------------------------------------------- | | `parameters.ip` | string | Required | Parameters for the Proxy and VPN Detection action | | `parameters.strictness` | string | Optional | Parameters for the Proxy and VPN Detection action | | `parameters.mobile` | string | Optional | Parameters for the Proxy and VPN Detection action | | `parameters.fast` | string | Optional | Parameters for the Proxy and VPN Detection action | | `parameters.transaction_strictness` | string | Optional | Parameters for the Proxy and VPN Detection action | | `parameters.user_agent` | string | Optional | Parameters for the Proxy and VPN Detection action | | `parameters.user_language` | string | Optional | Parameters for the Proxy and VPN Detection action | | `parameters.allow_public_access_points` | string | Optional | Parameters for the Proxy and VPN Detection action | | `parameters.lighter_penalties` | string | Optional | Parameters for the Proxy and VPN Detection action | ### Input Example `{"parameters":{"ip":"1.1.1.1","strictness":"2","mobile":"","fast":"","transaction_strictness":"2","user_agent":"Mozilla/5.0 () () ","user_language":"fr-CH, fr;q=0.9, en;q=0.8","allow_public_access_points":"","lighter_penalties":""}}` ### 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 | ### Output 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\"; m...` ## 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** | | -------------------------------- | -------- | ------------ | ----------------------------------------------------- | | `path_parameters.private_key` | string | Required | Parameters for the Report Fraudulent Addresses action | | `parameters.ip` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_first_name` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_last_name` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_company` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_country` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_address_1` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_address_2` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_city` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_region` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_postcode` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_email` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.billing_phone` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_first_name` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_last_name` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_company` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_country` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_address_1` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_address_2` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_city` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_region` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_postcode` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_email` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.shipping_phone` | string | Optional | Parameters for the Report Fraudulent Addresses action | | `parameters.username` | string | Optional | Parameters for the Report Fraudulent Addresses action | ### Input Example `{"parameters":{"ip":"1.1.1.1","billing_first_name":"Swimlane","billing_last_name":"Soar","billing_company":"Swimlane","billing_country":"US","billing_address_1":"123 Swimlane Drive","billing_address_2":"Unit 3","billing_city":"Chicago","billing_region":"IL","billing_postcode":"12345","billing_email":"Swimlane@gmail.com","billing_phone":"1234567890","shipping_first_name":"Swimlane","shipping_last_name":"Swimlane","shipping_company":"Swimlane","shipping_country":"US","shipping_address_1":"123 Swimlane Drive","shipping_address_2":"Unit 3","shipping_city":"Chicago","shipping_region":"IL","shipping_postcode":"12345","shipping_email":"swimlane@gmail.com","shipping_phone":"0123456789","username":"user or user@swimlane.com","password_hash":"Password","credit_card_bin":"765987","credit_card_hash":"5fd924625f6ab16a19cc9807c7c506ae1813490e4ba675f843d5a10e0baacdb8","credit_card_expiration_year":"22","credit_card_expiration_month":"05","avs_code":"123","cvv_code":"123","order_amount":"123","order_quantity":"50","recurring":"","recurring_times":"12"},"path_parameters":{"private_key":"TUtZlAfLGn6NSrPEbapRzpid28nbSQdW"}}` ### 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 | ### Output 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\"; m...` ## 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** | | ----------------------- | -------- | ------------ | ---------------------------------------------------- | | `parameters.ip_address` | string | Optional | Parameters for the Retrieve Previous Requests action | | `parameters.start_date` | string | Required | Parameters for the Retrieve Previous Requests action | | `parameters.stop_date` | string | Optional | Parameters for the Retrieve Previous Requests action | | `parameters.tracker_id` | string | Optional | Parameters for the Retrieve Previous Requests action | | `parameters.limit` | string | Optional | Parameters for the Retrieve Previous Requests action | | `parameters.type` | string | Optional | Parameters for the Retrieve Previous Requests action | | `parameters.page` | string | Optional | Parameters for the Retrieve Previous Requests action | | `parameters.device_id` | string | Optional | Parameters for the Retrieve Previous Requests action | ### Input Example `{"parameters":{"ip_address":"8.8.8.8","start_date":"2020-01-01 00:00:00","stop_date":"2023-01-01 00:00:00","tracker_id":"123","limit":"25","type":"email","page":"2","device_id":"323"}}` ### 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 | ### Output 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\"; m...` # 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 | 77686e8d2fc1a4cf-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":604800} | | Server | Information about the software used by the origin server | cloudflare | | Transfer-Encoding | HTTP response header: Transfer-Encoding | chunked |