API Reference

Complete API documentation for Bizifai's business verification platform.

Base URL

https://api.bizifai.com/v1

Authentication

All API requests require authentication using your API key. Include the key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can find your API key in your dashboard under Settings > API Keys.

Rate Limits

Plan Requests per Minute Requests per Day
Free 10 100
Starter 60 1,000
Professional 300 10,000
Enterprise 1,000 100,000

Endpoints

POST /verify

Verify a business using advanced verification methods.

Request Body

{
  "url": "string (required)",
  "company_name": "string (optional)",
  "country": "string (optional)"
}

Response

{
  "company_name": "string",
  "website_url": "string",
  "trust_score": "number (0-100)",
  "risk_level": "string (low|medium|high)",
  "summary": "string",
  "detailed_analysis": "string",
  "inconsistencies": "array",
  "recommendations": "string",
  "citations": "array",
  "extracted_data": "object",
  "timestamp": "string (ISO 8601)"
}

Example Request

curl -X POST "https://api.bizifai.com/v1/verify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "company_name": "Example Corp",
    "country": "US"
  }'

Example Response

{
  "company_name": "Example Corp",
  "website_url": "https://example.com",
  "trust_score": 85,
  "risk_level": "low",
  "summary": "Legitimate business with strong online presence",
  "detailed_analysis": "The business shows all signs of legitimacy...",
  "inconsistencies": [],
  "recommendations": "Continue with business relationship",
  "citations": ["whois.net", "business-registry.gov"],
  "extracted_data": {
    "domain_age": "5 years",
    "ssl_certificate": "valid",
    "business_registration": "verified"
  },
  "timestamp": "2024-12-15T10:30:00Z"
}
GET /verify/history

Retrieve your verification history.

Query Parameters

limit integer optional

Number of results to return (default: 50, max: 100)

offset integer optional

Number of results to skip (default: 0)

Response

{
  "verifications": [
    {
      "id": "string",
      "company_name": "string",
      "website_url": "string",
      "trust_score": "number",
      "risk_level": "string",
      "status": "string",
      "created_at": "string (ISO 8601)"
    }
  ],
  "total": "integer",
  "limit": "integer",
  "offset": "integer"
}
GET /verify/{id}

Get detailed information about a specific verification.

Path Parameters

id string required

The verification ID

Response

{
  "id": "string",
  "company_name": "string",
  "website_url": "string",
  "trust_score": "number",
  "risk_level": "string",
  "summary": "string",
  "detailed_analysis": "string",
  "inconsistencies": "array",
  "recommendations": "string",
  "citations": "array",
  "extracted_data": "object",
  "created_at": "string (ISO 8601)",
  "updated_at": "string (ISO 8601)"
}
GET /account

Get your account information and usage statistics.

Response

{
  "account": {
    "id": "string",
    "email": "string",
    "plan": "string",
    "created_at": "string (ISO 8601)"
  },
  "usage": {
    "verifications_used": "integer",
    "verifications_limit": "integer",
    "verifications_remaining": "integer"
  },
  "billing": {
    "next_billing_date": "string (ISO 8601)",
    "payment_method": "string"
  }
}

Error Codes

Code Message Description
400 Bad Request Invalid request parameters
401 Unauthorized Invalid or missing API key
402 Payment Required Usage limit exceeded
403 Forbidden Insufficient permissions
404 Not Found Resource not found
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Server error occurred

SDKs

Official SDKs for popular programming languages:

Python

pip install bizifai-python 
from bizifai import BizifaiClient

client = BizifaiClient(api_key='YOUR_API_KEY')
result = client.verify_business(
    url='https://example.com',
    company_name='Example Corp',
    country='US'
)

Node.js

npm install bizifai-js 
const BizifaiClient = require('bizifai-js');

const client = new BizifaiClient('YOUR_API_KEY');
const result = await client.verifyBusiness({
  url: 'https://example.com',
  companyName: 'Example Corp',
  country: 'US'
});

PHP

composer require bizifai/php-sdk 
use Bizifai\BizifaiClient;

$client = new BizifaiClient('YOUR_API_KEY');
$result = $client->verifyBusiness([
    'url' => 'https://example.com',
    'company_name' => 'Example Corp',
    'country' => 'US'
]);

Webhooks

Receive real-time notifications about verification events.

Webhook Events

verification.completed

Triggered when a verification is completed

verification.failed

Triggered when a verification fails

account.limit_exceeded

Triggered when usage limits are exceeded

Webhook Payload

{
  "event": "verification.completed",
  "data": {
    "id": "string",
    "company_name": "string",
    "website_url": "string",
    "trust_score": "number",
    "risk_level": "string",
    "status": "string"
  },
  "timestamp": "string (ISO 8601)"
}

Need Help?

📚 Documentation

Complete guides and tutorials

View Docs

💬 Community

Join our developer community

Join Community

🆘 Support

Get help from our support team

Contact Support