EmailVeritas URL Checker PHP SDK

🔗 Official SDK for the EmailVeritas URL Checker —
a real-time phishing and malicious link detection API.

This PHP library provides easy access to the EmailVeritas URL Checker API,
including the /v1/url/lookup and /v1/url/scan endpoints.

🛡️ Detect and classify phishing URLs, scams, and unsafe redirects directly from your PHP applications.

🌐 Official Resources

• Website: https://www.emailveritas.com
• Product page: https://www.emailveritas.com/url-checker
• API Documentation: EmailVeritas Phish Guard API
• Support email: support@emailveritas.com

🚀 Features

• ✅ Easy integration with the EmailVeritas URL Checker API
• 🔍 Perform URL Lookup — classify domains as legitimate, phishing, or pending scan
• 🧠 Perform URL Scan — full redirect-chain, WHOIS, IP info, and HTML metadata
• 🌎 Native PHP with no external dependencies (uses cURL)
• 🧱 Ready for production, CI/CD pipelines, or serverless environments

📦 Installation

Using Composer

composer require Email-Veritas/url-checker-php-sdk

Or manually:

git clone https://github.com/Email-Veritas/url-checker-php-sdk.git
cd url-checker-php-sdk
composer install

🔑 Getting an API Key

To use the EmailVeritas URL Checker PHP SDK, you need a valid API key.
You can obtain your API key by signing up or logging into the EmailVeritas Dashboard.
Once logged in, navigate to the API section to generate and manage your API keys.
Keep your API key secure and do not expose it in public repositories.

⚙️ Quick Start

Set your API key (from EmailVeritas Dashboard)
and call either lookup() or scan() methods.

Lookup example

require 'vendor/autoload.php';

use EmailVeritas\UrlCheckerClient;

$client = new UrlCheckerClient('YOUR_API_KEY');

$response = $client->lookup([
    "t.email.currys.co.uk",
    "click.convertkit-mail2.com",
    "shop.doazmaz.top"
]);

print_r($response);

Scan example

$client = new UrlCheckerClient('YOUR_API_KEY');

$response = $client->scan(
    ['https://google.com'],
    webPageInfo: true,
    htmlContent: true,
    whois: true
);

print_r($response);

🔗 API Endpoints

/v1/url/lookup

Checks if a domain or URL is known as legitimate, phishing, or needs scanning.

Example cURL:

curl --request POST \
  --url https://openai.emailveritas.com/v1/url/lookup \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: YOUR_API_KEY' \
  --data '{
  "urls": [
    "t.email.currys.co.uk",
    "click.convertkit-mail2.com",
    "shop.doazmaz.top"
  ]
}'

/v1/url/scan

Performs full scan including WHOIS, redirects, and HTML metadata.

Example cURL:

curl --request POST \
  --url https://openai.emailveritas.com/v1/url/scan \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apikey: YOUR_API_KEY' \
  --data '{
  "urls": ["google.com"],
  "web_page_info": true,
  "html_content": true,
  "whois": true
}'

🧪 Example Responses

Lookup response

{
  "message": "Success",
  "cod": "200",
  "legitimate": ["google.com"],
  "phishing": ["shop.doazmaz.top"],
  "need_to_scan": ["t.email.currys.co.uk"]
}

Scan response

{
  "message": "Success",
  "cod": "200",
  "urls": [
    {
      "url": "google.com",
      "domain": "google.com",
      "classification": "legitimate",
      "data": {
        "analysis": [
          {
            "summary": "Safe website",
            "analysis_date": "2025-10-05T12:00:00Z",
            "redirection_chain": ["http://google.com", "https://www.google.com/"]
          }
        ]
      }
    }
  ]
}

⚠️ Error Handling

The SDK throws \RuntimeException on:
- Network or timeout errors
- Invalid or non-JSON responses
- Missing or invalid API key

Wrap API calls in a try/catch block for production use.

🤝 Contributing

Pull requests and issues are welcome.
Follow PSR-12 style and ensure all code passes tests before submitting a PR.

1. Fork this repository
2. Create a feature branch (feat/my-feature)
3. Submit a Pull Request

🧾 License

Released under the MIT License.
© EmailVeritas Security Technologies Ltd.

💬 Contact

For integration help or enterprise plans:
📧 support@emailveritas.com
🌍 https://www.emailveritas.com/url-checker