Bulk verification

Retrieve bulk email verification results in JSON format

Retrieve verification results for a bulk email verification task using a task ID in JSON format. Results are available within 90 days of verification.<br><br> When making a request with the state parameter included, you might not receive all the verified results if the task is not yet finished. To obtain a comprehensive list of the verified emails that have been processed so far, you should omit the state parameter from your request.

get/v1/verify/bulk/dump

Request

  • Base URL: https://api.bounceban.com
  • URL: https://api.bounceban.com/v1/verify/bulk/dump
  • Auth: API key in header Authorization

Query parameters

idstring required

Bulk email verification task ID.

state'' | 'deliverable' | 'risky' | 'undeliverable' | 'unknown'

Specifies emails to retrieve based on verification state (deliverable, undeliverable , risky, or unknown). If not set, all emails will be returned. When making a request with the state parameter included, you might not receive all the verified results if the task is not yet finished. To obtain a comprehensive list of the verified emails that have been processed so far, you should omit the state parameter from your request.

cursorstring

(Optional) Provide this parameter to retrieve results from the next page. You can obtain the cursor value from the previous rquest response. <br> If retrieve_all is set to 1, the page_size and cursor parameters will be ignored.

page_sizeinteger

(Optional) Specify the number of emails to return per request. Default: 100. Maximum: 3,000. Minimum: 100. <br> If retrieve_all is set to 1, the page_size and cursor parameters will be ignored.

retrieve_all'' | '1'

(Optional) Retrieve all emails for the task by setting this parameter to 1. Default: Disabled (empty). <br> Important Notes: If retrieve_all is set to 1, the page_size and cursor parameters will be ignored. This parameter is only effective if the total number of emails for the task is less than or equal to 20,000.

Response

Indicates the request is successful.

result'ok' | 'err'

ok Indicates the request is successful.<br> err The bulk task has not finished yet, please try again later.

status'importing' | 'verifying' | 'finished'

Bulk email verification task status.

importing indicates the list of emails are being imported for verification.<br> verifying indicates all the emails are imported and are being verified.<br> finished indicates verification for the whole list has finished.

cursorstring

Use this value to retrieve next page.

Changes

No recorded changes to this operation across all 1 revision of this API.