API QUICKSTART
Version 2: Getting Started
POSTMAN COLLECTION
To test version 2 of the API in Postman, save the Postman Collection contents as a .json file or you can get the file from our GitHub repository.
In Postman, on the top menu, click on File, then choose Import. Then choose the JSON file you saved or downloaded from GitHub to import it.
Postman Collection JSON file:
{
"info": {
"_postman_id": "948780e4-bf36-4c9c-bb29-2c32c9053091",
"name": "ZeroBounce API v2",
"schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
},
"item": [
{
"name": "Validate Emails",
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.zerobounce.in/v2/validate?api_key=replacewithyours&email=replacewithyours&ip_address=",
"protocol": "https",
"host": [
"api",
"zerobounce",
"net"
],
"path": [
"v2",
"validate"
],
"query": [
{
"key": "api_key",
"value": "replacewithyours",
"description": "Your API Key, found in your account."
},
{
"key": "email",
"value": "replacewithyours",
"description": "The email address you want to validate"
},
{
"key": "ip_address",
"value": "",
"description": "The IP Address the email signed up from (Can be blank, but parameter required)"
}
]
},
"description": "API for single email address validation."
},
"response": []
},
{
"name": "Get Credit Balance",
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.zerobounce.in/v2/getcredits?api_key=replacewithyours",
"protocol": "https",
"host": [
"api",
"zerobounce",
"net"
],
"path": [
"v2",
"getcredits"
],
"query": [
{
"key": "api_key",
"value": "replacewithyours",
"description": "Your API Key, found in your account."
}
]
},
"description": "This API will tell you how many credits you have left on your account."
},
"response": []
},
{
"name": "Send File",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"description": "csv or txt file",
"type": "file",
"src": ""
},
{
"key": "api_key",
"value": "replacewithyours",
"description": "Your API Key, found in your account. (Required)",
"type": "text"
},
{
"key": "return_url",
"value": "",
"description": "The URL will be used to call back when the validation is completed. (Optional)",
"type": "text",
"disabled": true
},
{
"key": "email_address_column",
"value": "replacewithyours",
"description": "The column index of the email address in your file. Index starts from 1. (Required, number)",
"type": "text"
},
{
"key": "first_name_column",
"value": "",
"description": "The column index of the first name column. (Optional, number)",
"type": "text",
"disabled": true
},
{
"key": "last_name_column",
"value": "",
"description": "The column index of the last name column. (Optional, number)",
"type": "text",
"disabled": true
},
{
"key": "gender_column",
"value": "",
"description": "The column index of the gender column. (Optional, number)",
"type": "text",
"disabled": true
},
{
"key": "ip_address_column",
"value": "",
"description": "The IP Address the email signed up from. (Optional, number)",
"type": "text",
"disabled": true
},
{
"key": "has_header_row",
"value": "",
"description": "If the first row from the submitted file is a header row. (Optional, true/false)",
"type": "text",
"disabled": true
}
]
},
"url": "https://bulkapi.zerobounce.in/v2/sendfile",
"description": "This API allows user to send a file for bulk email validation."
},
"response": []
},
{
"name": "File Status",
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://bulkapi.zerobounce.in/v2/filestatus?api_key=replacewithyours&file_id=replacewithyours",
"protocol": "https",
"host": [
"bulkapi",
"zerobounce",
"net"
],
"path": [
"v2",
"filestatus"
],
"query": [
{
"key": "api_key",
"value": "replacewithyours",
"description": "Your API Key, found in your account."
},
{
"key": "file_id",
"value": "replacewithyours",
"description": "The returned file ID when calling sendfile API."
}
]
},
"description": "The API returns the file processing status for the file been submitted using sendfile API."
},
"response": []
},
{
"name": "Get File",
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://bulkapi.zerobounce.in/v2/getfile?api_key=replacewithyours&file_id=replacewithyours",
"protocol": "https",
"host": [
"bulkapi",
"zerobounce",
"net"
],
"path": [
"v2",
"getfile"
],
"query": [
{
"key": "api_key",
"value": "replacewithyours",
"description": "Your API Key, found in your account."
},
{
"key": "file_id",
"value": "replacewithyours",
"description": "The returned file ID when calling sendfile API."
}
]
},
"description": "The API allows users to get the validation results file for the file been submitted using sendfile API."
},
"response": []
},
{
"name": "Delete File",
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://bulkapi.zerobounce.in/v2/deletefile?api_key=replacewithyours&file_id=replacewithyours",
"protocol": "https",
"host": [
"bulkapi",
"zerobounce",
"net"
],
"path": [
"v2",
"deletefile"
],
"query": [
{
"key": "api_key",
"value": "replacewithyours",
"description": "Your API Key, found in your account."
},
{
"key": "file_id",
"value": "replacewithyours",
"description": "The returned file ID when calling sendfile API."
}
]
},
"description": "The API returns the file processing status for the file been submitted using sendfile API."
},
"response": []
}
]
}The ZeroBounce email validation API operates both in real time and in bulk. If you need to verify emails consistently and would like to save time and automate the process, we recommend using the bulk feature.
The API detects more than 30 types of risky email addresses, prevents them from getting on your list and helps to maintain your email hygiene for a longer period of time. A healthy email list supports your sender reputation and is a cornerstone of good email deliverability.
Activate the API today by installing it on your registration and signup forms, or wherever you collect email addresses online.
Need help getting started with the email validation API? Get in touch with our customer support team. We are here to answer your questions and assist you around the clock, 365 days a year.
Get Credit Balance (v2)
This API will tell you how many credits you have left on your account. It's simple, fast and easy to use.
Here are a few scenarios that businesses will use this API for.
- You use our API to validate emails and you need to check within a certain time-frame when your credit balance is too low, so you can make a payment.
- You want to track how many email validation credits you're using per your defined time-frame to generate useful statistical information.
- You want to automate and integrate information into your application dashboard that shows you your currently remaining credit balance.
Below, you will find the instructions on how to use our API. It's very easy to use and it requires SSL.
GET /V2/GETCREDITS
API URL: https://api.zerobounce.in/v2/getcredits
Below you will find the instructions on how to use our API, it's very easy to use and requires SSL. The API requires that you have an active credit balance and will never consume a credit for any unknown result.
URL Parameters
- ParameterDescription
- api_keyYour API Key, found in your account.
GET CREDIT BALANCE CODE SAMPLES
This API will tell you how many credits you have left on your account. It's simple, fast and easy to use.
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 key:
https://api.zerobounce.in/v2/getcredits?api_key=[replacewithyours]
This API will tell you how many credits you have left on your account.
The API will return these results in a JSON format using the "getcredits" method. credits - The amount of credits you have left in your account for email validations. If a -1 is returned, that means your API Key is invalid.
ENDPOINT RESPONSE
This API will tell you how many credits you have left on your account. It's simple, fast and easy to use.
Successful Response
{"Credits":2375323}
{"Credits":-1}GetCredits V1 and V2 Rate Limits
We allow a maximum of 20.000 requests in 1 hour for the https://api.zerobounce.in/v1/getcredits and https://api.zerobounce.in/v2/getcredits before temporarily blocking for 1 day.
Bad API key requests to https://api.zerobounce.in/v1/getcredits and https://api.zerobounce.in/v2/getcredits 200 times in 1 hour will result in a temporary block for 1 day.