AI SCORING API: FILE STATUS

Would you like to see the status of a file you submitted via the ZeroBounce email scoring API? You can check it at any time and see details about your credit usage and processed data.

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

GET /V2/SCORING/FILESTATUS

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

URL Parameters

  • Parameter
    Required / Optional
    Description
  • api_key
    Required
    Your API Key, found in your account
  • file_id
    Required
    The returned file ID when calling scoring sendfile API

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

FILE STATUS CODE SAMPLES

ENDPOINT RESPONSE

Below we provide examples of both successful and unsuccessful responses for using the filestatus API.

This is an example of a successful 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",
        "complete_percentage": "100%",
        "return_url": "Your return URL if provided when calling sendfile API"
    }
This is an example of an error response:

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

Using the email scoring API to further validate catch-all emails allows you to automate this process and save time. ZeroBounce will use one credit for every email address the scoring system processes.

Need more help regarding your email scoring API file status? Please reach out to our customer support team – we’re always available to answer and questions and guide you.