IPQS
Refresh Secret

About Refreshing Secrets

You can call the refresh API to request a fresh API secret for a given user. This will generate and return a new API secret, which you can use to make future requests. You are encouraged to refresh periodically and whenever you have reason to believe your user's API secret may have been compromised.

Request URL

Warning

For security reasons, you should only call this API server-side.

Below is an example of a refresh URL:

https://www.ipqualityscore.com/webhooks/EXAMPLE-INTEGRATION/json/refresh

Request Parameters

Parameter Description Example Value / Format
key Required. Your site's domain or the domain that requested this integration. google.com
secret Required. Your user's current secret created during the authentication process. char(128)

Response Parameters

Note

Only JSON responses are available from this API.

Parameter Description Example Value / Format
message Description of the status of this call. May contain errors if errors exist. text
success Boolean result of if the request was successful or not. boolean
secret The user's new secret created by this request and used for all future authentication. char(128)
// URL for this request.
$URL = 'https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/refresh';

// Configuration items for this request. NOTE: $secret will be user specific not application specific.
$key = 'example.com';
$secret = 'YOUR_API_KEY_HERE';

// Prepare POST fields.
$fields = array(
	'secret' => $secret,
	'key' => $key
);
	
// Create CURL.
$curl = curl_init();
	
// Configure CURL
curl_setopt($curl, CURLOPT_URL, $URL);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_POST, 1);

// Set POST Parameters
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($fields));

// Fetch URL
$result = curl_exec($curl);

// GET response code.
$response_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);

// Close CURL
curl_close($curl);
	
// Handle result.
if((int) $response_code === 200){
	// JSON Decode
	$output = json_decode($result, true);
	
	// Store new secret.
	// $output['secret'];
} else {
	echo "There appears to be an unforeseen error. Please contact IPQualityScore support if this persists.";
}

Ready to eliminate fraud?

Start fighting fraud now with 1,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