FILE STATUS CODE SAMPLES

Would you like to check the status of a file you submitted for email validationⓘ via the ZeroBounce API? You can do that at any time – please see our instructions below.

The filestatus API returns the file processing status for the file that has been submitted using the sendfile API. Please refer to the C# example for details.

GET /V2/FILESTATUS

API URL: https://bulkapi.zerobounce.net/v2/filestatus

If you want to call the API from your browser to test it, all you have to do is to replace the API KEY with your unique API key and the FILE ID with the returned file ID from sendfile API:

https://bulkapi.zerobounce.net/v2/filestatus?api_key=[replacewithyours]&file_id=[replacewithyours]

FILE STATUS CODE SAMPLES

Below you can find samples of both successful and error responses.

ENDPOINT RESPONSE

  {
    "success": true,
    "file_id": "aaaaaaaa-zzzz-xxxx-yyyy-5003727fffff",
    "file_name": "Your file name.csv",
    "upload_date": "2023-04-28T15:25:41Z",
    "file_status": "Complete",
    "file_phase_2_status": "N/A",
    "complete_percentage": "100%",
    "return_url": "Your return URL if provided when calling sendfile API"
  }
  

Successful Response - phase 2 enabled

  {
    "success": true,
    "file_id": "aaaaaaaa-zzzz-xxxx-yyyy-5003727fffff",
    "file_name": "Your file name.csv",
    "upload_date": "2023-04-28T15:25:41Z",
    "file_status": "Complete",
    "file_phase_2_status": "Complete",
    "complete_percentage": "100%",
    "return_url": "Your return URL if provided when calling sendfile API"
  }
  

Other possible statuses for "file_phase_2_status":

file_status=Queued → file_phase_2_status="Queued"
file_status=Processing → file_phase_2_status="Processing"
file_status=CatchAllProcessing → file_phase_2_status="Processing"
file_status=Complete → file_phase_2_status="Complete"

NOTE: For all other statuses, "file_phase_2_status" will copy the value of "file_status", like it does for Queued, Processing, Complete.

Error Response

  {      
    "success": false,
    "error_message": "Error messages"
  }
  

Using the email validationⓘ API is an effective way to prevent erroneous and poor-quality data from entering your email lists. You can use the API in either bulk or real time. For each email address it verifies, the API consumes one credit from your ZeroBounce account. If you use the API on a consistent basis, please make sure your account is replenished periodically with credits.

Need help determining the status of your email validationⓘ API files? Please reach out to our Customer Support team. We are available around the clock to answer any questions and assist you.