Creating Allowlist Entries API Overview


Utilize the Allowlist API to manage your account's allowlisted variables. You may use the following endpoint to create an entry, which overrides the "fraud_score" value to 0 and sets all risk analysis variables as "false". If the API type supports a "valid" or "active" field (such as our email validation or phone validation API endpoints), then these values will always be "true". You can also add a reason why each entry made this list.

Example API URLs
JSON:

NOTE: Do not share this key with anyone. It's like a password and can be used to make queries using our API.

Required GET/POST Parameters:

This API endpoint has 3 required input parameters, and 1 optional parameter.

Required:

  • value - The value you wish to allow list.
  • value_type - What kind of value you're allow listing (EG: ip, cidr, etc... see below)
  • type - What API you wish to allow list this value for. (One of: proxy, url, email, phone, mobiletracker, devicetracker)

Optional:

  • reason - Why did this entry make your allow list.
Accepted Type Accepted value_types Description
proxy ip The IP you wish to add to the allow list. (EG: 1.1.1.1)
cidr A CIDR (formatted ip/network) you wish to add to the allow list. (EG: 1.1.1.0/24)
isp The name of an ISP you wish to allow list.
Accepted Type Accepted value_types Description
devicetracker deviceid The DeviceID you wish to allow list. (EG: b2q3...)
ip The IP you wish to add to the allow list. (EG: 1.1.1.1)
cidr A CIDR (formatted ip/network) you wish to add to the allow list. (EG: 1.1.1.0/24)
isp The name of an ISP you wish to allow list. (EG: Spectrum)
Accepted Type Accepted value_types Description
mobiletracker deviceid The DeviceID you wish to allow list. (EG: b2q3...)
ip The IP you wish to add to the allow list. (EG: 1.1.1.1)
cidr A CIDR (formatted ip/network) you wish to add to the allow list. (EG: 1.1.1.0/24)
isp The name of an ISP you wish to allow list. (EG: Spectrum)
Accepted Type Accepted value_types Description
email email The email you wish to allow list. (EG: noreply@ipqualityscore.com)
Accepted Type Accepted value_types Description
url domain The domain you wish to allow list. (EG: ipqualityscore.com)
Accepted Type Accepted value_types Description
phone phone The phone number you wish to allow list. (EG: 1-800-713-2618 or 18007132618)
Accepted Type Accepted value_types Description
custom your_custom_variable (EG: userID) The variable you wish to block list. (EG: 1234)
Example Response
Example Code