Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

The IPQualityScore fraud detection API suite features a variety of different risk analysis APIs designed to Proactively Prevent Fraud™ with industry leading accuracy to identify fraudulent users, suspicious payments, and abusive behavior.

Connect IP Quality Score with Devo SOAR

  1. Navigate to Automations > Integrations.

  2. Search for IP Quality Score.

  3. Click Details, then the + icon. Enter the required information in the following fields.

  4. Label: Enter a connection name.

  5. Reference Values: Define variables here to templatize integration connections and actions. For example, you can use https://www.{{hostname}}.com where, hostname is a variable defined in this input. For more information on how to add data, see 'Add Data' Input Type for Integrations.

  6. Verify SSL: Select option to verify connecting server's SSL certificate (Default is Verify SSL Certificate).

  7. Remote Agent: Run this integration using the Devo SOAR Remote Agent.

  8. API Key: The API key to connect to the IP Quality Score.

  9. After you've entered all the details, click Connect.

Stats and Average

This action is to retrieve average fraud rates so your platform can perform the necessarily business logic to mitigate any potential risk.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

Params

Jinja-templated JSON containing the params to be passed to the API.

Optional

Output

JSON containing the following items:

``` {json}{ "message": "Unable to locate records matching your request.", "success": false, "error": null, "has_error": false }

## User, Payment, & Transaction Fraud Detection

User data for orders, payments, transactions, lead generation, and personal user information can be analyzed to enhance Fraud Scores.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

| Input Name | Description                                                                               | Required |
| :--------- | :---------------------------------------------------------------------------------------- | :------- |
| Params     | [Jinja-templated](doc:jinja-template) JSON containing the params to be passed to the API. | Optional |
| IP         | [Jinja-templated](doc:jinja-template) containing the IP.                                  | Required |

### Output

JSON containing the following items:


``` {json}{
  "zip_code": "N/A",
  "organization": "Cloudflare",
  "city": "Hong Kong",
  "ASN": 13335,
  "ISP": "Cloudflare",
  "success": true,
  "latitude": 22.28000069,
  "vpn": false,
  "active_vpn": false,
  "connection_type": "Premium required.",
  "fraud_score": 0,
  "host": "one.one.one.one",
  "timezone": "Asia/Hong_Kong",
  "tor": false,
  "abuse_velocity": "Premium required.",
  "longitude": 114.15000153,
  "country_code": "HK",
  "has_error": false,
  "is_crawler": false,
  "error": null,
  "proxy": false,
  "bot_status": true,
  "request_id": "7BfASDkSb",
  "region": "Hong Kong",
  "message": "Success",
  "mobile": false,
  "recent_abuse": false,
  "active_tor": false
}

Postback API & Conversion Notifications

IPQS Postback API allows you to alter previous Proxy Detection API requests to our API based on new or additional data for the purposes of receiving a new fraud score.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

Params

Jinja-templated JSON containing the params to be passed to the API.

Optional

Output

JSON containing the following items:

``` {json}{ "success": false, "has_error": false, "error": null, "request_id": "7BfN7ASDN", "message": "" }

## Email Validation

IPQualityScore's Email Validation API estimates deliverability rates by detecting invalid mailboxes as well as disposable and fraudulent email addresses, spam traps, and honeypots via our simple to use Email Reputation API.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

| Input Name | Description                                                                               | Required |
| :--------- | :---------------------------------------------------------------------------------------- | :------- |
| Email      | [Jinja-templated](doc:jinja-template) containing the email to be passed to the API.       | Required |
| Params     | [Jinja-templated](doc:jinja-template) JSON containing the params to be passed to the API. | Optional |

### Output

JSON containing the following items:


``` {json}{
  "domain_age": {
    "human": "12 years ago",
    "timestamp": 1270058717,
    "iso": "2010-03-31T14:05:17-04:00"
  },
  "first_name": "ABC",
  "disposable": false,
  "honeypot": false,
  "success": true,
  "deliverability": "high",
  "associated_names": {
    "status": "Enterprise Plus or higher required.",
    "names": []
  },
  "fraud_score": 0,
  "overall_score": 4,
  "domain_velocity": "Enterprise Mini or higher required.",
  "sanitized_email": "indrajeet@logichub.com",
  "timed_out": false,
  "generic": false,
  "user_activity": "Enterprise L4+ required.",
  "catch_all": false,
  "has_error": false,
  "common": false,
  "error": null,
  "leaked": false,
  "frequent_complainer": false,
  "smtp_score": 3,
  "suggested_domain": "N/A",
  "spam_trap_score": "none",
  "suspect": false,
  "valid": true,
  "request_id": "7BfQASD71v",
  "message": "Success.",
  "dns_valid": true,
  "first_seen": {
    "human": "just now",
    "timestamp": 1663216382,
    "iso": "2022-09-15T00:33:02-04:00"
  },
  "associated_phone_numbers": {
    "status": "Enterprise Plus or higher required.",
    "phone_numbers": []
  },
  "recent_abuse": false
}

