| Parameter Name | Description | Expected Values | Update Example |
| ConversionStatus | Allows you to flag a request as having led to a conversion. | Boolean, string true or string false | update[ConversionStatus]=true |
| ConversionDate | Allows you to set a date the request was made a conversion. | Date formatted yyyy-mm-dd or yyyy-mm-dd hh-mm-ss | update[ConversionDate]=2017-01-01 |
| ClickDate | Allows you to alter the first seen date on a device. | Date formatted yyyy-mm-dd or yyyy-mm-dd hh-mm-ss | update[ClickDate]=2017-01-01 |
| user_agent | Updates the user agent string. | String | update[user_agent]=Lynx/2.8.7dev.9%20libwww-FM/2.14 |
| language | Updates the chosen language of the user's browser. | String | update[language]=en-US |
| request_id | A unique ID is provided for each request. You can use this ID for lookups. | String | request_id=DWwJ |
| type | Required for request lookups when you don't provide a "request_id". Fetches a request of this type. | String ("proxy", "email", "devicetracker", or "mobiletracker") | type=devicetracker |
| tracker_id | This optional parameter narrows the scope of a variable lookup for a device tracker postback. | Integer (number associated with your tracker in the IPQS device tracker management screen.) | tracker_id=233 |
| newest | Defaults to "false". When set to "true", the API chooses the most recent request if there are multiple requests with your specified parameters. | Boolean (true/false) | newest=true |
Advanced Options
Additional Request Parameters
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.
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.
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
XML
| Method | Value | Example |
| GET | key | key=MLXgZDE46iPuRm5ok8K76QKd83bdkmH2&phone=18007132618 |
| POST | key | key=MLXgZDE46iPuRm5ok8K76QKd83bdkmH2&phone=18007132618 |
| Header | IPQS-KEY (Additional parameters passed as either GET or POST) | IPQS-KEY: MLXgZDE46iPuRm5ok8K76QKd83bdkmH2 |
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.
Next Steps
Learn more about each of the variables included in the responses you receive.