IPQS supports bulk CSV file uploading via HTTP POST file upload, URL file retrieval, and JSON. All of these upload methods work via the same URL but may require additional parameters.
Allowed file types are:
| Warning: This API will return responses containing your API key. Treat these responses like passwords and do not share them with third parties. |
Replace YOUR_FILE_TYPE with the file type you are uploading (e.g., email, phone, etc.)
You may optionally remove the key and type of file from the URL and pass them in as POST, GET, or JSON parameters instead. In which case, the URL would look like this:
To upload via Post / file upload, you will need to include the following headers with your request.
Include one file in the body of your request with any key.
The request must be form-data encoded.
Headers
| Field | Value |
| Content-Type | multipart/form-data |
| Content-Length | Calculated when request is sent |
GET / POST / URL Parameters
| Field | Value |
| key | Your API Key. |
| type | The type of CSV ("proxy", "email", "url", or "phone"). |
| file_name | An optional name for this file. A name will automatically be generated if none is supplied. |
You can upload your file by providing us with the file's download URL via either GET or POST parameters.
Your URL must lead directly to the file, include the protocol (http, https, or ftp), and include any authentication methods in the URL.
GET / POST Parameters
| Field | Value |
| key | Your API Key. |
| type | The type of CSV ("proxy", "email", "url", or "phone"). |
| input OR url | The full link to download the file you wish to process. |
| file_name | An optional name for this file. A name will automatically be generated if none is supplied. |
You can upload your data for processing via JSON.
| Note: When uploading via JSON, you must include the header Content-type: application/json. |
Headers
| Field | Value |
| Content-Type | application/json |
IP Risk Scoring
This is an example request for uploading a CSV containing IP addresses.
Email Verification
This is an example request for uploading a CSV containing email addresses.
Phone Verification
This is an example request for uploading a CSV containing phone numbers.
Malicious URL Scanning
This is an example request for uploading a CSV containing URLs.
This is an example success response in JSON format. Responses are also available in XML format.
This is an example failure response that you may encounter when submitting an invalid CSV URL.
After uploading your data, check the verification status and download the results.
We're happy to answer any questions or concerns.
Chat with our fraud detection experts any day of the week.