API Data Provider - Online Help

Connecting to ZeroBounce

Using API Key Authentication

ZeroBounce uses API key authentication. To obtain an API key:

  1. Log in to your ZeroBounce account at https://app.zerobounce.net
  2. Navigate to the API tab in your account dashboard
  3. Copy the API key displayed on the page

After obtaining your API key, set the following connection properties:

  • AuthScheme: Set this to APIKey.
Set the following in the ProfileSettings connection property:
  • APIKey: Set this to your ZeroBounce API key.

Example Connection String

Profile=C:\profiles\ZeroBounce.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Available Tables

The ZeroBounce API Profile provides access to the following tables:

  • Credits: Retrieve the remaining validation credits for the ZeroBounce account
  • ApiUsage: Retrieve API usage statistics for a specified date range (requires StartDate and EndDate)
  • ActivityData: Retrieve email activity data for a specified email address (requires Email)
  • EmailValidation: Validate an email address in real time (requires Address)
  • EmailScoring: Retrieve the AI-based quality score for an email address (requires Email)
  • EmailFinder: Discover the email address format used by a company or domain (requires Domain or CompanyName)
  • BulkValidationFiles: Retrieve the processing status of a bulk email validation file (requires FileId)
  • AIScoringFiles: Retrieve the processing status of a bulk AI email scoring file (requires FileId)

Usage Examples

Credits:

SELECT * FROM Credits

ApiUsage:

SELECT * FROM ApiUsage WHERE StartDate = '2024-01-01' AND EndDate = '2024-01-31'

ActivityData:

SELECT * FROM ActivityData WHERE Email = '[email protected]'

EmailValidation:

SELECT * FROM EmailValidation WHERE Address = '[email protected]'

EmailValidation with optional parameters:

SELECT * FROM EmailValidation WHERE Address = '[email protected]' AND IpAddress = '99.110.204.1'

EmailScoring:

SELECT * FROM EmailScoring WHERE Email = '[email protected]'

EmailFinder by domain:

SELECT * FROM EmailFinder WHERE Domain = 'example.com'

EmailFinder by company name:

SELECT * FROM EmailFinder WHERE CompanyName = 'Example Corp'

BulkValidationFiles:

SELECT * FROM BulkValidationFiles WHERE FileId = 'your-file-id'

AIScoringFiles:

SELECT * FROM AIScoringFiles WHERE FileId = 'your-file-id'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey The API key used to authenticate requests to the ZeroBounce API.
AuthScheme The scheme used for authentication. Accepted entries are APIKey or None.
Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9655.0