API Documentation

Welcome to the DeGhost API. Our endpoints allow you to validate users in real-time by analyzing their Email, Domain, and IP address.

Authentication

Currently, all endpoints are public for integration testing. Rate limits apply per IP. Contact us for production API keys.

Base URL

https://fraudcheckapi.hexbyte.dev

All API requests use this base URL. Append the endpoint paths shown below.

1. Email Validation

Validates an email address by checking syntax, domain existence, and MX records. Also checks internal blacklists for disposable providers.

GET
https://fraudcheckapi.hexbyte.dev/email/:email

Example Request

cURL
curl -X GET "https://fraudcheckapi.hexbyte.dev/email/user@example.com"

Response

JSON
{
  "status": "allowed",
  "has_mx": true,
  "disposable": false,
  "spam": false,
  "public_domain": false,
  "relay_domain": false,
  "whitelisted": false,
  "blacklisted": false,
  "domain_age_in_days": 365
}
FieldTypeDescription
statusstringOverall validation status: 'allowed', 'not_allowed', or 'not_applicable'
has_mxbooleanWhether the domain has valid MX records
disposablebooleanTrue if from a disposable email provider
spambooleanTrue if domain is known for spam
public_domainbooleanTrue if public email provider (Gmail, etc.)
relay_domainbooleanTrue if used as email relay
whitelistedbooleanTrue if domain is whitelisted
blacklistedbooleanTrue if domain is blacklisted
domain_age_in_daysnumberDomain age in days since registration

Status Codes

Status CodeDescription
200Email validated successfully (Allowed)
400Invalid input format
403Forbidden: Email is disposable, spam, or has no MX records
499Client Closed Request
504Gateway Timeout (>5s)

2. Domain Validation

Isolates the check to the domain level. Useful if you want to allow specific email patterns but block entire domain providers.

GET
https://fraudcheckapi.hexbyte.dev/domain/:domain

Example Request

cURL
curl -X GET "https://fraudcheckapi.hexbyte.dev/domain/example.com"

Response

JSON
{
  "status": "allowed",
  "has_mx": true,
  "disposable": false,
  "spam": false,
  "public_domain": false,
  "relay_domain": false,
  "whitelisted": false,
  "blacklisted": false,
  "domain_age_in_days": 365
}
FieldTypeDescription
statusstringOverall validation status: 'allowed', 'not_allowed', or 'not_applicable'
has_mxbooleanWhether the domain has valid MX records
disposablebooleanTrue if from a disposable email provider
spambooleanTrue if domain is known for spam
public_domainbooleanTrue if public email provider (Gmail, etc.)
relay_domainbooleanTrue if used as email relay
whitelistedbooleanTrue if domain is whitelisted
blacklistedbooleanTrue if domain is blacklisted
domain_age_in_daysnumberDomain age in days since registration

Status Codes

Status CodeDescription
200Domain validated successfully
400Invalid domain format
403Forbidden: Domain is disposable, spam, or invalid
499Client Closed Request
504Gateway Timeout (>5s)

3. IP Intelligence

Checks the IP address against global threat databases. Returns detailed security flags to help you decide whether to block the user.

GET
https://fraudcheckapi.hexbyte.dev/ip/:ip

Example Request

cURL
curl -X GET "https://fraudcheckapi.hexbyte.dev/ip/8.8.8.8"

Response

JSON
{
  "ip": "8.8.8.8",
  "security": {
    "is_abuser": false,
    "is_attacker": false,
    "is_bogon": false,
    "is_cloud_provider": true,
    "is_proxy": false,
    "is_relay": false,
    "is_tor": false,
    "is_tor_exit": false,
    "is_vpn": false,
    "is_anonymous": false,
    "is_threat": false
  }
}

Security Recommendation

We recommend blocking the user if any of these fields are true:

  • • is_abuser
  • • is_attacker
  • • is_threat
FieldTypeDescription
is_abuserbooleanIP has history of abusive behavior
is_attackerbooleanIP is known for attacks
is_bogonbooleanIP is unallocated or reserved
is_cloud_providerbooleanIP belongs to cloud hosting
is_proxybooleanIP is a known proxy server
is_relaybooleanIP is used as relay
is_torbooleanIP is part of Tor network
is_tor_exitbooleanIP is a Tor exit node
is_vpnbooleanIP associated with VPN services
is_anonymousbooleanIP used for anonymous browsing
is_threatbooleanIP identified as active threat

Status Codes

Status CodeDescription
200IP validated successfully
403Forbidden: Private/Reserved/Localhost IP
500Internal Server Error

Need help with integration?

Contact Support