Device Fingerprint Verification

A simple API that can retrieve the results server side. Requests to this API and all reporting APIs will not consume an API lookup credit.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

User IP

Jinja-templated containing the user ip to be passed to the API.

Required

Device Id

Jinja-templated containing the device id to be passed to the API.

Required

Params

Jinja-templated JSON containing the params to be passed to the API.

Optional

Output

JSON containing the following items:

``` {json}{ "message": "Invalid IP/Device ID.", "success": false, "error": null, "has_error": false }

## Phone Number Validation

IPQualityScore's Phone Number Validation API enables quick user verification and chargeback defense on a global scale by analyzing phone numbers to verify their risk score, country of origin, carrier, validity, and line connection status while also detecting fraudulent activity in real time.

### Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

| Input Name | Description                                                                               | Required |
| :--------- | :---------------------------------------------------------------------------------------- | :------- |
| User Phone | [Jinja-templated](doc:jinja-template) containing the user phone to be passed to the API.  | Required |
| Params     | [Jinja-templated](doc:jinja-template) JSON containing the params to be passed to the API. | Optional |

### Output

JSON containing the following items:


``` {json}{
  "zip_code": "110040",
  "city": "New Delhi",
  "risky": false,
  "name": "N/A",
  "success": true,
  "carrier": "Idea Cellular",
  "associated_email_addresses": {
    "status": "Enterprise Plus or higher required.",
    "emails": []
  },
  "fraud_score": 0,
  "sms_domain": "ideacellular.net",
  "timezone": "Asia/Kolkata",
  "mnc": "N/A",
  "formatted": "+9181231231239",
  "local_format": "081231231239",
  "spammer": false,
  "active_status": "N/A",
  "country": "IN",
  "user_activity": "Enterprise L4+ required.",
  "has_error": false,
  "prepaid": false,
  "error": null,
  "leaked": false,
  "line_type": "Wireless",
  "mcc": "N/A",
  "do_not_call": false,
  "VOIP": false,
  "valid": true,
  "request_id": "7BfZzSeGUy",
  "sms_email": "08512001119@ideacellular.net",
  "region": "India",
  "message": "Phone is valid.",
  "dialing_code": 91,
  "recent_abuse": false,
  "active": true
}

Fraud Reporting

IPQualityScore allows you to report fraudulent IP addresses, email addresses, phone numbers, transactions, and similar user data through our Fraud Fusion™ program. Data passed through this API endpoint trains your account's machine learning algorithms that identify high risk behavior among your users, clicks, and transactions.

Input Field

Choose a connection that you have previously created and then fill in the necessary information in the following input fields to complete the connection.

Input Name

Description

Required

Params

Jinja-templated JSON containing the params to be passed to the API.

Optional

Output

JSON containing the following items:

{json}{ "success": true, "has_error": false, "error": null, "request_id": "7BfvASDtyC", "message": "Success" }

Release Notes

  • v2.0.0 - Updated architecture to support IO via filesystem

  • v1.0.1 - Added 7 new actions: Stats and Average, User, Payment & Transaction Fraud Detection, Postback API & Conversion Notifications, Email Validation, Device Fingerprint Verification, Phone Number Validation and Fraud Reporting.

  • No labels