<< Back to Categories

Creating Allowlist Entries

About

You can use 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 the email verification or phone verification API endpoints), these values will always be true. You can also add a reason why each entry made this list.

API Request URL

Request 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	Description	Accepted value_types
proxy	The IP you wish to add to the allowlist. (e.g., 1.1.1.1)	ip
	A CIDR (formatted IP/network) you wish to add to the allowlist. (e.g., 1.1.1.0/24)	cidr
	The name of an ISP you wish to allowlist.	isp
devicetracker	The DeviceID you wish to allowlist. (e.g., b2q3...)	deviceid
	The IP you wish to add to the allowlist. (e.g., 1.1.1.1)	ip
	A CIDR (formatted IP/network) you wish to add to the allowlist. (e.g., 1.1.1.0/24)	cidr
	The name of an ISP you wish to allowlist. (e.g., Spectrum)	isp
mobiletracker	The DeviceID you wish to allowlist. (e.g., b2q3...)	deviceid
	The IP you wish to add to the allowlist. (e.g., 1.1.1.1)	ip
	A CIDR (formatted IP/network) you wish to add to the allowlist. (e.g., 1.1.1.0/24)	cidr
	The name of an ISP you wish to allowlist. (e.g., Spectrum)	isp
email	The email you wish to allowlist. (e.g., noreply@ipqualityscore.com)	email
url	The domain you wish to allow list. (e.g., ipqualityscore.com)	domain
phone	The phone number you wish to allowlist. (e.g., 1-800-713-2618 or 18007132618)	phone
custom	The variable you wish to allowlist. (e.g., 1234)	your_custom_variable (e.g., userID)

Example Response

This is an example success response in JSON format. Responses are also available in XML format.

{
    "success":true,
    "message":"Successfully inserted Allow List entry.",
    "request_id":"CXSWDmbNcw"
}

EXAMPLE CODE

<?php

/*
* Create an entry in the Allowlist.
*/

// create post fields
$post = [
    'value' => '1.1.1.1',
    'value_type' => 'ip',
    'type'   => 'proxy',
    'reason' => 'The reason this entry is on the Allowlist.'
];

// Initialise the cURL var
$ch = curl_init();

// Get the response from cURL
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Set type to POST
curl_setopt($ch,CURLOPT_POST, 1);   

// Set the POST parameters
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);

// Set the endpoint to request.
curl_setopt($ch, CURLOPT_URL, 'https://ipqualityscore.com/api/json/allowlist/create/YOUR_API_KEY_HERE');

// Execute the request
$raw_response = curl_exec($ch);

// Decode the response.
$response = json_decode($raw_response, true);

// Print out the result or error.
if($response['success']){
    echo "Entry created successfully!";
} else {
    echo "Failed to create entry: ".$response['message'];
}

Ready to eliminate fraud?

Start fighting fraud now with 5,000 Free Lookups!

We're happy to answer any questions or concerns.

Chat with our fraud detection experts any day of the week.

Call us at: (800) 713-2618

Schedule a Demo Sign Up