Once you've uploaded your CSV for processing, you'll likely want to retrieve the current status of the processing until the CSV has finished processing. This bulk verification API returns the status of your CSVs which are processing or completed. Once a bulk upload has finished processing, the status will display as "FINISHED" along with a series of one-time download links which can be used to retrieve the results.
Download links are only valid for 15 minutes from the time you request this API or when the link is downloaded, whichever comes first.
Each request to this API will result in fresh links being made available if the CSV has finished processing.
Download links contain a one-time use authentication key which WILL NOT require login to retrieve. Treat these links like passwords!
You must supply the CSV ID in the request URL or via POST parameters.
When you finish uploading a file a successful response should look like this:
Once your file has finished processing downloads will contain links to retrieve your results.
If we're unable to retrieve data about your chosen CSV or there's another issue, you may receive an error response such as:
|message||Messages about the status of your request to include potential errors.||string|
|success||True if this request was successful, false if unsuccessful.||boolean|
|id||The unique, numeric, ID of the file being processed.||int64|
|file_name||The name of the file or an automatically generated name if no name was specified during upload.||string|
|type||The type of CSV that was uploaded. Value can be: "proxy", "url", "email", or "phone".||string/enum|
|strictness||The strictness level of this file's processing. (Integer 0 - 3, 0 = default). We recommend the default strictness level.||int|
The current status of the CSV's processing.
|aborted||True if processing on this CSV was cancelled before completion.||boolean|
|invalid_records||The current number of invalid records detected in the CSV.||int|
A list of available download links. Unavailable or impossible links will return null.