- About the IPQS APIs
- Proxy & VPN Detection API
- Email Verification API
- Phone Number Validation API
- Malicious URL Scanner API
- Device Fingerprint API
- Mobile Device Fingerprinting SDK
- Gaming Fraud Detection SDK
- Dark Web Leak API
- Malware File Scanner API
- Request List API
- Fraud Reporting API
- Account Management APIs
- Bulk Validation CSV
- Allowlist Blocklist APIs
- Plugins Platforms Integrations
- IP Reputation Database
- IP Address Abuse Feed
- Email Verification Database
-
Custom Integrations
- Getting Started
- Authentication
- Refresh Secret
- IP & Proxy Checks
- Email Verification Checks
- Phone Number Validity Checks
- Device Tracker
- List Device Trackers
- Device Tracker Statistics
- Login Tokens
- Overview Statistics
- Recent Proxy Statistics
- Recent Email Statistics
- Fraud Reporting
- Retrieve Requests by ID
- Country List API Documentation
- Release Notes
Additional Request Parameters
| Parameter Name | Description | Expected Values | Example |
|---|---|---|---|
| strictness | How in depth (strict) the reputation check should be. Stricter checks may provide a higher false-positive rate. We recommend starting at "0", the lowest strictness setting, and increasing to "1" or "2" depending on your levels of fraud. | Integer | strictness=1 |
| country | Optionally provide the default country or countries this phone number is suspected to be associated with. The API will prefer to use a country on this list for verification or will require a country to be specified in the event the phone number is less than 10 digits. | string or array of strings | country[]=UK |
Custom Variables
You can pass custom tracking variables (such as userID and transactionID) established in your account settings with each API request. This allows our reporting tools to filter by specific variables such as users, products, campaigns, and transactions so you can easily match up records with your system to identify fraudulent activity.
Making Requests Without Passing API Key in URL
Due to the nature of platform requirements or frameworks, you may need to request the Phone Number Validation API endpoints without passing the API key to the URL. You can alternatively pass the Phone Validation API key via GET, POST, or Headers. These requests use the following endpoints:
JSON
https://ipqualityscore.com/api/json/phone
XML
https://ipqualityscore.com/api/xml/phone
| Method | Value | Example |
|---|---|---|
| GET | key | key=YOUR_API_KEY&phone=18007132618 |
| POST | key | key=YOUR_API_KEY&phone=18007132618 |
| Header | IPQS-KEY (Additional parameters passed as either GET or POST) | IPQS-KEY: YOUR_API_KEY |
Bulk Phone Validation
You can upload a large list of phone numbers for batch processing through the Phone Number Validation API.
For information about bulk validation, see Bulk Validation CSV API.
Reporting Fraud and Improving Machine Learning
Train your account's machine learning algorithms to better identify fraud for your audience. You can use the following endpoint to report phone numbers as fraudulent. Please only report data that is highly likely to be abusive.
Replace USER_PHONE_HERE with the phone number to report.
https://ipqualityscore.com/api/json/report/YOUR_API_KEY_HERE?country=US&phone=USER_PHONE_HERE
Next Steps
Learn more about each of the variables included in the responses you receive.