Quickstart Guide
Quickstart Guide
Get started with BillionVerify API in 5 minutes
Quickstart Guide
Get up and running with the BillionVerify API in just a few minutes. This guide will walk you through the essential steps to start verifying emails.
Prerequisites
Before you begin, you'll need:
- A BillionVerify account (Sign up free)
- An API key (available in your dashboard)
- Basic knowledge of HTTP requests
Step 1: Get Your API Key
- Log in to your BillionVerify dashboard
- Navigate to API Keys section
- Click Create New Key
- Copy your API key and keep it secure
Never expose your API key in client-side code or public repositories.
Step 2: Make Your First Request
Here's a simple example to verify a single email address:
Using cURL
curl -X POST https://api.billionverify.com/v1/verify \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email": "test@example.com"}'Using JavaScript
const response = await fetch('https://api.billionverify.com/v1/verify', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
email: 'test@example.com'
})
});
const result = await response.json();
console.log(result);Using Python
import requests
response = requests.post(
'https://api.billionverify.com/v1/verify',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={'email': 'test@example.com'}
)
result = response.json()
print(result)Step 3: Understanding the Response
A typical response looks like this:
{
"email": "test@example.com",
"status": "valid",
"result": {
"deliverable": true,
"valid_format": true,
"valid_domain": true,
"valid_mx": true,
"disposable": false,
"role": false,
"catchall": false,
"free": false
},
"score": 0.95,
"credits_used": 1
}Key Fields Explained
- status: Overall verification status (
valid,invalid, orunknown) - deliverable: Whether the email can receive messages
- disposable: Whether it's a temporary/disposable email
- role: Whether it's a role-based address (e.g., info@, support@)
- catchall: Whether the domain accepts all emails
- score: Confidence score (0-1, higher is better)
Step 4: Install an SDK (Optional)
For easier integration, use one of our official SDKs:
Node.js
npm install @billionverify/nodeconst BillionVerify = require('@billionverify/node');
const client = new BillionVerify('YOUR_API_KEY');
const result = await client.verify('test@example.com');Python
pip install billionverifyfrom billionverify import Client
client = Client('YOUR_API_KEY')
result = client.verify('test@example.com')Next Steps
API Reference
Explore all available endpoints
Bulk Verification
Learn to verify multiple emails
Webhooks
Set up real-time notifications
Common Use Cases
- Form Validation: Verify emails in real-time during signup
- List Cleaning: Remove invalid emails from your mailing lists
- Lead Scoring: Use verification data to qualify leads
- Fraud Prevention: Block disposable emails from creating accounts
Need help? Contact our support team or check our FAQ.